s3mpi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 750b7484b10dac34808cb7c1cb1c1f2bdfd7eeb0
-  data.tar.gz: e63652c05a474322356d2587ad62dff51f030d25
+  metadata.gz: 67cdd6effa5fd9982c41d98ab9771893af7a21bb
+  data.tar.gz: 993b03afcfdc8b04b7499f820c9786eae4ca678a
 SHA512:
-  metadata.gz: ce652479bba4088e04d61aa1565c8f03db7db7839b4525520a34efc36e199a4dd7d32c475e86a354c065bb46b1fba8818ee38f1441f5f30099afa759a958c1b3
-  data.tar.gz: adf00002f3bb1e21a1ec052603fc8f44044b530e4f9e935f8bac9ece01138b22bf58d78fde509acf652e75a926df3ebb6b67f1f9affd57197d52cffbd6363728
+  metadata.gz: 5b61de73d975d2e90c3de2ef5f341dbeddc239caefb226d286b9776e8d48931f4f4936dc67154444f8d2c7d7e59896d1a6b266f38e7b911fd4342a169461f27b
+  data.tar.gz: c6876dd9999bc7108b9caa5e9fff3346ba3903e2b8130090b2f697e5227df4b921068657fa951e625b62ce717c773df9494d571063c9a7c8cb0470f0a9d1ca88

data/README.md

@@ -1,7 +1,27 @@
 S3MPI 
 =========
 
-Upload and download files to S3 using a very convenient API.
+Upload and download Ruby objects to S3 using a very convenient API.
+
+
+Usage
+-----
+
+To set up an S3 interface, one can run
+
+```ruby
+MPI = S3MPI::Interface.new('bucket', 'path/in/bucket')
+# or a constant name of your choosing
+```
+
+Then, assuming our [credentials are set up correctly](https://aws.amazon.com/articles/8621639827664165),
+we can store and read Ruby objects:
+
+```ruby
+MPI.store({some: 'ruby', object: 5}, 'some_object')
+MPI.read('some_object')
+```
 
 [![Build Status](https://travis-ci.org/robertzk/s3mpi.svg?branch=master)](https://travis-ci.org/robertzk/s3mpi)
 [![Code Climate](https://codeclimate.com/github/robertzk/s3mpi.png)](https://codeclimate.com/github/robertzk/s3mpi)
+

data/lib/s3mpi/interface.rb

@@ -61,6 +61,16 @@ module S3MPI
       s3_object(key).exists?
     end
 
+    # Fetch the S3 object as an AWS::S3::S3Object.
+    # 
+    # @param [String] name
+    #    The key under which to save the object in the S3 bucket.
+    #    
+    # @return [AWS::S3::S3Object]
+    def object(key)
+      AWS::S3::S3Object.new(@bucket, "#{@path}#{key}")
+    end
+
   end
 end
 

data/lib/s3mpi/version.rb

@@ -2,7 +2,7 @@ module S3MPI
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    PATCH = 2
+    PATCH = 3
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3mpi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Robert Krzyzanowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk