paperclip-aws 1.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+  gem 'paperclip', '>=2.3.0'
+  gem 'aws-sdk', '>=1.0.3'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    aws-sdk (1.0.3)
+      httparty (~> 0.7)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+      uuidtools (~> 2.1)
+    builder (2.1.2)
+    cocaine (0.1.0)
+    crack (0.1.8)
+    git (1.2.5)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.3)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    paperclip (2.3.16)
+      activerecord (>= 2.3.0)
+      activesupport (>= 2.3.2)
+      cocaine (>= 0.0.2)
+      mime-types
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    tzinfo (0.3.29)
+    uuidtools (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (>= 1.0.3)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  paperclip (>= 2.3.0)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Igor Alexandrov
+
+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.md

@@ -0,0 +1,100 @@
+# Storage module to official 'aws-sdk' gem for Amazon S3 #
+
+'paperclip-aws' is a full featured storage module that supports all S3 locations (US, European and Tokio) without any additional hacking.
+
+Just install in and your model is ready to be stored all over ther world.
+
+## Requirements ##
+
+* [paperclip][0] ~> 2.3
+* [aws-sdk][1] >= 1.0.3
+
+## Installation ##
+
+    gem install papepclip-aws
+
+After this add 'papepclip-aws' to your `Gemfile` or `environment.rb`
+    
+## Using Storage ##
+
+    class SomeS3Attachment < ActiveRecord::Base
+      def self.s3_config
+        @@s3_config ||= YAML.load(ERB.new(File.read("#{Rails.root}/config/s3.yml")).result)[Rails.env]    
+      end
+
+      has_attached_file :data,
+                        :styles => {
+                          :thumb => [">75x"],
+                          :medium => [">600x"]
+                        },                    
+                        :storage => :aws,
+                        :s3_credentials => {
+                          :access_key_id => self.s3_config['access_key_id'],
+                          :secret_access_key => self.s3_config['secret_access_key'],
+                          :endpoint => self.s3_config['endpoint']
+                        },
+                        :s3_bucket => self.s3_config['bucket'],                    
+                        :s3_host_alias => self.s3_config['s3_host_alias'],
+                        :s3_acl => :public_read,
+                        :s3_protocol => 'http',
+                        :path => "company_documents/:id/:style/:data_file_name"  
+    end
+                      
+## Possible options ##
+
+### :endpoint ###
+Endpoint where your bucket is located. Default is `'s3.amazonaws.com'` which is for 'US Standard' region.
+
+You can find full list of endpoints and regions [here](http://aws.amazon.com/articles/3912#s3)
+
+### :s3_acl  ###
+Sets permissions to your objects. Values are:
+
+    :private
+    :public_read
+    :public_read_write
+    :authenticated_read
+    :bucket_owner_read
+    :bucket_owner_full_control
+   
+### :s3_protocol ###
+Default protocol to use: `'http'` or `'https'`.
+
+## Get your data
+
+'paperclip-aws' redefines Paperclip `url` method to get object URL.
+
+    def url(style=default_style, options={})
+    end
+
+Supported options are 
+
+* `:protocol` — `'http'` or `'https'`
+
+  Use this options to redefine default protocol, configured in model.
+
+* `:expires`
+
+  Sets the expiration time of the URL; after this time S3 will return an error if the URL is used.  This can be an integer (to specify the number of seconds after the current time), a string (which is parsed as a date using Time#parse), a Time, or a DateTime object. This option defaults to one hour after the current time.
+  
+  Default is set to 3600 seconds.
+
+* `:action`
+  
+  Method, the HTTP verb or object method for which the returned URL will be valid.  Valid values:
+  
+  * `:get` or `:read`
+  * `:put` or `:write`
+  * `:delete`
+  
+  Default is set to `:read`, which is the most common used.
+
+## Examples
+  
+Create link for file that will expire in 10 seconds after it was created. Useful when redirecting user to file.
+  
+    file.data.url(:original, { :expires => Time.now + 10.seconds, :protocol => 'https' })
+    
+    
+[0]: https://github.com/thoughtbot/paperclip
+[1]: https://github.com/amazonwebservices/aws-sdk-for-ruby

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "paperclip-aws"
+  gem.homepage = "http://github.com/igor-alexandrov/paperclip-aws"
+  gem.license = "MIT"
+  gem.summary = %Q{Storage module to official 'aws-sdk' gem for Amazon S3}
+  gem.description = %Q{'paperclip-aws' is a full featured storage module that supports all S3 locations (US, European and Tokio) without any additional hacking.}
+  gem.email = "igor.alexandrov@gmail.com"
+  gem.authors = ["Igor Alexandrov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "paperclip-aws #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/papepclip-aws.rb

@@ -0,0 +1,149 @@
+# coding: UTF-8
+
+require 'paperclip'
+
+module Paperclip
+  module Storage
+    module Aws
+      def self.extended base
+        begin
+          require 'aws-sdk'
+        rescue LoadError => e
+          e.message << " (You may need to install the aws-sdk gem)"
+          raise e
+        end unless defined?(AWS)
+
+        base.instance_eval do
+          @s3_credentials   = parse_credentials(@options[:s3_credentials])
+          
+          # setup bucket
+          @s3_bucket = @options[:s3_bucket] || @s3_credentials[:bucket]
+          @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc) 
+          
+          # setup permissions
+          @s3_acl           = @options[:s3_acl]           || :public_read
+          
+          # choose what storage class we use, 'standard' or 'reduced_redundancy'
+          @s3_storage_class = @options[:s3_storage_class] || :standard
+          
+          @s3_protocol      = @options[:s3_protocol]      || 'http'
+          @s3_headers       = @options[:s3_headers]       || {}
+          @s3_host_alias    = @options[:s3_host_alias]
+          @s3_host_alias    = @s3_host_alias.call(self) if @s3_host_alias.is_a?(Proc)
+          
+          @s3_endpoint = @s3_credentials[:endpoint] || 's3.amazonaws.com'
+          
+          @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
+      end
+              
+      def url(style=default_style, options={})
+        if options[:expires].present? || options[:action].present?
+          options.reverse_merge!({
+            :expires => 60*60,
+            :action => :read
+          })          
+          secure = ( self.choose_protocol(options) == 'https' )                   
+          @s3.buckets[@s3_bucket].objects[path(style)].url_for(options[:action], {  :secure => secure, :expires => options[:expires] }).to_s
+        else
+          if @s3_host_alias.present?
+            "#{choose_protocol(options)}://#{@s3_host_alias}/#{path(style).gsub(%r{^/}, "")}"
+          else
+            "#{choose_protocol(options)}://#{@s3_endpoint}/#{@s3_bucket}/#{path(style).gsub(%r{^/}, "")}"
+          end        
+        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 exists?(style = default_style)
+        @s3.buckets[@s3_bucket].objects[path(style)].exists?
+      end
+
+      def choose_protocol(options={})
+        if options[:protocol].present?
+          return options[:protocol].to_s
+        else
+          return @s3_protocol
+        end
+      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]
+        filename = path(style)
+        extname  = File.extname(filename)
+        basename = File.basename(filename, extname)
+        file = Tempfile.new([basename, extname])
+        file.binmode
+        file.write(@s3.buckets[@s3_bucket].objects[path(style)].read)
+        file.rewind
+        return file
+      end
+
+      def create_bucket
+        @s3.buckets.create(@s3_bucket)
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          begin
+            log("saving #{path(style)}")
+            
+            @s3.buckets[@s3_bucket].objects[path(style)].write(
+              file,
+              :acl => @s3_acl,
+              :storage_class => @s3_storage_class
+            )
+          rescue AWS::S3::Errors::NoSuchBucket => e
+            create_bucket
+            retry
+          rescue AWS::S3::Errors::Base => e
+            raise
+          end
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            @s3.buckets[@s3_bucket].objects[path].delete
+          rescue AWS::S3::Base => e
+            raise
+          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, Pathname
+          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

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'papepclip-aws'
+
+class Test::Unit::TestCase
+end

data/test/test_papepclip-aws.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPapepclipAws < 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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-aws
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Igor Alexandrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: &70127719039620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127719039620
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: &70127719038940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127719038940
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70127719038340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70127719038340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70127719037660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70127719037660
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70127719036700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70127719036700
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70127719035940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70127719035940
+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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/papepclip-aws.rb
+- test/helper.rb
+- test/test_papepclip-aws.rb
+homepage: http://github.com/igor-alexandrov/paperclip-aws
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 488569729423285379
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Storage module to official 'aws-sdk' gem for Amazon S3
+test_files: []