paperclip-dropbox 1.0.0 → 1.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Janko Marohnić
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -48,21 +48,21 @@ access_token_secret: <%= ENV["DROPBOX_ACCESS_TOKEN_SECRET"] %>
 user_id: <%= ENV["DROPBOX_USER_ID"] %>
 ```
 
-This is a good practice; I didn't put my credentials directly in the YAML file, but I first
-set them in my system's environment variables, and then embedded them here through ERB.
+This is a good practice; Don't put your credentials directly in your YAML file.
+Instead set them in system environment variables, and then embed them here through ERB.
 
 Note that all credentials mentioned here are required.
 
-- If you don't have your app key and secret yet, go to your
-  [Dropbox apps](https://www.dropbox.com/developers/apps), and create a new app there, which
-  will then provide you the app key and secret. Note that your app has to have the
-  **Full Dropbox** access level (not the "App folder"). This is because the uploaded files
-  have to be stored in your `Public` directory, otherwise accessing their URLs
-  would be too slow.
+If you don't have your app key and secret yet, go to your [Dropbox apps](https://www.dropbox.com/developers/apps),
+and create a new app there, which will then provide you your app key and secret.
+Note that your app has to have the **Full Dropbox** access level (not the "App folder").
+This is because the uploaded files have to be stored in your `Public` folder.
 
-- If you already have your app key and secret, you can obtain the rest of
-  the credentials through the `dropbox:authorize` rake task, which is described in
-  more detail at the bottom of the page.
+If you're a relatively new Dropbox user, you'll have to enable your `Public` folder first by visiting
+[this link](https://www.dropbox.com/enable_public_folder).
+
+After you obtain your app key and secret, you can obtain the rest of the credentials
+through the `dropbox:authorize` rake task, which is described in more detail at the bottom of the readme.
 
 You can also namespace your credentials in `development`, `testing` and `production` environments
 (just like you do in your `database.yml`).
@@ -77,7 +77,7 @@ You can pass it 3 options:
 - `:unique_filename` – Boolean
 
 The `:path` option works in this way; you give it a block, and the return value
-will be the path that the uploaded file will be saved to. The block yields the style (if any),
+will be the path that the uploaded file will be saved to. The block yields attachment style,
 and is executed in the scope of the class' instance. For example, let's say you have
 
 ```ruby
@@ -85,15 +85,15 @@ class User < ActiveRecord::Base
   has_attached_file :avatar,
     :storage => :dropbox,
     :dropbox_credentials => "...",
+    :styles => { :medium => "300x300" },
     :dropbox_options => {
       :path => proc { |style| "#{style}/#{id}_#{avatar.original_filename}"}
-    },
-    :styles => { :medium => "300x300" }
+    }
 end
 ```
 
-Let's say now that a user is saved in the database, with a `photo.jpg` as his
-avatar. The path where that files were saved could look something like this:
+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:
 
 ```
 Public/original/23_photo.jpg
@@ -101,12 +101,29 @@ Public/medium/23_photo_medium.jpg
 ```
 
 The other file is called `photo_medium.jpg` because style names (other than `original`)
-will always be appended to the filenames.
+will always be appended to the filenames, for better management.
 
 Files in Dropbox inside a certain folder have to have **unique filenames**, otherwise exception
 `Paperclip::Storage::Dropbox::FileExists` is thrown. To help you with that, you
-can pass in `:unique_filename => true` to `:dropbox_options`, and that will set
-`:path` to something that will be unique.
+can set
+
+```ruby
+# ...
+    :dropbox_options => {
+      :unique_filename => true
+    }
+```
+
+That will set `:path` to something that will be unique.
+
+You can also pass in the `:download` option to attachment's `#url`:
+
+```ruby
+user.avatar.url(:download => true)
+```
+
+And that will return a download URL for that attachment (so, if a user clicks to
+that link, the file will be downloaded, as opposed to being opened in the browser).
 
 ### The `dropbox:authorize` rake task
 
@@ -120,7 +137,7 @@ It will provide you an authorization URL which you have to visit, and after that
 it will output the rest of your credentials, which you just copy-paste wherever
 you need to.
 
-If you're in a non-Rails application, to get this task, you must require it in
+If you're in a non-Rails application, to get this rake task, you must require it in
 your `Rakefile`:
 
 ```ruby

data/lib/paperclip/dropbox/rake.rb

@@ -7,19 +7,23 @@ module Paperclip
 
       def authorize(app_key, app_secret)
         session = create_new_session(app_key, app_secret)
-        puts "Visit this URL: #{session.get_authorize_url}"
+
+        puts "\nVisit this URL: #{session.get_authorize_url}"
         print "And after you approved the authorization confirm it here (y/n): "
+
         assert_answer!
         session.get_access_token
         dropbox_client = DropboxClient.new(session, "dropbox")
         account_info = dropbox_client.account_info
 
         puts <<-MESSAGE
+
 Authorization was successful. Here you go:
 
 access_token: #{session.access_token.key}
 access_token_secret: #{session.access_token.secret}
 user_id: #{account_info["uid"]}
+
         MESSAGE
       end
 
@@ -34,5 +38,3 @@ user_id: #{account_info["uid"]}
     end
   end
 end
-
-load "paperclip/dropbox/tasks/authorize.rake"

data/lib/paperclip/dropbox/tasks/authorize.rake

@@ -2,8 +2,11 @@ require "rake"
 require "paperclip/dropbox/rake" unless defined?(Paperclip::Dropbox::Rake)
 
 namespace :dropbox do
-  desc "Obtains your credentials"
+  desc "Obtains your Dropbox credentials"
   task :authorize do
+    if ENV["APP_KEY"].nil? or ENV["APP_SECRET"].nil?
+      raise ArgumentError, "usage: `rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret`"
+    end
     Paperclip::Dropbox::Rake.authorize(ENV["APP_KEY"], ENV["APP_SECRET"])
   end
 end

data/lib/paperclip/storage/dropbox.rb

@@ -44,11 +44,13 @@ module Paperclip
       end
 
       def url(*args)
-        style = args.first.is_a?(Symbol) ? args.first : default_style
-        options = args.last.is_a?(Hash) ? args.last : {}
-        query = options[:download] ? "?dl=1" : ""
+        unless blank?
+          style = args.first.is_a?(Symbol) ? args.first : default_style
+          options = args.last.is_a?(Hash) ? args.last : {}
+          query = options[:download] ? "?dl=1" : ""
 
-        File.join("http://dl.dropbox.com/u/#{user_id}", path_for_url(style) + query)
+          File.join("http://dl.dropbox.com/u/#{user_id}", path_for_url(style) + query)
+        end
       end
 
       def path(style)

data/paperclip-dropbox.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "paperclip-dropbox"
-  gem.version       = "1.0.0"
+  gem.version       = "1.0.1"
   gem.platform      = Gem::Platform::RUBY
 
   gem.homepage      = "https://github.com/janko-m/paperclip-dropbox"
@@ -11,13 +11,12 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Janko Marohnić"]
   gem.email         = ["janko.marohnic@gmail.com"]
 
-  gem.files         = Dir["lib/**/*"] + ["README.md", "UPGRADING", "paperclip-dropbox.gemspec"]
+  gem.files         = Dir["lib/**/*"] + ["README.md", "LICENSE", "paperclip-dropbox.gemspec"]
   gem.require_path  = "lib"
 
   gem.required_ruby_version = ">= 1.9.2"
 
   gem.license       = "MIT"
-  gem.post_install_message = File.read("UPGRADING")
 
   gem.add_dependency "paperclip", "~> 3.1"
   gem.add_dependency "dropbox-sdk", "~> 1.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-dropbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2012-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
@@ -169,25 +169,12 @@ files:
 - lib/paperclip/storage/dropbox.rb
 - lib/paperclip-dropbox.rb
 - README.md
-- UPGRADING
+- LICENSE
 - paperclip-dropbox.gemspec
 homepage: https://github.com/janko-m/paperclip-dropbox
 licenses:
 - MIT
-post_install_message: ! '########################################
-
-  # NOTE FOR UPGRADING FROM 0.x VERSIONS #
-
-  ########################################
-
-
-  paperclip-dropbox 1.0 is a rewrite of 0.x versions,
-
-  and it introduces a lot of non-backwards compatible changes.
-
-  It is suggested that you read the Readme again.
-
-'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -203,9 +190,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -407876590355858584
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -213,3 +197,4 @@ signing_key:
 specification_version: 3
 summary: Extends Paperclip with Dropbox storage.
 test_files: []
+has_rdoc: 

data/UPGRADING

@@ -1,7 +0,0 @@
-########################################
-# NOTE FOR UPGRADING FROM 0.x VERSIONS #
-########################################
-
-paperclip-dropbox 1.0 is a rewrite of 0.x versions,
-and it introduces a lot of non-backwards compatible changes.
-It is suggested that you read the Readme again.