Merge pull request #559 from rackspace/working

Merging working -> master in preparation for release

Author: ycombinator

.travis.yml

@@ -6,9 +6,12 @@ php:
   - "5.3"
   - hhvm
 
+sudo: false
+
 matrix:
   allow_failures:
     - php: hhvm
+  fast_finish: true
 
 branches:
   only:
@@ -28,3 +31,6 @@ notifications:
     - [email protected]
     - [email protected]
     - [email protected]
+
+env:
+  - secure: "bdrUeYb3nSGgBB+QtDZxUHVPw6B/wjb3KXLm8TgonWrQm4GPeWKK29qhmDnFZmQjwQPfuebe7wAk1ZxGoZKbEiELVpJJ+8XYVOt6W/6V53H31JL6FqiIE5+7qBwDe+9ziveM6GcTXHT1GI5mUeACIbeBDPZaNubIJH3U6MPim64="

CONTRIBUTING.md

@@ -17,7 +17,15 @@ efforts. Here are a few general guidelines to follow:
    minor typographical error, create a description which explains your changes
    and, where relevant, references the existing issue you're hoping to fix.
 
-5. Document your code!
+5. If your pull request introduces a large change or addition, please consider
+   creating a work-in-progress (WIP) pull request. This lets us review your changes
+   and provide feedback early and often rather than all at once when the entire pull
+   request is ready. To denote a pull request as WIP, simply add the "PR: Work In Progress"
+   label to it. When you are finished with your work in the pull request and
+   are ready for a final review and merge, please remove the "PR: Work In Progress"
+   label.
+
+6. Document your code!
 
 If you submit code, please add your name and email address to the
 CONTRIBUTORS file.

README.md

@@ -32,12 +32,15 @@ php composer.phar require rackspace/php-opencloud
 ```
 
 Once you have installed the library, you will need to load Composer's autoloader (which registers all the required
-namespaces):
+namespaces). To do this, place the following line of PHP code at the top of your application's PHP files:
 
 ```php
 require 'vendor/autoload.php';
 ```
 
+**Note**: this assumes your application's PHP files are located in the same folder as `vendor/`. If your files are located
+elsewhere, please supply the path to `vendor/autoload.php` in the `require` statement above.
+
 And you're ready to go!
 
 You can also check out the [Getting Started guide](docs/getting-started.md) for a quick tutorial.
@@ -60,7 +63,7 @@ Your feedback is appreciated! If you have specific problems or bugs with this SD
 also have a [mailing list](https://groups.google.com/forum/#!forum/php-opencloud), so feel free to join to keep up to
 date with all the latest changes and announcements to the library.
 
-For general feedback and support requests, send an email to sdk-support@rackspace.com.
+For general feedback and support requests, contact us at https://developer.rackspace.com/support/
 
 You can also find assistance via IRC on #rackspace at freenode.net.
 

apigen.neon

@@ -0,0 +1,3 @@
+templateTheme: bootstrap
+
+accessLevels: [public]

composer.json

@@ -13,6 +13,11 @@
         {
             "name": "Glen Campbell",
             "email": "[email protected]"
+        },
+        {
+            "name": "Shaunak Kashyap",
+            "email": "[email protected]",
+            "homepage": "https://github.com/ycombinator"
         }
     ],
     "autoload": {
@@ -22,14 +27,14 @@
     },
     "require": {
         "php" : ">=5.3.3",
-        "guzzle/http" : "~3.8",
+        "guzzle/guzzle" : "~3.8",
         "psr/log": "~1.0"
     },
     "require-dev" : {
         "phpunit/phpunit": "4.3.*",
-        "guzzle/guzzle": "~3.8",
         "satooshi/php-coveralls": "0.6.*@dev",
         "jakub-onderka/php-parallel-lint": "0.*",
-        "fabpot/php-cs-fixer": "1.0.*@dev"
+        "fabpot/php-cs-fixer": "1.0.*@dev",
+        "apigen/apigen": "~2.8"
     }
 }

doc/.gitignore

@@ -0,0 +1 @@
+_build/

doc/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/php-opencloud.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/php-opencloud.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/php-opencloud"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/php-opencloud"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

doc/caching-creds.rst

@@ -0,0 +1,44 @@
+Caching credentials
+===================
+
+You can speed up your API operations by caching your credentials in a
+(semi-)permanent location, such as your DB or local filesystem. This
+enable subsequent requests to access a shared resource, instead of
+repetitively having to re-authenticate on every thread of execution.
+
+Tokens are valid for 24 hours, so you can effectively re-use the same
+cached value for that period. If you try to use a cached version that
+has expired, an authentication request will be made.
+
+Filesystem example
+------------------
+
+In this example, credentials will be saved to a file in the local
+filesystem. Be sure to exclude it from your VCS.
+
+.. code-block:: php
+
+  use OpenCloud\Rackspace;
+
+  $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array(
+      'username' => 'foo',
+      'apiKey'   => 'bar'
+  ));
+
+  $cacheFile = __DIR__ . '/.opencloud_token';
+
+  // If the cache file exists, try importing it into the client
+  if (file_exists($cacheFile)) {
+      $data = unserialize(file_get_contents($cacheFile));
+      $client->importCredentials($data);
+  }
+
+  $token = $client->getTokenObject();
+
+  // If no token exists, or the current token is expired, re-authenticate and save the new token to disk
+  if (!$token || ($token && $token->hasExpired())) {
+      $client->authenticate();
+      file_put_contents($cacheFile, serialize($client->exportCredentials()));
+  }
+
+In tests, the above code shaved about 1-2s off the execution time.

doc/conf.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+#
+# php-opencloud documentation build configuration file, created by
+# sphinx-quickstart on Tue Mar  3 12:28:19 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+from sphinx.highlighting import lexers
+from pygments.lexers.web import PhpLexer
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+lexers['php'] = PhpLexer(startinline=True, linenos=1)
+lexers['php-annotations'] = PhpLexer(startinline=True, linenos=1)
+primary_domain = 'php'
+
+extensions = ['sphinxcontrib.phpdomain']
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+project = u'php-opencloud'
+copyright = u'2015, Jamie Hannaford, Shaunak Kashyap'
+version = '1.12'
+release = '1.12.1'
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+html_theme = 'default'
+
+if not on_rtd:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "_templates"]
+
+html_static_path = ['_static']
+html_use_index = True
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'php-openclouddoc'
+
+latex_documents = [
+  ('index', 'php-opencloud.tex', u'php-opencloud Documentation',
+   u'Jamie Hannaford, Shaunak Kashyap', 'manual'),
+]
+
+man_pages = [
+    ('index', 'php-opencloud', u'php-opencloud Documentation',
+     [u'Jamie Hannaford, Shaunak Kashyap'], 1)
+]
+
+texinfo_documents = [
+  ('index', 'php-opencloud', u'php-opencloud Documentation',
+   u'Jamie Hannaford, Shaunak Kashyap', 'php-opencloud', 'One line description of project.',
+   'Miscellaneous'),
+]