dragonfly 0.7.0 → 0.7.1

data/.yardopts

@@ -8,6 +8,7 @@ extra_docs/Rails3.md
 extra_docs/Rack.md
 extra_docs/Sinatra.md
 extra_docs/Heroku.md
+extra_docs/Mongo.md
 extra_docs/Models.md
 extra_docs/DataStorage.md
 extra_docs/Analysers.md

data/History.md

@@ -1,3 +1,18 @@
+0.7.1 (2010-08-26)
+==================
+Fixes
+-----
+- SimpleEndpoint was modifying env path_info so wasn't creating proper cache keys
+- to_response accepts env, so can use if-not-modified, etc.
+
+Features
+--------
+- Doc tweaks: Added mongo page, notes about Capistrano
+
+Changes
+-------
+- ETags generated by hash of job.serialize - was getting a bit long
+
 0.7.0 (2010-08-25)
 ==================
 
@@ -28,6 +43,8 @@ Fixes
 - proper use of ETags
 - remove whitespace from file/s3 datastore uids
 - dragonfly/rails/images url-encodes rack-cache config for windows users
+- Ruby 1.9.2 support
+- Better RMagick memory management using image.destroy!
 
 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.0'
+    gem 'dragonfly', '~>0.7.1'
 
 **Initializer** (e.g. config/initializers/dragonfly.rb):
 
@@ -47,6 +47,16 @@ NB: REMEMBER THE MULTIPART BIT!!!
     <%= image_tag @album.cover_image.process(:greyscale).encode(:tiff).url %>
     ...etc.
 
+If using Capistrano with the above, you probably will want to keep the cache between deploys, so in deploy.rb:
+
+    namespace :dragonfly do
+      desc "Symlink the Rack::Cache files"
+      task :symlink, :roles => [:app] do
+        run "mkdir -p #{shared_path}/tmp/dragonfly && ln -nfs #{shared_path}/tmp/dragonfly #{release_path}/tmp/dragonfly"
+      end
+    end
+    after 'deploy:update_code', 'dragonfly:symlink'
+
 Using outside of rails, custom storage/processing/encoding/analysis, and more...
 --------------------------------------------------------------------------------
 Dragonfly is primarily a Rack app, so you can use it as a standalone app, or with Sinatra, Merb, etc.

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/dragonfly.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dragonfly}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Evans"]
-  s.date = %q{2010-08-25}
+  s.date = %q{2010-08-26}
   s.email = %q{mark@new-bamboo.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
      "extra_docs/Index.md",
      "extra_docs/MimeTypes.md",
      "extra_docs/Models.md",
+     "extra_docs/Mongo.md",
      "extra_docs/Processing.md",
      "extra_docs/Rack.md",
      "extra_docs/Rails2.md",

data/extra_docs/Caching.md

@@ -9,7 +9,8 @@ proxy like {http://varnish.projects.linpro.no Varnish}, {http://www.squid-cache.
 {http://tomayko.com/src/rack-cache/ Rack::Cache}, etc. in front of the app, so that subsequent requests are served
 super-quickly straight out of the cache.
 
-The file 'dragonfly/rails/images' puts Rack::Cache in front of Dragonfly by default.
+The file 'dragonfly/rails/images' puts Rack::Cache in front of Dragonfly by default, but for better performance
+you may wish to look into something like Varnish.
 
 Given a dragonfly app
 

data/extra_docs/DataStorage.md

@@ -1,7 +1,8 @@
 Data Storage
 ============
 
-Each dragonfly app has a key-value datastore to store the content.
+Each dragonfly app has a key-value datastore to store the content (originals only).
+
 Lets say we have an app
 
     app = Dragonfly[:my_app_name]

data/extra_docs/Index.md

@@ -8,6 +8,9 @@ I actually lied about image handling - it can be used for any type of content.
 
 See the links on the right for more info.
 
+**NOTE: the API has changed since v0.6.2!
+[Docs for v0.6.2 are here](v0.6.2/index.html) for a very limited time.**
+
 Installation
 ------------
 

data/extra_docs/Mongo.md

@@ -0,0 +1,45 @@
+Mongo
+=====
+Dragonfly can be used with any ActiveModel-compatible model, therefore libraries like [Mongoid](http://mongoid.org) work out of the box.
+
+Furthermore, Mongo DB has support for storing blob-like objects directly in the database (using MongoDB 'GridFS'),
+so you can make use of this with the supplied {Dragonfly::DataStorage::MongoDataStore MongoDataStore}.
+
+For more info about ActiveModel, see {file:Models}.
+
+For more info about using the Mongo data store, see {file:DataStorage}.
+
+Example setup in Rails, using Mongoid
+-------------------------------------
+In config/initializers/dragonfly.rb:
+
+    require 'dragonfly'
+
+    app = Dragonfly[:images]
+
+    # Get database name from config/mongoid.yml
+    db = YAML.load_file(Rails.root.join('config/mongoid.yml'))[Rails.env]['database']
+
+    # Configure to use RMagick, Rails defaults, and the Mongo data store
+    app.configure_with(:rmagick)
+    app.configure_with(:rails) do |c|
+      c.datastore = Dragonfly::DataStorage::MongoDataStore.new :database => db
+    end
+
+    # Allow all mongoid models to use the macro 'image_accessor'
+    app.define_macro_on_include(Mongoid::Document, :image_accessor)
+
+    # ... any other setup, see Rails docs
+
+Then in models:
+
+    class Album
+      include Mongoid::Document
+
+      field :cover_image_uid
+      image_accessor :cover_image
+
+      # ...
+    end
+
+See {file:Models} for more info.

data/extra_docs/Rails2.md

@@ -34,10 +34,22 @@ Gems
 ----
 environment.rb
 
-    config.gem 'dragonfly', '~>0.7.0'
+    config.gem 'dragonfly', '~>0.7.1'
     config.gem 'rmagick', :lib => 'RMagick'
     config.gem 'rack-cache', :lib => 'rack/cache'
 
+Capistrano
+----------
+If using Capistrano with the above, you probably will want to keep the cache between deploys, so in deploy.rb:
+
+    namespace :dragonfly do
+      desc "Symlink the Rack::Cache files"
+      task :symlink, :roles => [:app] do
+        run "mkdir -p #{shared_path}/tmp/dragonfly && ln -nfs #{shared_path}/tmp/dragonfly #{release_path}/tmp/dragonfly"
+      end
+    end
+    after 'deploy:update_code', 'dragonfly:symlink'
+
 Use it!
 -------
 

data/extra_docs/Rails3.md

@@ -33,10 +33,22 @@ application.rb:
 Gemfile
 -------
 
-    gem 'dragonfly', '~>0.7.0'
+    gem 'dragonfly', '~>0.7.1'
     gem 'rmagick', :require => 'RMagick'
     gem 'rack-cache', :require => 'rack/cache'
 
+Capistrano
+----------
+If using Capistrano with the above, you probably will want to keep the cache between deploys, so in deploy.rb:
+
+    namespace :dragonfly do
+      desc "Symlink the Rack::Cache files"
+      task :symlink, :roles => [:app] do
+        run "mkdir -p #{shared_path}/tmp/dragonfly && ln -nfs #{shared_path}/tmp/dragonfly #{release_path}/tmp/dragonfly"
+      end
+    end
+    after 'deploy:update_code', 'dragonfly:symlink'
+
 Use it!
 -------
 

data/extra_docs/Sinatra.md

@@ -2,10 +2,14 @@ Sinatra
 =======
 You can use {Dragonfly::Job Job}'s `to_response` method like so:
 
+    app = Dragonfly[:images].configure_with(:rmagick)
+
     get '/images/:size.:format' do |size, format|
-      app.fetch_file('~/some/image.png').thumb(size).encode(format).to_response
+      app.fetch_file('~/some/image.png').thumb(size).encode(format).to_response(env)
     end
 
+`to_response` returns a rack-style response array with status, headers and body.
+
 NOTE: uids from the datastore currently have slashes and dots in them so may cause problems when using ':uid' as
 a path segment.
 

data/features/support/env.rb

@@ -25,7 +25,7 @@ Before do
 end
 
 AfterStep do |scenario|
-  FileUtils.rm_f("#{ROOT_PATH}/Gemfile.lock")
+  Dir["#{ROOT_PATH}/Gemfile*.lock"].each{|f| FileUtils.rm_f(f) }
 end
 
 module MyHelpers

data/lib/dragonfly/app.rb

@@ -46,7 +46,7 @@ module Dragonfly
     configurable_attr :url_path_prefix
     configurable_attr :url_host
     configurable_attr :protect_from_dos_attacks, false
-    configurable_attr :secret
+    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
 

data/lib/dragonfly/job.rb

@@ -128,6 +128,7 @@ module Dragonfly
       end
 
       def from_path(path, app)
+        path = path.dup
         path.sub!(app.url_path_prefix, '') if app.url_path_prefix
         path.sub!('/', '')
         deserialize(path, app)
@@ -237,7 +238,10 @@ module Dragonfly
     def serialize
       Serializer.marshal_encode(to_a)
     end
-    alias unique_signature serialize
+
+    def unique_signature
+      Digest::SHA1.hexdigest(serialize)
+    end
 
     def sha
       Digest::SHA1.hexdigest("#{serialize}#{app.secret}")[0...8]
@@ -258,8 +262,8 @@ module Dragonfly
       JobEndpoint.new(self)
     end
 
-    def to_response
-      to_app.call
+    def to_response(env={})
+      to_app.call(env)
     end
 
     def url(*args)

data/spec/dragonfly/job_endpoint_spec.rb

@@ -56,7 +56,7 @@ describe Dragonfly::JobEndpoint do
       end
 
       it "should not have applied any steps if the correct ETag is specified in HTTP_IF_NONE_MATCH header" do
-        response = make_request(@job, 'HTTP_IF_NONE_MATCH' => @job.serialize)
+        response = make_request(@job, 'HTTP_IF_NONE_MATCH' => @job.unique_signature)
         @job.applied_steps.should be_empty
       end
     end

data/spec/dragonfly/simple_endpoint_spec.rb

@@ -1,5 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require 'rack/mock'
+require 'rack/cache'
 
 def request(app, path)
   Rack::MockRequest.new(app).get(path)
@@ -75,4 +76,14 @@ describe Dragonfly::SimpleEndpoint do
     response.content_type.should == 'text/plain'
   end
 
+  it "should return a cacheable response" do
+    url = "/#{@app.fetch(@uid).serialize}"
+    cache = Rack::Cache.new(@endpoint, :entitystore => 'heap:/')
+    response = request(cache, url)
+    response.status.should == 200
+    response.headers['X-Rack-Cache'].should == "miss, store"
+    response = request(cache, url)
+    response.status.should == 200
+    response.headers['X-Rack-Cache'].should == "fresh"
+  end
 end

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ ENV['PATH'] += ':' + extra_paths.join(':')
 SAMPLES_DIR = File.expand_path(File.dirname(__FILE__) + '/../samples') unless defined?(SAMPLES_DIR)
 
 Spec::Runner.configure do |c|
-  c.after(:all){ FileUtils.rm_f("#{ROOT_PATH}/Gemfile.lock") }
+  c.after(:all){ Dir["#{ROOT_PATH}/Gemfile*.lock"].each{|f| FileUtils.rm_f(f) } }
 end
 
 def todo

data/yard/templates/default/layout/html/layout.erb

@@ -52,13 +52,14 @@
             ['Rack', 'Rack'],
             ['Sinatra', 'Sinatra'],
             ['Heroku', 'Heroku'],
+            ['Mongo', 'Mongo'],
             ['DataStorage', 'Data Storage'],
             ['Analysers', 'Analysers'],
             ['Processing', 'Processing'],
             ['Encoding', 'Encoding'],
             ['Generators', 'Generators'],
             ['Configuration', 'Configuration'],
-            ['URLs', 'URLs'],
+            ['URLs', 'URLs / Endpoints'],
             ['MimeTypes', 'Mime Types'],
             ['Caching', 'Caching'],
             ['History', 'History'],

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Mark Evans
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 +01:00
+date: 2010-08-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,6 +64,7 @@ files:
 - extra_docs/Index.md
 - extra_docs/MimeTypes.md
 - extra_docs/Models.md
+- extra_docs/Mongo.md
 - extra_docs/Processing.md
 - extra_docs/Rack.md
 - extra_docs/Rails2.md