docbase 1.0.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79387b87e93070c54a55c175ec428b0d6e457df3e05a78902a1f98b257df9551
-  data.tar.gz: 357041378d3e422328d250390d2fe4d987f74c497ae98280d8fb8a3426e2d96b
+  metadata.gz: 20af66cc5d5085854e9aef5f65e57383291a8f217961a4fa6cead0bb2e678941
+  data.tar.gz: 24cf39072ac1eaf9c4cc700f6ee2bcc694939b5c4d26427cb932aedeabf499f0
 SHA512:
-  metadata.gz: 0db6c5469d56c75f181f11121f6730da26e9ae7351e2c4298196f354385f1b8410641f023157f85bbda081ce25f38d21a679af2471174efbdbc25b2bb518d2e6
-  data.tar.gz: d28405501b0f97b93eb653f5c97cefeed88b63a56c8a562ee0502ff5516aabe638f724a2fddcae3d5ed7cc2d69520bae7820a2a795695130b4d9065990ba4c32
+  metadata.gz: 12a494552034d86ba01f68a95e30a438ed068307223d83dd23b9e92fa23f15a85dc98cee60577342696b123ec2b5153f0935d77b58a3887f810da919beb7b0f8
+  data.tar.gz: d5dc0fea1f5d08a13ea5df13c38c504e11a80b5a82f121ce9afe7d087cb1d4b06d48188434939bd41758a67029aacc692fd7db8466fd5db9c1f2fe6023a3ef7c

data/.travis.yml

@@ -1,10 +1,6 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
   - 2.6
+  - 2.7
+  - 3.0
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 2.1.2
+
+* 利用制限時にリトライできるように
+
+## 2.1.1
+
+* グループ取得APIにグループ名/ページネーションが渡せてるように fix: #17
+
+## 2.1.0
+
+* faradayを1.0.0以上でも使えるように
+* ruby 2.4をサポート対象外に
+
+## 2.0.1
+
+* ファイルダウンロードAPIに対応
+
+## 2.0.0
+
+* DocBaseAPIv2用としてリリース
+* チーム一覧APIを廃止
+* 環境変数`DOCBASE_ACCESS_TOKEN`でのトークン読み込みを廃止
+
 ## 1.0.0
 
 * DocBaseAPIv1用としてリリース

data/Gemfile

@@ -4,6 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rake', '~> 10.4'
-  gem 'rspec', '~> 3.8.0'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.10'
 end

data/README.md

@@ -26,20 +26,15 @@ Or install it yourself as:
 client = DocBase::Client.new(access_token: 'your_access_token', team: 'your_team')
 ```
 
-or
+### Docbase::Client.new options
 
-```ruby
-ENV['DOCBASE_ACCESS_TOKEN'] = 'your_access_token'
-
-client = DocBase::Client.new(team: 'your_team')
-```
-
-### teams
-
-```ruby
-client.teams.body
-# => [{ domain: 'kray', name: 'kray' }, { domain: 'danny', name: 'danny' }]
-```
+* access_token
+    * access token
+* team
+    * team subdomain
+* retry_on_rate_limit_exceeded
+    * [#16](https://github.com/krayinc/docbase-ruby/issues/16)
+    * true or false
 
 ### users
 
@@ -63,6 +58,8 @@ client.tags.body
 
 ```ruby
 client.groups.body
+client.groups(name: 'developers').body
+client.groups(page: 2, per_page: 10).body
 ```
 
 #### Show
@@ -200,6 +197,13 @@ client.upload('./test.jpg')
 client.upload(['./test.jpg', './README.md'])
 ```
 
+#### Download
+
+```ruby
+response = client.attachment(file_id)
+File.open(file_id, 'wb') { |f| f.write(response.body) }
+```
+
 ### switch team
 
 ```ruby
@@ -208,6 +212,7 @@ client.tags.body
 # => [{ name: 'ruby' }, { name: 'rails' }]
 
 client.team = 'danny'
+client.access_token = 'danny_team_access_token'
 client.tags.body
 # => [{ name: 'javascript' }, { name: 'react' }]
 ```

data/docbase.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 0.15.2'
-  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'faraday', '>= 0.15.2'
+  spec.add_dependency 'faraday_middleware', '>= 0.12.2'
 end

data/lib/docbase/client.rb

@@ -5,13 +5,15 @@ module DocBase
 
     class NotSetTeamError < StandardError; end
     class NotSetPostIdError < StandardError; end
+    class TooManyRequestError < StandardError; end
 
-    attr_accessor :team
+    attr_accessor :team, :access_token, :retry_on_rate_limit_exceeded
 
-    def initialize(access_token: nil, url: nil, team: nil)
-      @access_token = access_token || ENV['DOCBASE_ACCESS_TOKEN']
+    def initialize(access_token: nil, url: nil, team: nil, retry_on_rate_limit_exceeded: false)
+      self.access_token = access_token
       self.team = team
       @url = url || DEFAULT_URL
+      self.retry_on_rate_limit_exceeded = retry_on_rate_limit_exceeded
     end
 
     def team!
@@ -19,28 +21,24 @@ module DocBase
       @team
     end
 
-    def teams
-      connection.get('/teams')
-    end
-
     def users(q: nil, page: 1, per_page: 100, include_user_groups: false)
-      connection.get("/teams/#{team!}/users", q: q, page: page, per_page: per_page, include_user_groups: include_user_groups)
+      request(method: :get, path: "/teams/#{team!}/users", params: { q: q, page: page, per_page: per_page, include_user_groups: include_user_groups })
     end
 
     def tags
-      connection.get("/teams/#{team!}/tags")
+      request(method: :get, path: "/teams/#{team!}/tags")
     end
 
-    def groups
-      connection.get("/teams/#{team!}/groups")
+    def groups(name: nil, page: 1, per_page: 100)
+      request(method: :get, path: "/teams/#{team!}/groups", params: { name: name, page: page, per_page: per_page })
     end
 
     def group(id)
-      connection.get("/teams/#{team!}/groups/#{id}")
+      request(method: :get, path: "/teams/#{team!}/groups/#{id}")
     end
 
     def create_group(params)
-      connection.post("/teams/#{team!}/groups", params)
+      request(method: :post, path: "/teams/#{team!}/groups", params: params)
     end
 
     def add_users_to_group(params)
@@ -48,7 +46,7 @@ module DocBase
       raise NotSetTeamError if group_id <= 0
 
       users_params = except(params, :group_id)
-      connection.post("/teams/#{team!}/groups/#{group_id}/users", users_params)
+      request(method: :post, path: "/teams/#{team!}/groups/#{group_id}/users", params: users_params)
     end
 
     def remove_users_from_group(params)
@@ -56,19 +54,19 @@ module DocBase
       raise NotSetTeamError if group_id <= 0
 
       users_params = except(params, :group_id)
-      connection.delete("/teams/#{team!}/groups/#{group_id}/users", users_params)
+      request(method: :delete, path: "/teams/#{team!}/groups/#{group_id}/users", params: users_params)
     end
 
     def post(id)
-      connection.get("/teams/#{team!}/posts/#{id}")
+      request(method: :get, path: "/teams/#{team!}/posts/#{id}")
     end
 
     def posts(q: '*', page: 1, per_page: 20)
-      connection.get("/teams/#{team!}/posts", q: q, page: page, per_page: per_page)
+      request(method: :get, path: "/teams/#{team!}/posts", params: { q: q, page: page, per_page: per_page })
     end
 
     def create_post(params)
-      connection.post("/teams/#{team!}/posts", params)
+      request(method: :post, path: "/teams/#{team!}/posts", params: params)
     end
 
     def update_post(params)
@@ -76,19 +74,19 @@ module DocBase
       raise NotSetTeamError if post_id <= 0
 
       post_params = except(params, :id)
-      connection.patch("/teams/#{team!}/posts/#{post_id}", post_params)
+      request(method: :patch, path: "/teams/#{team!}/posts/#{post_id}", params: post_params)
     end
 
     def delete_post(id)
-      connection.delete("/teams/#{team!}/posts/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/posts/#{id}")
     end
 
     def archive_post(id)
-      connection.put("/teams/#{team!}/posts/#{id}/archive")
+      request(method: :put, path: "/teams/#{team!}/posts/#{id}/archive")
     end
 
     def unarchive_post(id)
-      connection.put("/teams/#{team!}/posts/#{id}/unarchive")
+      request(method: :put, path: "/teams/#{team!}/posts/#{id}/unarchive")
     end
 
     def create_comment(params)
@@ -96,11 +94,11 @@ module DocBase
       raise NotSetTeamError if post_id <= 0
 
       comment_params = except(params, :post_id)
-      connection.post("/teams/#{team!}/posts/#{post_id}/comments", params)
+      request(method: :post, path: "/teams/#{team!}/posts/#{post_id}/comments", params: params)
     end
 
     def delete_comment(id)
-      connection.delete("/teams/#{team!}/comments/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/comments/#{id}")
     end
 
     def upload(paths)
@@ -114,7 +112,11 @@ module DocBase
         }
       end
 
-      connection.post("/teams/#{team!}/attachments", params)
+      request(method: :post, path: "/teams/#{team!}/attachments", params: params)
+    end
+
+    def attachment(id)
+      request(method: :get, path: "/teams/#{team!}/attachments/#{id}", for_binary: true)
     end
 
     private
@@ -131,13 +133,37 @@ module DocBase
       end
     end
 
+    def connection_for_binary
+      @connection ||= Faraday.new({ url: @url, headers: headers }) do |faraday|
+        faraday.request :json
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
     def headers
       {
         'Accept'         => 'application/json',
         'User-Agent'     => USER_AGENT,
-        'X-DocBaseToken' => @access_token,
-        'X-Api-Version'  => '1',
+        'X-DocBaseToken' => access_token,
+        'X-Api-Version'  => '2',
       }
     end
+
+    def request(method:, path:, params: nil, for_binary: false)
+      response = for_binary ? connection_for_binary.send(method, path, params) : connection.send(method, path, params)
+      raise TooManyRequestError if retry_on_rate_limit_exceeded && response.status == 429
+      response
+    rescue TooManyRequestError
+      reset_time = response.headers['x-ratelimit-reset'].to_i
+      puts "DocBase API Rate limit exceeded: will retry at #{Time.at(reset_time).strftime("%Y/%m/%d %H:%M:%S")}."
+      wait_for(reset_time)
+      retry
+    end
+
+    def wait_for(reset_time)
+      wait_time = reset_time - Time.now.to_i
+      return if wait_time <= 0
+      sleep wait_time
+    end
   end
 end

data/lib/docbase/version.rb

@@ -1,3 +1,3 @@
 module DocBase
-  VERSION = '1.0.1'
+  VERSION = '2.1.2'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.2
 platform: ruby
 authors:
 - ttakuru88
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.2
 description: DocBase API Client, written in Ruby
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: DocBase API Client, written in Ruby