rpbertp13-dm-s3 0.1.0 → 0.1.2

data/README.rdoc

@@ -1,6 +1,76 @@
 = dm-s3
 
-Description goes here.
+Very often we want to store a file in s3 and keep a record of it in our database.
+
+== Setting
+
+If you have a model class that will have s3 objects living in different buckets do
+
+  property :s3_key, String
+  property :s3_bucket, String
+
+  has_s3_file 
+
+and define a method to save your resource and your s3 object
+
+  def self.create!(key, bucket, file, options)
+    object = self.new :s3_key => key, :s3_bucket => bucket
+    object.save if object.store_with(file, options)
+  end
+
+If all the s3 objects will live in the same bucket then do
+
+  property :s3_key, String
+
+  has_s3_file_at 'my-bucket-name'
+  
+The save method will reflect the difference
+
+  def self.create!(key, file, options)
+    object = self.new :s3_key => key
+    object.save if object.store_with(file, options)
+  end
+  
+You can directly access the bucket object associated with this model too
+  
+  MyModel.bucket
+  
+== Getting
+  
+To retrieve data from s3 simply pull the datamapper object, e.g.
+  
+  object = MyModel.first
+
+Doing
+  
+  object.s3
+
+Will give you the s3 object. So you can do things like
+
+  object.s3.value
+  object.s3.url
+  object.s3.about
+
+etc. 
+
+For convenience, the methods 'value', 'metadata', 'about' and 'url' get bound to the datamapper object directly so the following is valid
+
+  object.value
+  object.metadata
+  object.about
+  object.url
+
+Make sure these don't conflict with your properties.
+
+== Gotchas
+
+* The gem assumes that you will call 
+   
+   AWS::S3::Base.establish_connection!
+
+with the appropriate credentials some time before you create or access your s3 enabled models
+
+* The gem won't create buckets for you. Make sure the buckets exist before attempting to use them.
 
 == Copyright
 

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "dm-s3"
-    gem.summary = %Q{TODO}
+    gem.summary = "A simple gem that makes it easy to associate datamapper objects with s3 objects "
     gem.email = "roberto.n.thais@gmail.com"
     gem.homepage = "http://github.com/rpbertp13/dm-s3"
     gem.authors = ["Roberto Thais"]

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 0
+:patch: 2

data/dm-s3.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-s3}
-  s.version = "0.1.0"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roberto Thais"]
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.4}
-  s.summary = %q{TODO}
+  s.summary = %q{A simple gem that makes it easy to associate datamapper objects with s3 objects}
   s.test_files = [
     "test/dm-s3_test.rb",
      "test/test_helper.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rpbertp13-dm-s3
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - Roberto Thais
@@ -77,7 +77,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: TODO
+summary: A simple gem that makes it easy to associate datamapper objects with s3 objects
 test_files: 
 - test/dm-s3_test.rb
 - test/test_helper.rb