s33r 0.3.1 → 0.4

data/html/classes/S33r/Sync.html

@@ -87,7 +87,7 @@ s33r to compare files on the filesystem to S3 objects.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000054">md5sum</a>&nbsp;&nbsp;
+      <a href="#M000059">md5sum</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -109,11 +109,11 @@ s33r to compare files on the filesystem to S3 objects.
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000054" class="method-detail">
-        <a name="M000054"></a>
+      <div id="method-M000059" class="method-detail">
+        <a name="M000059"></a>
 
         <div class="method-heading">
-          <a href="#M000054" class="method-signature">
+          <a href="#M000059" class="method-signature">
           <span class="method-name">md5sum</span><span class="method-args">(filename)</span>
           </a>
         </div>
@@ -124,8 +124,8 @@ Get the MD5 checksum for a local file (comparable to the ETag on S3
 objects).
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000054-source">
+            onclick="toggleCode('M000059-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000059-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/s33r/sync.rb, line 7</span>
  7:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">md5sum</span>(<span class="ruby-identifier">filename</span>)

data/html/classes/XML.html

@@ -158,8 +158,10 @@ href="XML/Document.html">XML::Document</a> instance.
       
         <div class="method-description">
           <p>
-Find first matching element and return its content (intended for use as a
-mixed-in method for <a href="XML/Document.html">Document</a> instances).
+Find first element matching <tt>xpath</tt> and return its content (intended
+for use as a mixed-in method for <a
+href="XML/Document.html">Document</a>/<a href="XML/Node.html">Node</a>
+instances).
 </p>
 <p>
 <tt>xpath</tt>: XPath query to run against self.

data/html/created.rid

@@ -1 +1 @@
-Wed Sep 27 09:47:06 BST 2006
+Mon Oct 23 16:01:19 BST 2006

data/html/files/README_txt.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Sep 26 11:29:17 BST 2006</td>
+      <td>Mon Oct 23 16:00:58 BST 2006</td>
     </tr>
     </table>
   </div>
@@ -71,25 +71,54 @@
     <div id="description">
       <h1>Introduction</h1>
 <p>
-This is a first pass at a Ruby library for talking to Amazon&#8217;s S3
-service.
+This is my go at a Ruby library for talking to Amazon&#8217;s S3 service
+via REST. It is based on the sample Ruby code for S3 provided by Amazon,
+but has gone a long way beyond it now. Most of the remaining Amazon code is
+now in core.rb; the rest is mine.
 </p>
 <p>
-It is less complete than my previous effort (<a
-href="http://townx.org/blog/elliot/s3_rails">townx.org/blog/elliot/s3_rails</a>),
-but more solid, more elegant, and with a test suite (which uses RSpec - see
-<a
-href="http://rubyforge.org/projects/rspec">rubyforge.org/projects/rspec</a>).
-</p>
-<p>
-To use it from inside your Ruby script:
+To use it from inside your Ruby script (as a gem):
 </p>
 <pre>
-  require 's33r'
+  require 'rubygems'
+  require_gem 's33r'
 </pre>
 <p>
+Alternatively, just load lib/s33r.rb.
+</p>
+<p>
 By the way, I&#8217;ve tested this on Linux, but not on Windows or Mac.
 </p>
+<h1>Features</h1>
+<p>
+Supports the following aspects of S3:
+</p>
+<ul>
+<li>List all buckets
+
+</li>
+<li>Get bucket
+
+</li>
+<li>Create bucket
+
+</li>
+<li>Delete bucket
+
+</li>
+<li>Put resource into bucket (text or file)
+
+</li>
+<li>Delete resource from bucket
+
+</li>
+<li>Set ACL for a bucket or resource
+
+</li>
+<li>Turn on logging for a bucket or resource
+
+</li>
+</ul>
 <h1>Requirements</h1>
 <p>
 To get the most from s33r, you will need:
@@ -99,11 +128,14 @@ To get the most from s33r, you will need:
 versions)
 
 </li>
-<li>openssl (you can use s33r without this, but obviously you won&#8217;t be
-able to encrypt connections)
+<li>libxml (REQUIRED: s33r relies on this for parsing responses from S3)
+
+</li>
+<li>builder (REQUIRED)
 
 </li>
-<li>libxml (s33r relies on this for parsing responses from S3)
+<li>openssl (you can use s33r without this, but obviously you won&#8217;t be
+able to encrypt connections)
 
 </li>
 <li>rspec (if you want to run the unit tests)
@@ -113,7 +145,7 @@ able to encrypt connections)
 
 </li>
 </ul>
-<h1>Usage</h1>
+<h1>Basic usage</h1>
 <ul>
 <li>Set up an Amazon S3 account at <a
 href="http://amazon.com/s3">amazon.com/s3</a>.
@@ -140,9 +172,10 @@ aws_secret_access_key with your settings.
 <li>Try the following code:
 
 <pre>
-  require 'lib/s33r'
+  require_gem 's33r'
   include S33r
   # initialise a client instance from a config file
+  # (see the sample in examples/s3.yaml)
   client = Client.init('/home/you/.s33r')
   # create a bucket called 'some-outlandish-name'
   client.create_bucket('some-outlandish-name')
@@ -154,20 +187,41 @@ aws_secret_access_key with your settings.
 </li>
 </ul>
 <p>
-Note that the simple Client class is not sophisticated and returns raw
-requests (list_buckets returns a HTTPResponse object with attached body,
-for example). I tend to use NamedBucket instead, which provides a
-simplified interface to a single bucket. This saves having to pass the
-bucket name to every method call, and parses bucket listings into an object
-representation.
+Note that the simple Client class is not particularly sophisticated and
+returns raw requests for some methods. I tend to use NamedBucket instead,
+which provides a simplified interface to a single bucket. This saves having
+to pass the bucket name to every method call, and parses bucket listings
+into an object representation.
+</p>
+<h1>Examples</h1>
+<p>
+_Command line client_
 </p>
 <p>
 If you want to see a full example program which uses the library, have a
-look at bin/s3cli.rb. This is a simple command line client which you can
-use to post a file to S3 and email a link to the file to someone. Useful
-for sending big files to people without clogging their email inbox with
-enormous files. It is also intended as a demonstration of how to use the
-library. Full instructions are included at the top of the file.
+look at examples/cli/s3cli.rb. This is a simple command line client which
+you can use to post a file to S3 and email a link to the file to someone.
+Useful for sending big files to people without clogging their email inbox
+with enormous files. It is also intended as a demonstration of how to use
+the library. Full instructions are included at the top of the file.
+</p>
+<p>
+_Rails application_
+</p>
+<p>
+examples/fores33r contains a Rails application which makes use of the <a
+href="../classes/S33r.html">S33r</a> library. It will display a bucket list
+and the contents of individual buckets. You can upload files to your
+buckets using it.
+</p>
+<p>
+Before use, you will need to configure it by editing the file
+examples/s3.yaml (so it knows your Amazon S3 keys) and copying it into the
+config folder.
+</p>
+<p>
+This has been kept deliberately simple, and doesn&#8217;t provide any
+access control or logging management.
 </p>
 <h1>Credits</h1>
 <p>

data/html/files/lib/s33r/bucket_listing_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Sep 26 11:38:55 BST 2006</td>
+      <td>Sun Oct 22 15:49:34 BST 2006</td>
     </tr>
     </table>
   </div>
@@ -68,13 +68,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-TODO: use prefix to limit keys to some subset of all available keys; TODO:
-use delimiter to group keys
-</p>
-
-    </div>
 
     <div id="requires-list">
       <h3 class="section-bar">Required files</h3>

data/html/files/lib/s33r/builder_rb.html

@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: builder.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>builder.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/s33r/builder.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sun Oct 22 20:27:31 BST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+
+      <div class="name-list">
+      builder&nbsp;&nbsp;
+      </div>
+    </div>
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/html/files/lib/s33r/client_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed Sep 27 00:50:59 BST 2006</td>
+      <td>Mon Oct 23 15:40:22 BST 2006</td>
     </tr>
     </table>
   </div>
@@ -75,6 +75,7 @@
       <div class="name-list">
       net/https&nbsp;&nbsp;
       cgi&nbsp;&nbsp;
+      erb&nbsp;&nbsp;
       yaml&nbsp;&nbsp;
       </div>
     </div>

data/html/files/lib/s33r/core_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Sep 18 11:13:16 BST 2006</td>
+      <td>Mon Oct 23 15:51:40 BST 2006</td>
     </tr>
     </table>
   </div>
@@ -79,6 +79,7 @@
       net/https&nbsp;&nbsp;
       openssl&nbsp;&nbsp;
       xml/libxml&nbsp;&nbsp;
+      parsedate&nbsp;&nbsp;
       </div>
     </div>
 

data/html/files/lib/s33r/libxml_extensions_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Sep 04 14:11:25 BST 2006</td>
+      <td>Sun Oct 22 00:09:49 BST 2006</td>
     </tr>
     </table>
   </div>

data/html/files/lib/s33r/logging_rb.html

@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: logging.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+  <div id="fileHeader">
+    <h1>logging.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/s33r/logging.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sun Oct 22 21:14:29 BST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+    <div id="requires-list">
+      <h3 class="section-bar">Required files</h3>
+
+      <div class="name-list">
+      rubygems&nbsp;&nbsp;
+      xml/libxml&nbsp;&nbsp;
+      </div>
+    </div>
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>