docbase 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c70d4491502f49f4510006bcc8f630d7b207c2e33b4d40dc11cbd4749b0ae4
-  data.tar.gz: 206860601acdc3d22e1a315c0ddce113f6b6776a309570cbe4804e7f878a0cf4
+  metadata.gz: 04de1814e9cdba377e46783519ead41b3471972cd19d4e32c058eb952ad9261d
+  data.tar.gz: 30f7944856b0157e89cc178b72f2d437a2ae1b1a6352b6437840566d461115fa
 SHA512:
-  metadata.gz: dbe5ff0494d2605b6aacea6a1b95b417ca710e302233bce291da160cd6b311785e684a4d5492f5c2824500d9a6b0d67f1966cc1d5733dedb8283c5d88f9bf8a9
-  data.tar.gz: a9b8d6813eb18db3599a1ad4019f9d45f29441caea3c0e5d47ee33734e7eacd8b1837e9cdffbee281c6cc726dd08e8e006d81d61c972e83607296db395ea2468
+  metadata.gz: 63c7b0575d1b5ca821ae2cf0c6cde0ba94514321ce061f7f8f4c1e8a63e6ab8040e2d219a857d87b5b71e375e539faf16e427f900fa5265b2fcda755bc901644
+  data.tar.gz: af1764af0574365f63fdc14e9a206fb983632cb17c705cb442f68f9228c92b87a4c4c8af2fa66bf31200c77b0b02a408c85fa023445d62c0cfe9c4565d61dc2c

data/CHANGELOG.md

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

data/README.md

@@ -26,13 +26,43 @@ 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
+
+### profile
+
+```ruby
+client.profile.body
+```
+
 ### users
 
 ```ruby
 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
@@ -140,6 +170,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
@@ -160,6 +209,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
@@ -178,6 +234,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,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'base64'
   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, :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!
@@ -19,24 +21,44 @@ module DocBase
       @team
     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)
+    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/#{user_id}/groups",
+        params: { page: page, per_page: per_page }
+      )
+    end
+
+    def delete_user(id)
+      request(method: :delete, path: "/teams/#{team!}/users/#{id}")
     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 +66,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,51 +74,95 @@ 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)
       post_id = params[:id].to_i
-      raise NotSetTeamError if post_id <= 0
+      raise NotSetPostIdError 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 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)
-      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 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",
+        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)
-      connection.post("/teams/#{team!}/posts/#{post_id}/comments", params)
+      request(method: :post, path: "/teams/#{team!}/posts/#{post_id}/comments", params: comment_params)
     end
 
     def delete_comment(id)
-      connection.delete("/teams/#{team!}/comments/#{id}")
+      request(method: :delete, path: "/teams/#{team!}/comments/#{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",
+        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/#{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}")
     end
 
     def upload(paths)
@@ -110,11 +176,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
@@ -132,7 +198,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
@@ -143,8 +209,25 @@ module DocBase
         'Accept'         => 'application/json',
         'User-Agent'     => USER_AGENT,
         'X-DocBaseToken' => access_token,
-        'X-Api-Version'  => '2',
       }
     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
+    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 = '3.0.0'
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: docbase
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - ttakuru88
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -64,7 +77,6 @@ homepage: https://github.com/krayinc/docbase-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: DocBase API Client, written in Ruby
 test_files: []