carrierwave-dropbox 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2ca8dc58cbc02e2c7c1a98eed41c49ed45699b0
+  data.tar.gz: 550df72f35dce48e4d39eb32d368f502968fcdeb
+SHA512:
+  metadata.gz: ea3d13fe24390bab8c55344013277dfa0a08a141bfd1ab9d8b30277532036d42da685b3f48bd5dc37565f59dbc241a4b6bde876019a0414242be82fd3ae11551
+  data.tar.gz: 499f42b826128d0e6f1b849a5991b76fae97765ef3a3da01cb32b4d6dcc3d682613f74f7cc6c0fa64975c41c6bd3b2ca998f70eddd4e839829b246942abf978a

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrierwave-dropbox.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robin Dupret
+
+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,82 @@
+# Carrierwave uploads on Dropbox
+
+This gem allows you to easily upload your medias on Dropbox using the awesome
+[Carrierwave](https://github.com/carrierwaveuploader/carrierwave) gem.
+
+## Installation
+
+First, you have to create a [Dropbox app](https://www.dropbox.com/developers/apps). You can either create a "full dropbox" or "app folder" application. Please see
+[this wiki](https://github.com/janko-m/paperclip-dropbox/wiki/Access-types) for
+further information and gotchas.
+
+Then, add this line to your application's Gemfile:
+
+~~~ruby
+gem 'carrierwave-dropbox'
+~~~
+
+And make sure that it get installed running the `bundle` command. Then, you have
+to run the `rake authorize` command to authorize your application to access to
+your Dropbox.
+
+If you are using Rails, the Rake task is automatically loaded. Otherwise, if you
+aren't running a Rails application, first load the task in your `Rakefile`:
+
+~~~ruby
+load "paperclip/dropbox/tasks.rake"
+~~~
+
+Then you have to run this task:
+
+~~~bash
+rake dropbox:authorize APP_KEY=app_key APP_SECRET=app_secret ACCESS_TYPE=dropbox|app_folder
+~~~
+
+Finally, you will get your credentials. Config CarrierWave to make it work with
+your Dropbox:
+
+~~~ruby
+CarrierWave.configure do |config|
+  config.dropbox_app_key = ENV["APP_KEY"]
+  config.dropbox_app_secret = ENV["APP_SECRET"]
+  config.dropbox_access_token = ENV["ACCESS_TOKEN"]
+  config.dropbox_access_token_secret = ENV["ACCESS_TOKEN_SECRET"]
+  config.dropbox_user_id = ENV["USER_ID"]
+  config.dropbox_access_type = "dropbox"
+end
+~~~
+
+**Note**: It's advisable not to directly store the credentials in your files
+especially if you are using a SCM (e.g. git). You should store these values in
+[environment variables for instance](https://gist.github.com/canton7/1423106)
+like in the above example.
+
+Then you can either specify in your uploader files the storage or define it
+globally through `CarrierWave.configure`:
+
+~~~ruby
+class ImageUploader < CarrierWave::Uploader::Base
+  storage :dropbox
+end
+~~~
+
+## Special thanks
+
+This project is highly based on these two gems:
+
+* [paperclip-dropbox](https://github.com/janko-m/paperclip-dropbox)
+* [carrierwave-aws](https://github.com/sorentwo/carrierwave-aws)
+
+Thanks to their respective authors and contributors!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Please see the `LICENSE` file for further information.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/carrierwave-dropbox.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/dropbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-dropbox"
+  spec.version       = CarrierWave::Dropbox::VERSION
+  spec.authors       = ["Robin Dupret"]
+  spec.email         = ["robin.dupret@gmail.com"]
+  spec.description   = %q{CarrierWave storage for Dropbox}
+  spec.summary       = %q{Dropbox integration for CarrierWave}
+  spec.homepage      = "https://github.com/robin850/carrierwave-dropbox"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "carrierwave", "~> 0.9"
+  spec.add_dependency "dropbox-sdk", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "capybara", "~> 2.0"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "mini_magick"
+  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "rails", ">= 3.2.14", "< 5.0"
+end

data/lib/carrierwave/dropbox.rb

@@ -0,0 +1,18 @@
+require 'carrierwave'
+require 'carrierwave/storage/dropbox'
+
+require 'carrierwave/dropbox/version'
+require 'carrierwave/dropbox/railtie' if defined?(Rails)
+
+class CarrierWave::Uploader::Base
+  add_config :dropbox_app_key
+  add_config :dropbox_app_secret
+  add_config :dropbox_access_token
+  add_config :dropbox_access_token_secret
+  add_config :dropbox_user_id
+  add_config :dropbox_access_type
+
+  configure do |config|
+    config.storage_engines[:dropbox] = 'CarrierWave::Storage::Dropbox'
+  end
+end

data/lib/carrierwave/dropbox/authorize.rake

@@ -0,0 +1,13 @@
+require "carrierwave/dropbox/rake"
+
+namespace :dropbox do
+  desc "Obtains your Dropbox credentials"
+  task :authorize do
+    if ENV["APP_KEY"].nil? or ENV["APP_SECRET"].nil?
+      puts "USAGE: `rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret` ACCESS_TYPE=your_access_type"
+      exit
+    end
+
+    CarrierWave::Dropbox::Rake.authorize(ENV["APP_KEY"], ENV["APP_SECRET"], ENV["ACCESS_TYPE"] || "dropbox")
+  end
+end

data/lib/carrierwave/dropbox/railtie.rb

@@ -0,0 +1,9 @@
+module CarrierWave
+  module Dropbox
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "carrierwave/dropbox/authorize.rake"
+      end
+    end
+  end
+end

data/lib/carrierwave/dropbox/rake.rb

@@ -0,0 +1,41 @@
+require "dropbox_sdk"
+
+# This code is directly extracted from this repository:
+# https://github.com/janko-m/paperclip-dropbox
+module CarrierWave
+  module Dropbox
+    module Rake
+      extend self
+
+      def authorize(app_key, app_secret, access_type)
+        session = create_new_session(app_key, app_secret)
+
+        puts "Visit 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, access_type)
+        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
+
+      def create_new_session(app_key, app_secret)
+        DropboxSession.new(app_key, app_secret)
+      end
+
+      def assert_answer!
+        answer = STDIN.gets.strip
+        exit if answer == "n"
+      end
+    end
+  end
+end

data/lib/carrierwave/dropbox/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module Dropbox
+    VERSION = "1.0.0"
+  end
+end

data/lib/carrierwave/storage/dropbox.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require 'dropbox_sdk'
+
+module CarrierWave
+  module Storage
+    class Dropbox < Abstract
+
+      # Stubs we must implement to create and save
+      # files (here on Dropbox)
+
+      # Store a single file
+      def store!(file)
+        location = uploader.store_path
+        location = "/Public/#{location}" if config[:access_type] == "dropbox"
+
+        dropbox_client.put_file(location, file.to_file)
+      end
+
+      # Retrieve a single file
+      def retrieve!(file)
+        CarrierWave::Storage::Dropbox::File.new(uploader, config, uploader.store_path(file))
+      end
+
+      private
+
+      def dropbox_client
+        @dropbox_client ||= begin
+          session = DropboxSession.new(config[:app_key], config[:app_secret])
+          session.set_access_token(config[:access_token], config[:access_token_secret])
+          DropboxClient.new(session, config[:access_type])
+        end
+      end
+
+      def config
+        @config ||= {}
+
+        @config[:app_key] ||= uploader.dropbox_app_key
+        @config[:app_secret] ||= uploader.dropbox_app_secret
+        @config[:access_token] ||= uploader.dropbox_access_token
+        @config[:access_token_secret] ||= uploader.dropbox_access_token_secret
+        @config[:access_type] ||= uploader.dropbox_access_type || "dropbox"
+        @config[:user_id] ||= uploader.dropbox_user_id
+
+        @config
+      end
+
+      class File
+        include CarrierWave::Utilities::Uri
+        attr_reader :path
+
+        def initialize(uploader, config, path)
+          @uploader, @config, @path = uploader, config, path
+        end
+
+        def url
+          user_id, path = @config[:user_id], @path
+          "https://dl.dropboxusercontent.com/u/#{user_id}/#{path}"
+        end
+      end
+    end
+  end
+end

data/spec/carrierwave-uploader-base_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe CarrierWave::Uploader::Base do
+  it "has the dropbox storage" do
+    described_class.configure do |c|
+      c.storage_engines.should have_key(:dropbox)
+    end
+  end
+
+  it "should respond to the different configuration methods" do
+    described_class.should respond_to(:dropbox_app_key)
+    described_class.should respond_to(:dropbox_app_secret)
+    described_class.should respond_to(:dropbox_access_token)
+    described_class.should respond_to(:dropbox_access_token_secret)
+    described_class.should respond_to(:dropbox_user_id)
+    described_class.should respond_to(:dropbox_access_type)
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org/'
+
+gem 'rails', '~> 4.0.0'
+
+gem 'sqlite3'
+
+gem 'carrierwave', '~> 0.9'
+
+gem 'carrierwave-dropbox', path: "../../"
+
+gem 'mini_magick'

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/articles_controller.rb

@@ -0,0 +1,58 @@
+class ArticlesController < ApplicationController
+  before_action :set_article, only: [:show, :edit, :update, :destroy]
+
+  # GET /articles
+  def index
+    @articles = Article.all
+  end
+
+  # GET /articles/1
+  def show
+  end
+
+  # GET /articles/new
+  def new
+    @article = Article.new
+  end
+
+  # GET /articles/1/edit
+  def edit
+  end
+
+  # POST /articles
+  def create
+    @article = Article.new(article_params)
+
+    if @article.save
+      redirect_to @article, notice: 'Article was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /articles/1
+  def update
+    if @article.update(article_params)
+      redirect_to @article, notice: 'Article was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /articles/1
+  def destroy
+    @article.destroy
+    redirect_to articles_url, notice: 'Article was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_article
+      @article = Article.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def article_params
+      params.require(:article).permit(:title, :body, :image)
+    end
+end