futuresinc-attachment_fu 1.0.4 → 1.0.5

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 4
+:patch: 5
 :major: 1
 :minor: 0

data/attachment_fu.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{attachment_fu}
-  s.version = "1.0.4"
+  s.version = "1.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Technoweenie"]
@@ -24,17 +24,17 @@ Gem::Specification.new do |s|
      "attachment_fu.gemspec",
      "init.rb",
      "install.rb",
+     "lib/attachment_fu.rb",
+     "lib/attachment_fu/backends/cloud_file_backend.rb",
+     "lib/attachment_fu/backends/db_file_backend.rb",
+     "lib/attachment_fu/backends/file_system_backend.rb",
+     "lib/attachment_fu/backends/s3_backend.rb",
+     "lib/attachment_fu/processors/core_image_processor.rb",
+     "lib/attachment_fu/processors/gd2_processor.rb",
+     "lib/attachment_fu/processors/image_science_processor.rb",
+     "lib/attachment_fu/processors/mini_magick_processor.rb",
+     "lib/attachment_fu/processors/rmagick_processor.rb",
      "lib/geometry.rb",
-     "lib/technoweenie/attachment_fu.rb",
-     "lib/technoweenie/attachment_fu/backends/cloud_file_backend.rb",
-     "lib/technoweenie/attachment_fu/backends/db_file_backend.rb",
-     "lib/technoweenie/attachment_fu/backends/file_system_backend.rb",
-     "lib/technoweenie/attachment_fu/backends/s3_backend.rb",
-     "lib/technoweenie/attachment_fu/processors/core_image_processor.rb",
-     "lib/technoweenie/attachment_fu/processors/gd2_processor.rb",
-     "lib/technoweenie/attachment_fu/processors/image_science_processor.rb",
-     "lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb",
-     "lib/technoweenie/attachment_fu/processors/rmagick_processor.rb",
      "rackspace_cloudfiles.yml.tpl",
      "test/backends/db_file_test.rb",
      "test/backends/file_system_test.rb",

data/init.rb

@@ -1 +1 @@
-require 'technoweenie/attachment_fu'
+require File.dirname(__FILE__) + '/lib/attachment_fu'

data/lib/attachment_fu/backends/cloud_file_backend.rb

@@ -0,0 +1,209 @@
+module AttachmentFu # :nodoc:
+  module Backends
+    # = CloudFiles Storage Backend
+    #
+    # Enables use of {Rackspace Cloud Files}[http://www.mosso.com/cloudfiles.jsp] as a storage mechanism
+    #
+    # Based heavily on the Amazon S3 backend.
+    #
+    # == Requirements
+    #
+    # Requires the {Cloud Files Gem}[http://www.mosso.com/cloudfiles.jsp] by Rackspace 
+    #
+    # == Configuration
+    #
+    # Configuration is done via <tt>RAILS_ROOT/config/rackspace_cloudfiles.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
+    # The minimum connection options that you must specify are a container name, your Mosso login name and your Mosso API key.
+    # You can sign up for Cloud Files and get access keys by visiting https://www.mosso.com/buy.htm 
+    #
+    # Example configuration (RAILS_ROOT/config/rackspace_cloudfiles.yml)
+    #
+    #   development:
+    #     container_name: appname_development
+    #     username: <your key>
+    #     api_key: <your key>
+    #
+    #   test:
+    #     container_name: appname_test
+    #     username: <your key>
+    #     api_key: <your key>
+    #
+    #   production:
+    #     container_name: appname
+    #     username: <your key>
+    #     apik_key: <your key>
+    #
+    # You can change the location of the config path by passing a full path to the :cloudfiles_config_path option.
+    #
+    #   has_attachment :storage => :cloud_files, :cloudfiles_config_path => (RAILS_ROOT + '/config/mosso.yml')
+    #
+    # === Required configuration parameters
+    #
+    # * <tt>:username</tt> - The username for your Rackspace Cloud (Mosso) account. Provided by Rackspace.
+    # * <tt>:secret_access_key</tt> - The api key for your Rackspace Cloud account. Provided by Rackspace.
+    # * <tt>:container_name</tt> - The name of a container in your Cloud Files account.
+    #
+    # If any of these required arguments is missing, a AuthenticationException will be raised from CloudFiles::Connection.
+    #
+    # == Usage
+    #
+    # To specify Cloud Files as the storage mechanism for a model, set the acts_as_attachment <tt>:storage</tt> option to <tt>:cloud_files/tt>.
+    #
+    #   class Photo < ActiveRecord::Base
+    #     has_attachment :storage => :cloud_files
+    #   end
+    #
+    # === Customizing the path
+    #
+    # By default, files are prefixed using a pseudo hierarchy in the form of <tt>:table_name/:id</tt>, which results
+    # in Cloud Files object names (and urls) that look like: http://:server/:container_name/:table_name/:id/:filename with :table_name
+    # representing the customizable portion of the path. You can customize this prefix using the <tt>:path_prefix</tt>
+    # option:
+    #
+    #   class Photo < ActiveRecord::Base
+    #     has_attachment :storage => :cloud_files, :path_prefix => 'my/custom/path'
+    #   end
+    #
+    # Which would result in public URLs like <tt>http(s)://:server/:container_name/my/custom/path/:id/:filename.</tt>
+    #
+    # === Permissions
+    #
+    # File permisisons are determined by the permissions of the container.  At present, the options are public (and distributed
+    # by the Limelight CDN), and private (only available to your login)
+    #
+    # === Other options
+    #
+    # Of course, all the usual configuration options apply, such as content_type and thumbnails:
+    #
+    #   class Photo < ActiveRecord::Base
+    #     has_attachment :storage => :cloud_files, :content_type => ['application/pdf', :image], :resize_to => 'x50'
+    #     has_attachment :storage => :cloud_files, :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+    #   end
+    #
+    # === Accessing Cloud Files URLs
+    #
+    # You can get an object's public URL using the cloudfiles_url accessor. For example, assuming that for your postcard app
+    # you had a container name like 'postcard_world_development', and an attachment model called Photo:
+    #
+    #   @postcard.cloudfiles_url # => http://cdn.cloudfiles.mosso.com/c45182/uploaded_files/20/london.jpg
+    #
+    # The resulting url is in the form: http://:server/:container_name/:table_name/:id/:file.
+    # The optional thumbnail argument will output the thumbnail's filename (if any).
+    #
+    # Additionally, you can get an object's base path relative to the container root using
+    # <tt>base_path</tt>:
+    #
+    #   @photo.file_base_path # => uploaded_files/20
+    #
+    # And the full path (including the filename) using <tt>full_filename</tt>:
+    #
+    #   @photo.full_filename # => uploaded_files/20/london.jpg
+    #
+    # Niether <tt>base_path</tt> or <tt>full_filename</tt> include the container name as part of the path.
+    # You can retrieve the container name using the <tt>container_name</tt> method.
+    module CloudFileBackend
+      class RequiredLibraryNotFoundError < StandardError; end
+      class ConfigFileNotFoundError < StandardError; end
+
+      def self.included(base) #:nodoc:
+        mattr_reader :container_name, :cloudfiles_config
+
+        begin
+          require 'cloudfiles'
+        rescue LoadError
+          raise RequiredLibraryNotFoundError.new('CloudFiles could not be loaded')
+        end
+
+        begin
+          @@cloudfiles_config_path = base.attachment_options[:cloudfiles_config_path] || (RAILS_ROOT + '/config/rackspace_cloudfiles.yml')
+          @@cloudfiles_config = @@cloudfiles_config = YAML.load(ERB.new(File.read(@@cloudfiles_config_path)).result)[RAILS_ENV].symbolize_keys
+        rescue
+          #raise ConfigFileNotFoundError.new('File %s not found' % @@cloudfiles_config_path)
+        end
+
+        @@container_name = @@cloudfiles_config[:container_name]
+        @@cf = CloudFiles::Connection.new(@@cloudfiles_config[:username], @@cloudfiles_config[:api_key])
+        @@container = @@cf.container(@@container_name)
+        
+        base.before_update :rename_file
+      end
+
+      # Overwrites the base filename writer in order to store the old filename
+      def filename=(value)
+        @old_filename = filename unless filename.nil? || @old_filename
+        write_attribute :filename, sanitize_filename(value)
+      end
+
+      # The attachment ID used in the full path of a file
+      def attachment_path_id
+        ((respond_to?(:parent_id) && parent_id) || id).to_s
+      end
+
+      # The pseudo hierarchy containing the file relative to the container name
+      # Example: <tt>:table_name/:id</tt>
+      def base_path
+        File.join(attachment_options[:path_prefix], attachment_path_id)
+      end
+
+      # The full path to the file relative to the container name
+      # Example: <tt>:table_name/:id/:filename</tt>
+      def full_filename(thumbnail = nil)
+        File.join(base_path, thumbnail_name_for(thumbnail))
+      end
+
+      # All public objects are accessible via a GET request to the Cloud Files servers. You can generate a
+      # url for an object using the cloudfiles_url method.
+      #
+      #   @photo.cloudfiles_url
+      #
+      # The resulting url is in the CDN URL for the object
+      #
+      # The optional thumbnail argument will output the thumbnail's filename (if any).
+      #
+      # If you are trying to get the URL for a nonpublic container, nil will be returned.
+      def cloudfiles_url(thumbnail = nil)
+        if @@container.public?
+          File.join(@@container.cdn_url, full_filename(thumbnail))
+        else
+          nil
+        end
+      end
+      alias :public_filename :cloudfiles_url
+
+      def create_temp_file
+        write_to_temp_file current_data
+      end
+
+      def current_data
+        @@container.get_object(full_filename).data
+      end
+
+      protected
+        # Called in the after_destroy callback
+        def destroy_file
+          @@container.delete_object(full_filename)
+        end
+
+        def rename_file
+          # Cloud Files doesn't rename right now, so we'll just nuke.
+          return unless @old_filename && @old_filename != filename
+
+          old_full_filename = File.join(base_path, @old_filename)
+          @@container.delete_object(old_full_filename)
+
+          @old_filename = nil
+          true
+        end
+
+        def save_to_storage
+          if save_attachment?
+            @object = @@container.create_object(full_filename)
+            @object.write((temp_path ? File.open(temp_path) : temp_data))
+          end
+
+          @old_filename = nil
+          true
+        end
+    end
+  end
+end

data/lib/attachment_fu/backends/db_file_backend.rb

@@ -0,0 +1,37 @@
+module AttachmentFu # :nodoc:
+  module Backends
+    # Methods for DB backed attachments
+    module DbFileBackend
+      def self.included(base) #:nodoc:
+        Object.const_set(:DbFile, Class.new(ActiveRecord::Base)) unless Object.const_defined?(:DbFile)
+        base.belongs_to  :db_file, :class_name => '::DbFile', :foreign_key => 'db_file_id'
+      end
+
+      # Creates a temp file with the current db data.
+      def create_temp_file
+        write_to_temp_file current_data
+      end
+      
+      # Gets the current data from the database
+      def current_data
+        db_file.data
+      end
+      
+      protected
+        # Destroys the file.  Called in the after_destroy callback
+        def destroy_file
+          db_file.destroy if db_file
+        end
+        
+        # Saves the data to the DbFile model
+        def save_to_storage
+          if save_attachment?
+            (db_file || build_db_file).data = temp_data
+            db_file.save!
+            self.class.update_all ['db_file_id = ?', self.db_file_id = db_file.id], ['id = ?', id]
+          end
+          true
+        end
+    end
+  end
+end

data/lib/attachment_fu/backends/file_system_backend.rb

@@ -0,0 +1,124 @@
+require 'fileutils'
+require 'digest/sha2'
+
+module AttachmentFu # :nodoc:
+  module Backends
+    # Methods for file system backed attachments
+    module FileSystemBackend
+      def self.included(base) #:nodoc:
+        base.before_update :rename_file
+      end
+    
+      # Gets the full path to the filename in this format:
+      #
+      #   # This assumes a model name like MyModel
+      #   # public/#{table_name} is the default filesystem path 
+      #   RAILS_ROOT/public/my_models/5/blah.jpg
+      #
+      # Overwrite this method in your model to customize the filename.
+      # The optional thumbnail argument will output the thumbnail's filename.
+      def full_filename(thumbnail = nil)
+        file_system_path = (thumbnail ? thumbnail_class : self).attachment_options[:path_prefix].to_s
+        File.join(RAILS_ROOT, file_system_path, *partitioned_path(thumbnail_name_for(thumbnail)))
+      end
+    
+      # Used as the base path that #public_filename strips off full_filename to create the public path
+      def base_path
+        @base_path ||= File.join(RAILS_ROOT, 'public')
+      end
+    
+      # The attachment ID used in the full path of a file
+      def attachment_path_id
+        ((respond_to?(:parent_id) && parent_id) || id) || 0
+      end
+    
+      # Partitions the given path into an array of path components.
+      #
+      # For example, given an <tt>*args</tt> of ["foo", "bar"], it will return
+      # <tt>["0000", "0001", "foo", "bar"]</tt> (assuming that that id returns 1).
+      #
+      # If the id is not an integer, then path partitioning will be performed by
+      # hashing the string value of the id with SHA-512, and splitting the result
+      # into 4 components. If the id a 128-bit UUID (as set by :uuid_primary_key => true)
+      # then it will be split into 2 components.
+      # 
+      # To turn this off entirely, set :partition => false.
+      def partitioned_path(*args)
+        if respond_to?(:attachment_options) && attachment_options[:partition] == false 
+          args
+        elsif attachment_options[:uuid_primary_key]
+          # Primary key is a 128-bit UUID in hex format. Split it into 2 components.
+          path_id = attachment_path_id.to_s
+          component1 = path_id[0..15] || "-"
+          component2 = path_id[16..-1] || "-"
+          [component1, component2] + args
+        else
+          path_id = attachment_path_id
+          if path_id.is_a?(Integer)
+            # Primary key is an integer. Split it after padding it with 0.
+            ("%08d" % path_id).scan(/..../) + args
+          else
+            # Primary key is a String. Hash it, then split it into 4 components.
+            hash = Digest::SHA512.hexdigest(path_id.to_s)
+            [hash[0..31], hash[32..63], hash[64..95], hash[96..127]] + args
+          end
+        end
+      end
+    
+      # Gets the public path to the file
+      # The optional thumbnail argument will output the thumbnail's filename.
+      def public_filename(thumbnail = nil)
+        full_filename(thumbnail).gsub %r(^#{Regexp.escape(base_path)}), ''
+      end
+    
+      def filename=(value)
+        @old_filename = full_filename unless filename.nil? || @old_filename
+        write_attribute :filename, sanitize_filename(value)
+      end
+
+      # Creates a temp file from the currently saved file.
+      def create_temp_file
+        copy_to_temp_file full_filename
+      end
+
+      protected
+        # Destroys the file.  Called in the after_destroy callback
+        def destroy_file
+          FileUtils.rm full_filename
+          # remove directory also if it is now empty
+          Dir.rmdir(File.dirname(full_filename)) if (Dir.entries(File.dirname(full_filename))-['.','..']).empty?
+        rescue
+          logger.info "Exception destroying  #{full_filename.inspect}: [#{$!.class.name}] #{$1.to_s}"
+          logger.warn $!.backtrace.collect { |b| " > #{b}" }.join("\n")
+        end
+
+        # Renames the given file before saving
+        def rename_file
+          return unless @old_filename && @old_filename != full_filename
+          if save_attachment? && File.exists?(@old_filename)
+            FileUtils.rm @old_filename
+          elsif File.exists?(@old_filename)
+            FileUtils.mv @old_filename, full_filename
+          end
+          @old_filename =  nil
+          true
+        end
+        
+        # Saves the file to the file system
+        def save_to_storage
+          if save_attachment?
+            # TODO: This overwrites the file if it exists, maybe have an allow_overwrite option?
+            FileUtils.mkdir_p(File.dirname(full_filename))
+            FileUtils.cp(temp_path, full_filename)
+            FileUtils.chmod(attachment_options[:chmod] || 0644, full_filename)
+          end
+          @old_filename = nil
+          true
+        end
+        
+        def current_data
+          File.file?(full_filename) ? File.read(full_filename) : nil
+        end
+    end
+  end
+end