Added folder sync to Cloud Files. Fixed several unicode issues. Removed lazy load in Cloud Databases volume information.

Author: EdLeafe

RELEASENOTES.md

@@ -1,5 +1,16 @@
 # Release Notes for pyrax
 
+2013.02.05 - Added the `sync_folder_to_container()` method to cloudfiles to make it
+             easier to keep a copy of a local folder synced to the cloud.
+           - Removed the lazy load of volume info for cloud databases. Changed the
+             'volume' attribute to be an object to allow for dot notation access
+             to its values.
+           - Eliminated as many places as possible where use of non-ASCII characters
+             caused encoding issues. Added a configuration option to allow users to
+             specify their preferred encoding; default=utf-8.
+           - Fixed a bug in the `get_object_names()` method of the Cloud Files
+             container class.
+
 2013.01.26 - Fixed an issue preventing existing node objects being created if in
              'DRAINING' condition (GitHub #6). Modified the rax_identity to accept
              UTC dates returned from the LON datacenter (GitHub #5). Fixed an

docs/cloud_files.md

@@ -213,6 +213,26 @@ Since a folder upload can take a while, the uploading happens in a background th
 Sometimes it is necessary to stop a folder upload before it has completed. To do this, call `cloudfiles.cancel_folder_upload(upload_key)`, which will cause the background thread to stop uploading.
 
 
+## Syncing a Local Folder with a Container
+Another common use case is to use Cloud Files as a backup of the important files on your local machine. `pyrax` provides the `sync_folder_to_container()` method that makes this straightforward. It takes the following parameters:
+
+Parameter | Required? | Description | Default
+---- | ---- | ---- | ---- 
+**folder_path** | yes | Full path to the folder on your local machine | n/a
+**container** | yes | Either the name of an existing container, or an actual container object | n/a
+**include_hidden** | no | When False, files in your folder that begin with a period are ignored | False
+**ignore_timestamps** | no | When False, if the local file and remote object differ, the local file is uploaded and overwrites the remote. When True, the local file's modification time is compared with the remote object's last_modified time, and the remote object is only overwritten if the local file is newer. | False
+
+As an example, assume you have a project named 'important' that you want to make sure is always backed up to Cloud Files. You could write a quick script like this, and call it from a cron job.
+
+    cf = pyrax.cloudfiles
+    local = "/home/myname/projects/important"
+    remote = cf.create_container("important_files")
+    cf.sync_folder_to_container(local, remote)
+
+This would sync all of the files in that folder, except for hidden files, such as .git subdirectories, or the .swp files that vim creates.
+
+
 ## Listing Objects in a Container
 Assuming you have a `Container` object, simply call:
 

docs/cloud_servers.md

@@ -209,7 +209,7 @@ Since each `Server` object has a `delete()` method, it is simple to delete all t
 If you have a `Server` object and want to create an image of that server, you can call its `create_image()` method, passing in the name of the image to create, along with any optional metadata for the image.
 
     cs = pyrax.cloudservers
-    server = cs.get(id_of_server)
+    server = cs.servers.get(id_of_server)
     server.create_image("my_image_name")
 
 Another option is to use call `pyrax.servers.create_image()`, passing in either the name or the ID of the server from which you want to create the image, along with the image name and optional metadata.
@@ -224,7 +224,7 @@ Resizing a server is the process of changing the amount of resources allocated t
 Resizing is a multi-step process. First, determine the desired `Flavor` to which the server is to be resized. Then call the `resize()` method on the server, passing in the ID of the desired `Flavor`. The server's status will then be set to "RESIZE".
 
     cs = pyrax.cloudservers
-    server = cs.get(id_of_server)
+    server = cs.servers.get(id_of_server)
     server.resize(new_flavor_ID)
 
 On the host, a new server instance with the new flavor size will be created based on your existing server. When it is ready, the ID, name, networking, and so forth for the current server instance will be transferred to the new instance. At that point, `get(ID)` will return the new instance, and it will have a status of "CONFIRM_RESIZE". Now you will need to determine if the resize was successful, and that the server is functioning properly. If all is well, call:

docs/html/____init_____8py.html

@@ -143,6 +143,8 @@
 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#affa3c4afe67ff7c721e823ac8b67fa16">default_region</a> = None</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#a395a063eb4a0103b5e6924806e1a7c00">FALLBACK_REGION</a> = &quot;DFW&quot;</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#a29094260a6921954174501a2f1df2d2f">keyring_username</a> = None</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#ab1000d1f2ea9878f60bc119650013894">encoding</a> = None</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#afe27f0e1c4864c0be1ff0061994415f2">DEFAULT_ENCODING</a> = &quot;utf-8&quot;</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#af2dfe76f6f24fbcdfd28b75ed32ada24">USER_AGENT</a> = &quot;pyrax/%s&quot;</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#a6e3493c19e86089da9cd511800adbde3">_http_debug</a> = False</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">tuple&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepyrax.html#ae6512f1802b7f1f9cc6f196a0938db60">config_file</a> = os.path.expanduser(&quot;~/.pyrax.cfg&quot;)</td></tr>
@@ -165,7 +167,7 @@
 
 
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Jan 15 2013 17:17:39 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Feb 5 2013 13:13:12 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.7.6.1
 </small></address>

docs/html/classpyrax_1_1cf__wrapper_1_1client_1_1CFClient-members.html

@@ -136,6 +136,7 @@
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a77469aa965e7df1c81ad902bea324a36">set_container_web_index_page</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a684f0273a86b04ee46bf5a7304df768d">set_object_metadata</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#af0a50c69bbe50a35557fb373cf3b4b6f">store_object</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
+  <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#af2b0d6de7b4f7cb42d5ecef34b239907">sync_folder_to_container</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a3857f84faa9608b0bf0a4e84ba5b1566">upload_file</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a1d81cba43ddabd40e412c5d709192958">upload_folder</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td></td></tr>
   <tr class="memlist"><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#ac1b27022e729d81b2b33590aea822188">user_agent</a></td><td><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html">CFClient</a></td><td><code> [static]</code></td></tr>
@@ -157,7 +158,7 @@
 
 
 <hr class="footer"/><address class="footer"><small>
-Generated on Mon Dec 17 2012 18:02:49 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Feb 5 2013 13:13:12 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.7.6.1
 </small></address>

docs/html/classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html

@@ -153,6 +153,8 @@
 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Uploads the specified file to the container.  <a href="#a3857f84faa9608b0bf0a4e84ba5b1566"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a1d81cba43ddabd40e412c5d709192958">upload_folder</a></td></tr>
 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience method for uploading an entire folder, including any sub-folders, to Cloud Files.  <a href="#a1d81cba43ddabd40e412c5d709192958"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#af2b0d6de7b4f7cb42d5ecef34b239907">sync_folder_to_container</a></td></tr>
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares the contents of the specified folder, and checks to make sure that the corresponding object is present in the specified container.  <a href="#af2b0d6de7b4f7cb42d5ecef34b239907"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a537487e2f2dabc8103e2006739cbeb0e">get_uploaded</a></td></tr>
 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes uploaded for the specified process.  <a href="#a537487e2f2dabc8103e2006739cbeb0e"></a><br/></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#a621a0e61fdb17290b5e9f5dec5eb12fc">cancel_folder_upload</a></td></tr>
@@ -1535,6 +1537,62 @@
 
 <p>Creates a new object in the specified container, and populates it with the given data. </p>
 
+</div>
+</div>
+<a class="anchor" id="af2b0d6de7b4f7cb42d5ecef34b239907"></a><!-- doxytag: member="pyrax::cf_wrapper::client::CFClient::sync_folder_to_container" ref="af2b0d6de7b4f7cb42d5ecef34b239907" args="" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">def <a class="el" href="classpyrax_1_1cf__wrapper_1_1client_1_1CFClient.html#af2b0d6de7b4f7cb42d5ecef34b239907">sync_folder_to_container</a> </td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>self</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>folder_path</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>container</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>delete</em> = <code>False</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>include_hidden</em> = <code>False</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>ignore_timestamps</em> = <code>False</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>Compares the contents of the specified folder, and checks to make sure that the corresponding object is present in the specified container. </p>
+<p>If there is no remote object matching the local file, it is created. If a matching object exists, the etag is examined to determine if the object in the container matches the local file; if they differ, the container is updated with the local file if the local file is newer when `ignore_timestamps' is False (default). If `ignore_timestamps` is True, the object is overwritten with the local file contents whenever the etags differ. NOTE: the timestamp of a remote object is the time it was uploaded, not the original modification time of the file stored in that object.</p>
+<p>Unless 'include_hidden' is True, files beginning with an initial period are ignored.</p>
+<p>If the 'delete' option is True, any objects in the container that do not have corresponding files in the local folder are deleted. </p>
+
 </div>
 </div>
 <a class="anchor" id="a3857f84faa9608b0bf0a4e84ba5b1566"></a><!-- doxytag: member="pyrax::cf_wrapper::client::CFClient::upload_file" ref="a3857f84faa9608b0bf0a4e84ba5b1566" args="" -->
@@ -1805,7 +1863,7 @@
 
 
 <hr class="footer"/><address class="footer"><small>
-Generated on Mon Dec 17 2012 18:02:49 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Feb 5 2013 13:13:12 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.7.6.1
 </small></address>

docs/html/classpyrax_1_1cf__wrapper_1_1container_1_1Container.html

@@ -427,14 +427,49 @@
           <td class="memname">def <a class="el" href="classpyrax_1_1cf__wrapper_1_1container_1_1Container.html#a1ffef9ff929707223146f6c5373e2a14">get_object_names</a> </td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
-          <td class="paramname"><em>self</em></td><td>)</td>
+          <td class="paramname"><em>self</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>marker</em> = <code>None</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>limit</em> = <code>None</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>prefix</em> = <code>None</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>delimiter</em> = <code>None</code>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
           <td></td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname"><em>full_listing</em> = <code>False</code>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 
 <p>Returns a list of the names of all the objects in this container. </p>
+<p>The same pagination parameters apply as in self.get_objects(). </p>
 
 </div>
 </div>
@@ -928,7 +963,7 @@
 
 
 <hr class="footer"/><address class="footer"><small>
-Generated on Tue Nov 20 2012 15:03:05 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Feb 5 2013 13:13:12 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.7.6.1
 </small></address>

docs/html/functions_0x68.html

@@ -134,12 +134,12 @@ <h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
 , <a class="el" href="classpyrax_1_1exceptions_1_1NoUniqueMatch.html#adc16a229378030a650cd7e8d6dc16677">NoUniqueMatch</a>
 , <a class="el" href="classpyrax_1_1exceptions_1_1BadRequest.html#adc16a229378030a650cd7e8d6dc16677">BadRequest</a>
 </li>
-<li>HUMAN_ID
-: <a class="el" href="classpyrax_1_1resource_1_1BaseResource.html#a494d50825f5dfc848a56d8a568c16172">BaseResource</a>
-</li>
 <li>human_id()
 : <a class="el" href="classpyrax_1_1resource_1_1BaseResource.html#a386641658f158d35fbe6af4c8e0d128a">BaseResource</a>
 </li>
+<li>HUMAN_ID
+: <a class="el" href="classpyrax_1_1resource_1_1BaseResource.html#a494d50825f5dfc848a56d8a568c16172">BaseResource</a>
+</li>
 </ul>
 </div><!-- contents -->
 <!-- window showing the filter options -->
@@ -159,7 +159,7 @@ <h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
 
 
 <hr class="footer"/><address class="footer"><small>
-Generated on Mon Dec 24 2012 16:05:48 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Tue Feb 5 2013 13:13:14 for pyrax by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.7.6.1
 </small></address>