dm-s3 0.1.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Roberto Thais
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,77 @@
+= dm-s3
+
+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
+
+Copyright (c) 2009 Roberto Thais. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-s3"
+    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"]
+    gem.add_dependency('aws-s3', '>= 0.6.2')
+    gem.add_dependency('dm-core', '>= 0.9.11')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-s3 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/dm-s3.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-s3}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roberto Thais"]
+  s.date = %q{2009-07-10}
+  s.email = %q{roberto.n.thais@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "dm-s3.gemspec",
+     "lib/dm-s3.rb",
+     "test/dm-s3_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rpbertp13/dm-s3}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0.6.2"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.9.11"])
+    else
+      s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
+      s.add_dependency(%q<dm-core>, [">= 0.9.11"])
+    end
+  else
+    s.add_dependency(%q<aws-s3>, [">= 0.6.2"])
+    s.add_dependency(%q<dm-core>, [">= 0.9.11"])
+  end
+end

data/lib/dm-s3.rb

@@ -0,0 +1,116 @@
+require 'dm-core'
+require 'aws/s3'
+
+module DataMapper  
+  module S3
+    
+    class BaseBucketConnector      
+      def initialize
+        @s3 = AWS::S3::S3Object
+      end
+            
+      def get_s3_object(instance)
+        @s3.find(instance.s3_key)
+      end
+      
+      def store(instance, file, options)
+        @s3.store(instance.s3_key, file, options)
+      end  
+    end
+    
+    class InstanceBucketConnector < BaseBucketConnector      
+      def get_s3_object(instance)
+        s3(instance)
+        super
+      end
+      
+      def store(instance, file, options)
+        s3(instance)
+        super
+      end
+      
+      def s3(instance)
+        @s3.set_current_bucket_to instance.s3_bucket
+      end
+    end
+    
+    class ClassBucketConnector < BaseBucketConnector
+      def initialize(klass, bucket_name)
+        @class = klass
+        @bucket_name = bucket_name
+        super()
+      end
+      
+      def get_s3_object(instance)       
+        self.s3
+        super
+      end
+      
+      def store(instance, file, options)
+        s3
+        super
+      end
+      
+      def bucket        
+        AWS::S3::Bucket.find @bucket_name
+      end
+      
+      def s3 
+        @s3.set_current_bucket_to @bucket_name
+        @s3
+      end      
+    end    
+    
+    module InstanceMethods    
+      def s3
+        self.class.connector.get_s3_object(self)
+      end
+      
+      def store_with(file, options = nil)
+        self.class.connector.store(self, file, options)
+      end
+      
+      #Shortcut method for urls - defaults to unauthenticated
+      def url(options = {:authenticated => false}) 
+        s3.url(options)
+      end
+                
+      [:value, :metadata, :about].each do |m|
+        send :define_method, m do
+           s3.send(m)
+         end
+      end  
+    end
+    
+    module ClassMethods
+      #Auto-add the properties in future version
+      
+      def has_s3_file_at(bucket_name)
+        @connector = ClassBucketConnector.new(self, bucket_name)
+
+        class << self  
+          attr_reader :connector
+     
+          send :define_method, :s3 do
+            self.connector.s3
+          end
+          
+          send :define_method, :bucket do            
+            self.connector.bucket
+          end               
+        end 
+        
+        send :after_class_method, :inherited do |retval, subclass|
+          subclass.instance_variable_set "@connector", @connector
+        end                     
+      end
+      
+      def has_s3_file
+        @connector = InstanceBucketConnector.new
+      end       
+                  
+    end    
+  end
+  Resource.append_inclusions(S3::InstanceMethods)
+  Model.append_extensions(S3::ClassMethods)
+end

data/test/dm-s3_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class DmS3Test < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-s3'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: dm-s3
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Roberto Thais
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-10 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aws-s3
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+description: 
+email: roberto.n.thais@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- dm-s3.gemspec
+- lib/dm-s3.rb
+- test/dm-s3_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rpbertp13/dm-s3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+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