paperclip-aws 1.6.1 → 1.6.5

data/README.md

@@ -10,16 +10,15 @@
 * supports both `http` and `https` urls;
 * supports expiring urls;
 * supports different permissions for each Paperclip style;
-* can generate urls for `read`, `write` и `delete` operations;
-* correctly sets content-type of uploaded files;
-* ability to set content-disposition of uploaded files;
+* supports generating urls for `read`, `write` и `delete` operations;
 * **supports amazon server side encryption** (thanks to @pvertenten);
+* **supports versioning**;
 * highly compatible with included in Paperclip S3 storage module
 
 
 ## Requirements ##
 
-* [paperclip][0] ~> 2.4
+* [paperclip][0] ~> 2.6
 * [aws-sdk][1] >= 1.2.0
 
 ## Installation ##
@@ -46,7 +45,7 @@ After this add 'paperclip-aws' to your `Gemfile` or `environment.rb`
                           :secret_access_key => self.s3_config['secret_access_key'],
                           :endpoint => self.s3_config['endpoint']
                         },
-                        :bucket => self.s3_config['bucket'],                    
+                        :s3_bucket => self.s3_config['bucket'],                    
                         :s3_host_alias => self.s3_config['s3_host_alias'],
                         :s3_permissions => :public_read,
                         :s3_protocol => 'http',
@@ -109,12 +108,12 @@ Default protocol to use: `'http'` or `'https'`.
 ### :s3_options ###
 Hash of additional options. Available options are:
 
-* `:sse` –  `'AES256'` (the only available encryption now)
+* `:server_side_encryption` –  `'AES256'` (the only available encryption now)
 * `:storage_class` – `:standard` (default) or `:reduced_redundancy`
 * `:content_disposition`
 
 
-## How `paperclip-aws` creates urls?
+## How `paperclip-aws` creates urls? ##
 
 'paperclip-aws' redefines Paperclip `url` method to get object URL.
 
@@ -143,13 +142,28 @@ Supported options are:
   
   Default is set to `:read`, which is the most common used.
 
-## Can I use it in production?
+## Versioning ##
+
+'paperclip-aws' lets you easily use S3 file versioning if it is enabled for selected bucket.
+To find more information about versioning and how to enable it, please follow [AWS FAQs](http://aws.amazon.com/s3/faqs/#What_is_Versioning) and [AWS S3 Docs](http://docs.amazonwebservices.com/AmazonS3/latest/dev/Versioning.html).
+
+Also you can enable versioning from your Rails console by using following code:
+  
+    some_s3_attachment.data.bucket.enable_versioning
+  
+Please make sure, that user that is used to connect to S3 has enough permissions to do this, or you will get `AWS::S3::Errors::AccessDenied` error.
+  
+To get array of file versions use #versions method:
+  
+    some_s3_attachment.data.versions()
+
+## Can I use it in production? ##
 
 Yes, usage of **paperclip-aws** is confirmed by several rather big projects:
 
 * [www.sdelki.ru](http://www.sdelki.ru)
-* [www.lienlog.com](http://www.lienlog.com) (opens for public in December 2011)
-* [www.sharypic.com](http://www.sharypic.com) (soon)
+* [www.lienlog.com](http://www.lienlog.com)
+* [www.sharypic.com](http://www.sharypic.com)
 
 I hope that it is used in a lot of other projects, if you know them – let me know.
     

data/VERSION

@@ -1 +1 @@
-1.6.1
+1.6.5

data/lib/paperclip-aws.rb

@@ -18,12 +18,12 @@ module Paperclip
         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_credentials
+          self.setup_s3_bucket                 
+          self.setup_s3_permissions          
+          self.setup_s3_protocol
           self.setup_s3_options
-          self.setup_s3_host_alias          
+          self.setup_s3_host_alias
         end        
       end
       
@@ -58,13 +58,34 @@ module Paperclip
           return URI.escape(url)
         end              
       end
+      
+      def bucket
+        @bucket ||= self.s3.buckets[@s3_bucket]
+      end
+      
+      def s3_bucket=(value)
+        @bucket = nil
+                
+        @s3_bucket = value
+        @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc)
+      end
+      
+      def versions(style = default_style)
+        begin
+          return nil unless self.bucket.versioning_enabled?
+          self.bucket.objects[path(style)].versions          
+        rescue AWS::S3::Errors::Base => e
+          log "ERROR: Error occured while fetching versions for `#{path(style)}`. Probably versions are disabled or suspended for `#{self.bucket.name}` bucket."
+          return nil
+        end
+      end
             
       def exists?(style = default_style)
         if path(style).nil? || path(style).to_s.strip == ""
           return false
         end
         begin
-          return self.s3.buckets[@s3_bucket].objects[path(style)].exists?
+          return self.bucket.objects[path(style)].exists?
         rescue AWS::S3::Errors::Base
           return false
         end
@@ -87,7 +108,7 @@ module Paperclip
         basename = File.basename(filename, extname)
         file = Tempfile.new([basename, extname])
         file.binmode
-        file.write(self.s3.buckets[@s3_bucket].objects[path(style)].read)
+        file.write(self.bucket.objects[path(style)].read)
         file.rewind
         return file
       end
@@ -99,7 +120,7 @@ module Paperclip
       def flush_writes #:nodoc:
         @queued_for_write.each do |style, file|
           begin
-            log("saving #{path(style)}")
+            log "Saving #{path(style)}"
             
             self.s3.buckets[@s3_bucket].objects[path(style)].write({
               :file => file.path,
@@ -119,7 +140,7 @@ module Paperclip
       def flush_deletes #:nodoc:
         @queued_for_delete.each do |path|
           begin
-            log("deleting #{path}")
+            log "Deleting #{path}"
             self.s3.buckets[@s3_bucket].objects[path].delete
           rescue AWS::Errors::Base => e
             raise
@@ -129,9 +150,9 @@ module Paperclip
       end
       
     # PRIVATE METHODS        
-      def setup_credentials
+      def setup_s3_credentials
         if @options[:s3_credentials].present?
-          @s3_credentials = self.parse_credentials(@options[:s3_credentials]).stringify_keys
+          @s3_credentials = self.parse_s3_credentials(@options[:s3_credentials]).stringify_keys
           env = Object.const_defined?(:Rails) ? Rails.env : nil
           
           @s3_credentials = (@s3_credentials[env] || @s3_credentials).symbolize_keys              
@@ -140,9 +161,9 @@ module Paperclip
           raise ArgumentError, "missing required :s3_credentials option"
         end
       end
-      protected :setup_credentials
+      protected :setup_s3_credentials
       
-      def parse_credentials(creds)
+      def parse_s3_credentials(creds)
         case creds
         when File
           YAML::load(ERB.new(File.read(creds.path)).result)
@@ -154,24 +175,27 @@ module Paperclip
           raise ArgumentError, "Credentials are not a path, file, or hash."
         end
       end        
-      protected :parse_credentials
+      protected :parse_s3_credentials
       
-      def setup_bucket
+      def setup_s3_bucket
         if @options[:bucket].present?
-          @s3_bucket = @options[:bucket] || @s3_credentials[:bucket]
-          @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc)         
+          log "DEPRECATION WARNING: Passing  `:bucket` options to paperclip is deprecated. Please use `:s3_bucket` instead."
+        end
+        
+        if @options[:s3_bucket].present? || @s3_credentials[:bucket].present? || @options[:bucket].present?
+          self.s3_bucket = @options[:s3_bucket] || @s3_credentials[:bucket] || @options[:bucket]     
         else
-          raise ArgumentError, "missing required :bucket option"
+          raise ArgumentError, "missing required :s3_bucket option"
         end
       end
-      protected :setup_bucket
+      protected :setup_s3_bucket
       
-      def setup_permissions
-        @s3_permissions = self.parse_permissions(@options[:s3_permissions])
+      def setup_s3_permissions
+        @s3_permissions = self.parse_s3_permissions(@options[:s3_permissions])
       end
-      protected :setup_permissions
+      protected :setup_s3_permissions
       
-      def parse_permissions(permissions)
+      def parse_s3_permissions(permissions)
         if permissions.is_a?(Hash)
           permissions[:default] = permissions[:default] || :public_read
         else
@@ -179,7 +203,7 @@ module Paperclip
         end
         permissions                
       end
-      protected :parse_permissions
+      protected :parse_s3_permissions
       
       def setup_s3_protocol
         @s3_protocol = @options[:s3_protocol] ||

data/paperclip-aws.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "paperclip-aws"
-  s.version = "1.6.1"
+  s.version = "1.6.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Igor Alexandrov"]
-  s.date = "2012-02-24"
+  s.date = "2012-02-27"
   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 = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-aws
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
-  requirement: &70118178437640 !ruby/object:Gem::Requirement
+  requirement: &70288657009700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70118178437640
+  version_requirements: *70288657009700
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70118178437140 !ruby/object:Gem::Requirement
+  requirement: &70288657009200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70118178437140
+  version_requirements: *70288657009200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70118180010020 !ruby/object:Gem::Requirement
+  requirement: &70288657008700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70118180010020
+  version_requirements: *70288657008700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70118180009540 !ruby/object:Gem::Requirement
+  requirement: &70288657008220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70118180009540
+  version_requirements: *70288657008220
 description: ! '''paperclip-aws'' is a full featured storage module that supports
   all S3 locations (US, European and Tokio) without any additional hacking.'
 email: igor.alexandrov@gmail.com
@@ -93,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3176807649922925597
+      hash: -1621524216927201616
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: