docbase 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04de1814e9cdba377e46783519ead41b3471972cd19d4e32c058eb952ad9261d
-  data.tar.gz: 30f7944856b0157e89cc178b72f2d437a2ae1b1a6352b6437840566d461115fa
+  metadata.gz: db7bc6f5163f765c5a16ec85c3a190c894e87b484acac0901458f44b81ca0355
+  data.tar.gz: 0eaace24913ca86fa825a2da026da6f9aff7e3a5cad1af5df1f505a91ec39d6e
 SHA512:
-  metadata.gz: 63c7b0575d1b5ca821ae2cf0c6cde0ba94514321ce061f7f8f4c1e8a63e6ab8040e2d219a857d87b5b71e375e539faf16e427f900fa5265b2fcda755bc901644
-  data.tar.gz: af1764af0574365f63fdc14e9a206fb983632cb17c705cb442f68f9228c92b87a4c4c8af2fa66bf31200c77b0b02a408c85fa023445d62c0cfe9c4565d61dc2c
+  metadata.gz: 84a27324711539c8ffaea3365cbb1b75b8b2d6041d9f385b4994099657e183d4d42929c873701b4fed2e682c4164e240a03e5417f89c5897d20c2be3efd90fb4
+  data.tar.gz: 7a715b93cad6b2167bb98ca766698924e87ad63aa3034afe977fc60a97c07130cbb10c6f259e4a80c4fcad674abdea15b6a422faffa157378af5305d2e40c9f0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.1.0
+
+* faradayを2.14.4以上3未満に変更し、faraday_middlewareへの依存を削除（faraday 2.14.3以前では使えなくなります）
+* `access_token`を差し替えても古いトークンで送信される不具合を修正
+* IDやチーム名が不正なときはURLに埋め込まず`ArgumentError`にするように
+* 利用制限時のリトライに上限を追加（3回まで、1回の待ちは60秒まで）。有効な`X-RateLimit-Reset`がない429はリトライしない
+
 ## 3.0.0
 
 * DocBase API v3対応

data/README.md

@@ -35,6 +35,7 @@ client = DocBase::Client.new(access_token: 'your_access_token', team: 'your_team
 * retry_on_rate_limit_exceeded
     * [#16](https://github.com/krayinc/docbase-ruby/issues/16)
     * true or false
+    * When true, a 429 response is retried after waiting until `X-RateLimit-Reset`, up to 3 times and at most 60 seconds per wait. A 429 response without a valid `X-RateLimit-Reset` is returned without retrying.
 
 ### profile
 

data/docbase.gemspec

@@ -18,6 +18,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'base64'
-  spec.add_dependency 'faraday', '>= 0.15.2'
-  spec.add_dependency 'faraday_middleware', '>= 0.12.2'
+  spec.add_dependency 'faraday', '>= 2.14.4', '< 3'
 end

data/lib/docbase/client.rb

@@ -1,7 +1,11 @@
 module DocBase
   class Client
     DEFAULT_URL = 'https://api.docbase.io'
+    TEAM_FORMAT = /\A[a-z0-9]+(-[a-z0-9]+)*\z/
+    ID_FORMAT = /\A[1-9][0-9]*\z/
     USER_AGENT = "DocBase Ruby Gem #{DocBase::VERSION}"
+    MAX_RATE_LIMIT_RETRIES = 3
+    MAX_RATE_LIMIT_WAIT_SECONDS = 60
 
     class NotSetTeamError < StandardError; end
     class NotSetPostIdError < StandardError; end
@@ -18,6 +22,8 @@ module DocBase
 
     def team!
       raise NotSetTeamError unless @team
+      raise ArgumentError, "invalid team: #{@team.inspect}" unless TEAM_FORMAT.match?(@team.to_s)
+
       @team
     end
 
@@ -36,13 +42,13 @@ module DocBase
     def user_groups(user_id, page: 1, per_page: 20)
       request(
         method: :get,
-        path: "/teams/#{team!}/users/#{user_id}/groups",
+        path: "/teams/#{team!}/users/#{id_segment(user_id)}/groups",
         params: { page: page, per_page: per_page }
       )
     end
 
     def delete_user(id)
-      request(method: :delete, path: "/teams/#{team!}/users/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/users/#{id_segment(id)}")
     end
 
     def tags
@@ -54,7 +60,7 @@ module DocBase
     end
 
     def group(id)
-      request(method: :get, path: "/teams/#{team!}/groups/#{id}")
+      request(method: :get, path: "/teams/#{team!}/groups/#{id_segment(id)}")
     end
 
     def create_group(params)
@@ -78,7 +84,7 @@ module DocBase
     end
 
     def post(id)
-      request(method: :get, path: "/teams/#{team!}/posts/#{id}")
+      request(method: :get, path: "/teams/#{team!}/posts/#{id_segment(id)}")
     end
 
     def posts(q: '*', page: 1, per_page: 20)
@@ -106,21 +112,21 @@ module DocBase
     end
 
     def delete_post(id)
-      request(method: :delete, path: "/teams/#{team!}/posts/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/posts/#{id_segment(id)}")
     end
 
     def archive_post(id)
-      request(method: :put, path: "/teams/#{team!}/posts/#{id}/archive")
+      request(method: :put, path: "/teams/#{team!}/posts/#{id_segment(id)}/archive")
     end
 
     def unarchive_post(id)
-      request(method: :put, path: "/teams/#{team!}/posts/#{id}/unarchive")
+      request(method: :put, path: "/teams/#{team!}/posts/#{id_segment(id)}/unarchive")
     end
 
     def comments(post_id, page: 1, per_page: 20, order: 'asc', created_after: nil, created_before: nil)
       request(
         method: :get,
-        path: "/teams/#{team!}/posts/#{post_id}/comments",
+        path: "/teams/#{team!}/posts/#{id_segment(post_id)}/comments",
         params: {
           page: page,
           per_page: per_page,
@@ -140,13 +146,13 @@ module DocBase
     end
 
     def delete_comment(id)
-      request(method: :delete, path: "/teams/#{team!}/comments/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/comments/#{id_segment(id)}")
     end
 
     def good_jobs(post_id, page: 1, per_page: 100, order: 'asc', created_after: nil, created_before: nil)
       request(
         method: :get,
-        path: "/teams/#{team!}/posts/#{post_id}/good_jobs",
+        path: "/teams/#{team!}/posts/#{id_segment(post_id)}/good_jobs",
         params: {
           page: page,
           per_page: per_page,
@@ -158,11 +164,11 @@ module DocBase
     end
 
     def create_good_job(post_id, params = {})
-      request(method: :post, path: "/teams/#{team!}/posts/#{post_id}/good_jobs", params: params)
+      request(method: :post, path: "/teams/#{team!}/posts/#{id_segment(post_id)}/good_jobs", params: params)
     end
 
     def delete_good_job(post_id, good_job_id)
-      request(method: :delete, path: "/teams/#{team!}/posts/#{post_id}/good_jobs/#{good_job_id}")
+      request(method: :delete, path: "/teams/#{team!}/posts/#{id_segment(post_id)}/good_jobs/#{id_segment(good_job_id)}")
     end
 
     def upload(paths)
@@ -180,11 +186,24 @@ module DocBase
     end
 
     def attachment(id)
-      request(method: :get, path: "/teams/#{team!}/attachments/#{id}", for_binary: true)
+      request(method: :get, path: "/teams/#{team!}/attachments/#{path_segment(id)}", for_binary: true)
     end
 
     private
 
+    def id_segment(id)
+      raise ArgumentError, "invalid id: #{id.inspect}" unless ID_FORMAT.match?(id.to_s)
+
+      id.to_s
+    end
+
+    def path_segment(value)
+      value = value.to_s
+      raise ArgumentError, "invalid id: #{value.inspect}" if value.empty? || value == '.' || value == '..'
+
+      URI.encode_www_form_component(value).gsub('+', '%20')
+    end
+
     def except(hash, reject_key)
       hash.reject { |key, _| key == reject_key }
     end
@@ -206,28 +225,35 @@ module DocBase
 
     def headers
       {
-        'Accept'         => 'application/json',
-        'User-Agent'     => USER_AGENT,
-        'X-DocBaseToken' => access_token,
+        'Accept'     => 'application/json',
+        'User-Agent' => USER_AGENT,
       }
     end
 
     def request(method:, path:, params: nil, for_binary: false)
-      conn = for_binary ? connection_for_binary : connection
-      response = conn.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
+      retries = 0
+      loop do
+        conn = for_binary ? connection_for_binary : connection
+        response = conn.send(method, path, params, 'X-DocBaseToken' => access_token)
+        return response unless retry_on_rate_limit_exceeded && response.status == 429
+
+        reset_time = rate_limit_reset_time(response)
+        return response if reset_time.nil? || retries >= MAX_RATE_LIMIT_RETRIES
+
+        retries += 1
+        wait_for(reset_time)
+      end
+    end
+
+    def rate_limit_reset_time(response)
+      reset_time = Integer(response.headers['x-ratelimit-reset'].to_s, exception: false)
+      reset_time if reset_time && reset_time > 0
     end
 
     def wait_for(reset_time)
-      wait_time = reset_time - Time.now.to_i
-      return if wait_time <= 0
-      sleep wait_time
+      wait_time = (reset_time - Time.now.to_i).clamp(0, MAX_RATE_LIMIT_WAIT_SECONDS)
+      puts "DocBase API Rate limit exceeded: will retry at #{(Time.now + wait_time).strftime("%Y/%m/%d %H:%M:%S")}."
+      sleep wait_time if wait_time > 0
     end
   end
 end

data/lib/docbase/version.rb

@@ -1,3 +1,3 @@
 module DocBase
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/lib/docbase.rb

@@ -1,5 +1,4 @@
 require 'base64'
 require 'faraday'
-require 'faraday_middleware'
 require 'docbase/version'
 require 'docbase/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - ttakuru88
@@ -29,28 +29,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 2.14.4
+    - - "<"
       - !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
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 2.14.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: DocBase API Client, written in Ruby
 email:
 - asaumi+docbase-ruby@kray.jp
@@ -91,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: DocBase API Client, written in Ruby
 test_files: []