docbase 2.1.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20af66cc5d5085854e9aef5f65e57383291a8f217961a4fa6cead0bb2e678941
-  data.tar.gz: 24cf39072ac1eaf9c4cc700f6ee2bcc694939b5c4d26427cb932aedeabf499f0
+  metadata.gz: db7bc6f5163f765c5a16ec85c3a190c894e87b484acac0901458f44b81ca0355
+  data.tar.gz: 0eaace24913ca86fa825a2da026da6f9aff7e3a5cad1af5df1f505a91ec39d6e
 SHA512:
-  metadata.gz: 12a494552034d86ba01f68a95e30a438ed068307223d83dd23b9e92fa23f15a85dc98cee60577342696b123ec2b5153f0935d77b58a3887f810da919beb7b0f8
-  data.tar.gz: d5dc0fea1f5d08a13ea5df13c38c504e11a80b5a82f121ce9afe7d087cb1d4b06d48188434939bd41758a67029aacc692fd7db8466fd5db9c1f2fe6023a3ef7c
+  metadata.gz: 84a27324711539c8ffaea3365cbb1b75b8b2d6041d9f385b4994099657e183d4d42929c873701b4fed2e682c4164e240a03e5417f89c5897d20c2be3efd90fb4
+  data.tar.gz: 7a715b93cad6b2167bb98ca766698924e87ad63aa3034afe977fc60a97c07130cbb10c6f259e4a80c4fcad674abdea15b6a422faffa157378af5305d2e40c9f0

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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対応
+* プロフィール、所属グループ一覧、メンバー削除、コメント一覧、メモ本文部分更新、グッジョブAPIを追加
+* `users`の`include_user_groups`引数を削除（v3で廃止）
+* Ruby 3.4以降向けに`base64`依存を追加
+* `X-Api-Version`ヘッダを削除（v3トークンでAPIバージョンが決まる）
+* `create_comment`が`post_id`をリクエストボディに含めてしまう不具合を修正
+* バイナリ取得用コネクションがJSON用と共有されていた不具合を修正
+
 ## 2.1.2
 
 * 利用制限時にリトライできるように

data/README.md

@@ -35,6 +35,13 @@ 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
+
+```ruby
+client.profile.body
+```
 
 ### users
 
@@ -42,7 +49,21 @@ client = DocBase::Client.new(access_token: 'your_access_token', team: 'your_team
 client.users(q: 'name')
 client.users(q: 'name', page: 2)
 client.users(q: 'name', page: 1, per_page: 100)
-client.users(q: 'name', page: 1, per_page: 100, include_user_groups: true)
+```
+
+所属グループはv3ではユーザー検索APIのレスポンスに含まれません。`user_groups`を利用してください。
+
+#### User groups
+
+```ruby
+client.user_groups(1).body
+client.user_groups(1, page: 2, per_page: 20).body
+```
+
+#### Delete user
+
+```ruby
+client.delete_user(1)
 ```
 
 ### tags
@@ -150,6 +171,25 @@ params = {
 client.update_post(params)
 ```
 
+#### Partial body update
+
+```ruby
+params = {
+  id: 1,
+  operations: [
+    {
+      start: 3,
+      end: 5,
+      old_content: "line3\r\nline4\r\nline5",
+      content: 'new text',
+    },
+  ],
+  notice: true,
+}
+
+client.update_post_body(params)
+```
+
 #### Archive
 
 ```ruby
@@ -170,6 +210,13 @@ client.delete_post(1)
 
 ### Comment
 
+#### List
+
+```ruby
+client.comments(1).body
+client.comments(1, page: 2, per_page: 20, order: 'desc').body
+```
+
 #### Create
 
 ```ruby
@@ -188,6 +235,28 @@ client.create_comment(params)
 client.delete_comment(1)
 ```
 
+### good jobs
+
+#### List
+
+```ruby
+client.good_jobs(1).body
+client.good_jobs(1, page: 2, per_page: 100, order: 'desc').body
+```
+
+#### Create
+
+```ruby
+client.create_good_job(1)
+client.create_good_job(1, notice: false)
+```
+
+#### Delete
+
+```ruby
+client.delete_good_job(1, 111)
+```
+
 ### attachments
 
 #### Create

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 'base64'
+  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,11 +22,33 @@ module DocBase
 
     def team!
       raise NotSetTeamError unless @team
+      raise ArgumentError, "invalid team: #{@team.inspect}" unless TEAM_FORMAT.match?(@team.to_s)
+
       @team
     end
 
-    def users(q: nil, page: 1, per_page: 100, include_user_groups: false)
-      request(method: :get, path: "/teams/#{team!}/users", params: { q: q, page: page, per_page: per_page, include_user_groups: include_user_groups })
+    def profile
+      request(method: :get, path: "/teams/#{team!}/profile")
+    end
+
+    def users(q: nil, page: 1, per_page: 100)
+      request(
+        method: :get,
+        path: "/teams/#{team!}/users",
+        params: { q: q, page: page, per_page: per_page }
+      )
+    end
+
+    def user_groups(user_id, page: 1, per_page: 20)
+      request(
+        method: :get,
+        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_segment(id)}")
     end
 
     def tags
@@ -34,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)
@@ -58,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)
@@ -71,34 +97,78 @@ module DocBase
 
     def update_post(params)
       post_id = params[:id].to_i
-      raise NotSetTeamError if post_id <= 0
+      raise NotSetPostIdError if post_id <= 0
 
       post_params = except(params, :id)
       request(method: :patch, path: "/teams/#{team!}/posts/#{post_id}", params: post_params)
     end
 
+    def update_post_body(params)
+      post_id = params[:id].to_i
+      raise NotSetPostIdError if post_id <= 0
+
+      body_params = except(params, :id)
+      request(method: :patch, path: "/teams/#{team!}/posts/#{post_id}/body", params: body_params)
+    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/#{id_segment(post_id)}/comments",
+        params: {
+          page: page,
+          per_page: per_page,
+          order: order,
+          created_after: created_after,
+          created_before: created_before,
+        }
+      )
     end
 
     def create_comment(params)
       post_id = params[:post_id].to_i
-      raise NotSetTeamError if post_id <= 0
+      raise NotSetPostIdError if post_id <= 0
 
       comment_params = except(params, :post_id)
-      request(method: :post, path: "/teams/#{team!}/posts/#{post_id}/comments", params: params)
+      request(method: :post, path: "/teams/#{team!}/posts/#{post_id}/comments", params: comment_params)
     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/#{id_segment(post_id)}/good_jobs",
+        params: {
+          page: page,
+          per_page: per_page,
+          order: order,
+          created_after: created_after,
+          created_before: created_before,
+        }
+      )
+    end
+
+    def create_good_job(post_id, 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/#{id_segment(post_id)}/good_jobs/#{id_segment(good_job_id)}")
     end
 
     def upload(paths)
@@ -116,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
@@ -134,7 +217,7 @@ module DocBase
     end
 
     def connection_for_binary
-      @connection ||= Faraday.new({ url: @url, headers: headers }) do |faraday|
+      @connection_for_binary ||= Faraday.new({ url: @url, headers: headers }) do |faraday|
         faraday.request :json
         faraday.adapter Faraday.default_adapter
       end
@@ -142,28 +225,35 @@ module DocBase
 
     def headers
       {
-        'Accept'         => 'application/json',
-        'User-Agent'     => USER_AGENT,
-        'X-DocBaseToken' => access_token,
-        'X-Api-Version'  => '2',
+        'Accept'     => 'application/json',
+        'User-Agent' => USER_AGENT,
       }
     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
+      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 = '2.1.2'
+  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,43 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.1.0
 platform: ruby
 authors:
 - ttakuru88
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 2.14.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        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
@@ -64,7 +69,6 @@ homepage: https://github.com/krayinc/docbase-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: DocBase API Client, written in Ruby
 test_files: []