rails_uploads 0.1.5 → 0.2.0

data/README.rdoc

@@ -1,4 +1,5 @@
-=== NOTE: From version 0.1.5 and above defaults must be put in public/uploads folder
+=== NOTE: From version 0.1.5 and above defaults must be in public folder
+=== NOTE: From version 0.2.0 and above the use of path is deprecated
 
 ---
 
@@ -15,6 +16,9 @@ Put this line in your Gemfile:
   
 Then bundle:
   $ bundle
+
+ImageMagick must be install, you can install it with homebrew:
+  brew install imagemagick
   
 = Usage
 
@@ -45,6 +49,23 @@ Define presets in your application.rb
     :custom => proc { |image| image.convert :resize => '100x100' } # ImageMagick wrapper to do whatever you want
   }
   config.uploads.default_presets = [:small] # Define the default presets for all models with attached images
+  config.uploads.storage = :local # The default it's local, you can use :s3 as well
+
+If you want to use S3 create a s3.yml file in your config directory like this:
+  development:
+    bucket: development-bucket
+    access_key_id: development_access_key_id
+    secret_access_key: development_secret_access_key
+
+  test:
+    bucket: test-bucket
+    access_key_id: test_access_key_id
+    secret_access_key: test_secret_access_key
+
+  production:
+    bucket: production-bucket
+    access_key_id: production_access_key_id
+    secret_access_key: production_secret_access_key
 
 The validation works very similar to paperclip:
   class Model < ActiveRecord::Base
@@ -61,10 +82,9 @@ If you want to translate the errores the keys are:
   errors.messages.attachment_content_type # :types
 
 In your views:
-  a{ :href => record.file.path } # To get the file
-  a{ :href => record.image.path } # To get the original image
-  a{ :href => record.image.path(:big) } # To get the thumb
-  a{ :href => record.image.url(:big) } # If you want to use a base url
+  a{ :href => record.file.url } # To get the file url
+  a{ :href => record.image.url } # To get the original image
+  a{ :href => record.image.url(:big) } # To get the a thumb
 
 In your forms:
   = f.file_field :prop
@@ -73,15 +93,21 @@ In your forms:
 
 == How can I use a cdn with this plugin?
 
-Just define a base url in your application.rb and use url method instead of path:
-  config.uploads.base_url = 'http://example.com'
+Just define a base url in your application.rb:
+  config.uploads.base_url = 'http://cdn.example.com'
+
+== Can I automatically create buckets?
+
+Yes, use this rake task after create the s3.yml file:
+  rake uploads:s3:buckets:create
   
 == How can I clean a preset?
 
-Just remove the corresponding folder in uploads/images manually or with rake task:
-  rake uploads:preset:clean[preset]
+Just remove the corresponding folder in uploads/images manually or with this rake task:
+  rake uploads:preset:clean NAME=preset
 
 == How to migrate from versions before 0.1.0?
 
 To migrate from versions before 0.1.0 you need to reorganize uploads with this task after define your presets in your application.rb:
   rake uploads:migrate
+

data/app/controllers/rails_uploads/application_controller.rb

@@ -1,4 +1,5 @@
 module RailsUploads
   class ApplicationController < ActionController::Base
+
   end
 end

data/app/controllers/rails_uploads/presets_controller.rb

@@ -1,16 +1,14 @@
 module RailsUploads
   class PresetsController < ApplicationController
 
-    layout false
-
     def generate
       filename = "#{params[:image]}.#{params[:format]}"
       preset = params[:preset].gsub('-', '_').to_sym
-      if Rails.application.config.uploads.presets.has_key?(preset)
+      if Rails.application.config.uploads.presets.has_key? preset
         image = RailsUploads::Types::Image.new(filename)
         if image.exists? and !image.exists?(preset)
           image.send :generate_preset, preset
-          redirect_to request.url, :cb => Random.rand(100000) and return
+          redirect_to request.url, :cb => Random.rand(100000)
         end
       end
     end

data/lib/rails_uploads.rb

@@ -1,5 +1,7 @@
 require 'rails_uploads/active_record/base'
 require 'rails_uploads/magick/image'
+require 'rails_uploads/storages/local'
+require 'rails_uploads/storages/s3'
 require 'rails_uploads/types/file'
 require 'rails_uploads/types/image'
 require 'rails_uploads/validators/base'

data/lib/rails_uploads/active_record/base.rb

@@ -1,7 +1,59 @@
 module RailsUploads
   module ActiveRecord
     module Base
-      module NonAttachable
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      protected
+
+      def build_attachment_instance(source, options)
+        klass = options.has_key?(:type) ? options[:type].to_s.classify : 'File'
+        RailsUploads::Types.const_get(klass).new(source, options)  
+      end
+      
+      def check_changed_attachments
+        @stored_attachments = []
+        @deleted_attachments = []
+        self.class.send(:attachments).each do |attr, options|
+          if changed_attributes.has_key? attr.to_s
+            stored = attributes[attr.to_s]
+            deleted = changed_attributes[attr.to_s]
+            add_changed_attachment stored, options, :stored if stored.present?
+            add_changed_attachment deleted, options, :deleted if deleted.present?
+          end
+        end
+      end
+      
+      def iterate_attachments
+        self.class.send(:attachments).each do |attr, options|
+          next unless instance = send(attr)
+          yield instance
+        end
+      end
+      
+      def add_changed_attachment(source, options, type)
+        (type == :stored ? @stored_attachments : @deleted_attachments) << build_attachment_instance(source, options)
+      end
+      
+      def store_attachments
+        iterate_attachments { |a| a.store }
+      end
+
+      def delete_attachments
+        iterate_attachments { |a| a.delete }  
+      end
+      
+      def remove_stored_attachments
+        @stored_attachments.each { |a| a.delete }
+      end
+   
+      def remove_deleted_attachments
+        @deleted_attachments.each { |a| a.delete }
+      end   
+
+      module ClassMethods
     
         def self.extended(base)
           [:image].each do |type|
@@ -15,15 +67,17 @@ module RailsUploads
 
         def attached_file(*args)
           options = args.extract_options!
-          options.reverse_merge! :type => :file
+          options.reverse_merge! type: :file
           define_attachment *args.append(options)
         end
 
         def is_attachable?
-          not defined?(@attachments).nil?
-        end          
+          attachments.present?
+        end
 
         protected
+
+        attr_reader :attachments
         
         def define_attachment(*args)
           options = args.extract_options!
@@ -35,7 +89,6 @@ module RailsUploads
         end
 
         def make_attachable
-          send :include, RailsUploads::ActiveRecord::Base::Attachable
           before_save :store_attachments, :check_changed_attachments
           after_save :remove_deleted_attachments
           before_destroy :delete_attachments           
@@ -53,7 +106,7 @@ module RailsUploads
           define_method "#{attr}=" do |value|
             @attachments = {} if defined?(@attachments).nil?
             if value.is_a? ActionDispatch::Http::UploadedFile or value.is_a? Rack::Test::UploadedFile
-              @attachments[attr] = get_attachment_instance(value, options)
+              @attachments[attr] = build_attachment_instance(value, options)
               super(@attachments[attr].filename)
             end
           end 
@@ -64,59 +117,11 @@ module RailsUploads
             @attachments = {} if defined?(@attachments).nil?
             return @attachments[attr] if @attachments.has_key? attr
             return nil if super().nil? and not options.has_key? :default
-            @attachments[attr] = get_attachment_instance(super(), options)
+            @attachments[attr] = build_attachment_instance(super(), options)
           end 
         end
 
       end    
-      module Attachable
-
-        protected
-
-        def get_attachment_instance(source, options)
-          klass = options.has_key?(:type) ? options[:type].to_s.classify : 'File'
-          RailsUploads::Types.const_get(klass).new(source, options)  
-        end
-        
-        def check_changed_attachments
-          @stored_attachments = []
-          @deleted_attachments = []
-          self.class.instance_variable_get('@attachments').each do |attr, options|
-            if changed_attributes.has_key? attr.to_s
-              add_changed_attachment attributes[attr.to_s], options, :stored
-              add_changed_attachment changed_attributes[attr.to_s], options, :deleted
-            end
-          end
-        end
-        
-        def iterate_attachments
-          self.class.instance_variable_get('@attachments').each do |attr, options|
-            next unless value = send(attr)
-            yield value
-          end        
-        end
-        
-        def add_changed_attachment(value, options, type)
-          (type == :stored ? @stored_attachments : @deleted_attachments) << get_attachment_instance(value, options) unless value.nil?
-        end
-        
-        def store_attachments
-          iterate_attachments { |a| a.store }
-        end
-
-        def delete_attachments
-          iterate_attachments { |a| a.delete }  
-        end
-        
-        def remove_stored_attachments
-          @stored_attachments.each { |a| a.delete }
-        end
-     
-        def remove_deleted_attachments
-          @deleted_attachments.each { |a| a.delete }
-        end   
-     
-      end
     end
   end
 end

data/lib/rails_uploads/magick/image.rb

@@ -33,7 +33,7 @@ module RailsUploads
       end
 
       def dimensions
-        identify(:format => '%wx%h') do |success, output|
+        identify(format: '%wx%h') do |success, output|
           success ? output.chomp.split('x').map(&:to_i) : []
         end
       end
@@ -49,13 +49,13 @@ module RailsUploads
       def resize_to_fill(max_width, max_height)
         width, height = dimensions
         scale = [max_width/width.to_f, max_height/height.to_f].max
-        convert :resize => "#{(scale*width).to_i}x#{(scale*height).to_i}", :gravity => 'center', :crop => "#{max_width}x#{max_height}+0+0" 
+        convert resize: "#{(scale*width).to_i}x#{(scale*height).to_i}", gravity: 'center', crop: "#{max_width}x#{max_height}+0+0" 
       end
 
       def resize_to_fit(max_width, max_height)
         width, height = dimensions
         scale = [max_width/width.to_f, max_height/height.to_f].min
-        convert :resize => "#{(scale*width).to_i}x#{(scale*height).to_i}", :gravity => 'center'
+        convert resize: "#{(scale*width).to_i}x#{(scale*height).to_i}", gravity: 'center'
       end
 
       protected

data/lib/rails_uploads/railtie.rb

@@ -5,9 +5,14 @@ module RailsUploads
     config.uploads.presets = {}
     config.uploads.default_presets = []
     config.uploads.base_url = ''
+    config.uploads.storage = :local
 
     initializer 'rails_uploads' do
-      ::ActiveRecord::Base.send :extend, RailsUploads::ActiveRecord::Base::NonAttachable
+      ::ActiveRecord::Base.send :include, RailsUploads::ActiveRecord::Base
+      if config.uploads.storage == :s3
+        require 'aws-sdk'
+        RailsUploads::Storages::S3.config = YAML.load_file(Rails.root.join('config', 's3.yml'))
+      end 
     end
 
   end

data/lib/rails_uploads/storages/local.rb

@@ -0,0 +1,57 @@
+module RailsUploads
+  module Storages
+    class Local
+
+      def initialize(tmp)
+        @tmp = tmp
+      end
+
+      def exists?(path)
+        ::File.exists? realpath(path)
+      end
+
+      def size(path)
+        ::File.size realpath(path)
+      end
+
+      def url(path)
+        ::File.join Rails.application.config.uploads.base_url, path
+      end
+
+      def store(upload, path)
+        create_dir realpath(path)
+        upload.rewind # Hack to avoid empty files
+        ::File.open(realpath(path), 'wb') do |file|
+          while chunk = upload.read(16 * 1024)
+            file.write(chunk)
+          end
+        end
+      end
+      
+      def delete(path)
+        ::File.delete realpath(path)
+      end
+
+      def magick(source, output, upload)
+        create_dir realpath(output)
+        yield RailsUploads::Magick::Image.new(realpath(source), realpath(output))
+      end
+
+      protected
+
+      def realpath(path)
+        base_path.join path
+      end
+
+      def base_path
+        Rails.root.join @tmp ? 'tmp' : 'public'
+      end
+
+      def create_dir(path)
+        dir = base_path.join('uploads', path).dirname
+        FileUtils.mkdir_p dir unless ::File.directory? dir
+      end
+
+    end
+  end
+end

data/lib/rails_uploads/storages/s3.rb

@@ -0,0 +1,61 @@
+module RailsUploads
+  module Storages
+    class S3
+      
+      cattr_accessor :config
+
+      def initialize(test)
+        config = self.class.config[test ? 'test' : 'production']
+        AWS.config access_key_id: config['access_key_id'], secret_access_key: config['secret_access_key']
+        @bucket = AWS::S3.new.buckets[config['bucket']]
+        @tmp = {}
+      end
+
+      def exists?(path)
+        object(path).exists?
+      end
+
+      def size(path)
+        object(path).content_length
+      end
+
+      def url(path)
+        base_url = Rails.application.config.uploads.base_url
+        base_url.present? ? ::File.join(base_url, path) : object(path).public_url(secure: false)
+      end
+
+      def store(upload, path)
+        @bucket.objects.create(path, Pathname.new(upload.path)).acl = :public_read
+      end
+      
+      def delete(path)
+        object(path).delete
+      end
+
+      def magick(source, output, upload)
+        if @tmp[source].blank?
+          if upload.present?
+            @tmp[source] = upload.path
+          else
+            tmp = Tempfile.open('s3', Rails.root.join('tmp')) do |file|
+              object(source).read do |chunk|
+                file.write(chunk)
+              end
+            end
+            @tmp[source] = tmp.path
+          end
+        end
+        tmp = Tempfile.new('s3', Rails.root.join('tmp'))
+        yield RailsUploads::Magick::Image.new(@tmp[source], tmp.path)
+        store tmp, output
+      end
+
+      protected
+
+      def object(path)
+        @bucket.objects[path]
+      end
+
+    end
+  end
+end

data/lib/rails_uploads/types/file.rb

@@ -7,45 +7,32 @@ module RailsUploads
           @upload = source          
           @stored = false
           @default = false
+          @storage = build_storage(:local)
         elsif source.is_a? String
           @upload = false
           @filename = source
           @stored = true
           @default = false
+          @storage = build_storage
         elsif options.has_key? :default
           @upload = false
           @filename = options[:default]
           @stored = true
           @default = true
+          @storage = build_storage
         end
         @deleted = false        
         @options = options
       end
 
-      def is_default?
-        @default
-      end
-
-      def is_upload?
-        @upload != false
-      end
-
-      def is_stored?
-        @stored
-      end
-
-      def is_deleted?
-        @deleted
-      end 
-
       def exists?(*args)
         return false if is_deleted?
-        ::File.exists? realpath(*args)
+        storage.exists? path(*args)
       end
 
       def size(*args)
         return 0 if is_deleted?
-        ::File.size realpath(*args)
+        storage.size path(*args)
       end
 
       def extname
@@ -60,37 +47,29 @@ module RailsUploads
 
       def path(*args)
         return nil if is_deleted?
-        ::File.join '', public_path(*args)
+        is_stored? ? destination_path(*args) : @upload.path
       end
 
       def url(*args)
-        return nil if is_deleted?
-        ::File.join Rails.application.config.uploads.base_url, path(*args)
-      end
-      
-      def realpath(*args)
-        return nil if is_deleted?
-        ::File.expand_path(is_stored? ? destination_path(*args) : @upload.path)
+        return nil if is_deleted? or not is_stored?
+        storage.url path(*args)
       end
 
       def store
         if not is_stored? and is_upload?
-          create_dir
-          @upload.rewind # Hack to avoid empty files
-          ::File.open(destination_path, 'wb') do |file|
-            while chunk = @upload.read(16 * 1024)
-              file.write(chunk)
-            end
-          end
-          @stored = true
+          @storage = build_storage
+          storage.store @upload, destination_path
           yield if block_given?
+          @stored = true
+          @deleted = false
         end
       end
       
       def delete
         if not is_default? and is_stored? and exists?
-          ::File.delete realpath
+          storage.delete path
           yield if block_given?
+          @storage = build_storage(:local) if @upload.present?
           @stored = false
           @deleted = true
         end
@@ -98,20 +77,33 @@ module RailsUploads
        
       protected
 
-      def base_path
-        Rails.root.join (Rails.env == 'test' and not is_default?) ? 'tmp' : 'public'
+      def build_storage(type=nil)
+        tmp = (Rails.env == 'test' and not is_default?)
+        type = (type or Rails.application.config.uploads.storage)
+        RailsUploads::Storages.const_get(type.to_s.classify).new(tmp)
       end
 
-      def create_dir(*args)
-        dir = base_path.join('uploads', store_path(*args))
-        FileUtils.mkdir_p dir unless ::File.directory? dir
+      def storage
+        @storage
       end
 
-      def destination_path(*args)
-        base_path.join public_path(*args)
+      def is_default?
+        @default
+      end
+
+      def is_upload?
+        @upload != false
       end
 
-      def public_path(*args)
+      def is_stored?
+        @stored
+      end
+
+      def is_deleted?
+        @deleted
+      end
+
+      def destination_path(*args)
         ::File.join 'uploads', store_path(*args), filename
       end