chatwork 0.7.0 → 0.8.0

data/lib/chatwork/invitation_link.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module InvitationLink
-    extend EntityMethods
-
     # Get invitation link
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-link
@@ -9,6 +7,10 @@ module ChatWork
     #
     # @param room_id [Integer]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -18,8 +20,8 @@ module ChatWork
     #     "need_acceptance": true,
     #     "description": "Link description text"
     #   }
-    def self.get(room_id:)
-      _get("/rooms/#{room_id}/link")
+    def self.get(room_id:, &block)
+      ChatWork.client.get_invitation_link(room_id: room_id, &block)
     end
 
     # Create invitation link
@@ -32,6 +34,10 @@ module ChatWork
     # @param description [String] description of link page
     # @param need_acceptance [Boolean] Approval necessity. Whether participation requires administrator approval.
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -41,13 +47,8 @@ module ChatWork
     #     "need_acceptance": true,
     #     "description": "This is a public room for topic A."
     #   }
-    def self.create(room_id:, code: nil, description: nil, need_acceptance: nil)
-      params = {
-        code:            code,
-        description:     description,
-        need_acceptance: boolean_to_integer(need_acceptance),
-      }
-      _post("/rooms/#{room_id}/link", params)
+    def self.create(room_id:, code: nil, description: nil, need_acceptance: nil, &block)
+      ChatWork.client.create_invitation_link(room_id: room_id, code: code, description: description, need_acceptance: need_acceptance, &block)
     end
 
     # Update invitation link
@@ -60,6 +61,10 @@ module ChatWork
     # @param description [String] description of link page
     # @param need_acceptance [Boolean] Approval necessity. Whether participation requires administrator approval.
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -69,13 +74,8 @@ module ChatWork
     #     "need_acceptance": false,
     #     "description": "Public room for everybody"
     #   }
-    def self.update(room_id:, code: nil, description: nil, need_acceptance: nil)
-      params = {
-        code:            code,
-        description:     description,
-        need_acceptance: boolean_to_integer(need_acceptance),
-      }
-      _put("/rooms/#{room_id}/link", params)
+    def self.update(room_id:, code: nil, description: nil, need_acceptance: nil, &block)
+      ChatWork.client.update_invitation_link(room_id: room_id, code: code, description: description, need_acceptance: need_acceptance, &block)
     end
 
     # Delete invitation link
@@ -85,14 +85,18 @@ module ChatWork
     #
     # @param room_id [Integer]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
     #   {
     #     "public": false
     #   }
-    def self.destroy(room_id:)
-      _delete("/rooms/#{room_id}/link")
+    def self.destroy(room_id:, &block)
+      ChatWork.client.destroy_invitation_link(room_id: room_id, &block)
     end
   end
 end

data/lib/chatwork/me.rb

@@ -1,12 +1,14 @@
 module ChatWork
   module Me
-    extend EntityMethods
-
     # Get your account information
     #
     # @see http://developer.chatwork.com/ja/endpoint_me.html#GET-me
     # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -31,8 +33,8 @@ module ChatWork
     #     "avatar_image_url": "https://example.com/abc.png",
     #     "login_mail": "account@example.com"
     #   }
-    def self.get
-      _get("/me")
+    def self.get(&block)
+      ChatWork.client.get_me(&block)
     end
   end
 end

data/lib/chatwork/member.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module Member
-    extend EntityMethods
-
     # Get the list of all chat members associated with the specified chat
     #
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-members
@@ -9,6 +7,10 @@ module ChatWork
     #
     # @param room_id [Integer]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Array<Hashie::Mash>] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Array<Hashie::Mash>]
     #
     # @example response format
@@ -24,8 +26,8 @@ module ChatWork
     #       "avatar_image_url": "https://example.com/abc.png"
     #     }
     #   ]
-    def self.get(room_id:)
-      _get("/rooms/#{room_id}/members")
+    def self.get(room_id:, &block)
+      ChatWork.client.get_members(room_id: room_id, &block)
     end
 
     # Change associated members of group chat at once
@@ -39,6 +41,10 @@ module ChatWork
     # @param members_member_ids [Array<Integer>, String] List of user IDs who will be given member permission for the group chat.
     # @param members_readonly_ids [Array<Integer>, String] List of user IDs who will be given read-only permission for the group chat.
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -47,14 +53,14 @@ module ChatWork
     #     "member": [10, 103],
     #     "readonly": [6, 11]
     #   }
-    def self.update_all(room_id:, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil)
-      params = {
-        members_admin_ids: Array(members_admin_ids).join(","),
-      }
-      params[:members_member_ids] = Array(members_member_ids).join(",") if members_member_ids
-      params[:members_readonly_ids] = Array(members_readonly_ids).join(",") if members_readonly_ids
-
-      _put("/rooms/#{room_id}/members", params)
+    def self.update_all(room_id:, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, &block)
+      ChatWork.client.update_all_members(
+        room_id:              room_id,
+        members_admin_ids:    members_admin_ids,
+        members_member_ids:   members_member_ids,
+        members_readonly_ids: members_readonly_ids,
+        &block
+      )
     end
   end
 end

data/lib/chatwork/message.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module Message
-    extend EntityMethods
-
     # Get all messages associated with the specified chat (returns up to 100 entries).
     #
     # If the parameter is not set, it returns the next 100 entries from previous call.
@@ -12,6 +10,10 @@ module ChatWork
     # @param room_id [Integer]
     # @param force   [Boolean, Integer] Flag which forces to get 100 newest entries regardless of previous calls.
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Array<Hashie::Mash>] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Array<Hashie::Mash>]
     #
     # @example response format
@@ -28,8 +30,8 @@ module ChatWork
     #       "update_time": 0
     #     }
     #   ]
-    def self.get(room_id:, force: nil)
-      _get("/rooms/#{room_id}/messages", force: boolean_to_integer(force))
+    def self.get(room_id:, force: nil, &block)
+      ChatWork.client.get_messages(room_id: room_id, force: force, &block)
     end
 
     # Add new message to the chat
@@ -40,14 +42,18 @@ module ChatWork
     # @param room_id [Integer]
     # @param body    [String] message body
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
     #   {
     #     "message_id": "1234"
     #   }
-    def self.create(room_id:, body:)
-      _post("/rooms/#{room_id}/messages", body: body)
+    def self.create(room_id:, body:, &block)
+      ChatWork.client.create_message(room_id: room_id, body: body, &block)
     end
 
     # Mark messages as read
@@ -58,6 +64,10 @@ module ChatWork
     # @param room_id [Integer]
     # @param message_id [String]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -65,8 +75,8 @@ module ChatWork
     #     "unread_num": 461,
     #     "mention_num": 0
     #   }
-    def self.read(room_id:, message_id: nil)
-      _put("/rooms/#{room_id}/messages/read", message_id: message_id)
+    def self.read(room_id:, message_id: nil, &block)
+      ChatWork.client.read_message(room_id: room_id, message_id: message_id, &block)
     end
 
     # Mark messages as unread
@@ -77,6 +87,10 @@ module ChatWork
     # @param room_id [Integer]
     # @param message_id [String]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -84,8 +98,8 @@ module ChatWork
     #     "unread_num": 3,
     #     "mention_num": 0
     #   }
-    def self.unread(room_id:, message_id:)
-      _put("/rooms/#{room_id}/messages/unread", message_id: message_id)
+    def self.unread(room_id:, message_id:, &block)
+      ChatWork.client.unread_message(room_id: room_id, message_id: message_id, &block)
     end
 
     # Get information about the specified message
@@ -96,6 +110,10 @@ module ChatWork
     # @param room_id [Integer]
     # @param message_id [String]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -110,8 +128,8 @@ module ChatWork
     #     "send_time": 1384242850,
     #     "update_time": 0
     #   }
-    def self.find(room_id:, message_id:)
-      _get("/rooms/#{room_id}/messages/#{message_id}")
+    def self.find(room_id:, message_id:, &block)
+      ChatWork.client.find_message(room_id: room_id, message_id: message_id, &block)
     end
 
     # Update the specified message
@@ -123,14 +141,18 @@ module ChatWork
     # @param message_id [String]
     # @param body [String] message body
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
     #   {
     #     "message_id": "1234"
     #   }
-    def self.update(room_id:, message_id:, body:)
-      _put("/rooms/#{room_id}/messages/#{message_id}", body: body)
+    def self.update(room_id:, message_id:, body:, &block)
+      ChatWork.client.update_message(room_id: room_id, message_id: message_id, body: body, &block)
     end
 
     # Destroy the specified message
@@ -141,14 +163,18 @@ module ChatWork
     # @param room_id [Integer]
     # @param message_id [String]
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
     #   {
     #     "message_id": "1234"
     #   }
-    def self.destroy(room_id:, message_id:)
-      _delete("/rooms/#{room_id}/messages/#{message_id}")
+    def self.destroy(room_id:, message_id:, &block)
+      ChatWork.client.destroy_message(room_id: room_id, message_id: message_id, &block)
     end
   end
 end

data/lib/chatwork/my_status.rb

@@ -1,12 +1,14 @@
 module ChatWork
   module MyStatus
-    extend EntityMethods
-
     # Get the number of: unread messages, unread To messages, and unfinished tasks.
     #
     # @see http://developer.chatwork.com/ja/endpoint_my.html#GET-my-status
     # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Hashie::Mash]
     #
     # @example response format
@@ -18,8 +20,8 @@ module ChatWork
     #     "mention_num": 1,
     #     "mytask_num": 8
     #   }
-    def self.get
-      _get("/my/status")
+    def self.get(&block)
+      ChatWork.client.get_my_status(&block)
     end
   end
 end

data/lib/chatwork/my_task.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module MyTask
-    extend EntityMethods
-
     # Get the list of all unfinished tasks
     #
     # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
@@ -12,6 +10,10 @@ module ChatWork
     # @param assigned_by_account_id [Integer] Account ID of the person who assigned task
     # @param status [String] Task status (open, done)
     #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Array<Hashie::Mash>] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
     # @return [Array<Hashie::Mash>]
     #
     # @example response format
@@ -34,8 +36,8 @@ module ChatWork
     #       "status": "open"
     #     }
     #   ]
-    def self.get(assigned_by_account_id: nil, status: nil)
-      _get("/my/tasks", assigned_by_account_id: assigned_by_account_id, status: status)
+    def self.get(assigned_by_account_id: nil, status: nil, &block)
+      ChatWork.client.get_my_tasks(assigned_by_account_id: assigned_by_account_id, status: status, &block)
     end
   end
 end

data/lib/chatwork/oauth_client.rb

@@ -2,9 +2,17 @@ require "base64"
 
 module ChatWork
   class OAuthClient < BaseClient
-    def initialize(client_id, client_secret, oauth_api_base)
+    require "chatwork/oauth_client/token_methods"
+
+    include TokenMethods
+
+    # @param client_id     [String]
+    # @param client_secret [String]
+    # @param api_base      [String] default is {ChatWork.oauth_api_base}
+    def initialize(client_id:, client_secret:, api_base: nil)
+      api_base ||= ChatWork.oauth_api_base
       signature = Base64.encode64("#{client_id}:#{client_secret}").delete("\n")
-      super(oauth_api_base, "", { "Authorization" => "Basic #{signature}" })
+      super(api_base: api_base, header: { "Authorization" => "Basic #{signature}" })
     end
   end
 end

data/lib/chatwork/oauth_client/token_methods.rb

@@ -0,0 +1,25 @@
+module ChatWork::OAuthClient::TokenMethods
+  # refresh access_token with refresh_token
+  #
+  # @param refresh_token [String]
+  # @param scope [Array<String>]
+  #
+  # @return [Hash]
+  # @example response
+  #   {
+  #     "access_token" => "new_access_token",
+  #     "token_type" => "Bearer",
+  #     "expires_in" => "1800",
+  #     "refresh_token" => "refresh_token",
+  #     "scope" => "users.all:read rooms.all:read_write contacts.all:read_write",
+  #   }
+  def refresh_access_token(refresh_token, scope = [])
+    params = {
+      grant_type:    "refresh_token",
+      refresh_token: refresh_token,
+    }
+    params[:scope] = scope.join(" ") unless scope.empty?
+
+    post("/token", params)
+  end
+end