dragonfly 1.0 → 1.0.1

data/lib/dragonfly/job/generate.rb

@@ -0,0 +1,27 @@
+require 'dragonfly/job/step'
+
+module Dragonfly
+  class Job
+    class Generate < Step
+      def init
+        generator.update_url(job.url_attributes, *arguments) if generator.respond_to?(:update_url)
+      end
+
+      def name
+        args.first
+      end
+
+      def generator
+        @generator ||= app.get_generator(name)
+      end
+
+      def arguments
+        args[1..-1]
+      end
+
+      def apply
+        generator.call(job.content, *arguments)
+      end
+    end
+  end
+end

data/lib/dragonfly/job/process.rb

@@ -0,0 +1,27 @@
+require 'dragonfly/job/step'
+
+module Dragonfly
+  class Job
+    class Process < Step
+      def init
+        processor.update_url(job.url_attributes, *arguments) if processor.respond_to?(:update_url)
+      end
+
+      def name
+        args.first.to_sym
+      end
+
+      def arguments
+        args[1..-1]
+      end
+
+      def processor
+        @processor ||= app.get_processor(name)
+      end
+
+      def apply
+        processor.call(job.content, *arguments)
+      end
+    end
+  end
+end

data/lib/dragonfly/job/step.rb

@@ -0,0 +1,44 @@
+module Dragonfly
+  class Job
+    class Step
+
+      class << self
+        # Dragonfly::Job::Fetch -> 'Fetch'
+        def basename
+          @basename ||= name.split('::').last
+        end
+        # Dragonfly::Job::Fetch -> :fetch
+        def step_name
+          @step_name ||= basename.gsub(/[A-Z]/){ "_#{$&.downcase}" }.sub('_','').to_sym
+        end
+        # Dragonfly::Job::Fetch -> 'f'
+        def abbreviation
+          @abbreviation ||= basename.scan(/[A-Z]/).join.downcase
+        end
+      end
+
+      def initialize(job, *args)
+        @job, @args = job, args
+        init
+      end
+
+      def init # To be overridden
+      end
+
+      attr_reader :job, :args
+
+      def app
+        job.app
+      end
+
+      def to_a
+        [self.class.abbreviation, *args]
+      end
+
+      def inspect
+        "#{self.class.step_name}(#{args.map{|a| a.inspect }.join(', ')})"
+      end
+
+    end
+  end
+end

data/lib/dragonfly/model/attachment.rb

@@ -164,8 +164,6 @@ module Dragonfly
         "<Dragonfly Attachment uid=#{uid.inspect}, app=#{app.name.inspect}>"
       end
 
-      protected
-
       attr_reader :job
 
       private

data/lib/dragonfly/model/class_methods.rb

@@ -53,6 +53,11 @@ module Dragonfly
             dragonfly_attachments[attribute].stored?
           end
 
+          # Define the xxx_changed? method
+          define_method "#{attribute}_changed?" do
+            dragonfly_attachments[attribute].changed?
+          end
+
           # Define the URL setter
           define_method "#{attribute}_url=" do |url|
             unless Utils.blank?(url)

data/lib/dragonfly/rails/images.rb

@@ -0,0 +1 @@
+raise LoadError, "\n*****\ndragonfly/rails/images no longer exists! Please use the rails generator instead\n\n\trails generate dragonfly\n\nsee the documentation at http://markevans.github.io/dragonfly/rails for more details\n*****\n"

data/lib/dragonfly/response.rb

@@ -80,7 +80,7 @@ module Dragonfly
       {
         "Content-Type" => job.mime_type,
         "Content-Length" => job.size.to_s,
-        "Content-Disposition" => (%(filename="#{URI.encode(job.name)}") if job.name)
+        "Content-Disposition" => filename_string
       }
     end
 
@@ -97,6 +97,15 @@ module Dragonfly
       end
     end
 
+    def filename_string
+      return unless job.name
+      filename = request_from_msie? ? URI.encode(job.name) : job.name
+      %(filename="#{filename}")
+    end
+
+    def request_from_msie?
+      env["HTTP_USER_AGENT"] =~ /MSIE/
+    end
+
   end
 end
-

data/lib/dragonfly/routed_endpoint.rb

@@ -14,12 +14,20 @@ module Dragonfly
 
     def call(env)
       params = Utils.symbolize_keys Rack::Request.new(env).params
-      job = @block.call(params.merge(routing_params(env)), @app)
-      Response.new(job, env).to_response
+      value = @block.call(params.merge(routing_params(env)), @app)
+      case value
+      when nil then plain_response(404, "Not Found")
+      when Job, Model::Attachment
+        job = value.is_a?(Model::Attachment) ? value.job : value
+        Response.new(job, env).to_response
+      else
+        Dragonfly.warn("can't handle return value from routed endpoint: #{value.inspect}")
+        plain_response(500, "Server Error")
+      end
     rescue Job::NoSHAGiven => e
-      [400, {"Content-Type" => 'text/plain'}, ["You need to give a SHA parameter"]]
+      plain_response(400, "You need to give a SHA parameter")
     rescue Job::IncorrectSHA => e
-      [400, {"Content-Type" => 'text/plain'}, ["The SHA parameter you gave (#{e}) is incorrect"]]
+      plain_response(400, "The SHA parameter you gave is incorrect")
     end
 
     def inspect
@@ -32,10 +40,12 @@ module Dragonfly
       env['rack.routing_args'] ||
         env['action_dispatch.request.path_parameters'] ||
         env['router.params'] ||
-        env['usher.params'] ||
         env['dragonfly.params'] ||
         raise(NoRoutingParams, "couldn't find any routing parameters in env #{env.inspect}")
     end
 
+    def plain_response(status, message)
+      [status, {"Content-Type" => "text/plain"}, [message]]
+    end
   end
 end

data/lib/dragonfly/serializer.rb

@@ -31,7 +31,7 @@ module Dragonfly
       raise MaliciousString, "potentially malicious marshal string #{marshal_string.inspect}" if opts[:check_malicious] && marshal_string[/@[a-z_]/i]
       Marshal.load(marshal_string)
     rescue TypeError, ArgumentError => e
-      raise BadString, "couldn't decode #{string} - got #{e}"
+      raise BadString, "couldn't marshal decode string - got #{e}"
     end
 
     def json_encode(object)
@@ -42,7 +42,7 @@ module Dragonfly
       raise BadString, "can't decode blank string" if Utils.blank?(string)
       MultiJson.decode(string)
     rescue MultiJson::DecodeError => e
-      raise BadString, "couldn't decode #{string} - got #{e}"
+      raise BadString, "couldn't json decode string - got #{e}"
     end
 
     def json_b64_encode(object)

data/lib/dragonfly/shell.rb

@@ -11,11 +11,7 @@ module Dragonfly
     def run(command, opts={})
       command = escape_args(command) unless opts[:escape] == false
       Dragonfly.debug("shell command: #{command}")
-      Open3.popen3 command do |stdin, stdout, stderr, wait_thread|
-        status = wait_thread.value
-        raise CommandFailed, "Command failed (#{command}) with exit status #{status.exitstatus} and stderr #{stderr.read}" unless status.success?
-        stdout.read
-      end
+      run_command(command)
     end
 
     def escape_args(args)
@@ -29,5 +25,32 @@ module Dragonfly
       q + string + q
     end
 
+    private
+
+    # Annoyingly, Open3 seems buggy on jruby/1.8.7:
+    # Some versions don't yield a wait_thread in the block and
+    # you can't run sub-shells (if explicitly turning shell-escaping off)
+    if RUBY_PLATFORM == 'java' || RUBY_VERSION < '1.9'
+
+      # Unfortunately we have no control over stderr this way
+      def run_command(command)
+        result = `#{command}`
+        status = $?
+        raise CommandFailed, "Command failed (#{command}) with exit status #{status.exitstatus}" unless status.success?
+        result
+      end
+
+    else
+
+      def run_command(command)
+        Open3.popen3 command do |stdin, stdout, stderr, wait_thread|
+          status = wait_thread.value
+          raise CommandFailed, "Command failed (#{command}) with exit status #{status.exitstatus} and stderr #{stderr.read}" unless status.success?
+          stdout.read
+        end
+      end
+
+    end
+
   end
 end

data/lib/dragonfly/version.rb

@@ -1,3 +1,3 @@
 module Dragonfly
-  VERSION = '1.0'
+  VERSION = '1.0.1'
 end

data/spec/dragonfly/file_data_store_spec.rb

@@ -16,6 +16,13 @@ describe Dragonfly::FileDataStore do
     File.exists?(path).should be_false
   end
 
+  def assert_contains(dir, filepattern)
+    entries = Dir["#{dir}/*"]
+    unless entries.any?{|f| filepattern === f}
+      raise "expected #{entries} to contain #{filepattern}"
+    end
+  end
+
   let (:app) { test_app }
   let (:content) { Dragonfly::Content.new(app, 'goobydoo') }
   let (:new_content) { Dragonfly::Content.new(app) }
@@ -24,10 +31,10 @@ describe Dragonfly::FileDataStore do
 
     before(:each) do
       @data_store = Dragonfly::FileDataStore.new(:root_path => 'tmp/file_data_store_test')
+      FileUtils.rm_rf("#{@data_store.root_path}")
     end
 
     after(:each) do
-      # Clean up created files
       FileUtils.rm_rf("#{@data_store.root_path}")
     end
 
@@ -38,56 +45,51 @@ describe Dragonfly::FileDataStore do
       before(:each) do
         # Set 'now' to a date in the past
         Time.stub(:now).and_return Time.mktime(1984,"may",4,14,28,1)
-        @file_pattern_prefix_without_root = '1984/05/04/14_28_01_0_'
-        @file_pattern_prefix = "#{@data_store.root_path}/#{@file_pattern_prefix_without_root}"
+        @dir = "#{@data_store.root_path}/1984/05/04"
       end
 
       it "should store the file in a folder based on date, with default filename" do
         @data_store.write(content)
-        assert_exists "#{@file_pattern_prefix}file"
+        assert_contains @dir, /file$/
       end
 
       it "should use the content name if it exists" do
         content.should_receive(:name).at_least(:once).and_return('hello.there')
         @data_store.write(content)
-        assert_exists "#{@file_pattern_prefix}hello.there"
+        assert_contains @dir, /hello\.there$/
       end
 
       it "should get rid of funny characters in the content name" do
         content.should_receive(:name).at_least(:once).and_return('A Picture with many spaces in its name (at 20:00 pm).png')
         @data_store.write(content)
-        assert_exists "#{@file_pattern_prefix}A_Picture_with_many_spaces_in_its_name_at_20_00_pm_.png"
+        assert_contains @dir, /A_Picture_with_many_spaces_in_its_name_at_20_00_pm_\.png$/
       end
 
       it "stores meta as YAML" do
         content.meta = {'wassup' => 'doc'}
-        @data_store.write(content)
-        File.read("#{@file_pattern_prefix}file.meta.yml").should =~ /---\s+wassup: doc/
+        uid = @data_store.write(content)
+        File.read("#{@data_store.root_path}/#{uid}.meta.yml").should =~ /---\s+wassup: doc/
       end
 
       describe "when the filename already exists" do
 
         it "should use a different filename" do
-          touch_file("#{@file_pattern_prefix}file")
-          @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file").and_return("#{@file_pattern_prefix}file_2")
-          @data_store.write(content)
-          assert_exists "#{@file_pattern_prefix}file_2"
-        end
-
-        it "should use a different filename taking into account the name and ext" do
-          content.should_receive(:name).at_least(:once).and_return('hello.png')
-          touch_file("#{@file_pattern_prefix}hello.png")
-          @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}hello.png").and_return("#{@file_pattern_prefix}blah.png")
-          @data_store.write(content)
+          touch_file("#{@data_store.root_path}/blah")
+          @data_store.should_receive(:disambiguate).with(/blah/).and_return("#{@data_store.root_path}/blah2")
+          @data_store.write(content, :path => 'blah')
+          assert_exists "#{@data_store.root_path}/blah2"
         end
 
         it "should keep trying until it finds a free filename" do
-          touch_file("#{@file_pattern_prefix}file")
-          touch_file("#{@file_pattern_prefix}file_2")
-          @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file").and_return("#{@file_pattern_prefix}file_2")
-          @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file_2").and_return("#{@file_pattern_prefix}file_3")
-          @data_store.write(content)
-          assert_exists "#{@file_pattern_prefix}file_3"
+          path1 = "#{@data_store.root_path}/blah1"
+          path2 = "#{@data_store.root_path}/blah2"
+          path3 = "#{@data_store.root_path}/blah3"
+          touch_file(path1)
+          touch_file(path2)
+          @data_store.should_receive(:disambiguate).with(path1).and_return(path2)
+          @data_store.should_receive(:disambiguate).with(path2).and_return(path3)
+          @data_store.write(content, :path => 'blah1')
+          assert_exists path3
         end
 
         describe "specifying the uid" do
@@ -107,13 +109,8 @@ describe Dragonfly::FileDataStore do
 
       describe "return value" do
 
-        it "should return the filepath without the root of the stored file when a file name is not provided" do
-          @data_store.write(content).should == "#{@file_pattern_prefix_without_root}file"
-        end
-
-        it "should return the filepath without the root of the stored file when a file name is provided" do
-          content.should_receive(:name).at_least(:once).and_return('hello.you.png')
-          @data_store.write(content).should == "#{@file_pattern_prefix_without_root}hello.you.png"
+        it "should return the relative path" do
+          @data_store.write(content).should =~ /^1984\/05\/04\/\w+$/
         end
 
       end

data/spec/dragonfly/job/fetch_file_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Dragonfly::Job::FetchFile do
+
+  let (:app) { test_app }
+  let (:job) { Dragonfly::Job.new(app) }
+
+  before(:each) do
+    job.fetch_file!(SAMPLES_DIR.join('egg.png'))
+  end
+
+  it { job.steps.should match_steps([Dragonfly::Job::FetchFile]) }
+
+  it "should fetch the specified file when applied" do
+    job.size.should == 62664
+  end
+
+  it "should set the url_attributes" do
+    job.url_attributes.name.should == 'egg.png'
+  end
+
+  it "should set the name" do
+    job.name.should == 'egg.png'
+  end
+
+end

data/spec/dragonfly/job/fetch_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Dragonfly::Job::Fetch do
+
+  let (:app) { test_app }
+  let (:job) { Dragonfly::Job.new(app) }
+
+  before(:each) do
+    job.fetch!('some_uid')
+  end
+
+  it { job.steps.should match_steps([Dragonfly::Job::Fetch]) }
+
+  it "should read from the app's datastore when applied" do
+    app.datastore.should_receive(:read).with('some_uid').and_return ["", {}]
+    job.apply
+  end
+
+  it "raises NotFound if the datastore returns nil" do
+    app.datastore.should_receive(:read).and_return(nil)
+    expect {
+      job.apply
+    }.to raise_error(Dragonfly::Job::Fetch::NotFound)
+  end
+
+end

data/spec/dragonfly/job/fetch_url_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe Dragonfly::Job::FetchUrl do
+
+  let (:app) { test_app }
+  let (:job) { Dragonfly::Job.new(app) }
+
+  before(:each) do
+    stub_request(:get, %r{http://place\.com/.*}).to_return(:body => 'result!')
+  end
+
+  it "adds a step" do
+    job.fetch_url!('some.url')
+    job.steps.should match_steps([Dragonfly::Job::FetchUrl])
+  end
+
+  it "should fetch the specified url when applied" do
+    job.fetch_url!('http://place.com')
+    job.data.should == "result!"
+  end
+
+  it "should default to http" do
+    job.fetch_url!('place.com')
+    job.data.should == "result!"
+  end
+
+  it "should also work with https" do
+    stub_request(:get, /place.com/).to_return(:body => 'secure result!')
+    job.fetch_url!('https://place.com')
+    job.data.should == "secure result!"
+  end
+
+  [
+    "place.com",
+    "http://place.com",
+    "place.com/",
+    "place.com/stuff/",
+    "place.com/?things"
+  ].each do |url|
+    it "doesn't set the name if there isn't one, e.g. for #{url}" do
+      job.fetch_url!(url)
+      job.name.should be_nil
+    end
+
+    it "doesn't set the name url_attr if there isn't one, e.g. for #{url}" do
+      job.fetch_url!(url)
+      job.url_attributes.name.should be_nil
+    end
+  end
+
+  [
+    "place.com/dung.beetle",
+    "http://place.com/dung.beetle",
+    "place.com/stuff/dung.beetle",
+    "place.com/dung.beetle?morethings"
+  ].each do |url|
+    it "sets the name if there is one, e.g. for #{url}" do
+      job.fetch_url!(url)
+      job.name.should == 'dung.beetle'
+    end
+
+    it "sets the name url_attr if there is one, e.g. for #{url}" do
+      job.fetch_url!(url)
+      job.url_attributes.name.should == 'dung.beetle'
+    end
+  end
+
+  it "should raise an error if not found" do
+    stub_request(:get, "notfound.com").to_return(:status => 404, :body => "BLAH")
+    expect{
+      job.fetch_url!('notfound.com').apply
+    }.to raise_error(Dragonfly::Job::FetchUrl::ErrorResponse){|error|
+      error.status.should == 404
+      error.body.should == "BLAH"
+    }
+  end
+
+  it "should raise an error if server error" do
+    stub_request(:get, "error.com").to_return(:status => 500, :body => "BLAH")
+    expect{
+      job.fetch_url!('error.com').apply
+    }.to raise_error(Dragonfly::Job::FetchUrl::ErrorResponse){|error|
+      error.status.should == 500
+      error.body.should == "BLAH"
+    }
+  end
+
+  it "should follow redirects" do
+    stub_request(:get, "redirectme.com").to_return(:status => 302, :headers => {'Location' => 'http://ok.com'})
+    stub_request(:get, "ok.com").to_return(:body => "OK!")
+    job.fetch_url('redirectme.com').data.should == 'OK!'
+  end
+
+  it "follows redirects to https" do
+    stub_request(:get, "redirectme.com").to_return(:status => 302, :headers => {'Location' => 'https://ok.com'})
+    stub_request(:get, /ok.com/).to_return(:body => "OK!")
+    job.fetch_url('redirectme.com').data.should == 'OK!'
+  end
+
+  it "raises if redirecting too many times" do
+    stub_request(:get, "redirectme.com").to_return(:status => 302, :headers => {'Location' => 'http://redirectme-back.com'})
+    stub_request(:get, "redirectme-back.com").to_return(:status => 302, :headers => {'Location' => 'http://redirectme.com'})
+    expect {
+      job.fetch_url('redirectme.com').apply
+    }.to raise_error(Dragonfly::Job::FetchUrl::TooManyRedirects)
+  end
+
+  describe "data uris" do
+    it "accepts standard base64 encoded data uris" do
+      job.fetch_url!("data:text/plain;base64,aGVsbG8=\n")
+      job.data.should == 'hello'
+      job.mime_type.should == 'text/plain'
+      job.ext.should == 'txt'
+    end
+
+    it "doesn't accept other data uris" do
+      expect {
+        job.fetch_url!("data:text/html;charset=utf-8,<stuff />").apply
+      }.to raise_error(Dragonfly::Job::FetchUrl::CannotHandle)
+    end
+  end
+
+end