dragonfly 0.7.5 → 0.7.6

data/lib/dragonfly/data_storage/mongo_data_store.rb

@@ -11,6 +11,10 @@ module Dragonfly
       configurable_attr :port
       configurable_attr :database, 'dragonfly'
 
+      # Mongo gem deprecated ObjectID in favour of ObjectId
+      OBJECT_ID = defined?(BSON::ObjectId) ? BSON::ObjectId : BSON::ObjectID
+      INVALID_OBJECT_ID = defined?(BSON::InvalidObjectId) ? BSON::InvalidObjectId : BSON::InvalidObjectID
+
       def initialize(opts={})
         self.host = opts[:host]
         self.port = opts[:port]
@@ -32,13 +36,13 @@ module Dragonfly
           grid_io.read,
           extra
         ]
-      rescue Mongo::GridFileNotFound, BSON::InvalidObjectID => e
+      rescue Mongo::GridFileNotFound, INVALID_OBJECT_ID => e
         raise DataNotFound, "#{e} - #{uid}"
       end
 
       def destroy(uid)
         grid.delete(bson_id(uid))
-      rescue Mongo::GridFileNotFound, BSON::InvalidObjectID => e
+      rescue Mongo::GridFileNotFound, INVALID_OBJECT_ID => e
         raise DataNotFound, "#{e} - #{uid}"
       end
 
@@ -57,7 +61,7 @@ module Dragonfly
       end
 
       def bson_id(uid)
-        BSON::ObjectID.from_string(uid)
+        OBJECT_ID.from_string(uid)
       end
 
     end

data/lib/dragonfly/data_storage/s3data_store.rb

@@ -32,7 +32,7 @@ module Dragonfly
       end
 
       def store(temp_object, opts={})
-        uid = generate_uid(temp_object.name || 'file')
+        uid = opts[:path] || generate_uid(temp_object.name || 'file')
         ensure_initialized
         object = use_filesystem ? temp_object.file : temp_object.data
         extra_data = temp_object.attributes

data/lib/dragonfly/job.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'digest/sha1'
+require 'base64'
 
 module Dragonfly
   class Job
@@ -15,7 +16,7 @@ module Dragonfly
     class IncorrectSHA < StandardError; end
 
     extend Forwardable
-    def_delegators :result, :data, :file, :tempfile, :path, :to_file, :size, :ext, :name, :meta, :format, :_format
+    def_delegators :result, :data, :file, :tempfile, :path, :to_file, :size, :ext, :name, :name=, :basename, :meta, :meta=, :format, :_format
 
     class Step
 
@@ -37,7 +38,15 @@ module Dragonfly
       def initialize(*args)
         @args = args
       end
+
       attr_reader :args
+
+      def update_temp_object(job, content, extra)
+        temp_object = TempObject.new(content, job.temp_object.attributes)
+        temp_object.extract_attributes_from(extra) if extra
+        job.temp_object = temp_object
+      end
+
       def inspect
         "#{self.class.step_name}(#{args.map{|a| a.inspect }.join(', ')})"
       end
@@ -49,7 +58,7 @@ module Dragonfly
       end
       def apply(job)
         content, extra = job.app.datastore.retrieve(uid)
-        job.temp_object = TempObject.new(content, (extra || {}))
+        job.temp_object = TempObject.new(content, extra)
       end
     end
 
@@ -62,11 +71,8 @@ module Dragonfly
       end
       def apply(job)
         raise NothingToProcess, "Can't process because temp object has not been initialized. Need to fetch first?" unless job.temp_object
-        old = job.temp_object
-        job.temp_object = TempObject.new(
-          job.app.processor.process(old, name, *arguments),
-          old.attributes
-        )
+        content, extra = job.app.processor.process(job.temp_object, name, *arguments)
+        update_temp_object(job, content, extra)
       end
     end
 
@@ -79,18 +85,16 @@ module Dragonfly
       end
       def apply(job)
         raise NothingToEncode, "Can't encode because temp object has not been initialized. Need to fetch first?" unless job.temp_object
-        old = job.temp_object
-        job.temp_object = TempObject.new(
-          job.app.encoder.encode(old, format, *arguments),
-          old.attributes.merge(:format => format)
-        )
+        content, extra = job.app.encoder.encode(job.temp_object, format, *arguments)
+        update_temp_object(job, content, extra)
+        job.temp_object.format = format
       end
     end
 
     class Generate < Step
       def apply(job)
         content, extra = job.app.generator.generate(*args)
-        job.temp_object = TempObject.new(content, (extra || {}))
+        job.temp_object = TempObject.new(content, extra)
       end
     end
 
@@ -210,6 +214,8 @@ module Dragonfly
       new_job
     end
 
+    # Applying, etc.
+
     def apply
       pending_steps.each{|step| step.apply(self) }
       self.next_step_index = steps.length
@@ -235,6 +241,8 @@ module Dragonfly
       }
     end
 
+    # Serializing, etc.
+
     def serialize
       Serializer.marshal_encode(to_a)
     end
@@ -258,6 +266,18 @@ module Dragonfly
       end
     end
 
+    # URLs, etc.
+
+    def url(*args)
+      app.url_for(self, *args) unless steps.empty?
+    end
+
+    def b64_data
+      "data:#{resolve_mime_type};base64,#{Base64.encode64(data)}"
+    end
+
+    # to_stuff...
+
     def to_app
       JobEndpoint.new(self)
     end
@@ -266,8 +286,8 @@ module Dragonfly
       to_app.call(env)
     end
 
-    def url(*args)
-      app.url_for(self, *args) unless steps.empty?
+    def to_path
+      "/#{serialize}"
     end
 
     def to_fetched_job(uid)
@@ -277,8 +297,59 @@ module Dragonfly
       new_job
     end
 
-    def to_path
-      "/#{serialize}"
+    # Step inspection
+
+    def fetch_step
+      last_step_of_type(Fetch)
+    end
+
+    def uid
+      step = fetch_step
+      step.uid if step
+    end
+
+    def uid_basename
+      File.basename(uid, '.*') if uid
+    end
+
+    def uid_extname
+      File.extname(uid) if uid
+    end
+
+    def generate_step
+      last_step_of_type(Generate)
+    end
+
+    def fetch_file_step
+      last_step_of_type(FetchFile)
+    end
+
+    def process_steps
+      steps.select{|s| s.is_a?(Process) }
+    end
+
+    def encode_step
+      last_step_of_type(Encode)
+    end
+
+    def encoded_format
+      step = encode_step
+      step.format if step
+    end
+
+    def encoded_extname
+      format = encoded_format
+      ".#{format}" if format
+    end
+
+    # Misc
+
+    def store(opts={})
+      app.store(result, opts)
+    end
+
+    def resolve_mime_type
+      app.resolve_mime_type(result)
     end
 
     def inspect
@@ -290,5 +361,11 @@ module Dragonfly
     attr_writer :steps
     attr_accessor :next_step_index
 
+    private
+
+    def last_step_of_type(type)
+      steps.select{|s| s.is_a?(type) }.last
+    end
+
   end
 end

data/lib/dragonfly/job_endpoint.rb

@@ -1,14 +1,12 @@
 module Dragonfly
   class JobEndpoint
 
-    include Endpoint
-
     def initialize(job)
       @job = job
     end
 
     def call(env={})
-      response_for_job(job, env)
+      Response.new(job, env).to_response
     end
 
     attr_reader :job

data/lib/dragonfly/r_magick_utils.rb

@@ -3,6 +3,8 @@ require 'tempfile'
 module Dragonfly
   module RMagickUtils
 
+    include Loggable
+
     private
 
     # Requires the extended object to respond to 'use_filesystem'

data/lib/dragonfly/response.rb

@@ -0,0 +1,82 @@
+require 'uri'
+
+module Dragonfly
+  class Response
+
+    DEFAULT_FILENAME = proc{|job, request|
+      if job.basename
+        extname = job.encoded_extname || (".#{job.ext}" if job.ext)
+        "#{job.basename}#{extname}"
+      end
+    }
+
+    def initialize(job, env)
+      @job, @env = job, env
+      @app = @job.app
+    end
+
+    def to_response
+      if etag_matches?
+        # Not Modified
+        [304, cache_headers, []]
+      else
+        # Success
+        [200, success_headers.merge(cache_headers), job.result]
+      end
+    rescue DataStorage::DataNotFound => e
+      [404, {"Content-Type" => 'text/plain'}, [e.message]]
+    end
+
+    private
+
+    attr_reader :job, :env, :app
+
+    def request
+      @request ||= Rack::Request.new(env)
+    end
+
+    def cache_headers
+      {
+        "Cache-Control" => "public, max-age=#{app.cache_duration}",
+        "ETag" => %("#{job.unique_signature}")
+      }
+    end
+
+    def etag_matches?
+      if_none_match = env['HTTP_IF_NONE_MATCH']
+      if if_none_match
+        if_none_match.tr!('"','')
+        if_none_match.split(',').include?(job.unique_signature) || if_none_match == '*'
+      else
+        false
+      end
+    end
+
+    def success_headers
+      {
+        "Content-Type" => job.resolve_mime_type,
+        "Content-Length" => job.size.to_s
+      }.merge(content_disposition_header)
+    end
+
+    def content_disposition_header
+      parts = []
+      parts << content_disposition if content_disposition
+      parts << %(filename="#{URI.encode(filename)}") if filename
+      parts.any? ? {"Content-Disposition" => parts.join('; ')} : {}
+    end
+
+    def content_disposition
+      @content_disposition ||= evaluate(app.content_disposition)
+    end
+
+    def filename
+      @filename ||= evaluate(app.content_filename)
+    end
+
+    def evaluate(attribute)
+      attribute.respond_to?(:call) ? attribute.call(job, request) : attribute
+    end
+
+  end
+end

data/lib/dragonfly/routed_endpoint.rb

@@ -1,8 +1,6 @@
 module Dragonfly
   class RoutedEndpoint
 
-    include Endpoint
-
     class NoRoutingParams < RuntimeError; end
 
     def initialize(app, &block)
@@ -13,7 +11,7 @@ module Dragonfly
     def call(env)
       params = symbolize_keys_of Rack::Request.new(env).params
       job = @block.call(params.merge(routing_params(env)), @app)
-      response_for_job(job, env)
+      Response.new(job, env).to_response
     rescue Job::NoSHAGiven => e
       [400, {"Content-Type" => 'text/plain'}, ["You need to give a SHA parameter"]]
     rescue Job::IncorrectSHA => e

data/lib/dragonfly/simple_endpoint.rb

@@ -1,7 +1,6 @@
 module Dragonfly
   class SimpleEndpoint
 
-    include Endpoint
     include Loggable
 
     # Instance methods
@@ -20,7 +19,7 @@ module Dragonfly
       else
         job = Job.from_path(request.path_info, app)
         job.validate_sha!(request['s']) if app.protect_from_dos_attacks
-        response_for_job(job, env)
+        Response.new(job, env).to_response
       end
     rescue Serializer::BadString, Job::InvalidArray => e
       log.warn(e.message)
@@ -47,7 +46,7 @@ module Dragonfly
   `-.~--'  |=|  '--~.-'
   _~-.~'" /|=|\\ "'~.-~_
  (      ./ |=| \\.      )
-  `~~`"`   |=|   `"'~~"
+  `~~`"`   |=|   `"'ME"
            |-|
            <->
             V

data/lib/dragonfly/temp_object.rb

@@ -41,6 +41,7 @@ module Dragonfly
     # Instance Methods
 
     def initialize(obj, opts={})
+      opts ||= {} # in case it's nil
       initialize_from_object!(obj)
       validate_options!(opts)
       extract_attributes_from(opts)
@@ -57,6 +58,7 @@ module Dragonfly
           @tempfile = initialized_tempfile
         when :data
           @tempfile = Tempfile.new('dragonfly')
+          @tempfile.binmode
           @tempfile.write(initialized_data)
         when :file
           @tempfile = copy_to_tempfile(initialized_file.path)
@@ -89,8 +91,9 @@ module Dragonfly
       end
     end
 
-    attr_reader :name, :format
+    attr_accessor :name, :format
     alias _format format
+    attr_writer :meta
 
     def meta
       @meta ||= {}
@@ -138,9 +141,9 @@ module Dragonfly
     end
 
     def extract_attributes_from(hash)
-      self.name   = hash.delete(:name)   unless hash[:name].blank?
-      self.meta   = hash.delete(:meta)   unless hash[:meta].blank?
-      self.format = hash.delete(:format) unless hash[:format].blank?
+      self.name   = hash.delete(:name)     unless hash[:name].blank?
+      self.format = hash.delete(:format)   unless hash[:format].blank?
+      self.meta.merge!(hash.delete(:meta)) unless hash[:meta].blank?
     end
 
     def inspect
@@ -160,8 +163,6 @@ module Dragonfly
 
     private
 
-    attr_writer :name, :meta, :format
-
     def initialize_from_object!(obj)
       case obj
       when TempObject

data/spec/dragonfly/active_model_extensions/model_spec.rb

@@ -615,6 +615,58 @@ describe Item do
         }.should raise_error(NoMethodError)
       end
     end
+
+    describe "setting things on the attachment" do
+
+      before(:each) do
+        @item = Item.new
+      end
+
+      describe "name" do
+        before(:each) do
+          @item.preview_image = "Hello"
+          @item.preview_image.name = 'hello.there'
+        end
+        it "should allow for setting the name" do
+          @item.preview_image.name.should == 'hello.there'
+        end
+        it "should update the magic attribute" do
+          @item.preview_image_name.should == 'hello.there'
+        end
+        it "should return the name" do
+          (@item.preview_image.name = 'no.silly').should == 'no.silly'
+        end
+      end
+
+      describe "meta" do
+        before(:each) do
+          @item.preview_image = "Hello all"
+          @item.preview_image.meta = {:slime => 'balls'}
+        end
+        it "should allow for setting the meta" do
+          @item.preview_image.meta.should == {:slime => 'balls'}
+        end
+        it "should allow for updating the meta" do
+          @item.preview_image.meta[:numb] = 'nuts'
+          @item.preview_image.meta.should == {:slime => 'balls', :numb => 'nuts'}
+        end
+        it "should return the meta" do
+          (@item.preview_image.meta = {:doogs => 'boogs'}).should == {:doogs => 'boogs'}
+        end
+        it "should save it correctly" do
+          @item.save!
+          item = Item.find(@item.id)
+          item.preview_image.meta.should include_hash(:slime => 'balls')
+        end
+        it "should store meta info about the model" do
+          @item.save!
+          meta = {:model_class => 'Item', :model_attachment => :preview_image, :slime => 'balls'}
+          @app.fetch(@item.preview_image_uid).meta.should == meta
+        end
+      end
+
+    end
+
   end
 
   describe "inheritance" do