s3 0.2.1 → 0.2.2

data/.document

@@ -2,4 +2,5 @@ README.rdoc
 lib/**/*.rb
 bin/*
 features/**/*.feature
+extra/*
 LICENSE

data/README.rdoc

@@ -1,9 +1,20 @@
 = S3
 
+S3 library provides access to Amazon's Simple Storage Service. It
+supports both: European and US buckets through REST API.
+
 * repository: http://github.com/qoobaa/s3
 * issue tracker: http://github.com/qoobaa/s3/issues
 * rdoc: http://qoobaa.github.com/s3
 
+== Installation
+
+If you don't have the Gemcutter sources yet:
+  gem sources -a http://gemcutter.org
+
+To install the gem type:
+  sudo gem install s3
+
 == Usage
 
 Coming soon, see Rdoc documentation.
@@ -13,7 +24,7 @@ Coming soon, see Rdoc documentation.
 You have to pass access key id (-a) and secret access key (-s) to the
 command line tool. S3 reads ACCESS_KEY_ID and SECRET_ACCESS_KEY
 environment variables and uses them by default, so if you don't want
-to pass them each time, export them (e.g. in .bashrc file).
+to pass them each time, export them (e.g. in ~/.bashrc file).
 
 * list buckets
     s3 bucket

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/extra/s3_paperclip.rb

@@ -0,0 +1,142 @@
+# S3 backend for paperclip plugin. Copy the file to:
+# +config/initializers/+ directory
+#
+# Example configuration for CNAME bucket:
+#
+#   has_attached_file :image,
+#                     :s3_host_alias => "bucket.domain.tld",
+#                     :url => ":s3_alias_url",
+#                     :styles => {
+#                       :medium => "300x300>",
+#                       :thumb => "100x100>"
+#                     },
+#                     :storage => :s3,
+#                     :s3_credentials => {
+#                       :access_key_id => "...",
+#                       :secret_access_key => "..."
+#                     },
+#                     :bucket => "bucket.domain.tld",
+#                     :path => ":attachment/:id/:style.:extension"
+
+module Paperclip
+  module Storage
+    module S3
+      def self.extended(base)
+        begin
+          require "s3"
+        rescue LoadError => e
+          e.message << " (You may need to install the s3 gem)"
+          raise e
+        end
+
+        base.instance_eval do
+          @s3_credentials = parse_credentials(@options[:s3_credentials])
+          @bucket_name    = @options[:bucket]         || @s3_credentials[:bucket]
+          @bucket_name    = @bucket_name.call(self) if @bucket_name.is_a?(Proc)
+          @s3_options     = @options[:s3_options]     || {}
+          @s3_permissions = @options[:s3_permissions] || :public_read
+          @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == :public_read ? "http" : "https")
+          @s3_headers     = @options[:s3_headers]     || {}
+          @s3_host_alias  = @options[:s3_host_alias]
+          @url            = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
+          @service = ::S3::Service.new(@s3_options.merge(:access_key_id => @s3_credentials[:access_key_id],
+                                                         :secret_access_key => @s3_credentials[:secret_access_key],
+                                                         :use_ssl => @s3_protocol == "https"))
+          @bucket = @service.buckets.build(@bucket_name)
+        end
+        Paperclip.interpolates(:s3_alias_url) do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        Paperclip.interpolates(:s3_path_url) do |attachment, style|
+          "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        Paperclip.interpolates(:s3_domain_url) do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+      end
+
+      def bucket
+        @bucket
+      end
+
+      def bucket_name
+        @bucket.name
+      end
+
+      def s3_host_alias
+        @s3_host_alias
+      end
+
+      def parse_credentials(creds)
+        creds = find_credentials(creds).stringify_keys
+        (creds[RAILS_ENV] || creds).symbolize_keys
+      end
+
+      def exists?(style = default_style)
+        if original_filename
+          bucket.objects.build(path(style)).exists?
+        else
+          false
+        end
+      end
+
+      def s3_protocol
+        @s3_protocol
+      end
+
+      # Returns representation of the data of the file assigned to the given
+      # style, in the format most representative of the current storage.
+      def to_file(style = default_style)
+        return @queued_for_write[style] if @queued_for_write[style]
+        file = Tempfile.new(path(style))
+        file.write(bucket.objects.find(path(style)).content)
+        file.rewind
+        return file
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          begin
+            log("saving #{path(style)}")
+            object = bucket.objects.build(path(style))
+            object.content = file.read
+            object.acl = @s3_permisions
+            object.content_type = instance_read(:content_type)
+            object.content_disposition = @s3_headers[:content_disposition]
+            object.content_encoding = @s3_headers[:content_encoding]
+            object.save
+          rescue ::S3::Error::ResponseError => e
+            raise
+          end
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            bucket.objects.find(path).destroy
+          rescue ::S3::Error::ResponseError
+            # Ignore this.
+          end
+        end
+        @queued_for_delete = []
+      end
+
+      def find_credentials(creds)
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file, or hash."
+        end
+      end
+      private :find_credentials
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: s3
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 +02:00
+date: 2009-10-18 00:00:00 +02:00
 default_executable: s3
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,7 +40,8 @@ files:
 - Rakefile
 - VERSION
 - bin/s3
-- extra/s3_backend.rb
+- extra/s3_attachment_fu.rb
+- extra/s3_paperclip.rb
 - lib/s3.rb
 - lib/s3/bucket.rb
 - lib/s3/connection.rb
@@ -86,9 +87,9 @@ signing_key:
 specification_version: 3
 summary: Library for accessing S3 objects and buckets, with command line tool
 test_files: 
+- test/object_test.rb
+- test/test_helper.rb
 - test/bucket_test.rb
+- test/connection_test.rb
 - test/service_test.rb
 - test/signature_test.rb
-- test/connection_test.rb
-- test/test_helper.rb
-- test/object_test.rb