dropbox_api 0.1.0

data/lib/dropbox_api/metadata/base.rb

@@ -0,0 +1,22 @@
+module DropboxApi::Metadata
+  class Base
+    def self.field(name, type, *options)
+      @fields ||= {}
+      @fields[name] = DropboxApi::Metadata::Field.new(type, options)
+
+      attr_reader name
+    end
+
+    def self.each_field
+      @fields.each do |name, field|
+        yield name, field
+      end
+    end
+
+    def initialize(metadata)
+      self.class.each_field do |name, field|
+        instance_variable_set "@#{name}", field.cast(metadata[name.to_s])
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/basic_account.rb

@@ -0,0 +1,29 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
+  #   "name": {
+  #       "given_name": "Franz",
+  #       "surname": "Ferdinand",
+  #       "familiar_name": "Franz",
+  #       "display_name": "Franz Ferdinand (Personal)"
+  #   },
+  #   "email": "franz@dropbox.com",
+  #   "email_verified": true,
+  #   "disabled": false,
+  #   "is_teammate": true,
+  #   "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbid%3AAAH4f99T0taONIb-OurWxbNQ6ywGRopQngc?vers=1453416696524&size=128x128",
+  #   "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU"
+  # }
+  class BasicAccount < Base
+    field :account_id, String
+    field :name, DropboxApi::Metadata::Name
+    field :email, String
+    field :email_verified, :boolean
+    field :disabled, :boolean
+    field :is_teammate, :boolean
+    field :profile_photo_url, String
+    field :team_member_id, :boolean
+  end
+end

data/lib/dropbox_api/metadata/deleted.rb

@@ -0,0 +1,15 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   ".tag": "deleted",
+  #   "name": "file.txt",
+  #   "path_lower": "/file.txt",
+  #   "path_display": "/file.txt"
+  # }
+  class Deleted < Base
+    field :name, String
+    field :path_lower, String
+    field :path_display, String
+  end
+end

data/lib/dropbox_api/metadata/field.rb

@@ -0,0 +1,34 @@
+module DropboxApi::Metadata
+  class Field
+    def initialize(type, options = [])
+      @type = type
+      @options = options
+    end
+
+    def cast(object)
+      if object.nil? && @options.include?(:optional)
+        nil
+      else
+        force_cast object
+      end
+    end
+
+    def force_cast(object)
+      if @type == String
+        object.to_s
+      elsif @type == Time
+        Time.new(object)
+      elsif @type == Integer
+        object.to_i
+      elsif @type == Symbol
+        object[".tag"].to_sym
+      elsif @type == :boolean
+        object.to_s == "true"
+      elsif @type.ancestors.include? DropboxApi::Metadata::Base
+        @type.new(object)
+      else
+        raise NotImplementedError, "Can't cast `#{type}`"
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/file.rb

@@ -0,0 +1,30 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   ".tag": "file",
+  #   "name": "Prime_Numbers.txt",
+  #   "path_lower": "/homework/math/prime_numbers.txt",
+  #   "path_display": "/Homework/math/Prime_Numbers.txt",
+  #   "id": "id:a4ayc_80_OEAAAAAAAAAXw",
+  #   "client_modified": "2015-05-12T15:50:38Z",
+  #   "server_modified": "2015-05-12T15:50:38Z",
+  #   "rev": "a1c10ce0dd78",
+  #   "size": 7212,
+  #   "sharing_info": {
+  #     "read_only": true,
+  #     "parent_shared_folder_id": "84528192421",
+  #     "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc"
+  #   }
+  # }
+  class File < Base
+    field :name, String
+    field :path_lower, String
+    field :path_display, String
+    field :id, String
+    field :client_modified, Time
+    field :server_modified, Time
+    field :rev, String
+    field :size, Integer
+  end
+end

data/lib/dropbox_api/metadata/file_link.rb

@@ -0,0 +1,46 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   ".tag": "file",
+  #   "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0",
+  #   "name": "Prime_Numbers.txt",
+  #   "link_permissions": {
+  #     "can_revoke": false,
+  #     "resolved_visibility": {
+  #       ".tag": "public"
+  #     },
+  #     "revoke_failure_reason": {
+  #       ".tag": "owner_only"
+  #     }
+  #   },
+  #   "client_modified": "2015-05-12T15:50:38Z",
+  #   "server_modified": "2015-05-12T15:50:38Z",
+  #   "rev": "a1c10ce0dd78",
+  #   "size": 7212,
+  #   "id": "id:a4ayc_80_OEAAAAAAAAAXw",
+  #   "path_lower": "/homework/math/prime_numbers.txt",
+  #   "team_member_info": {
+  #     "team_info": {
+  #       "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
+  #       "name": "Acme, Inc."
+  #     },
+  #     "display_name": "Roger Rabbit",
+  #     "member_id": "dbmid:abcd1234"
+  #   }
+  # }
+  class FileLink < Base
+    field :url, String
+    field :name, String
+    field :link_permissions, DropboxApi::Metadata::LinkPermissions
+    field :client_modified, Time
+    field :server_modified, Time
+    field :rev, String
+    field :size, Integer
+    field :id, String, :optional
+    field :expires, Time, :optional
+    field :path_lower, String, :optional
+    field :team_member_info, DropboxApi::Metadata::TeamMemberInfo, :optional
+    field :content_owner_team_info, DropboxApi::Metadata::Team, :optional
+  end
+end

data/lib/dropbox_api/metadata/folder.rb

@@ -0,0 +1,17 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   "name": "arizona_baby",
+  #   "path_lower": "/arizona_baby",
+  #   "path_display": "/arizona_baby",
+  #   "id": "id:7eWkV5hcfzAAAAAAAAAAAQ"
+  # }
+  class Folder < Base
+    field :name, String
+    field :path_lower, String
+    field :path_display, String
+    field :id, String
+    field :sharing_info, DropboxApi::Metadata::FolderSharingInfo, :optional
+  end
+end

data/lib/dropbox_api/metadata/folder_link.rb

@@ -0,0 +1,12 @@
+module DropboxApi::Metadata
+  class FolderLink < Base
+    field :url, String
+    field :name, String
+    field :link_permissions, DropboxApi::Metadata::LinkPermissions
+    field :id, String, :optional
+    field :expires, Time, :optional
+    field :path_lower, String, :optional
+    field :team_member_info, DropboxApi::Metadata::TeamMemberInfo, :optional
+    field :content_owner_team_info, DropboxApi::Metadata::Team, :optional
+  end
+end

data/lib/dropbox_api/metadata/folder_sharing_info.rb

@@ -0,0 +1,13 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   "read_only": false,
+  #   "parent_shared_folder_id": "84528192421"
+  # }
+  class FolderSharingInfo < Base
+    field :read_only, :boolean
+    field :parent_shared_folder_id, String, :optional
+    field :shared_folder_id, String, :optional
+  end
+end

data/lib/dropbox_api/metadata/link_permissions.rb

@@ -0,0 +1,19 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   "can_revoke": false,
+  #   "resolved_visibility": {
+  #     ".tag": "public"
+  #   },
+  #   "revoke_failure_reason": {
+  #     ".tag": "owner_only"
+  #   }
+  # }
+  class LinkPermissions < Base
+    field :can_revoke, :boolean
+    field :resolved_visibility, Symbol, :optional
+    field :requested_visibility, Symbol, :optional
+    field :revoke_failure_reason, Symbol, :optional
+  end
+end

data/lib/dropbox_api/metadata/name.rb

@@ -0,0 +1,16 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #     "given_name": "Franz",
+  #     "surname": "Ferdinand",
+  #     "familiar_name": "Franz",
+  #     "display_name": "Franz Ferdinand (Personal)"
+  # },
+  class Name < Base
+    field :given_name, String
+    field :surname, String
+    field :familiar_name, String
+    field :display_name, String
+  end
+end

data/lib/dropbox_api/metadata/resource.rb

@@ -0,0 +1,31 @@
+module DropboxApi::Metadata
+  # This class is used as an adapter so we can create an object of the pertinent
+  # class when we need to infer the type from the data.
+  #
+  # For example, calling Resource.new({".tag" => "file", :name => ...}) will
+  # instantiate a `File` object.
+  #
+  # So this could initalize an object of either `File`, `Folder` or `Deleted`.
+  class Resource
+    class << self
+      def new(data)
+        class_for(data[".tag"].to_sym).new(data)
+      end
+
+      private
+
+      def class_for(tag)
+        case tag
+        when :file
+          DropboxApi::Metadata::File
+        when :folder
+          DropboxApi::Metadata::Folder
+        when :deleted
+          DropboxApi::Metadata::Deleted
+        else
+          raise ArgumentError, "Unable to infer resource type for `#{tag}`"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/shared_folder.rb

@@ -0,0 +1,26 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   ".tag" => "complete",
+  #   "access_type" => {".tag"=>"owner"},
+  #   "is_team_folder" => false,
+  #   "policy" => {
+  #     "acl_update_policy" => { ".tag" => "owner" },
+  #     "shared_link_policy" => { ".tag" => "anyone" }
+  #   },
+  #   "path_lower" => "/folder_a",
+  #   "name" => "folder_a",
+  #   "shared_folder_id" => "1231266557",
+  #   "time_invited" => "2016-06-04T10:00:35Z"
+  # }
+  class SharedFolder < Base
+    field :access_type, String
+    field :is_team_folder, :boolean
+    field :policy, DropboxApi::Metadata::SharedFolderPolicy
+    field :path_lower, String
+    field :name, String
+    field :shared_folder_id, Integer
+    field :time_invited, Time
+  end
+end

data/lib/dropbox_api/metadata/shared_folder_policy.rb

@@ -0,0 +1,12 @@
+module DropboxApi::Metadata
+  # NOTE: We should have a test to cover the initialization of this object.
+  # Sample:
+  # {
+  #   "acl_update_policy" => { ".tag" => "owner" },
+  #   "shared_link_policy" => { ".tag" => "anyone" }
+  # }
+  class SharedFolderPolicy < Base
+    field :acl_update_policy, Symbol
+    field :shared_link_policy, Symbol
+  end
+end

data/lib/dropbox_api/metadata/shared_link.rb

@@ -0,0 +1,26 @@
+module DropboxApi::Metadata
+  # This class is used as an adapter so we can create an object of the pertinent
+  # class when we need to infer the type from the data.
+  #
+  # This same pattern is used in `DropboxApi::Metadata::Resource`
+  class SharedLink
+    class << self
+      def new(data)
+        class_for(data[".tag"].to_sym).new(data)
+      end
+
+      private
+
+      def class_for(tag)
+        case tag
+        when :file
+          DropboxApi::Metadata::FileLink
+        when :folder
+          DropboxApi::Metadata::FolderLink
+        else
+          raise ArgumentError, "Unable to infer resource type for `#{tag}`"
+        end
+      end
+    end
+  end
+end

data/lib/dropbox_api/metadata/team.rb

@@ -0,0 +1,6 @@
+module DropboxApi::Metadata
+  class Team < Base
+    field :id, String
+    field :name, String
+  end
+end

data/lib/dropbox_api/metadata/team_member_info.rb

@@ -0,0 +1,17 @@
+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"
+  # }
+  class TeamMemberInfo < Base
+    field :team_info, DropboxApi::Metadata::Team
+    field :display_name, String
+    field :member_id, String, :optional
+  end
+end

data/lib/dropbox_api/middleware/decode_result.rb

@@ -0,0 +1,26 @@
+module DropboxApi::MiddleWare
+  class DecodeResult < Faraday::Middleware
+    def call(rq_env)
+      @app.call(rq_env).on_complete do |rs_env|
+        if !rs_env[:response_headers]['Dropbox-Api-Result'].nil?
+          rs_env[:api_result] = decode rs_env[:response_headers]['Dropbox-Api-Result']
+        elsif rs_env[:response_headers]['content-type'] == 'application/json'
+          rs_env[:api_result] = decode rs_env[:body]
+        end
+      end
+    end
+
+    def decode(json)
+      # Dropbox may send a response with the string 'null' in its body, this
+      # would be a void result. `add_folder_member` is an example of an
+      # endpoint without return values.
+      if json == "null"
+        {}
+      else
+        JSON.parse json
+      end
+    end
+  end
+
+  Faraday::Response.register_middleware :decode_result => DecodeResult
+end

data/lib/dropbox_api/result_builder.rb

@@ -0,0 +1,31 @@
+module DropboxApi
+  class ResultBuilder
+    def initialize(response_data)
+      @response_data = response_data
+    end
+
+    def error_summary
+      @response_data["error_summary"]
+    end
+
+    def error
+      @response_data["error"]
+    end
+
+    def has_error?
+      !error_summary.nil?
+    end
+
+    def success?
+      !has_error?
+    end
+
+    def build(result_class)
+      result_class.new(@response_data)
+    end
+
+    def build_error(error_type)
+      error_type.build(error_summary, error)
+    end
+  end
+end