paperclip-dropbox 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

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

@@ -0,0 +1,90 @@
+# Dropbox
+
+This gem extends [Paperclip](https://github.com/thoughtbot/paperclip) with Dropbox storage.
+
+## Installation
+
+Put it in your `Gemfile`:
+
+```ruby
+gem "paperclip-dropbox"
+```
+
+And run `bundle install`.
+
+## Usage
+
+Example:
+
+```ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar,
+    :storage => :dropbox,
+    :dropbox_settings => "#{Rails.root}/config/dropbox.yml"
+end
+```
+
+Valid options for `#has_attached_file` are:
+
+- `:dropbox_settings` – A `Hash`, a `File`, or a path to the file where your
+  Dropbox configuration is located
+
+- `:dropbox_options` – This can be used to overrride `:dropbox_settings` (for example,
+  you have configuration in your YAML file, but you want to override some things
+  that are specific for a certain attribute)
+
+## Configuration
+
+Example (`config/dropbox.yaml`):
+
+```erb
+app_key: <%= ENV["DROPBOX_APP_KEY"] %>
+app_secret: <%= ENV["DROPBOX_APP_SECRET"] %>
+access_token: <%= ENV["DROPBOX_ACCESS_TOKEN"] %>
+access_token_secret: <%= ENV["DROPBOX_ACCESS_TOKEN_SECRET"] %>
+```
+
+You can also namespace them inside of `development`, `testing` and `production` environments
+(just like you do with your `database.yml`).
+
+There are 3 more **optional** configurations:
+
+- `:access_type` – This is either `"app_folder"` or `"dropbox"` (defaults to `"app_folder"`)
+- `:path` - Similar to Paperclip's `:path` option (defaults to `"<filename>"`)
+- `:environment` - Here you can set your environment if you're in a non-Rails application
+
+### The `:path` option
+
+Let's say we've set `:path` to  `"<table_name>/<record_id>_<attachment_name>_<filename>"`. If a user with the ID of 13
+uploads `photo.jpg` for his avatar, the file would be saved to
+
+```
+users/13_avatar_photo.jpg
+```
+
+The keywords are: `<filename>`, `<table_name>`, `<model_name>`,
+`<attachment_name>` and `<style>`. Additionally, if you want to use a record's attribute, just
+prefix it with `record_` (like the `<record_id>` above).
+
+Filenames in Dropbox inside a folder have to be unique, otherwise exception
+`Paperclip::Storage::Dropbox::FileExists` is thrown. To help you with that, you
+can pass in `:unique_filename => true` to Dropbox configuration, which will
+ensure uniqueness of filenames (this is the same as passing `:path => "<model_name>_<record_id>_<attachment_name>"`).
+
+### Obtaining the access token
+
+To obtain the access token, you can use the following rake task:
+
+```
+$ rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret
+```
+
+And just follow the instructions.
+
+## Credits
+
+I found some solutions to my problems in **@dripster82**'s [paperclipdropbox](https://github.com/dripster82/paperclipdropbox) gem.
+
+## License
+
+[MIT](https://github.com/janko-m/paperclip-dropbox/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

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

@@ -0,0 +1,11 @@
+module Paperclip
+  module Storage
+    module Dropbox
+      class Railtie < Rails::Railtie
+        rake_tasks do
+          load "tasks/paperclip-dropbox.rake"
+        end
+      end
+    end
+  end
+end

data/lib/paperclip/storage/dropbox.rb

@@ -0,0 +1,125 @@
+require 'dropbox_sdk'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/inflector/methods'
+require 'yaml'
+require 'erb'
+
+module Paperclip
+  module Storage
+    module Dropbox
+      attr_reader :dropbox_client
+
+      def self.extended(base)
+        base.instance_eval do
+          @dropbox_settings = parse_settings(@options[:dropbox_settings] || {})
+          @dropbox_settings.update(@options[:dropbox_options] || {})
+
+          session = DropboxSession.new(@dropbox_settings[:app_key], @dropbox_settings[:app_secret])
+          session.set_access_token(@dropbox_settings[:access_token], @dropbox_settings[:access_token_secret])
+
+          @dropbox_client = DropboxClient.new(session, @dropbox_settings[:access_type] || :app_folder)
+
+          @dropbox_keywords = Hash.new do |hash, key|
+            if key =~ /^\<record_.+\>$/
+              attribute = key.match(/^\<record_(.+)\>$/)[1]
+              hash[key] = lambda { |style| instance.send(attribute) }
+            end
+          end
+          @dropbox_keywords.update(
+            "<model_name>"      => lambda { |style| instance.class.table_name.singularize },
+            "<table_name>"      => lambda { |style| instance.class.table_name },
+            "<filename>"        => lambda { |style| original_filename.match(/\.\w{3,4}$/).pre_match },
+            "<attachment_name>" => lambda { |style| name },
+            "<style>"           => lambda { |style| style }
+          )
+        end
+      end
+
+      def flush_writes
+        @queued_for_write.each do |style, file|
+          unless exists?(style)
+            response = dropbox_client.put_file(path(style), file.read)
+          else
+            raise FileExists, "\"#{path(style)}\" already exists on Dropbox"
+          end
+        end
+
+        after_flush_writes
+        @queued_for_write = {}
+      end
+
+      def flush_deletes
+        @queued_for_delete.each do |path|
+          dropbox_client.file_delete(path)
+        end
+        @queued_for_delete = []
+      end
+
+      def exists?(style)
+        !!url(style)
+      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" : ""
+
+        dropbox_client.media(path(style))["url"] + query
+
+      rescue DropboxError
+        nil
+      end
+
+      def path(style)
+        extension = original_filename[/\.\w{3,4}$/]
+        result = file_path
+        file_path.scan(/\<\w+\>/).each do |keyword|
+          result.sub!(keyword, @dropbox_keywords[keyword].call(style).to_s)
+        end
+        style_suffix = style != default_style ? "_#{style}" : ""
+        result = "#{result}#{style_suffix}#{extension}"
+      end
+
+      def copy_to_local_file(style, destination_path)
+        local_file = File.open(destination_path, "wb")
+        local_file.write(dropbox_client.get_file(path(style)))
+        local_file.close
+      end
+
+      private
+
+      def file_path
+        return @dropbox_settings[:path] if @dropbox_settings[:path]
+
+        if @dropbox_settings[:unique_filename]
+          "<model_name>_<record_id>_<attachment_name>"
+        else
+          "<filename>"
+        end
+      end
+
+      def parse_settings(settings)
+        settings = settings.respond_to?(:call) ? settings.call : settings
+        settings = get_settings(settings).stringify_keys
+        environment = defined?(Rails) ? Rails.env : @dropbox_settings[:environment].to_s
+        (settings[environment] || settings).symbolize_keys
+      end
+
+      def get_settings(settings)
+        case settings
+        when File
+          YAML.load(ERB.new(File.read(settings.path)).result)
+        when String, Pathname
+          YAML.load(ERB.new(File.read(settings)).result)
+        when Hash
+          settings
+        else
+          raise ArgumentError, "settings are not a path, file, or hash."
+        end
+      end
+
+      class FileExists < RuntimeError
+      end
+    end
+  end
+end

data/lib/paperclip-dropbox.rb

@@ -0,0 +1,2 @@
+require "paperclip/storage/dropbox"
+require "paperclip/storage/dropbox/railtie" if defined?(Rails)

data/lib/tasks/paperclip-dropbox.rake

@@ -0,0 +1,16 @@
+require 'rake'
+require 'dropbox_sdk'
+
+namespace :dropbox do
+  desc "Obtain your access token"
+  task :authorize do
+    session = DropboxSession.new(ENV["APP_KEY"], ENV["APP_SECRET"])
+    puts "Visit this URL: #{session.get_authorize_url}"
+    print "And after you approved the authorization confirm it here (y/n): "
+    answer = STDIN.gets.strip
+    exit if answer == "n"
+    session.get_access_token
+    puts "Access token: #{session.access_token.key}"
+    puts "Access token secret: #{session.access_token.secret}"
+  end
+end

data/paperclip-dropbox.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name          = "paperclip-dropbox"
+  gem.version       = "0.0.1"
+
+  gem.authors       = ["Janko Marohnić"]
+  gem.email         = ["janko.marohnic@gmail.com"]
+  gem.description   = %q{Extends Paperclip with Dropbox storage.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/janko-m/paperclip-dropbox"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "dropbox-sdk", "~> 1.3"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-dropbox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Extends Paperclip with Dropbox storage.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/paperclip-dropbox.rb
+- lib/paperclip/storage/dropbox.rb
+- lib/paperclip/storage/dropbox/railtie.rb
+- lib/tasks/paperclip-dropbox.rake
+- paperclip-dropbox.gemspec
+homepage: https://github.com/janko-m/paperclip-dropbox
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Extends Paperclip with Dropbox storage.
+test_files: []
+has_rdoc: