dropbox_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ff027599a73f3beca7e37fedc70c17b23b73987
+  data.tar.gz: 2f87aad226d661e403dccc007d2e2e4f7635beeb
+SHA512:
+  metadata.gz: e61331b3e9da8f57e3714d81d22456831e3b776dd9e44b081407fc2600055256e94a329cf5cb24916b0081317d7c237988913265c668a9a2c0ec9e82553dd15f
+  data.tar.gz: fad15b305fd531e379a572a1aa503713c18916678f74b60a88dc517e96ee543a7899a01b3541e47ba5cf08279eb35c497651e2d2d25e92c624bced16b9b3cbc1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  # - 1.8.7
+  # - 1.9.3
+  - 2.3.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jesús Burgos Maciá
+
+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,118 @@
+# DropboxApi
+
+Library for communicating with Dropbox API v2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dropbox_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dropbox_api
+
+## Usage
+
+### Authorize your application
+
+Dropbox uses OAuth, in order to use this library from your application you'll
+have to get an authorization code.
+
+Once you have it, just pass it on client initialization:
+
+```ruby
+DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+```
+
+Or set it as an ENV variable called `DROPBOX_OAUTH_BEARER`, for example:
+
+```ruby
+ENV["DROPBOX_OAUTH_BEARER"] = "VofXAX8D..."
+DropboxApi::Client.new
+#=> #<DropboxApi::Client ...>
+```
+
+#### Option A: Get your access token from the website
+
+The easiest way to obtain an access token is to get it from the Dropbox website.
+You just need to log in to Dropbox and refer to the *developers* section, go to
+*My apps* and select your application, you may need to create one if you
+haven't done so yet.
+
+Under your application settings, find section *OAuth 2*. You'll find a button
+to generate an access token.
+
+#### Option B: Use `DropboxApi::Authenticator`
+
+You can obtain an authorization code with this library:
+
+1. `require "dropbox_api/authenticator"`
+1. `authenticator = DropboxApi::Authenticator.new(CLIENT_ID, CLIENT_SECRET)`
+2. `authenticator.authorize_url  #=> "https://www.dropbox.com/..."`
+3. Open the authorization URL in your browser, authorize the application and
+   copy your code.
+4. `auth_bearer = authenticator.get_token(CODE) #=> #<OAuth2::AccessToken ...>`
+5. `auth_bearer.token #=> "VofXAX8D..."`. Keep this token!
+
+#### Standard OAuth flow
+
+Not implemented yet. :(
+
+### Performing API calls
+
+Once you've initialized a client, for example:
+
+```ruby
+client = DropboxApi::Client.new("VofXAX8D...")
+#=> #<DropboxApi::Client ...>
+```
+
+You can perform an API call like this:
+
+```ruby
+result = client.list_folder "/sample_folder"
+#=> #<DropboxApi::Results::ListFolderResult>
+result.entries
+#=> [#<DropboxApi::Metadata::Folder>, #<DropboxApi::Metadata::File>]
+result.has_more?
+#=> false
+```
+
+Refer to the documentation to see the details for each endpoint.
+
+## Dependencies
+
+###Network adapter
+
+This gem uses [faraday](https://github.com/lostisland/faraday#faraday).
+So it should work on any network library.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Any help will be much appreciated. It should be quite easy to implement most
+of the [endpoints that are still pending](api_coverage.md).
+
+1. Fork it ( https://github.com/Jesus/dropbox_api/fork )
+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 a new Pull Request

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,8 @@
+# Goals to publish v0.1
+
+- Write a tutorial showing how to set up authentication in a Rails app.
+- Add a small module for configuration. Needs to contain the OAuth bearer.
+
+# Further on
+
+- Supporting streams would be great.

data/api_coverage.md

@@ -0,0 +1,107 @@
+**IMPORTANT: This document is work in progress. Information isn't accurate.**
+
+The Dropbox API changes frequently, so you may find out that the feature that
+you need is missing. This document indicates what endpoints have been
+implemented.
+
+Full moon means fully implemented. Half moon means that the basic functionality
+of the endpoint has been implemented but some options may be missing.
+
+## Files namespace
+
+API call | Status
+--- | :---:
+`/copy` | 🌕
+`/copy_reference/get` | 🌑
+`/copy_reference/save` | 🌑
+`/create_folder` | 🌕
+`/delete` | 🌕
+`/download` | 🌔
+`/get_metadata` | 🌕
+`/get_preview` | 🌕
+`/get_temporary_link` | 🌕
+`/get_thumbnail` | 🌕
+`/list_folder` | 🌕
+`/list_folder/continue` | 🌕
+`/list_folder/get_latest_cursor` | 🌕
+`/list_folder/longpoll` | 🌕
+`/list_revisions` | 🌕
+`/move` | 🌕
+`/permanently_delete` | 🌑
+`/properties/add` | 🌑
+`/properties/overwrite` | 🌑
+`/properties/remove` | 🌑
+`/properties/template/get` | 🌑
+`/properties/template/list` | 🌑
+`/properties/update` | 🌑
+`/restore` | 🌑
+`/save_url` | 🌑
+`/save_url/check_job_status` | 🌑
+`/search` | 🌕
+`/upload` | 🌕
+`/upload_session/append` | 🌑
+`/upload_session/append_v2` | 🌑
+`/upload_session/finish` | 🌑
+`/upload_session/finish_batch` | 🌑
+`/upload_session/finish_batch/check` | 🌑
+`/upload_session/start` | 🌑
+
+## Sharing namespace
+API call | Status
+--- | :---:
+`/add_file_member` | 🌑
+`/add_folder_member` | 🌕
+`/change_file_member_access` | 🌑
+`/check_job_status` | 🌑
+`/check_remove_member_job_status` | 🌑
+`/check_share_job_status` | 🌑
+`/create_shared_link` | 🌑
+`/create_shared_link_with_settings` | 🌓
+`/get_file_metadata` | 🌑
+`/get_file_metadata/batch` | 🌑
+`/get_folder_metadata` | 🌑
+`/get_shared_link_file` | 🌑
+`/get_shared_link_metadata` | 🌑
+`/get_shared_links` | 🌑
+`/list_file_members` | 🌑
+`/list_file_members/batch` | 🌑
+`/list_file_members/continue` | 🌑
+`/list_folder_members` | 🌓
+`/list_folder_members/continue` | 🌑
+`/list_folders` | 🌑
+`/list_folders/continue` | 🌑
+`/list_mountable_folders` | 🌑
+`/list_mountable_folders/continue` | 🌑
+`/list_received_files` | 🌑
+`/list_received_files/continue` | 🌑
+`/list_shared_links` | 🌕
+`/modify_shared_link_settings` | 🌑
+`/mount_folder` | 🌑
+`/relinquish_file_membership` | 🌑
+`/relinquish_folder_membership` | 🌑
+`/remove_file_member` | 🌑
+`/remove_file_member_2` | 🌑
+`/remove_folder_member` | 🌑
+`/revoke_shared_link` | 🌑
+`/share_folder` | 🌕
+`/transfer_folder` | 🌑
+`/unmount_folder` | 🌑
+`/unshare_file` | 🌑
+`/unshare_folder` | 🌑
+`/update_folder_member` | 🌑
+`/update_folder_policy` | 🌑
+
+## Users namespace
+
+API call | Status
+--- | :---:
+`/get_account` | 🌕
+`/get_account_batch` | 🌑
+`/get_current_account` | 🌑
+`/get_space_usage` | 🌑
+
+
+## Dropbox Business API
+Unfortunately, none of the Dropbox Business endpoints have been implemented.
+If this is a problem for you, please [open an
+issue](https://github.com/Jesus/dropbox_api/issues/new).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dropbox_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dropbox_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dropbox_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropbox_api"
+  spec.version       = DropboxApi::VERSION
+  spec.authors       = ["Jesús Burgos"]
+  spec.email         = ["jburmac@gmail.com"]
+
+  spec.summary       = "Library for communicating with Dropbox API v2"
+  spec.homepage      = "https://github.com/Jesus/dropbox_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.require_paths = ["lib"]
+
+  spec.has_rdoc = "yard"
+
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "oauth2", "~> 1.1"
+  spec.add_dependency "faraday", "~> 0.8", "~> 0.9"
+end

data/lib/dropbox_api.rb

@@ -0,0 +1,102 @@
+require 'dropbox_api/version'
+
+require 'json'
+require 'faraday'
+
+require 'dropbox_api/middleware/decode_result'
+
+require 'dropbox_api/metadata/field'
+require 'dropbox_api/metadata/add_member'
+require 'dropbox_api/metadata/base'
+require 'dropbox_api/metadata/name'
+require 'dropbox_api/metadata/basic_account'
+require 'dropbox_api/metadata/link_permissions'
+require 'dropbox_api/metadata/team'
+require 'dropbox_api/metadata/team_member_info'
+require 'dropbox_api/metadata/file'
+require 'dropbox_api/metadata/folder_sharing_info'
+require 'dropbox_api/metadata/folder'
+require 'dropbox_api/metadata/deleted'
+require 'dropbox_api/metadata/resource'
+require 'dropbox_api/metadata/shared_folder_policy'
+require 'dropbox_api/metadata/shared_folder'
+require 'dropbox_api/metadata/file_link'
+require 'dropbox_api/metadata/folder_link'
+require 'dropbox_api/metadata/shared_link'
+
+require 'dropbox_api/errors/http_error'
+require 'dropbox_api/errors/basic_error'
+require 'dropbox_api/errors/already_shared_error'
+require 'dropbox_api/errors/lookup_error'
+require 'dropbox_api/errors/write_conflict_error'
+require 'dropbox_api/errors/write_error'
+require 'dropbox_api/errors/relocation_error'
+require 'dropbox_api/errors/restore_error'
+require 'dropbox_api/errors/search_error'
+require 'dropbox_api/errors/settings_error'
+require 'dropbox_api/errors/share_path_error'
+require 'dropbox_api/errors/share_folder_error'
+require 'dropbox_api/errors/create_folder_error'
+require 'dropbox_api/errors/create_shared_link_with_settings_error'
+require 'dropbox_api/errors/delete_error'
+require 'dropbox_api/errors/download_error'
+require 'dropbox_api/errors/get_metadata_error'
+require 'dropbox_api/errors/list_folder_error'
+require 'dropbox_api/errors/list_revisions_error'
+require 'dropbox_api/errors/list_shared_links_error'
+require 'dropbox_api/errors/list_folder_continue_error'
+require 'dropbox_api/errors/list_folder_longpoll_error'
+require 'dropbox_api/errors/preview_error'
+require 'dropbox_api/errors/add_member_selector_error'
+require 'dropbox_api/errors/shared_folder_access_error'
+require 'dropbox_api/errors/upload_write_failed_error'
+require 'dropbox_api/errors/upload_error'
+require 'dropbox_api/errors/add_folder_member_error'
+require 'dropbox_api/errors/get_account_error'
+
+require 'dropbox_api/result_builder'
+require 'dropbox_api/results/base'
+require 'dropbox_api/results/get_temporary_link_result'
+require 'dropbox_api/results/list_folder_result'
+require 'dropbox_api/results/list_revisions_result'
+require 'dropbox_api/results/list_folder_longpoll_result'
+require 'dropbox_api/results/list_folder_get_latest_cursor_result'
+require 'dropbox_api/results/list_shared_links_result'
+require 'dropbox_api/results/search/match'
+require 'dropbox_api/results/search_result'
+require 'dropbox_api/results/share_folder_launch'
+require 'dropbox_api/results/shared_folder_members'
+require 'dropbox_api/results/void_result'
+
+require 'dropbox_api/client'
+require 'dropbox_api/connection_builder'
+
+require 'dropbox_api/endpoints/base'
+require 'dropbox_api/endpoints/rpc'
+require 'dropbox_api/endpoints/rpc_notify'
+require 'dropbox_api/endpoints/content_download'
+require 'dropbox_api/endpoints/content_upload'
+require 'dropbox_api/endpoints/options_validator'
+require 'dropbox_api/endpoints/files/copy'
+require 'dropbox_api/endpoints/files/create_folder'
+require 'dropbox_api/endpoints/files/delete'
+require 'dropbox_api/endpoints/files/download'
+require 'dropbox_api/endpoints/files/get_metadata'
+require 'dropbox_api/endpoints/files/get_preview'
+require 'dropbox_api/endpoints/files/get_temporary_link'
+require 'dropbox_api/endpoints/files/get_thumbnail'
+require 'dropbox_api/endpoints/files/list_folder'
+require 'dropbox_api/endpoints/files/list_folder_continue'
+require 'dropbox_api/endpoints/files/list_folder_longpoll'
+require 'dropbox_api/endpoints/files/list_folder_get_latest_cursor'
+require 'dropbox_api/endpoints/files/list_revisions'
+require 'dropbox_api/endpoints/files/move'
+require 'dropbox_api/endpoints/files/restore'
+require 'dropbox_api/endpoints/files/search'
+require 'dropbox_api/endpoints/files/upload'
+require 'dropbox_api/endpoints/sharing/add_folder_member'
+require 'dropbox_api/endpoints/sharing/list_folder_members'
+require 'dropbox_api/endpoints/sharing/share_folder'
+require 'dropbox_api/endpoints/sharing/list_shared_links'
+require 'dropbox_api/endpoints/sharing/create_shared_link_with_settings'
+require 'dropbox_api/endpoints/users/get_account'