paperclip-aws 1.4.1 → 1.6.0

data/Gemfile

@@ -1,5 +1,5 @@
 source "http://rubygems.org"
-  gem 'paperclip', '>=2.4.0'
+  gem 'paperclip', '~>2.6.0'
   gem 'aws-sdk', '>=1.2.0'
 
 group :development do
@@ -8,7 +8,7 @@ group :development do
 end
 
 group :test do
-  gem "sqlite3"
+  gem "sqlite3", '~> 1.3.4'
   gem 'shoulda-context'
   gem "mocha"    
 end

data/Gemfile.lock

@@ -1,25 +1,25 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
       builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      arel (~> 2.2.1)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.3)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (2.2.1)
-    aws-sdk (1.2.3)
+    arel (3.0.0)
+    aws-sdk (1.3.4)
       httparty (~> 0.7)
       json (~> 1.4)
       nokogiri (>= 1.4.4)
       uuidtools (~> 2.1)
     builder (3.0.0)
-    cocaine (0.2.0)
+    cocaine (0.2.1)
     git (1.2.5)
     httparty (0.8.1)
       multi_json
@@ -29,22 +29,22 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.2)
+    json (1.6.5)
     metaclass (0.0.1)
     mime-types (1.17.2)
-    mocha (0.10.0)
+    mocha (0.10.4)
       metaclass (~> 0.0.1)
     multi_json (1.0.4)
     multi_xml (0.4.1)
     nokogiri (1.5.0)
-    paperclip (2.4.5)
+    paperclip (2.6.0)
       activerecord (>= 2.3.0)
       activesupport (>= 2.3.2)
       cocaine (>= 0.0.2)
       mime-types
     rake (0.9.2.2)
     shoulda-context (1.0.0)
-    sqlite3 (1.3.4)
+    sqlite3 (1.3.5)
     tzinfo (0.3.31)
     uuidtools (2.1.2)
 
@@ -56,6 +56,6 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
   mocha
-  paperclip (>= 2.4.0)
+  paperclip (~> 2.6.0)
   shoulda-context
-  sqlite3
+  sqlite3 (~> 1.3.4)

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.6.0

data/lib/paperclip-aws.rb

@@ -13,47 +13,26 @@ module Paperclip
         rescue LoadError => e
           e.message << " (You may need to install the aws-sdk gem)"
           raise e
-        end unless defined?(AWS)
+        end unless defined?(AWS::Core)
         
-        attr_accessor :s3_options
-        base.instance_eval do
-
-                   
-          @s3_credentials = parse_credentials(@options.s3_credentials)
-          @s3_permissions = set_permissions(@options.s3_permissions)
-          
-          @s3_protocol    = @options.s3_protocol    ||
-            Proc.new do |style, attachment|
-              permission  = (@s3_permissions[style.to_sym] || @s3_permissions[:default])
-              permission  = permission.call(attachment, style) if permission.is_a?(Proc)
-              (permission == :public_read) ? 'http' : 'https'
-            end
-          
-          @s3_headers     = @options.s3_headers     || {}
-          
-          @s3_bucket      = @options.bucket
-          @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc) 
-          
-          @s3_options     = @options.s3_options     || {}
-          # setup Amazon Server Side encryption
-          @s3_options.reverse_merge!({
-            :sse => false,
-            :storage_class => :standard,
-            :content_disposition => nil
-          })
-          
-          @s3_endpoint      = @s3_credentials[:endpoint] || 's3.amazonaws.com'
-                    
-          @s3_host_alias    = @options.s3_host_alias
-          @s3_host_alias    = @s3_host_alias.call(self) if @s3_host_alias.is_a?(Proc)
-                    
-          @s3 = AWS::S3.new(
-            :access_key_id => @s3_credentials[:access_key_id],
-            :secret_access_key => @s3_credentials[:secret_access_key],
-            :s3_endpoint => @s3_endpoint
-          )
-        end
+        attr_accessor :s3_credentials, :s3_bucket, :s3_permissions, :s3_options, :s3_protocol, :s3_host_alias
         
+        base.instance_eval do   
+          self.setup_credentials
+          self.setup_bucket                      
+          self.setup_permissions          
+          self.setup_s3_protocol          
+          self.setup_s3_options
+          self.setup_s3_host_alias          
+        end        
+      end
+      
+      def s3
+        @s3 ||= AWS::S3.new(
+          :access_key_id => @s3_credentials[:access_key_id],
+          :secret_access_key => @s3_credentials[:secret_access_key],
+          :s3_endpoint => @s3_endpoint
+        )        
       end
       
       def url(style=default_style, options={})
@@ -69,42 +48,23 @@ module Paperclip
             :action => :read
           })          
           secure = ( self.choose_protocol(style, options) == 'https' )                   
-          return @s3.buckets[@s3_bucket].objects[path(style).gsub(%r{^/}, "")].url_for(options[:action], {  :secure => secure, :expires => options[:expires] }).to_s
+          return self.s3.buckets[@s3_bucket].objects[path(style).gsub(%r{^/}, "")].url_for(options[:action], {  :secure => secure, :expires => options[:expires] }).to_s
         else
           if @s3_host_alias.present?
             url = "#{choose_protocol(style, options)}://#{@s3_host_alias}/#{path(style).gsub(%r{^/}, "")}"
           else
             url = "#{choose_protocol(style, options)}://#{@s3_endpoint}/#{@s3_bucket}/#{path(style).gsub(%r{^/}, "")}"
-          end        
+          end    
           return URI.escape(url)
         end              
       end
-      
-      def bucket_name
-        @s3_bucket
-      end
-
-      def parse_credentials(creds)
-        creds = find_credentials(creds).stringify_keys
-        env = Object.const_defined?(:Rails) ? Rails.env : nil
-        (creds[env] || creds).symbolize_keys
-      end
-      
-      def set_permissions permissions
-        if permissions.is_a?(Hash)
-          permissions[:default] = permissions[:default] || :public_read
-        else
-          permissions = { :default => permissions || :public_read }
-        end
-        permissions
-      end
-
+            
       def exists?(style = default_style)
         if path(style).nil? || path(style).to_s.strip == ""
           return false
         end
         begin
-          return @s3.buckets[@s3_bucket].objects[path(style)].exists?
+          return self.s3.buckets[@s3_bucket].objects[path(style)].exists?
         rescue AWS::S3::Errors::Base
           return false
         end
@@ -127,13 +87,13 @@ module Paperclip
         basename = File.basename(filename, extname)
         file = Tempfile.new([basename, extname])
         file.binmode
-        file.write(@s3.buckets[@s3_bucket].objects[path(style)].read)
+        file.write(self.s3.buckets[@s3_bucket].objects[path(style)].read)
         file.rewind
         return file
       end
 
       def create_bucket
-        @s3.buckets.create(@s3_bucket)
+        self.s3.buckets.create(@s3_bucket)
       end
 
       def flush_writes #:nodoc:
@@ -141,14 +101,11 @@ module Paperclip
           begin
             log("saving #{path(style)}")
             
-            @s3.buckets[@s3_bucket].objects[path(style)].write(
+            self.s3.buckets[@s3_bucket].objects[path(style)].write({
               :file => file.path,
               :acl => @s3_permissions[:style.to_sym] || @s3_permissions[:default],
-              :storage_class => @s3_options[:storage_class],
-              :content_type => file.content_type,
-              :content_disposition => @s3_options[:content_disposition],
-              :server_side_encryption => @s3_options[:sse]
-            )
+              :content_type => file.content_type
+            }.reverse_merge(@s3_options))
           rescue AWS::S3::Errors::NoSuchBucket => e
             create_bucket
             retry
@@ -163,15 +120,29 @@ module Paperclip
         @queued_for_delete.each do |path|
           begin
             log("deleting #{path}")
-            @s3.buckets[@s3_bucket].objects[path].delete
+            self.s3.buckets[@s3_bucket].objects[path].delete
           rescue AWS::Errors::Base => e
             raise
           end
         end
         @queued_for_delete = []
       end
-
-      def find_credentials creds
+      
+    # PRIVATE METHODS        
+      def setup_credentials
+        if @options[:s3_credentials].present?
+          @s3_credentials = self.parse_credentials(@options[:s3_credentials]).stringify_keys
+          env = Object.const_defined?(:Rails) ? Rails.env : nil
+          
+          @s3_credentials = (@s3_credentials[env] || @s3_credentials).symbolize_keys              
+          @s3_endpoint = @s3_credentials[:endpoint] || 's3.amazonaws.com'
+        else
+          raise ArgumentError, "missing required :s3_credentials option"
+        end
+      end
+      protected :setup_credentials
+      
+      def parse_credentials(creds)
         case creds
         when File
           YAML::load(ERB.new(File.read(creds.path)).result)
@@ -182,9 +153,63 @@ module Paperclip
         else
           raise ArgumentError, "Credentials are not a path, file, or hash."
         end
+      end        
+      protected :parse_credentials
+      
+      def setup_bucket
+        if @options[:bucket].present?
+          @s3_bucket = @options[:bucket] || @s3_credentials[:bucket]
+          @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc)         
+        else
+          raise ArgumentError, "missing required :bucket option"
+        end
       end
-      private :find_credentials
-
+      protected :setup_bucket
+      
+      def setup_permissions
+        @s3_permissions = self.parse_permissions(@options[:s3_permissions])
+      end
+      protected :setup_permissions
+      
+      def parse_permissions(permissions)
+        if permissions.is_a?(Hash)
+          permissions[:default] = permissions[:default] || :public_read
+        else
+          permissions = { :default => permissions || :public_read }
+        end
+        permissions                
+      end
+      protected :parse_permissions
+      
+      def setup_s3_protocol
+        @s3_protocol = @options[:s3_protocol] ||
+          Proc.new do |style, attachment|
+            permission  = (@s3_permissions[style.to_sym] || @s3_permissions[:default])
+            permission  = permission.call(attachment, style) if permission.is_a?(Proc)
+            (permission == :public_read) ? 'http' : 'https'
+          end                  
+      end
+      protected :setup_s3_protocol
+        
+      def setup_s3_options
+        @s3_options     = (@options[:s3_options] || {}).symbolize_keys
+        
+        # setup Amazon Server Side encryption
+        @s3_options.reverse_merge!({
+          :sse => false,
+          :storage_class => :standard,
+          :content_disposition => nil
+        })
+        @s3_options[:server_side_encryption] ||= @s3_options.delete(:sse)                            
+      end
+      protected :setup_s3_options
+      
+      
+      def setup_s3_host_alias
+        @s3_host_alias = @options[:s3_host_alias]
+        @s3_host_alias = @s3_host_alias.call(self) if @s3_host_alias.is_a?(Proc)                            
+      end
+      protected :setup_s3_host_alias
     end
   end
 end

data/paperclip-aws.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "paperclip-aws"
-  s.version = "1.4.1"
+  s.version = "1.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Igor Alexandrov"]
-  s.date = "2011-12-06"
+  s.date = "2012-02-12"
   s.description = "'paperclip-aws' is a full featured storage module that supports all S3 locations (US, European and Tokio) without any additional hacking."
   s.email = "igor.alexandrov@gmail.com"
   s.extra_rdoc_files = [
@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
     "paperclip-aws.gemspec",
     "test/aws_storage_test.rb",
     "test/database.yml",
-    "test/debug.log",
     "test/fixtures/5k.png",
     "test/fixtures/spaced file.png",
     "test/helper.rb"
@@ -43,18 +42,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<paperclip>, [">= 2.4.0"])
+      s.add_runtime_dependency(%q<paperclip>, ["~> 2.6.0"])
       s.add_runtime_dependency(%q<aws-sdk>, [">= 1.2.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
     else
-      s.add_dependency(%q<paperclip>, [">= 2.4.0"])
+      s.add_dependency(%q<paperclip>, ["~> 2.6.0"])
       s.add_dependency(%q<aws-sdk>, [">= 1.2.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     end
   else
-    s.add_dependency(%q<paperclip>, [">= 2.4.0"])
+    s.add_dependency(%q<paperclip>, ["~> 2.6.0"])
     s.add_dependency(%q<aws-sdk>, [">= 1.2.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

data/test/aws_storage_test.rb

@@ -8,7 +8,7 @@ class AwsStorageTest < Test::Unit::TestCase
   end
   
   def default_model_options(options={})
-    {
+    options.reverse_merge!({
       :storage => :aws,
       :bucket => "testing",
       :s3_credentials => {
@@ -16,44 +16,50 @@ class AwsStorageTest < Test::Unit::TestCase
         :secret_access_key => "SECRET_ACCESS_KEY"
       },
       :path => ":attachment/:basename.:extension"
-    }.deep_merge!(options)
+    })
   end
   
-  context "Parsing S3 credentials" do
-    setup do      
-      rebuild_model default_model_options
-
-      @dummy = Dummy.new
-      @avatar = @dummy.avatar
-    end
-    
+  context "Parsing S3 credentials" do    
     should "get the correct credentials when RAILS_ENV is production" do
       rails_env("production")
       
-      assert_equal(
-        { :access_key_id => "12345" },
-        @avatar.parse_credentials(
+      rebuild_model default_model_options(
+        :s3_credentials => {
           :production => { :access_key_id => '12345' },
-          :development => { :access_key_id => '54321' }
-        )
+          :development => { :access_key_id => '54321' }          
+        }
       )
+
+      @dummy = Dummy.new      
+      assert_equal({ :access_key_id => "12345" }, @dummy.avatar.s3_credentials)
     end
     
     should "get the correct credentials when RAILS_ENV is development" do
       rails_env("development")
       
-      assert_equal(
-        { :access_key_id => "54321" },
-        @avatar.parse_credentials(
+      rebuild_model default_model_options(
+        :s3_credentials => {
           :production => { :access_key_id => '12345' },
-          :development => { :access_key_id => '54321' }
-        )
-      )  
+          :development => { :access_key_id => '54321' }          
+        }
+      )
+
+      @dummy = Dummy.new          
+      assert_equal({ :access_key_id => "54321" }, @dummy.avatar.s3_credentials)
     end
     
     should "return the argument if the key does not exist" do
       rails_env("not really an env")
-      assert_equal({:test => "12345"}, @avatar.parse_credentials(:test => "12345"))
+      
+      rebuild_model default_model_options(
+        :s3_credentials => {
+          :test => "12345"
+        }
+      )
+
+      @dummy = Dummy.new
+      
+      assert_equal({:test => "12345"}, @dummy.avatar.s3_credentials)
     end
     
   end
@@ -193,7 +199,10 @@ class AwsStorageTest < Test::Unit::TestCase
   
   context "An attachment that uses S3 for storage and has spaces in file name" do
     setup do
-      rebuild_model default_model_options(:styles  => { :large => ['500x500#', :jpg] })
+      rebuild_model default_model_options(
+        :styles  => { :large => ['500x500#', :jpg] },
+        :restricted_characters => /[&$+,\/:;=?@<>\[\]\{\}\|\\\^~%#]/
+      )
       
       @dummy = Dummy.new
       @dummy.avatar = File.new(fixture_file('spaced file.png'), 'rb')
@@ -221,4 +230,93 @@ class AwsStorageTest < Test::Unit::TestCase
       assert ! Dummy.new.avatar.is_a?(Paperclip::Storage::Filesystem)
     end
   end
-end
+
+  context "S3 options" do
+    setup do
+      @writer = mock()
+      AWS::S3.expects(:new).returns(
+        stub(:buckets =>
+          stub(:[] =>
+            stub(:objects =>
+              stub(:[] => @writer)
+            )
+          )
+        )
+      )
+    end
+
+    should "be set to default" do
+      rebuild_model default_model_options
+
+      @writer.expects(:write).with do |value|
+        value[:sse] == nil &&
+        value[:server_side_encryption] == false &&
+        value[:storage_class] == :standard &&
+        value[:content_disposition] == nil &&
+        value[:expires] == nil
+      end
+
+      @dummy = Dummy.new
+      @dummy.avatar = File.new(fixture_file('spaced file.png'), 'rb')
+      @dummy.save
+    end
+
+    should "be configured" do
+      rebuild_model default_model_options(:s3_options => {
+        :sse => 'AES256',
+        :storage_class => :reduced_redundancy,
+        :content_disposition => :attachment,
+        :cache_control => 'max-age=86400'
+      })
+
+      @writer.expects(:write).with do |value|
+        value[:sse] == nil &&
+        value[:server_side_encryption] == 'AES256' &&
+        value[:storage_class] == :reduced_redundancy &&
+        value[:content_disposition] == :attachment &&
+        value[:cache_control] == 'max-age=86400'
+      end
+
+      @dummy = Dummy.new
+      @dummy.avatar = File.new(fixture_file('spaced file.png'), 'rb')
+      @dummy.save
+    end
+
+    should "work with string-keyed hash" do
+      rebuild_model default_model_options(:s3_options => {
+        'cache_control' => 'max-age=86400'
+      })
+
+      @writer.expects(:write).with do |value|
+        value['cache_control'] == nil &&
+        value[:cache_control] == 'max-age=86400'
+      end
+
+      @dummy = Dummy.new
+      @dummy.avatar = File.new(fixture_file('spaced file.png'), 'rb')
+      @dummy.save
+    end
+    
+    should "allow to modify options in instance" do
+      rebuild_model default_model_options
+
+      @writer.expects(:write).with do |value|
+        value[:sse] == nil &&
+        value[:server_side_encryption] == false &&
+        value[:storage_class] == :standard &&
+        value[:content_disposition] == "attachment; filename=spaced_file.png" &&
+        value[:expires] == nil
+      end
+      
+      Dummy.class_eval do
+        before_save do      
+          self.avatar.s3_options[:content_disposition] = "attachment; filename=#{self.avatar_file_name}"
+        end        
+      end
+      
+      @dummy = Dummy.new
+      @dummy.avatar = File.new(fixture_file('spaced file.png'), 'rb')
+      @dummy.save      
+    end
+  end
+end