dragonfly 0.7.5 → 0.7.6

data/.gitignore

@@ -10,3 +10,6 @@ fixtures/*/tmp_app
 .ginger
 .bundle
 spec/spec.log
+Gemfile.lock
+.s3_spec.yml
+

data/History.md

@@ -1,3 +1,26 @@
+0.7.6 (2010-09-12)
+==================
+Features
+--------
+- Added methods for querying job steps, and Job#uid, Job#uid_basename, etc.
+- Added Job#b64_data
+- Added configurable url_suffix
+- Added configurable content_disposition and content_filename
+- Can pass extra GET params to url_for
+- Can manually set uid on FileDataStore and S3DataStore
+    (not yet documented because attachments have no way to pass it on yet)
+- Model attachments store meta info about themselves
+
+Changes
+-------
+- Configurable module doesn't implicitly call 'call' if attribute set as proc
+- Refactored Endpoint module -> Response object
+
+Fixes
+-----
+- Ruby 1.9.2-p0 was raising encoding errors due to Tempfiles not being in binmode
+
+
 0.7.5 (2010-09-01)
 ==================
 Changes

data/README.md

@@ -11,7 +11,7 @@ For the lazy Rails user...
 
     gem 'rmagick',    :require => 'RMagick'
     gem 'rack-cache', :require => 'rack/cache'
-    gem 'dragonfly', '~>0.7.4'
+    gem 'dragonfly', '~>0.7.5'
 
 **Initializer** (e.g. config/initializers/dragonfly.rb):
 

data/VERSION

@@ -1 +1 @@
-0.7.5
+0.7.6

data/dragonfly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly}
-  s.version = "0.7.5"
+  s.version = "0.7.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2010-09-01}
+  s.date = %q{2010-09-12}
   s.email = %q{mark@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -89,7 +89,6 @@ Gem::Specification.new do |s|
      "lib/dragonfly/data_storage/s3data_store.rb",
      "lib/dragonfly/encoder.rb",
      "lib/dragonfly/encoding/r_magick_encoder.rb",
-     "lib/dragonfly/endpoint.rb",
      "lib/dragonfly/function_manager.rb",
      "lib/dragonfly/generation/r_magick_generator.rb",
      "lib/dragonfly/generator.rb",
@@ -103,6 +102,7 @@ Gem::Specification.new do |s|
      "lib/dragonfly/processor.rb",
      "lib/dragonfly/r_magick_utils.rb",
      "lib/dragonfly/rails/images.rb",
+     "lib/dragonfly/response.rb",
      "lib/dragonfly/routed_endpoint.rb",
      "lib/dragonfly/serializer.rb",
      "lib/dragonfly/simple_cache.rb",

data/extra_docs/Configuration.md

@@ -29,6 +29,12 @@ Here is an example of an app with all attributes configured:
 
       c.url_path_prefix = '/images'                         # defaults to nil
       c.url_host = 'http://some.domain.com:4000'            # defaults to nil
+      c.url_suffix = '.jpg'                                 # defaults to nil - has no effect other than change the url
+
+      c.content_filename = proc{|job, request|              # defaults to the original name, with modified ext if encoded
+        "file.#{job.ext}"
+      }
+      c.content_disposition = :attachment                   # defaults to nil (use the browser default)
 
       c.protect_from_dos_attacks = true                     # defaults to false - adds a SHA parameter on the end of urls
       c.secret = 'This is my secret yeh!!'                  # should set this if concerned about DOS attacks

data/extra_docs/Models.md

@@ -174,6 +174,21 @@ If the object assigned is a file, or responds to `original_filename` (as is the
     @album.cover_image.name    # => 'my_image.png'
     @album.cover_image.ext     # => 'png'
 
+Meta data
+---------
+You can store metadata along with the content data of your attachment:
+
+    @album.cover_image = File.new('path/to/my_image.png')
+    @album.cover_image.meta = {:taken => Date.yesterday}
+    @album.save!
+
+    @album.cover_image.meta      # => {:model_class=>"Album",
+                                 #     :model_attachment=>:cover_image,
+                                 #     :taken=>Sat, 11 Sep 2010}
+
+As you can see, a couple of things are added by the model. You can also access this directly on the {Dragonfly::Job Job} object.
+
+    app.fetch(@album.cover_image_uid).meta     # => {:model_class=>"Album", ...}
 
 'Magic' Attributes
 ------------------

data/extra_docs/Rails2.md

@@ -34,7 +34,7 @@ Gems
 ----
 environment.rb
 
-    config.gem 'dragonfly', '~>0.7.4'
+    config.gem 'dragonfly', '~>0.7.5'
     config.gem 'rmagick', :lib => 'RMagick'
     config.gem 'rack-cache', :lib => 'rack/cache'
 

data/extra_docs/Rails3.md

@@ -33,7 +33,7 @@ application.rb:
 Gemfile
 -------
 
-    gem 'dragonfly', '~>0.7.4'
+    gem 'dragonfly', '~>0.7.5'
     gem 'rmagick', :require => 'RMagick'
     gem 'rack-cache', :require => 'rack/cache'
 

data/extra_docs/URLs.md

@@ -17,13 +17,13 @@ to the urls:
 
 (or done in a configuration block).
 
-    app.fetch('my_uid').url                               # "/media/BAhbBlsH..."
+    app.fetch('my_uid').url                                  # "/media/BAhbBlsH..."
 
 This is done for you when using {file:Configuration Rails defaults}.
 
 You can override it using
 
-    app.fetch('my_uid').url(:path_prefix => '/images')    # "/images/BAhbBlsH..."
+    app.fetch('my_uid').url(:path_prefix => '/images')       # "/images/BAhbBlsH..."
 
 Host
 ----
@@ -34,6 +34,59 @@ You can also set a host for the urls
 
     app.fetch('my_uid').url(:host => 'http://localhost:80')  # "http://localhost:80/BAh..."
 
+Suffix
+------
+You can set a suffix for the urls (for example if some other component behaves badly with urls that have no file extension).
+
+Note that this has no effect on the response.
+
+    app.url_suffix = '.jpg'
+    app.fetch('some/uid').url                                # "...b21lL3VpZA.jpg"
+
+You can also pass it a block, that yields the {Dragonfly::Job Job}, for example:
+
+    app.url_suffix = proc{|job|
+      "/#{job.uid_basename}#{job.encoded_extname || job.uid_extname}"
+    }
+
+    app.fetch('2007/painting.pdf').url                       # "...eS5ib2R5/painting.pdf"
+    app.fetch('2007/painting.pdf').encode(:png).url          # "...gZlOgbmc/painting.png"
+
+And you can override it:
+
+    app.fetch('some/uid').url(:suffix => '/yellowbelly')     # "...b21lL3VpZA/yellowbelly"
+
+Content-Disposition and downloaded filename
+-------------------------------------------
+You can manually set the content-disposition of the response:
+
+    app.content_disposition = :attachment    # should be :inline or :attachment (or :hidden)
+
+`:attachment` tells the browser to download it, `:inline` tells it to display in-browser if possible.
+
+You can also use a block:
+
+    app.content_disposition = proc{|job, request|
+      if job.format == :jpg || request['d'] == 'inline' # request is a Rack::Request object
+        :inline
+      else
+        :attachment
+      end
+    }
+
+To specify the filename the browser uses for 'Save As' dialogues:
+
+    app.content_filename = proc{|job, request|
+      "#{job.basename}_#{job.process_steps.first.name}.#{job.encoded_format || job.ext}"
+    }
+
+This will for example give the following filenames for the following jobs:
+
+    app.fetch('some/tree.png').process(:greyscale)      # -> 'tree_greyscale.png'
+    app.fetch('some/tree.png').process(:greyscale).gif  # -> 'tree_greyscale.gif'
+
+By default the original filename is used, with a modified extension if it's been encoded.
+
 Routed Endpoints
 ----------------
 You can also use a number of Rack-based routers and create Dragonfly endpoints.

data/lib/dragonfly/active_model_extensions/attachment.rb

@@ -9,6 +9,7 @@ module Dragonfly
       def_delegators :job,
         :data, :to_file, :file, :tempfile, :path,
         :process, :encode, :analyse,
+        :meta, :meta=,
         :url
 
       def initialize(app, parent_model, attribute_name)
@@ -44,7 +45,12 @@ module Dragonfly
         sync_with_parent!
         destroy_previous!
         if job && !uid
-          set_uid_and_parent_uid app.store(job.result)
+          set_uid_and_parent_uid job.store(
+            :meta => {
+              :model_class => parent_model.class.name,
+              :model_attachment => attribute_name
+            }
+          )
           self.job = job.to_fetched_job(uid)
         end
       end
@@ -63,6 +69,12 @@ module Dragonfly
         end
       end
 
+      def name=(name)
+        job.name = name
+        set_magic_attribute(:name, name) if has_magic_attribute_for?(:name)
+        name
+      end
+
       def process!(*args)
         assign(process(*args))
         self
@@ -127,24 +139,25 @@ module Dragonfly
       end
 
       def magic_attributes
-        parent_model.public_methods.select { |name|
+        @magic_attributes ||= parent_model.public_methods.select { |name|
           name.to_s =~ /^#{attribute_name}_(.+)$/ && allowed_magic_attributes.include?($1.to_sym)
-        }
+        }.map{|name| name.to_s.sub("#{attribute_name}_", '').to_sym }
+      end
+
+      def set_magic_attribute(property, value)
+        parent_model.send("#{attribute_name}_#{property}=", value)
       end
 
       def set_magic_attributes
-        magic_attributes.each do |attribute|
-          method = attribute.to_s.sub("#{attribute_name}_", '')
-          parent_model.send("#{attribute}=", job.send(method))
-        end
+        magic_attributes.each{|property| set_magic_attribute(property, job.send(property)) }
       end
 
       def reset_magic_attributes
-        magic_attributes.each{|attribute| parent_model.send("#{attribute}=", nil) }
+        magic_attributes.each{|property| set_magic_attribute(property, nil) }
       end
 
       def has_magic_attribute_for?(property)
-        magic_attributes.include?("#{attribute_name}_#{property}".to_method_name)
+        magic_attributes.include?(property.to_sym)
       end
 
       def magic_attribute_for(property)

data/lib/dragonfly/analysis/r_magick_analyser.rb

@@ -4,7 +4,6 @@ module Dragonfly
   module Analysis
     class RMagickAnalyser
 
-      include Loggable
       include RMagickUtils
       include Configurable
 

data/lib/dragonfly/app.rb

@@ -45,10 +45,13 @@ module Dragonfly
     configurable_attr :fallback_mime_type, 'application/octet-stream'
     configurable_attr :url_path_prefix
     configurable_attr :url_host
+    configurable_attr :url_suffix
     configurable_attr :protect_from_dos_attacks, false
     configurable_attr :secret, 'secret yo'
     configurable_attr :log do Logger.new('/var/tmp/dragonfly.log') end
     configurable_attr :infer_mime_type_from_file_ext, true
+    configurable_attr :content_disposition
+    configurable_attr :content_filename, Response::DEFAULT_FILENAME
 
     attr_reader :analyser
     attr_reader :processor
@@ -124,11 +127,15 @@ module Dragonfly
 
     def url_for(job, *args)
       if (args.length == 1 && args.first.kind_of?(Hash)) || args.empty?
-        opts = args.first || {}
-        host = opts[:host] || url_host
-        path_prefix = opts[:path_prefix] || url_path_prefix
-        path = "#{host}#{path_prefix}#{job.to_path}"
-        path << "?#{dos_protection_query_string(job)}" if protect_from_dos_attacks
+        opts = args.first ? args.first.dup : {}
+        host = opts.delete(:host) || url_host
+        suffix = opts.delete(:suffix) || url_suffix
+        suffix = suffix.call(job) if suffix.respond_to?(:call)
+        path_prefix = opts.delete(:path_prefix) || url_path_prefix
+        path = "#{host}#{path_prefix}#{job.to_path}#{suffix}"
+        query = opts
+        query.merge!(server.required_params_for(job)) if protect_from_dos_attacks
+        path << "?#{Rack::Utils.build_query(query)}" if query.any?
         path
       else
         # Deprecation stuff - will be removed!!!
@@ -169,9 +176,5 @@ module Dragonfly
       '.' + format.to_s.downcase.sub(/^.*\./,'')
     end
 
-    def dos_protection_query_string(job)
-      server.required_params_for(job).map{|k,v| "#{k}=#{v}" }.join('&')
-    end
-
   end
 end

data/lib/dragonfly/configurable.rb

@@ -25,6 +25,8 @@ module Dragonfly
       end
     end
 
+    class DeferredBlock < Proc; end
+
     module InstanceMethods
 
       def configure(&block)
@@ -62,11 +64,11 @@ module Dragonfly
       private
 
       def configurable_attr attribute, default=nil, &blk
-        default_configuration[attribute] = blk || default
+        default_configuration[attribute] = blk ? DeferredBlock.new(&blk) : default
 
         # Define the reader
         define_method(attribute) do
-          if configuration_hash[attribute].respond_to? :call
+          if configuration_hash[attribute].is_a?(DeferredBlock)
             configuration_hash[attribute] = configuration_hash[attribute].call
           end
           configuration_hash[attribute]

data/lib/dragonfly/data_storage/file_data_store.rb

@@ -10,13 +10,17 @@ module Dragonfly
       configurable_attr :root_path, '/var/tmp/dragonfly'
 
       def store(temp_object, opts={})
-        filename = temp_object.name || 'file'
+        relative_path = if opts[:path]
+          opts[:path]
+        else
+          filename = temp_object.name || 'file'
+          relative_path = relative_path_for(filename)
+        end
 
-        relative_path = relative_path_for(filename)
         begin
-          while File.exist?(path = absolute_path(relative_path))
-            filename = disambiguate(filename)
-            relative_path = relative_path_for(filename)
+          path = absolute(relative_path)
+          until !File.exist?(path)
+            path = disambiguate(path)
           end
           prepare_path(path)
           temp_object.to_file(path).close
@@ -24,12 +28,12 @@ module Dragonfly
         rescue Errno::EACCES => e
           raise UnableToStore, e.message
         end
-      
-        relative_path
+
+        relative(path)
       end
 
       def retrieve(relative_path)
-        path = absolute_path(relative_path)
+        path = absolute(relative_path)
         [
           File.new(path),
           retrieve_extra_data(path)
@@ -39,7 +43,7 @@ module Dragonfly
       end
 
       def destroy(relative_path)
-        path = absolute_path(relative_path)
+        path = absolute(relative_path)
         FileUtils.rm path
         FileUtils.rm extra_data_path(path)
         purge_empty_directories(relative_path)
@@ -47,18 +51,23 @@ module Dragonfly
         raise DataNotFound, e.message
       end
 
-      def disambiguate(filename)
-        basename = File.basename(filename, '.*')
-        extname = File.extname(filename)
-        "#{basename}_#{Time.now.usec.to_s(32)}#{extname}"
+      def disambiguate(path)
+        dirname = File.dirname(path)
+        basename = File.basename(path, '.*')
+        extname = File.extname(path)
+        "#{dirname}/#{basename}_#{Time.now.usec.to_s(32)}#{extname}"
       end
 
       private
 
-      def absolute_path(relative_path)
+      def absolute(relative_path)
         File.join(root_path, relative_path)
       end
 
+      def relative(absolute_path)
+        absolute_path[/^#{root_path}\/(.*)$/, 1]
+      end
+
       def directory_empty?(path)
         Dir.entries(path) == ['.','..']
       end
@@ -70,31 +79,31 @@ module Dragonfly
       def relative_path_for(filename)
         "#{Time.now.strftime '%Y/%m/%d'}/#{filename.gsub(/[^\w.]+/,'_')}"
       end
-      
+
       def store_extra_data(data_path, temp_object)
         File.open(extra_data_path(data_path), 'w') do |f|
           f.write Marshal.dump(temp_object.attributes)
         end
       end
-      
+
       def retrieve_extra_data(data_path)
         path = extra_data_path(data_path)
         File.exist?(path) ? Marshal.load(File.read(path)) : {}
       end
-      
+
       def prepare_path(path)
         dir = File.dirname(path)
         FileUtils.mkdir_p(dir) unless File.exist?(dir)
       end
-      
+
       def purge_empty_directories(path)
         containing_directory = Pathname.new(path).dirname
         containing_directory.ascend do |relative_dir|
-          dir = absolute_path(relative_dir)
+          dir = absolute(relative_dir)
           FileUtils.rmdir dir if directory_empty?(dir)
         end
       end
-      
+
     end
 
   end