dropbox_api 0.1.1 → 0.1.3

data/lib/dropbox_api/metadata/space_allocation.rb

@@ -0,0 +1,10 @@
+module DropboxApi::Metadata
+  # Example of a serialized {SpaceAllocation} object:
+  #   {
+  #     ".tag": "individual",
+  #     "allocated": 2147483648
+  #   }
+  class SpaceAllocation < Base
+    field :allocated, Integer
+  end
+end

data/lib/dropbox_api/metadata/space_usage.rb

@@ -0,0 +1,14 @@
+module DropboxApi::Metadata
+  # Example of a serialized {SpaceUsage} object:
+  #   {
+  #     "used": 167685342,
+  #     "allocation": {
+  #       ".tag": "individual",
+  #       "allocated": 2147483648
+  #     }
+  #   }
+  class SpaceUsage < Base
+    field :used, String
+    field :allocation, DropboxApi::Metadata::SpaceAllocation
+  end
+end

data/lib/dropbox_api/metadata/team_member_info.rb

@@ -1,14 +1,13 @@
 module DropboxApi::Metadata
-  # NOTE: We should have a test to cover the initialization of this object.
-  # Sample:
-  # {
-  #   "team_info": {
-  #     "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
-  #     "name": "Acme, Inc."
-  #   },
-  #   "display_name": "Roger Rabbit",
-  #   "member_id": "dbmid:abcd1234"
-  # }
+  # Example of a serialized {TeamMemberInfo} object:
+  #   {
+  #     "team_info": {
+  #       "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+  #       "name": "Acme, Inc."
+  #     },
+  #     "display_name": "Roger Rabbit",
+  #     "member_id": "dbmid:abcd1234"
+  #   }
   class TeamMemberInfo < Base
     field :team_info, DropboxApi::Metadata::Team
     field :display_name, String

data/lib/dropbox_api/result_builder.rb

@@ -5,7 +5,7 @@ module DropboxApi
     end
 
     def error_summary
-      @response_data["error_summary"]
+      @response_data["error_summary"] if @response_data.is_a? Hash
     end
 
     def error

data/lib/dropbox_api/results/add_file_member_result_list.rb

@@ -0,0 +1,20 @@
+module DropboxApi::Results
+  # Example of a result of the +add_file_member+ endpoint:
+  #   [{
+  #     "member":{
+  #       ".tag": "email",
+  #       "email": "somebody@test.com"
+  #     },
+  #     "result": {
+  #       ".tag": "success",
+  #       "success": {
+  #         ".tag": "viewer"
+  #       }
+  #     }
+  #   }]
+  class AddFileMemberResultList < Array
+    def initialize(members)
+      super(members.map { |m| DropboxApi::Metadata::AddFileMemberResult.new m })
+    end
+  end
+end

data/lib/dropbox_api/results/basic_account_batch.rb

@@ -0,0 +1,7 @@
+module DropboxApi::Results
+  class BasicAccountBatch < Array
+    def initialize(accounts)
+      super(accounts.map { |a| DropboxApi::Metadata::BasicAccount.new a })
+    end
+  end
+end

data/lib/dropbox_api/version.rb

@@ -1,3 +1,3 @@
 module DropboxApi
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/rails_setup.md

@@ -0,0 +1,84 @@
+# @title Rails setup
+
+# Standard OAuth 2 flow set up
+
+This document describes how to implement the OAuth2 flow in a Rails
+application, the process is represented in the following diagram:
+
+![Oauth 2 flow](https://www.dropbox.com/static/images/developers/oauth2-web-diagram.png)
+
+Source: [https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web](https://www.dropbox.com/developers/reference/oauth-guide#oauth-2-on-the-web)
+
+## 1. Set up some new routes
+
+You'll have to create a couple of new routes:
+
+```ruby
+get 'dropbox/auth' => 'dropbox#auth'
+get 'dropbox/auth_callback' => 'dropbox#auth_callback'
+```
+
+We'll use `dropbox/auth` to perform the step 2 in the diagram, i.e. this route
+will redirect to Dropbox.
+
+The other route, `dropbox/auth_callback`, will process the authentication token
+that we'll receive from Dropbox. Steps 4 & 5.
+
+## 2. Set up a Dropbox controller
+
+```ruby
+class DropboxController < ApplicationController
+  # Example call:
+  # GET /dropbox/auth
+  def auth
+    url = authenticator.authorize_url :redirect_uri => redirect_uri
+
+    redirect_to url
+  end
+
+  # Example call:
+  # GET /dropbox/auth_callback?code=VofXAX8DO1sAAAAAAAACUKBwkDZyMg1zKT0f_FNONeA
+  def auth_callback
+    auth_bearer = authenticator.get_token(params[:code],
+                                          :redirect_uri => redirect_uri)
+    token = auth_bearer.token # This line is step 5 in the diagram.
+
+    # At this stage you may want to persist the reusable token we've acquired.
+    # Remember that it's bound to the Dropbox account of your user.
+
+    # If you persist this token, you can use it in subsequent requests or
+    # background jobs to perform calls to Dropbox API such as the following.
+    folders = DropboxApi::Client.new(token).list_folder "/"
+  end
+
+  private
+
+  def authenticator
+    client_id = "az8ykn83kecoodq"
+    client_secret = "ozp1pxo8e563fc5"
+
+    DropboxApi::Authenticator.new(client_id, client_secret)
+  end
+
+  def redirect_uri
+    dropbox_auth_callback_url # => http://localhost:3000/dropbox/auth_callback
+  end
+end
+```
+
+## 3. Set up redirect URI in your Dropbox app settings
+
+In the previous code, you probably noticed that we're providing a `redirect_uri`
+parameter. This is where the user will be redirected to after accepting our
+application.
+
+However, Dropbox will only redirect to a set of whitelisted URIs, so
+you'll need to add yours to the list. That's very easy:
+
+1. Log in to your Dropbox developer account at
+   [www.dropbox.com/developers](https://www.dropbox.com/developers).
+2. On the menu, click on "My Apps". Then click on your application to edit its
+   settings.
+4. On the OAuth 2 section, add the redirect URI that maps to the
+   `auth_callback` method that we've implemented above. For example,
+   `www.yourapp.com/dropbox/oauth_callback`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropbox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jesús Burgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,12 +124,15 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - TODO.md
 - api_coverage.md
+- api_reference.md
 - bin/console
 - bin/setup
 - dropbox_api.gemspec
@@ -160,12 +163,17 @@ files:
 - lib/dropbox_api/endpoints/options_validator.rb
 - lib/dropbox_api/endpoints/rpc.rb
 - lib/dropbox_api/endpoints/rpc_notify.rb
+- lib/dropbox_api/endpoints/sharing/add_file_member.rb
 - lib/dropbox_api/endpoints/sharing/add_folder_member.rb
 - lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb
 - lib/dropbox_api/endpoints/sharing/list_folder_members.rb
 - lib/dropbox_api/endpoints/sharing/list_shared_links.rb
 - lib/dropbox_api/endpoints/sharing/share_folder.rb
 - lib/dropbox_api/endpoints/users/get_account.rb
+- lib/dropbox_api/endpoints/users/get_account_batch.rb
+- lib/dropbox_api/endpoints/users/get_current_account.rb
+- lib/dropbox_api/endpoints/users/get_space_usage.rb
+- lib/dropbox_api/errors/add_file_member_error.rb
 - lib/dropbox_api/errors/add_folder_member_error.rb
 - lib/dropbox_api/errors/add_member_selector_error.rb
 - lib/dropbox_api/errors/already_shared_error.rb
@@ -174,6 +182,7 @@ files:
 - lib/dropbox_api/errors/create_shared_link_with_settings_error.rb
 - lib/dropbox_api/errors/delete_error.rb
 - lib/dropbox_api/errors/download_error.rb
+- lib/dropbox_api/errors/file_member_action_error.rb
 - lib/dropbox_api/errors/get_account_error.rb
 - lib/dropbox_api/errors/get_metadata_error.rb
 - lib/dropbox_api/errors/http_error.rb
@@ -191,10 +200,14 @@ files:
 - lib/dropbox_api/errors/share_folder_error.rb
 - lib/dropbox_api/errors/share_path_error.rb
 - lib/dropbox_api/errors/shared_folder_access_error.rb
+- lib/dropbox_api/errors/sharing_file_access_error.rb
+- lib/dropbox_api/errors/too_many_requests_error.rb
 - lib/dropbox_api/errors/upload_error.rb
 - lib/dropbox_api/errors/upload_write_failed_error.rb
 - lib/dropbox_api/errors/write_conflict_error.rb
 - lib/dropbox_api/errors/write_error.rb
+- lib/dropbox_api/metadata/access_level.rb
+- lib/dropbox_api/metadata/add_file_member_result.rb
 - lib/dropbox_api/metadata/add_member.rb
 - lib/dropbox_api/metadata/base.rb
 - lib/dropbox_api/metadata/basic_account.rb
@@ -202,20 +215,30 @@ files:
 - lib/dropbox_api/metadata/field.rb
 - lib/dropbox_api/metadata/file.rb
 - lib/dropbox_api/metadata/file_link.rb
+- lib/dropbox_api/metadata/file_member_action.rb
 - lib/dropbox_api/metadata/folder.rb
 - lib/dropbox_api/metadata/folder_link.rb
 - lib/dropbox_api/metadata/folder_sharing_info.rb
 - lib/dropbox_api/metadata/link_permissions.rb
+- lib/dropbox_api/metadata/member.rb
+- lib/dropbox_api/metadata/member_action_collection.rb
+- lib/dropbox_api/metadata/member_permission.rb
+- lib/dropbox_api/metadata/member_permission_list.rb
 - lib/dropbox_api/metadata/name.rb
+- lib/dropbox_api/metadata/parent_folder_access_info.rb
 - lib/dropbox_api/metadata/resource.rb
 - lib/dropbox_api/metadata/shared_folder.rb
 - lib/dropbox_api/metadata/shared_folder_policy.rb
 - lib/dropbox_api/metadata/shared_link.rb
+- lib/dropbox_api/metadata/space_allocation.rb
+- lib/dropbox_api/metadata/space_usage.rb
 - lib/dropbox_api/metadata/team.rb
 - lib/dropbox_api/metadata/team_member_info.rb
 - lib/dropbox_api/middleware/decode_result.rb
 - lib/dropbox_api/result_builder.rb
+- lib/dropbox_api/results/add_file_member_result_list.rb
 - lib/dropbox_api/results/base.rb
+- lib/dropbox_api/results/basic_account_batch.rb
 - lib/dropbox_api/results/get_temporary_link_result.rb
 - lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb
 - lib/dropbox_api/results/list_folder_longpoll_result.rb
@@ -228,6 +251,7 @@ files:
 - lib/dropbox_api/results/shared_folder_members.rb
 - lib/dropbox_api/results/void_result.rb
 - lib/dropbox_api/version.rb
+- rails_setup.md
 homepage: https://github.com/Jesus/dropbox_api
 licenses:
 - MIT