dropbox_api_v2 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f9711c3004053cf0168545124de63ecf789c54e3
4
+ data.tar.gz: a1711db8f79e43ffff63f6eeda93c9dc9f3a2752
5
+ SHA512:
6
+ metadata.gz: f843840283fd7ce791e0c54d6eb510914396bbc2e0ce6514221d7fd27fa76613d6383f8fc7f8208639a35b3f9c003745c971f85907baf488d19dc0ebcc1a0f13
7
+ data.tar.gz: d670cbffad4f1fb62e62171958690e7647e6419c72eb62d81a2edef87bad7d47ff9df1f687fdf39e600578cba265df9a8fa74a7eed43c565cf150d180819eede
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.3
4
+ before_install: gem install bundler -v 1.10.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in dropbox_api_v2.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 smurfik
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # DropboxApiV2
2
+
3
+ A Ruby client for the Dropbox API V2.
4
+
5
+ Current state: First release, includes methods listed below:
6
+
7
+ * list_folder
8
+ * list_folder_continue
9
+ * download
10
+ * upload
11
+ * search
12
+
13
+ ## Installation
14
+
15
+ In your Gemfile:
16
+
17
+ ```ruby
18
+ gem 'dropbox_api_v2'
19
+ ```
20
+
21
+ And then execute:
22
+
23
+ $ bundle
24
+
25
+ Or install it yourself as:
26
+
27
+ $ gem install dropbox_api_v2
28
+
29
+ ## Usage
30
+
31
+ ```ruby
32
+ folder_contents = DropboxApiV2.list_folder("/directory name", "dropbox_token", recursive: true)
33
+ #the methods `json, body, cursor` are avaible for all calls
34
+ folder_contents.json #returns response in the json form
35
+ folder_contents.body #returns raw response
36
+ folder_contents.cursor #returns cursor to be used in the future
37
+ folder_contents = DropboxApiV2.list_folder_continue("cursor_from_previous_call", "dropbox_token")
38
+ contents_of_file = DropboxApiV2.download("/path/file.txt", "dropbox_token")
39
+ upload_file = DropboxApiV2.upload("/path/new_file.txt", "dropbox_token", "content_to_write_in_the_file")
40
+ files_found = DropboxApiV2.search("/", "dropbox_token", query: "file_name")
41
+ ```
42
+
43
+ ## Contributing
44
+
45
+ Bug reports and pull requests are welcome on GitHub at https://github.com/smurfik/dropbox_api_v2.
46
+
47
+ ## License
48
+
49
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "dropbox_api_v2"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dropbox_api_v2/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dropbox_api_v2"
8
+ spec.version = DropboxApiV2::VERSION
9
+ spec.authors = ["smurfik"]
10
+ spec.email = ["tammy@mlpinit.com"]
11
+
12
+ spec.summary = %q{Ruby client library for the Dropbox Api V2}
13
+ spec.homepage = "https://github.com/smurfik/dropbox_api_v2"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.10"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "rspec"
24
+ spec.add_dependency "curb"
25
+ end
@@ -0,0 +1,24 @@
1
+ require "dropbox_api_v2/version"
2
+ require "dropbox_api_v2/request"
3
+
4
+ module DropboxApiV2
5
+ def self.list_folder(directory_path, token, args={})
6
+ Request.new("/files/list_folder", {path: directory_path, token: token}.merge(args)).response
7
+ end
8
+
9
+ def self.list_folder_continue(cursor, token)
10
+ Request.new("/files/list_folder/continue", cursor: cursor, token: token).response
11
+ end
12
+
13
+ def self.download(file_path, token)
14
+ Request.new("/files/download", path: file_path, file_transfer: true, token: token).response
15
+ end
16
+
17
+ def self.upload(file_path, token, body)
18
+ Request.new("/files/upload", path: file_path, body: body, file_transfer: true, token: token).response
19
+ end
20
+
21
+ def self.search(file_path, token, args={})
22
+ Request.new("/files/search", {path: file_path, token: token}.merge(args)).response
23
+ end
24
+ end
@@ -0,0 +1,74 @@
1
+ require 'curb'
2
+ require 'json'
3
+ require "dropbox_api_v2/response"
4
+
5
+ module DropboxApiV2
6
+ class Request
7
+ attr_reader :path, :verb
8
+
9
+ API_URL = "https://api.dropboxapi.com/2"
10
+ CONTENT_URL = "https://content.dropboxapi.com/2"
11
+
12
+ def initialize(path, params={})
13
+ @path = path
14
+ @token = params.delete(:token)
15
+ @body = params.delete(:body)
16
+ @file_transfer = params.delete(:file_transfer)
17
+ @params = params
18
+ end
19
+
20
+ def base_url
21
+ file_transfer? ? CONTENT_URL : API_URL
22
+ end
23
+
24
+ def url
25
+ base_url + path
26
+ end
27
+
28
+ def json_params
29
+ @params.to_json
30
+ end
31
+
32
+ def upload?
33
+ !!(file_transfer? && @body)
34
+ end
35
+
36
+ def download?
37
+ !!(file_transfer? && !@body)
38
+ end
39
+
40
+ def file_transfer?
41
+ @file_transfer
42
+ end
43
+
44
+ def content_type
45
+ if upload?
46
+ "application/octet-stream"
47
+ elsif download?
48
+ ""
49
+ else
50
+ "application/json"
51
+ end
52
+ end
53
+
54
+ def headers
55
+ headers = {"Authorization": "Bearer #{@token}", "Content-Type": content_type}
56
+ headers["Dropbox-API-Arg"] = json_params if file_transfer?
57
+ headers
58
+ end
59
+
60
+ def response
61
+ DropboxApiV2::Response.new perform
62
+ end
63
+
64
+ def body
65
+ file_transfer? ? @body : json_params
66
+ end
67
+
68
+ def perform
69
+ Curl.post(url, body) do |http|
70
+ http.headers = headers
71
+ end
72
+ end
73
+ end
74
+ end
@@ -0,0 +1,21 @@
1
+ require 'json'
2
+
3
+ module DropboxApiV2
4
+ class Response
5
+ def initialize(curl_response)
6
+ @curl_response = curl_response
7
+ end
8
+
9
+ def json
10
+ JSON.parse(body)
11
+ end
12
+
13
+ def body
14
+ @curl_response.body
15
+ end
16
+
17
+ def cursor
18
+ body["cursor"]
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,3 @@
1
+ module DropboxApiV2
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dropbox_api_v2
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - smurfik
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-06-27 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: curb
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description:
70
+ email:
71
+ - tammy@mlpinit.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - dropbox_api_v2.gemspec
86
+ - lib/dropbox_api_v2.rb
87
+ - lib/dropbox_api_v2/request.rb
88
+ - lib/dropbox_api_v2/response.rb
89
+ - lib/dropbox_api_v2/version.rb
90
+ homepage: https://github.com/smurfik/dropbox_api_v2
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.4.5.1
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Ruby client library for the Dropbox Api V2
114
+ test_files: []