dragonfly 0.9.8 → 0.9.9

data/Gemfile

@@ -23,7 +23,7 @@ group :development, :test, :cucumber do
     gem "jruby-openssl"
   else
     gem 'bluecloth'
-    gem 'bson_ext'
+    gem 'bson_ext', '~>1.3.1'
     gem 'sqlite3-ruby'
   end
 end

data/History.md

@@ -1,3 +1,35 @@
+0.9.9 (2011-12-30)
+==================
+Features
+--------
+- Created tempfiles use the original file extension if known
+- Added `:case_sensitive` option to `validates_property` for dealing with upper-case extensions and mime-types.
+- Github Markup syntax on readme for code highlighting
+- S3DataStore can use https for remote urls (either configurable or per-url)
+- `to_file` can take `:mode` option for setting custom permissions
+- `to_file` creates intermediate subdirs by default, can be turned off with `:mkdirs => false` option
+- Added some more S3 regions
+
+Changes
+-------
+- Datastores now use `temp_object.meta`, not the second arg passed in to `store`
+- `meta`, `name`, etc. now lazily load the job on an attachment - previously you'd have to call `apply` to get the meta from the datastore
+- When assigning an image via the activemodel extensions, mark that uid attribute will change
+- `validates_property` uses Rails 3 validators
+- Deprecated saved 'heroku' config, in favour of configuring S3 explicitly
+
+Fixes
+-----
+- Model attachment urls are consistent now - the name is appended to the url (with format "/:job/:name") ONLY if it has the "name" magic attribute
+- `identify` wasn't working properly for files with capital letter extensions
+- S3 datastore sets content mime_type by default
+- File extensions with numbers like JP2 weren't being processed/analysed properly
+- Protect against object_ids being recycled and messing with analyser cache
+- All url segments are correctly url-escaped now
+- Fixed TempObject File.open mode
+- S3DataStore was breaking on bucket_exists? when using AWS IAM
+- Put CookieMonster before ActionDispatch::Cookies in rack middleware stack - that way Rack::Cache won't come between them and mess things up
+
 0.9.8 (2011-09-08)
 ==================
 Fixes

data/README.md

@@ -11,73 +11,95 @@ For the lazy Rails user...
 --------------------------
 **Gemfile**:
 
-    gem 'rack-cache', :require => 'rack/cache'
-    gem 'dragonfly', '~>0.9.8'
+```ruby
+gem 'rack-cache', :require => 'rack/cache'
+gem 'dragonfly', '~>0.9.9'
+```
 
 **Initializer** (e.g. config/initializers/dragonfly.rb):
 
-    require 'dragonfly/rails/images'
+```ruby
+require 'dragonfly/rails/images'
+```
 
 **Migration**:
 
-    add_column :albums, :cover_image_uid,  :string
-    add_column :albums, :cover_image_name, :string  # Optional - only if you want urls
-                                                    # to end with the original filename
+```ruby
+add_column :albums, :cover_image_uid,  :string
+add_column :albums, :cover_image_name, :string  # Optional - only if you want urls
+                                                # to end with the original filename
+```
 
 **Model**:
 
-    class Album < ActiveRecord::Base
-      image_accessor :cover_image            # 'image_accessor' is provided by Dragonfly
-                                             # this defines a reader/writer for cover_image
-      # ...
-    end
+```ruby
+class Album < ActiveRecord::Base
+  image_accessor :cover_image            # 'image_accessor' is provided by Dragonfly
+                                         # this defines a reader/writer for cover_image
+  # ...
+end
+```
 
 **View** (for uploading via a file field):
 
-    <% form_for @album, :html => {:multipart => true} do |f| %>
-      ...
-      <%= f.file_field :cover_image %>
-      ...
-    <% end %>
+```erb
+<% form_for @album, :html => {:multipart => true} do |f| %>
+  ...
+  <%= f.file_field :cover_image %>
+  ...
+<% end %>
+```
 
 NB: REMEMBER THE MULTIPART BIT!!!
 
 You can avoid having to re-upload when validations fail with
 
-      <%= f.hidden_field :retained_cover_image %>
+```erb
+  <%= f.hidden_field :retained_cover_image %>
+```
 
 remove the attachment with
 
-      <%= f.check_box :remove_cover_image %>
+```erb
+  <%= f.check_box :remove_cover_image %>
+```
 
 assign from some other url with
 
-      <%= f.text_field :cover_image_url %>
+```erb
+  <%= f.text_field :cover_image_url %>
+```
 
 and display a thumbnail (on the upload form) with
 
-      <%= image_tag @album.cover_image.thumb('100x100').url if @album.cover_image_uid %>
+```erb
+  <%= image_tag @album.cover_image.thumb('100x100').url if @album.cover_image_uid %>
+```
 
 **View** (to display):
 
-    <%= image_tag @album.cover_image.url %>
-    <%= image_tag @album.cover_image.thumb('400x200#').url %>
-    <%= image_tag @album.cover_image.jpg.url %>
-    <%= image_tag @album.cover_image.process(:greyscale).encode(:tiff).url %>
-    ...etc.
+```erb
+<%= image_tag @album.cover_image.url %>
+<%= image_tag @album.cover_image.thumb('400x200#').url %>
+<%= image_tag @album.cover_image.jpg.url %>
+<%= image_tag @album.cover_image.process(:greyscale).encode(:tiff).url %>
+...etc.
+```
 
 The above relies on imagemagick being installed. Dragonfly doesn't depend on it per se, but the default configuration `'dragonfly/rails/images'`
 uses it. For alternative configurations, see below.
 
 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'
+```ruby
+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'
+```
 
 Sinatra, CouchDB, Mongo, Rack, S3, custom storage, processing, and more...
 --------------------------------------------------------------------------

data/VERSION

@@ -1 +1 @@
-0.9.8
+0.9.9

data/dragonfly.gemspec

@@ -4,15 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{dragonfly}
-  s.version = "0.9.8"
+  s.name = "dragonfly"
+  s.version = "0.9.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Mark Evans}]
-  s.date = %q{2011-09-08}
-  s.description = %q{Dragonfly is a framework that enables on-the-fly processing for any content type.
-  It is especially suited to image handling. Its uses range from image thumbnails to standard attachments to on-demand text generation.}
-  s.email = %q{mark@new-bamboo.co.uk}
+  s.authors = ["Mark Evans"]
+  s.date = "2011-12-30"
+  s.description = "Dragonfly is a framework that enables on-the-fly processing for any content type.\n  It is especially suited to image handling. Its uses range from image thumbnails to standard attachments to on-demand text generation."
+  s.email = "mark@new-bamboo.co.uk"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -89,8 +88,6 @@ Gem::Specification.new do |s|
     "lib/dragonfly/core_ext/array.rb",
     "lib/dragonfly/core_ext/hash.rb",
     "lib/dragonfly/core_ext/object.rb",
-    "lib/dragonfly/core_ext/string.rb",
-    "lib/dragonfly/core_ext/symbol.rb",
     "lib/dragonfly/data_storage.rb",
     "lib/dragonfly/data_storage/couch_data_store.rb",
     "lib/dragonfly/data_storage/file_data_store.rb",
@@ -101,6 +98,7 @@ Gem::Specification.new do |s|
     "lib/dragonfly/function_manager.rb",
     "lib/dragonfly/generation/image_magick_generator.rb",
     "lib/dragonfly/generator.rb",
+    "lib/dragonfly/has_filename.rb",
     "lib/dragonfly/hash_with_css_style_keys.rb",
     "lib/dragonfly/image_magick/analyser.rb",
     "lib/dragonfly/image_magick/config.rb",
@@ -126,7 +124,11 @@ Gem::Specification.new do |s|
     "lib/dragonfly/shell.rb",
     "lib/dragonfly/simple_cache.rb",
     "lib/dragonfly/temp_object.rb",
+    "lib/dragonfly/url_attributes.rb",
     "lib/dragonfly/url_mapper.rb",
+    "samples/DSC02119.JPG",
+    "samples/a.jp2",
+    "samples/beach.jpg",
     "samples/beach.png",
     "samples/egg.png",
     "samples/round.gif",
@@ -142,14 +144,13 @@ Gem::Specification.new do |s|
     "spec/dragonfly/cookie_monster_spec.rb",
     "spec/dragonfly/core_ext/array_spec.rb",
     "spec/dragonfly/core_ext/hash_spec.rb",
-    "spec/dragonfly/core_ext/string_spec.rb",
-    "spec/dragonfly/core_ext/symbol_spec.rb",
     "spec/dragonfly/data_storage/couch_data_store_spec.rb",
     "spec/dragonfly/data_storage/file_data_store_spec.rb",
     "spec/dragonfly/data_storage/mongo_data_store_spec.rb",
     "spec/dragonfly/data_storage/s3_data_store_spec.rb",
     "spec/dragonfly/data_storage/shared_data_store_examples.rb",
     "spec/dragonfly/function_manager_spec.rb",
+    "spec/dragonfly/has_filename_spec.rb",
     "spec/dragonfly/hash_with_css_style_keys_spec.rb",
     "spec/dragonfly/image_magick/analyser_spec.rb",
     "spec/dragonfly/image_magick/encoder_spec.rb",
@@ -167,6 +168,7 @@ Gem::Specification.new do |s|
     "spec/dragonfly/shell_spec.rb",
     "spec/dragonfly/simple_cache_spec.rb",
     "spec/dragonfly/temp_object_spec.rb",
+    "spec/dragonfly/url_attributes.rb",
     "spec/dragonfly/url_mapper_spec.rb",
     "spec/functional/deprecations_spec.rb",
     "spec/functional/image_magick_app_spec.rb",
@@ -187,11 +189,11 @@ Gem::Specification.new do |s|
     "yard/templates/default/module/html/configuration_summary.erb",
     "yard/templates/default/module/setup.rb"
   ]
-  s.homepage = %q{http://github.com/markevans/dragonfly}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Ideal gem for handling attachments in Rails, Sinatra and Rack applications.}
+  s.homepage = "http://github.com/markevans/dragonfly"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ideal gem for handling attachments in Rails, Sinatra and Rack applications."
   s.test_files = [
     "spec/dragonfly/active_model_extensions/model_spec.rb",
     "spec/dragonfly/active_model_extensions/spec_helper.rb",
@@ -202,14 +204,13 @@ Gem::Specification.new do |s|
     "spec/dragonfly/cookie_monster_spec.rb",
     "spec/dragonfly/core_ext/array_spec.rb",
     "spec/dragonfly/core_ext/hash_spec.rb",
-    "spec/dragonfly/core_ext/string_spec.rb",
-    "spec/dragonfly/core_ext/symbol_spec.rb",
     "spec/dragonfly/data_storage/couch_data_store_spec.rb",
     "spec/dragonfly/data_storage/file_data_store_spec.rb",
     "spec/dragonfly/data_storage/mongo_data_store_spec.rb",
     "spec/dragonfly/data_storage/s3_data_store_spec.rb",
     "spec/dragonfly/data_storage/shared_data_store_examples.rb",
     "spec/dragonfly/function_manager_spec.rb",
+    "spec/dragonfly/has_filename_spec.rb",
     "spec/dragonfly/hash_with_css_style_keys_spec.rb",
     "spec/dragonfly/image_magick/analyser_spec.rb",
     "spec/dragonfly/image_magick/encoder_spec.rb",
@@ -227,6 +228,7 @@ Gem::Specification.new do |s|
     "spec/dragonfly/shell_spec.rb",
     "spec/dragonfly/simple_cache_spec.rb",
     "spec/dragonfly/temp_object_spec.rb",
+    "spec/dragonfly/url_attributes.rb",
     "spec/dragonfly/url_mapper_spec.rb",
     "spec/functional/deprecations_spec.rb",
     "spec/functional/image_magick_app_spec.rb",
@@ -259,7 +261,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<bluecloth>, [">= 0"])
-      s.add_development_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<bson_ext>, ["~> 1.3.1"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
     else
       s.add_dependency(%q<rack>, [">= 0"])
@@ -277,7 +279,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<bluecloth>, [">= 0"])
-      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.3.1"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
   else
@@ -296,7 +298,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<bluecloth>, [">= 0"])
-    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.3.1"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
   end
 end

data/extra_docs/Configuration.md

@@ -112,14 +112,6 @@ registers the {Dragonfly::Analysis::FileCommandAnalyser FileCommandAnalyser} for
 
 The file 'dragonfly/rails/images' does this for you.
 
-Heroku
-------
-
-    app.configure_with(:heroku, 's3_bucket_name')
-
-The {Dragonfly::Config::Heroku Heroku configuration} configures it to use the {Dragonfly::DataStorage::S3DataStore}, using Heroku's config attributes.
-See {file:Heroku} for more info.
-
 Custom Saved Configuration
 --------------------------
 You can create your own saved configuration with any object that responds to 'apply_configuration':

data/extra_docs/DataStorage.md

@@ -44,7 +44,7 @@ or (the same)
 
 or
 
-    my_model.remote_url(:some => 'option')
+    my_model.attachment.remote_url(:some => 'option')
 
 You can create your own datastore, or use one of the provided ones as outlined below.
 
@@ -89,17 +89,22 @@ To configure with the {Dragonfly::DataStorage::S3DataStore S3DataStore}:
       c.secret_access_key = '8u2u3rhkhfo23...'
       c.region = 'eu-west-1'                        # defaults to 'us-east-1'
       c.storage_headers = {'some' => 'thing'}       # defaults to {'x-amz-acl' => 'public-read'}
+      c.url_scheme = 'https'                        # defaults to 'http'
     end
 
 You can also pass these options to `S3DataStore.new` as an options hash.
 
 You can serve directly from the S3DataStore using e.g.
 
-    my_model.remote_url
+    my_model.attachment.remote_url
 
 or with an expiring url:
 
-    my_model.remote_url(:expires => 3.days.from_now)
+    my_model.attachment.remote_url(:expires => 3.days.from_now)
+
+or with an https url:
+
+    my_model.attachment.remote_url(:scheme => 'https')   # also configurable for all urls with 'url_scheme'
 
 Extra options you can use on store are `:path` and `:headers`
 
@@ -163,7 +168,9 @@ Data stores are key-value in nature, and need to implement 3 methods: `store`, `
     class MyDataStore
 
       def store(temp_object, opts={})
-        # ... use temp_object.data, temp_object.file, temp_object.path, etc. ...
+        # ... use temp_object.data, temp_object.file, temp_object.path, etc.
+        # ... also we can use temp_object.meta and store it ...
+        
         # store and return the uid
         'return_some_unique_uid'
       end
@@ -187,7 +194,8 @@ You can now configure the app to use your datastore:
     Dragonfly[:my_app_name].datastore = MyDataStore.new
 
 Notice that `store` takes a second `opts` argument.
-Any options, including `:meta`, get passed here
+Any options, get passed here.
+`:meta` is treated specially and is accessible inside `MyDataStore#store` as `temp_object.meta`
 
     uid = app.store('SOME CONTENT',
       :meta => {:name => 'great_content.txt'},

data/extra_docs/ExampleUseCases.md

@@ -74,13 +74,16 @@ We can set up a Dragonfly endpoint in routes.rb for generating thumbnails:
       app.fetch(params[:uid]).thumb(params[:geometry])
     }
 
+NOTE: if you use `do`...`end` here instead of curly braces, make sure you put brackets around the arguments to `match`,
+otherwise Ruby will parse it incorrectly
+
 If we have access to the image uid in javascript, we can create the url like so:
 
     var url = '/thumbs/400x300?uid=' + uid
 
 Then we can get the content with ajax, create an img tag, etc.
 
-NB: in the above example we've put the uid in the query string and not the path because the dot in it confuses Rails' pattern recognition.
+NOTE: in the above example we've put the uid in the query string and not the path because the dot in it confuses Rails' pattern recognition.
 You could always put it in the path and escape/unescape it either side of the request.
 
 Also javascript's built-in `encodeURIComponent` function may be useful when Rails has difficulty matching routes due to special characters like '#' and '/'.

data/extra_docs/Heroku.md

@@ -4,7 +4,9 @@ Heroku
 The default configuration won't work out of the box for Heroku, because
 
 - Heroku doesn't allow saving files to the filesystem (although it does use tempfiles)
-- We won't need {http://tomayko.com/src/rack-cache/ Rack::Cache} on Heroku because it already uses the caching proxy {http://varnish.projects.linpro.no/ Varnish}, which we can make use of
+- If on Heroku {http://devcenter.heroku.com/articles/stack Aspen/Bamboo stacks}, we won't need {http://tomayko.com/src/rack-cache/ Rack::Cache},
+because it already uses the caching proxy {http://varnish.projects.linpro.no/ Varnish}, which we can make use of.
+We will still need it on {http://devcenter.heroku.com/articles/cedar Heroku Cedar}, however, as it doesn't include Varnish.
 
 Instead of the normal {file:DataStorage#File\_datastore FileDataStore}, we can use the {file:DataStorage#S3\_datastore S3DataStore}.
 
@@ -22,7 +24,15 @@ Initializer (e.g. config/initializers/dragonfly.rb in Rails):
 
     app.configure_with(:imagemagick)
     app.configure_with(:rails)
-    app.configure_with(:heroku, 'my_bucket_name') if Rails.env.production?
+    if Rails.env.production?
+      app.configure do |c|
+        c.datastore = Dragonfly::DataStorage::S3DataStore.new(
+          :bucket_name => 'my-bucket-name',
+          :access_key_id => ENV['S3_KEY'],
+          :secret_access_key => ENV['S3_SECRET']
+        )
+      end
+    end
 
     app.define_macro(ActiveRecord::Base, :image_accessor)
 
@@ -41,9 +51,7 @@ From your app's directory:
 
 Replace 'XXXXXXXXX' with your access key and secret.
 
-Now you can benefit from super-fast images served straight from Heroku's cache!
+**NOTE**: HEROKU'S VARNISH CACHE IS CLEARED EVERY TIME YOU DEPLOY!!! (DOESN'T APPLY TO CEDAR STACK)
 
-**NOTE**: HEROKU'S CACHE IS CLEARED EVERY TIME YOU DEPLOY!!!
-
-If this is an issue, you may want to look into storing thumbnails on S3 (see {file:ServingRemotely}), or maybe an after-deploy hook for hitting specific Dragonfly urls you want to cache, etc.
+If this is an issue, you may want to look into storing thumbnails on S3 (see {file:ServingRemotely}), or maybe generating thumbnails _on upload_ (see {file:Models#Up-front_thumbnailing}), or maybe an after-deploy hook for hitting specific Dragonfly urls you want to cache, etc.
 It won't be a problem for most sites though.

data/extra_docs/Models.md

@@ -89,6 +89,10 @@ We can play around with the data
 
     @album.cover_image.data                           # => "\377???JFIF\000\..."
     @album.cover_image.to_file('out.png')             # writes to file 'out.png' and returns a readable file object
+    @album.cover_image.to_file('out.png',
+      :mode => 0600,
+      :mkdirs => false
+    )
     @album.cover_image.tempfile                       # => #<File:/var/folders/st/strHv74sH044JPabSiODz... a closed Tempfile object
     @album.cover_image.file                           # => #<File:/var/folders/st/strHv74sH044JPabSiODz... a readable (open) File object
     @album.cover_image.file do |f|                    # Yields an open file object, returns the return value of
@@ -198,7 +202,7 @@ Validations
 
       validates_property :format, :of => :cover_image, :in => [:jpeg, :png, :gif]
       # ..or..
-      validates_property :mime_type, :of => :cover_image, :in => %w(image/jpeg image/png image/gif)
+      validates_property :mime_type, :of => :cover_image, :as => 'image/jpeg', :case_sensitive => false
 
       validates_property :width, :of => :cover_image, :in => (0..400), :message => "é demais cara!"