docbase 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c70d4491502f49f4510006bcc8f630d7b207c2e33b4d40dc11cbd4749b0ae4
-  data.tar.gz: 206860601acdc3d22e1a315c0ddce113f6b6776a309570cbe4804e7f878a0cf4
+  metadata.gz: 20af66cc5d5085854e9aef5f65e57383291a8f217961a4fa6cead0bb2e678941
+  data.tar.gz: 24cf39072ac1eaf9c4cc700f6ee2bcc694939b5c4d26427cb932aedeabf499f0
 SHA512:
-  metadata.gz: dbe5ff0494d2605b6aacea6a1b95b417ca710e302233bce291da160cd6b311785e684a4d5492f5c2824500d9a6b0d67f1966cc1d5733dedb8283c5d88f9bf8a9
-  data.tar.gz: a9b8d6813eb18db3599a1ad4019f9d45f29441caea3c0e5d47ee33734e7eacd8b1837e9cdffbee281c6cc726dd08e8e006d81d61c972e83607296db395ea2468
+  metadata.gz: 12a494552034d86ba01f68a95e30a438ed068307223d83dd23b9e92fa23f15a85dc98cee60577342696b123ec2b5153f0935d77b58a3887f810da919beb7b0f8
+  data.tar.gz: d5dc0fea1f5d08a13ea5df13c38c504e11a80b5a82f121ce9afe7d087cb1d4b06d48188434939bd41758a67029aacc692fd7db8466fd5db9c1f2fe6023a3ef7c

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.2
+
+* 利用制限時にリトライできるように
+
 ## 2.1.1
 
 * グループ取得APIにグループ名/ページネーションが渡せてるように fix: #17

data/README.md

@@ -26,6 +26,16 @@ Or install it yourself as:
 client = DocBase::Client.new(access_token: 'your_access_token', team: 'your_team')
 ```
 
+### Docbase::Client.new options
+
+* 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
 
 ```ruby

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, :access_token
+    attr_accessor :team, :access_token, :retry_on_rate_limit_exceeded
 
-    def initialize(access_token: nil, url: nil, team: nil)
+    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!
@@ -20,23 +22,23 @@ module DocBase
     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(name: nil, page: 1, per_page: 100)
-      connection.get("/teams/#{team!}/groups", name: name, page: page, per_page: per_page)
+      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)
@@ -44,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)
@@ -52,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)
@@ -72,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)
@@ -92,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)
@@ -110,11 +112,11 @@ module DocBase
         }
       end
 
-      connection.post("/teams/#{team!}/attachments", params)
+      request(method: :post, path: "/teams/#{team!}/attachments", params: params)
     end
 
     def attachment(id)
-      connection_for_binary.get("/teams/#{team!}/attachments/#{id}")
+      request(method: :get, path: "/teams/#{team!}/attachments/#{id}", for_binary: true)
     end
 
     private
@@ -146,5 +148,22 @@ module DocBase
         '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 = '2.1.1'
+  VERSION = '2.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - ttakuru88
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: DocBase API Client, written in Ruby