dropbox-explorer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6e9e1effd3121eb938c264564b7f5d2fc76cbcd
+  data.tar.gz: 7b0335a5f3d9c7005499bb286f100f231c4b5f8a
+SHA512:
+  metadata.gz: a7aef77d6abbf224d3760c665e2bd47008c82745f448ee4387b395ae1f147f87ba628ec375a732237ace2585ffcefd8f03c72e491a5cbc2573fb35477bf794d0
+  data.tar.gz: 8e8759dd0ff4b736eafe2e9440e7390058c094bc5aeacdbca848810c183a6836e9c5138232cd3a6f0265ebf4de86550d8961cbbbf587d5c2f933baeb4885f4b7

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+Gemfile.lock
+pkg/
+.rspec
+spec/config/dropbox.yml
+spec/config/app_folder.yml
+spec/fixtures/vcr_cassettes

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dropbox-explorer.gemspec
+gemspec
+
+group :test do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 davidcunha
+
+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,68 @@
+# Dropbox Explorer
+
+Explore Dropbox folders and download files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dropbox-explorer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dropbox-explorer
+
+## Usage
+
+### Authorize Access to Dropbox
+
+After creating a Dropbox app you must get an authorization. For this process you should have a "App key" and "App secret", and send the type of app (There are two types of Dropbox apps: **App folder** or **Full Dropbox** [dropbox apps](https://www.dropbox.com/developers/reference/devguide)). The rake task will use `"dropbox"` as default.
+
+```sh
+$ rake dropbox:authorize APP_KEY=your_app_key APP_SECRET=your_app_secret ACCESS_TYPE=dropbox|app_folder
+```
+
+This rake task will return an URL which you must visit to trigger the authorization process. Follow the instructions and you will have access to the following information:
+
+```yaml
+access_token: #{session.access_token.key}
+access_token_secret: #{session.access_token.secret}
+user_id: #{user_id}
+```
+
+This info should be added to the `config/dropbox.yml` file:
+
+```yaml
+app_key: "..."
+app_secret: "..."
+access_token: "..."
+access_token_secret: "..."
+user_id: "..."
+access_type: "dropbox|app_folder"
+```
+
+### Explore files and folders
+
+- `:config_path` – String, the config file path
+- `:only_files` – Boolean, for returning only files (optional - default returns files and folders)
+
+```ruby
+client = Dropbox::Explorer::Client.new(config_path: File.join(Rails.root, '/config/dropbox.yml'))
+files = client.contents_in_path('/', only_files: true)
+```
+
+### Get public URL for file
+
+```ruby
+client.get_file_url(file_path)
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Bundler.setup
+
+load "dropbox/explorer/rake/tasks.rake"

data/dropbox-explorer.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropbox-explorer"
+  spec.version       = "1.0.0"
+  spec.authors       = ["David Cunha"]
+  spec.email         = ["davidgoncalvescunha@gmail.com"]
+  spec.summary       = %q{Explore dropbox folders}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/imaginary-cloud/dropbox-explorer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "dropbox-sdk", "~> 1.6"
+  spec.add_dependency "activesupport", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/lib/dropbox-explorer.rb

@@ -0,0 +1 @@
+require "dropbox/explorer"

data/lib/dropbox/explorer.rb

@@ -0,0 +1,4 @@
+require "dropbox/explorer/client"
+require "dropbox/explorer/credentials"
+require "dropbox/explorer/folder"
+require "dropbox/explorer/rake/railtie" if defined?(Rails)

data/lib/dropbox/explorer/client.rb

@@ -0,0 +1,42 @@
+require "dropbox_sdk"
+
+module Dropbox
+  module Explorer
+    class Client
+      def initialize(options = {})
+        @options = options
+        @options[:credentials] = fetch_credentials
+
+        @dropbox_client = init_dropbox_client
+      end
+
+      def contents_in_path(path = '/', options = {})
+        folder_metadata = @dropbox_client.metadata(path)
+        Folder.new(folder_metadata).get_contents_paths(only_files: options[:only_files])
+      end
+
+      def get_file_content(file_path)
+        content, metadata = @dropbox_client.get_file_and_metadata(file_path)
+        content
+      end
+
+      def get_file_url(file_path)
+        generated_url = @dropbox_client.media(file_path)
+        generated_url['url']
+      end
+
+      private
+
+      def init_dropbox_client
+        credentials = @options[:credentials]
+        session = DropboxSession.new(credentials[:app_key], credentials[:app_secret])
+        session.set_access_token(credentials[:access_token], credentials[:access_token_secret])
+        DropboxClient.new(session, credentials[:access_type])
+      end
+
+      def fetch_credentials
+        Dropbox::Explorer::Credentials.new(config_path: @options[:config_path]).parse!
+      end
+    end
+  end
+end

data/lib/dropbox/explorer/credentials.rb

@@ -0,0 +1,20 @@
+require "yaml"
+require "active_support/core_ext/hash/keys"
+
+module Dropbox
+  module Explorer
+    class Credentials
+      def initialize(credentials)
+        @credentials = credentials
+      end
+
+      def parse!
+        if @credentials && @credentials[:config_path]
+          @credentials = YAML.load(File.read(@credentials[:config_path])).symbolize_keys
+        else
+          raise ArgumentError, "There is no path for the credentials config file"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox/explorer/folder.rb

@@ -0,0 +1,23 @@
+require "active_support/core_ext/hash/keys"
+
+module Dropbox
+  module Explorer
+    class Folder
+      def initialize(folder_metadata)
+        @folder_metadata = folder_metadata.symbolize_keys
+      end
+
+      def get_contents_paths(options = {})
+        if @folder_metadata[:contents]
+          if options[:only_files]
+            @folder_metadata[:contents].map { |content| content unless content['is_dir'] }.compact
+          else
+            @folder_metadata[:contents]
+          end
+        else
+          raise ArgumentError, "There is no contents for this folder metadata"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox/explorer/rake/railtie.rb

@@ -0,0 +1,9 @@
+module Dropbox
+  module Explorer
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "dropbox/explorer/rake/tasks.rake"
+      end
+    end
+  end
+end

data/lib/dropbox/explorer/rake/rake.rb

@@ -0,0 +1,44 @@
+require "dropbox_sdk"
+
+module Dropbox
+  module Explorer
+    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
+
+      rescue DropboxAuthError => e
+        puts e.message
+        puts "Please don't forget to approve the authorization"
+        exit
+      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/dropbox/explorer/rake/tasks.rake

@@ -0,0 +1,13 @@
+require "dropbox/explorer/rake/rake"
+
+namespace :dropbox do
+  desc "Get Authorization from Dropbox"
+  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
+
+    Dropbox::Explorer::Rake.authorize(ENV["APP_KEY"], ENV["APP_SECRET"], ENV["ACCESS_TYPE"] || "dropbox")
+  end
+end

data/spec/config/app_folder.yml.example

@@ -0,0 +1,6 @@
+app_key: ""
+app_secret: ""
+access_token: ""
+access_token_secret: ""
+user_id: ""
+access_type: "app_folder"

data/spec/config/dropbox.yml.example

@@ -0,0 +1,6 @@
+app_key: ""
+app_secret: ""
+access_token: ""
+access_token_secret: ""
+user_id: ""
+access_type: "dropbox"

data/spec/lib/dropbox/explorer/client_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Dropbox::Explorer::Client, vcr: true do
+  let(:path) { File.join(Bundler.root, "spec/config/dropbox.yml") }
+  let(:client) { Dropbox::Explorer::Client.new(config_path: path) }
+  let(:files) { client.contents_in_path('/', only_files: true) }
+
+  describe "#list_files" do
+    it "returns list of files in folder" do
+      expect(files).to be_a Array
+    end
+
+    it "returns list of files and folders in folder" do
+      files = client.contents_in_path('/')
+      expect(files).to be_a Array
+    end
+  end
+
+  describe "#get_file_url" do
+    it "get url from file" do
+      expect(client.get_file_url(files.first['path'])).to match(/dl.dropboxusercontent.com/)
+    end
+  end
+end

data/spec/lib/dropbox/explorer/credentials_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Dropbox::Explorer::Credentials do
+  describe "#parse!" do
+    let(:access_type) { :dropbox }
+    let(:path) { File.join(Bundler.root, "spec/config/#{access_type}.yml") }
+
+    it "parses dropbox credentials" do
+      credentials = Dropbox::Explorer::Credentials.new(access_type: access_type, config_path: path)
+      expect(credentials.parse!).to eq CREDENTIALS[:dropbox]
+    end
+
+    it "fails to parse dropbox credentials" do
+      credentials = Dropbox::Explorer::Credentials.new(access_type: access_type)
+      expect{credentials.parse!}.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/lib/dropbox/explorer/folder_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+require "yaml"
+require "json"
+require "active_support/core_ext/hash/keys"
+
+describe Dropbox::Explorer::Folder do
+  describe "#get_contents_paths" do
+    let(:path) { File.join(Bundler.root, "spec/fixtures/vcr_cassettes/Dropbox_Explorer_Client/_list_files/returns_list_of_files_in_folder.yml") }
+    let(:folder_metadata) { YAML.load(File.read(path))['http_interactions'][0]['response']['body']['string'] }
+
+    it "returns list of files from folder metadata" do
+      files = Dropbox::Explorer::Folder.new(JSON.parse(folder_metadata)).get_contents_paths(only_files: true)
+      expect(files).to be_a Array
+    end
+
+    it "returns list of files and folders from folder metadata" do
+      files = Dropbox::Explorer::Folder.new(JSON.parse(folder_metadata)).get_contents_paths
+      expect(files).to be_a Array
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+Bundler.setup
+
+require "dropbox-explorer"
+require "vcr"
+
+Dir[File.join(Bundler.root, "spec/support/*.rb")].each do |file|
+  require file
+end

data/spec/support/credentials.rb

@@ -0,0 +1,27 @@
+require "yaml"
+require "active_support/core_ext/string/strip"
+require "active_support/core_ext/hash/except"
+require "active_support/core_ext/hash/keys"
+
+CREDENTIAL_FILES = [:dropbox, :app_folder].inject({}) do |hash, access_type|
+  hash.update(access_type => File.join(Bundler.root, "spec/config/#{access_type}.yml"))
+end
+
+CREDENTIALS = [:dropbox, :app_folder].inject({}) do |hash, access_type|
+  begin
+    content = File.read(CREDENTIAL_FILES[access_type])
+    credentials = YAML.load(content).symbolize_keys
+    hash.update(access_type => credentials)
+  rescue Errno::ENOENT
+    $stderr.puts <<-EOS.strip_heredoc
+
+      Some of the credential files were not found.  Please, copy spec/config/dropbox.yml.example
+      into spec/config/dropbox.yml, and fill it with credentials of your Dropbox app with "full dropbox"
+      access you intend to use. And the same for spec/config/app_folder.yml and "app folder" access.
+
+      Make use of the "dropbox:authorize" Rake task.
+
+    EOS
+    exit
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,6 @@
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.hook_into :webmock
+  config.default_cassette_options = {record: :new_episodes}
+  config.configure_rspec_metadata!
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: dropbox-explorer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Cunha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Explore dropbox folders
+email:
+- davidgoncalvescunha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dropbox-explorer.gemspec
+- lib/dropbox-explorer.rb
+- lib/dropbox/explorer.rb
+- lib/dropbox/explorer/client.rb
+- lib/dropbox/explorer/credentials.rb
+- lib/dropbox/explorer/folder.rb
+- lib/dropbox/explorer/rake/railtie.rb
+- lib/dropbox/explorer/rake/rake.rb
+- lib/dropbox/explorer/rake/tasks.rake
+- spec/config/app_folder.yml.example
+- spec/config/dropbox.yml.example
+- spec/lib/dropbox/explorer/client_spec.rb
+- spec/lib/dropbox/explorer/credentials_spec.rb
+- spec/lib/dropbox/explorer/folder_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb
+homepage: https://github.com/imaginary-cloud/dropbox-explorer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Explore dropbox folders
+test_files:
+- spec/config/app_folder.yml.example
+- spec/config/dropbox.yml.example
+- spec/lib/dropbox/explorer/client_spec.rb
+- spec/lib/dropbox/explorer/credentials_spec.rb
+- spec/lib/dropbox/explorer/folder_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb
+- spec/support/vcr.rb