paperclip-dropbox 1.1.4 → 1.1.5

data/README.md

@@ -3,29 +3,45 @@
 This gem extends [Paperclip](https://github.com/thoughtbot/paperclip) with
 [Dropbox](https://www.dropbox.com) storage.
 
-## Installation
+## Setup
 
-```sh
-$ gem install paperclip-dropbox
+```ruby
+gem "paperclip-dropbox", ">= 1"
+```
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    :storage => :dropbox,
+    :dropbox_credentials => Rails.root.join("config/dropbox.yml"),
+    :dropbox_options => {...}
+end
 ```
 
-## Dropbox Setup
+Your `config/dropbox.yml`:
 
-You must [create a Dropbox app](https://www.dropbox.com/developers/apps) and
-authorize it to access the Dropbox account you want to use for storage. You have
-a choice of two access types: **App folder** or **Full Dropbox**. You can read
-about the differences in [this wiki](https://github.com/janko-m/paperclip-dropbox/wiki/Access-types).
+```yaml
+app_key: "..."
+app_secret: "..."
+access_token: "..."
+access_token_secret: "..."
+user_id: "..."
+access_type: "..."
+```
 
-After creating your app, it will have an "App key" and "App secret". Provide
-these and the access type (`dropbox` or `app_folder`) to the authorization Rake task:
+In order to fill these in, you must [create a Dropbox app](https://www.dropbox.com/developers/apps)
+and authorize it. There are two types of Dropbox apps: **App folder** or **Full Dropbox**. You can read
+about the differences and gotchas in [this wiki](https://github.com/janko-m/paperclip-dropbox/wiki/Access-types).
+
+After you have created an app, you will be given the "App key" and "App secret". Provide
+these and the access type to the authorization Rake task:
 
 ```sh
-$ rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret ACCESS_TYPE=your_access_type
+$ rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret ACCESS_TYPE=dropbox|app_folder
 ```
 
-First it will give you an authorization URL that you must visit to grant the app access.
-Then it will output your **access token**, and **user ID**.
-
 For non-Rails projects, you must require this task in your `Rakefile`:
 
 ```ruby
@@ -33,47 +49,29 @@ For non-Rails projects, you must require this task in your `Rakefile`:
 load "paperclip/dropbox/tasks.rake"
 ```
 
-## Configuration
-
-Example:
+Follow the instructions, and it will authorize the Dropbox app and output the rest of the credentials.
+Then you can fill in the rest of `config/dropbox.yml`.
 
-```ruby
-class User < ActiveRecord::Base
-  has_attached_file :avatar,
-    :storage => :dropbox,
-    :dropbox_credentials => "#{Rails.root}/config/dropbox.yml",
-    :dropbox_options => {...}
-end
-```
+And that's it. Everything should work now :)
 
 ### The `:dropbox_credentials` option
 
-This can be a hash or path to a YAML file containing the keys listed in the
-example below. These are obtained from your Dropbox app settings and the
-authorization Rake task.
-
-Example `config/dropbox.yml`:
-
-```yaml
-app_key: "APP_KEY"
-app_secret: "APP_SECRET"
-access_token: "ACCESS_TOKEN"
-access_token_secret: "ACCESS_TOKEN_SECRET"
-user_id: "USER_ID"
-access_type: "ACCESS_TYPE"
+```ruby
+:dropbox_credentials => Rails.root.join("config/dropbox.yml")
+# or
+:dropbox_credentials => {app_key: "foo", app_secret: "bar", ...}
 ```
 
-Of course, replace these strings with real values. The `"ACCESS_TYPE"`
-must be either `"dropbox"` or `"app_folder"` depending on the access
-type of your app; see **Dropbox Setup** above. If you're keeping your
-credentials in environment variables (or something similar), you can also use
-ERB:
+For the list of required credentials, take a look at the `config/dropbox.yml`
+above.
+
+The YAML file supports ERB:
 
 ```erb
 app_key: <%= ENV["DROPBOX_APP_KEY"] %>
 ```
 
-You can also nest your credentials in environments (like in your `database.yml`):
+And it supports environment nesting (just like `database.yml`):
 
 ```yaml
 development:
@@ -88,60 +86,42 @@ production:
 
 This is a hash containing any of the following options:
 
-- `:path` – Block, works similarly to Paperclip's `:path` option
-- `:unique_filename` – Boolean, whether to generate unique names for files in
-  the absence of a custom `:path`
 - `:environment` – String, the environment name to use for selecting namespaced
   credentials in a non-Rails app
 
-The `:path` option should be a block that returns a path that the uploaded file
-should be saved to. The block yields the attachment style and is executed in the
-scope of the model instance. For example:
+For example:
 
 ```ruby
 class User < ActiveRecord::Base
   has_attached_file :avatar,
     :storage => :dropbox,
-    :dropbox_credentials => "#{Rails.root}/config/dropbox.yml",
-    :styles => { :medium => "300x300" },
-    :dropbox_options => {
-      :path => proc { |style| "#{style}/#{id}_#{avatar.original_filename}" }
-    }
+    :dropbox_credentials => Rails.root.join("config/dropbox.yml"),
+    :dropbox_options => {environment: ENV["RACK_ENV"]}
 end
 ```
 
-Let's say now that a new user is created with the ID of `23`, and a `photo.jpg`
-as his avatar. The following files would be saved to the Dropbox:
+In Rails you don't need to specify it.
 
-```
-Public/original/23_photo.jpg
-Public/medium/23_photo_medium.jpg
-```
+### The `:path` option
 
-The other file is called `photo_medium.jpg` because style names (other than
-`original`) will always be appended to the filenames, for better management.
+To change the path of the file, use Paperclip's `:path` option:
 
-Filenames within a Dropbox folder must be unique; uploading a file with a
-duplicate name will throw error `Paperclip::Storage::Dropbox::FileExists`. If
-you don't want to bother crafting your own unique filenames with the `:path`
-option, you can instead set the `:unique_filename` option to true and it will
-take care of that.
+```ruby
+:path => ":style/:id_:filename"  # Defaults to ":filename"
+```
+
+In "Full Dropbox" mode it will automatically be searched in the `Public` folder,
+so there is not need to specify it.
 
 ### URL options
 
-When using `dropbox` access type, the `#url` method of attachments returns a
-URL to a "landing page" that provides a preview of the file and a download link.
-To make `#url` return a direct file download link, set the `:download` option as
-a parameter:
+If you want to force the browser to always download the file, you can use
+the `:download` option.
 
 ```ruby
 user.avatar.url(:download => true)
 ```
 
-When using `app_folder` access type, `#url` always returns a direct link, and
-setting the `:download` option simply forces the file to be downloaded even if
-the browser would normally just display it.
-
 ### Check if the file exists
 
 You can easily check if the file exists on Dropbox:

data/lib/paperclip/storage/dropbox/url_generator.rb

@@ -16,7 +16,7 @@ module Paperclip
             url.query = [url.query, "dl=1"].compact.join("&") if options[:download]
             url.to_s
           else
-            @attachment_options[:default_url]
+            @attachment_options[:interpolator].interpolate(@attachment_options[:default_url], @attachment, style)
           end
         end
 

data/paperclip-dropbox.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "paperclip-dropbox"
-  gem.version       = "1.1.4"
+  gem.version       = "1.1.5"
 
   gem.homepage      = "https://github.com/janko-m/paperclip-dropbox"
   gem.description   = %q{Extends Paperclip with Dropbox storage.}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-dropbox
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 487816321
+      hash: 129369807
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23