paperclip_heroku 0.2.1 → 0.4.0

data/README.md

@@ -1,6 +1,38 @@
-See documentation in <code>lib/paperclip/heroku.rb</code>.
+# paperclip_heroku
 
-## Specs
+One-line S3 storage setup for Paperclip on Heroku.
 
-	$ bundle install
-	$ bundle exec rspec spec
+Usage:
+
+	class User
+	  has_attached_file :avatar, heroku: true
+	end
+
+Using <code>heroku: true</code> configures Paperclip to use Amazon S3 on Heroku and the filesystem in development/testing.
+
+## Configuration
+
+S3 storage config can be set on the command line, like this:
+
+	$ heroku config:add S3_BUCKET=my_bucket_name
+	$ heroku config:add S3_KEY=my_s3_access_key_id
+	$ heroku config:add S3_SECRET=my_s3_secret_access_key
+
+You can also optionally set a S3_HOST_NAME to specify an endpoint for S3 requests: for example, if your S3 bucket is in the US West (Oregon) region, you should set S3_HOST_NAME to 's3-us-west-2.amazonaws.com'. If not set, this will default to s3.amazonaws.com. See [Amazon's docs][docs] for a list of valid hostnames/endpoints.
+
+## Environments
+
+By default, paperclip_heroku assumes you want to use S3 in production. To override this:
+
+	$ heroku config:add S3_ENVIRONMENT=staging
+
+Multiple environments are also supported:
+
+	$ heroku config:add S3_ENVIRONMENT=staging,production
+
+## Author
+
+Developed by [James Wilding][jw]. Released under the MIT license.
+
+[docs]: http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
+[jw]: http://jameswilding.net/

data/lib/paperclip_heroku/version.rb

@@ -0,0 +1,3 @@
+module PaperclipHeroku
+  VERSION = '0.4.0'
+end

data/lib/paperclip_heroku.rb

@@ -1 +1,52 @@
-require 'paperclip/heroku'
+require 'paperclip'
+require 'active_support/core_ext/module/aliasing'
+
+module PaperclipHeroku
+  # Storage systems to use in development and production
+  DEVELOPMENT_STORAGE = :filesystem
+  PRODUCTION_STORAGE  = :s3
+          
+  # Default endpoint for S3 requests
+  DEFAULT_S3_HOST_NAME = 's3.amazonaws.com'
+  
+  module ClassMethods    
+	  def has_attached_file_with_heroku(name, options = {})
+	    if options[:heroku] == true
+	      # Set per-environment options for Heroku/development
+	      #
+	      # :storage is a given. Other options are only set
+	      # if the user hasn't provided values for them.
+        #
+	      options[:storage]   = environment_storage
+	      options[:bucket]  ||= ENV['S3_BUCKET']
+        options[:s3_host_name]   ||= ENV['S3_HOST_NAME'] || PaperclipHeroku::DEFAULT_S3_HOST_NAME
+	      options[:s3_credentials] ||= {
+          :access_key_id      => ENV['S3_KEY'],
+          :secret_access_key  => ENV['S3_SECRET']
+	      }
+	    end
+  
+	    has_attached_file_without_heroku(name, options)
+	  end
+
+	  private
+	  def environment_storage
+      s3_environment? ? PaperclipHeroku::PRODUCTION_STORAGE : PaperclipHeroku::DEVELOPMENT_STORAGE	   
+	  end
+    
+    def s3_environment?
+      s3_environments.include?(Rails.env)
+    end
+    
+    def s3_environments
+      (ENV['S3_ENVIRONMENT'] || 'production').split(',').map(&:strip)
+    end
+  end
+end
+
+module Paperclip  
+	module ClassMethods
+	  include PaperclipHeroku::ClassMethods
+	  alias_method_chain :has_attached_file, :heroku
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip_heroku
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
@@ -97,8 +97,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/paperclip/heroku/version.rb
-- lib/paperclip/heroku.rb
+- lib/paperclip_heroku/version.rb
 - lib/paperclip_heroku.rb
 - README.md
 homepage: http://github.com/jameswilding/paperclip_heroku

data/lib/paperclip/heroku/version.rb

@@ -1,15 +0,0 @@
-module Paperclip
-  module Heroku
-    module Version
-      extend self
-      
-      MAJOR = 0
-      MINOR = 2
-      TINY  = 1
-      
-      def to_s
-        [MAJOR, MINOR, TINY].join('.')
-      end
-    end
-  end
-end

data/lib/paperclip/heroku.rb

@@ -1,80 +0,0 @@
-require 'paperclip'
-require 'active_support/core_ext/module/aliasing'
-
-module Paperclip
-  module Heroku
-    module ClassMethods
-      # Default filesystem path at which to save attachments.
-      DEFAULT_PATH = Paperclip::Attachment.default_options[:path]
-      
-      # Default endpoint for S3 requests
-      DEFAULT_S3_HOST_NAME = 's3.amazonaws.com'
-    
-      # Adds a :heroku option to Paperclip's +has_attached_file+ method.
-      #
-      #   class User
-      #     has_attached_file :avatar, heroku: true
-      #   end
-      # 
-      # Using +heroku: true+ configures Paperclip to use Amazon S3 on Heroku
-      # and the filesystem in development/testing.
-      #
-      # == Configuration
-      #
-      # S3 storage config can be set on the command line using +heroku config:add+, like this:
-      #
-      #   $ heroku config:add S3_BUCKET=my_bucket_name
-      #   $ heroku config:add S3_KEY=my_s3_access_key_id
-      #   $ heroku config:add S3_SECRET=my_s3_secret_access_key
-      #
-      # You can also optionally set a S3_HOST_NAME to specify an endpoint for S3
-      # requests: for example, if your S3 bucket is in the US West (Oregon) region,
-      # you should set S3_HOST_NAME to 's3-us-west-2.amazonaws.com'. If not set,
-      # this will default to s3.amazonaws.com.
-      #
-      # == Note
-      #
-      # Paperclip::Heroku assumes that Heroku is configured to run your
-      # Rails app in the production environment.
-      #
-  	  def has_attached_file_with_heroku(name, options = {})
-  	    if options[:heroku] == true
-  	      # Set per-environment options for Heroku/development
-  	      #
-  	      # :storage is a given. Other options are only set
-  	      # if the user hasn't provided values for them.
-          #
-  	      options[:storage]   = environment_storage
-  	      options[:path]    ||= environment_path
-  	      options[:url]     ||= environment_url
-  	      options[:bucket]  ||= ENV['S3_BUCKET']
-          options[:s3_host_name]   ||= ENV['S3_HOST_NAME'] || DEFAULT_S3_HOST_NAME
-  	      options[:s3_credentials] ||= {
-            :access_key_id      => ENV['S3_KEY'],
-            :secret_access_key  => ENV['S3_SECRET']
-  	      }
-  	    end
-    
-  	    has_attached_file_without_heroku(name, options)
-  	  end
-  
-  	  private
-  	  def environment_storage
-        Rails.env.production? ? :s3 : :filesystem	   
-  	  end
-    
-  	  def environment_path
-        Rails.env.production? ? DEFAULT_PATH : ['public', DEFAULT_PATH].join
-  	  end
-  
-  	  def environment_url
-        Rails.env.production? ? ':s3_domain_url' : DEFAULT_PATH
-  	  end      
-    end
-  end
-  
-	module ClassMethods
-	  include Paperclip::Heroku::ClassMethods
-	  alias_method_chain :has_attached_file, :heroku
-	end
-end