chatwork 0.7.0 → 0.8.0

data/lib/chatwork/client/my_status_methods.rb

@@ -0,0 +1,25 @@
+module ChatWork::Client::MyStatusMethods
+  # 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
+  #   {
+  #     "unread_room_num": 2,
+  #     "mention_room_num": 1,
+  #     "mytask_room_num": 3,
+  #     "unread_num": 12,
+  #     "mention_num": 1,
+  #     "mytask_num": 8
+  #   }
+  def get_my_status(&block)
+    get("/my/status", &block)
+  end
+end

data/lib/chatwork/client/my_task_methods.rb

@@ -0,0 +1,41 @@
+module ChatWork::Client::MyTaskMethods
+  # 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)
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_my.html#GET-my-tasks
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   [
+  #     {
+  #       "task_id": 3,
+  #       "room": {
+  #         "room_id": 5,
+  #         "name": "Group Chat Name",
+  #         "icon_path": "https://example.com/ico_group.png"
+  #       },
+  #       "assigned_by_account": {
+  #         "account_id": 456,
+  #         "name": "Anna",
+  #         "avatar_image_url": "https://example.com/def.png"
+  #       },
+  #       "message_id": "13",
+  #       "body": "buy milk",
+  #       "limit_time": 1384354799,
+  #       "status": "open"
+  #     }
+  #   ]
+  def get_my_tasks(assigned_by_account_id: nil, status: nil, &block)
+    get("/my/tasks", assigned_by_account_id: assigned_by_account_id, status: status, &block)
+  end
+end

data/lib/chatwork/client/room_methods.rb

@@ -0,0 +1,156 @@
+module ChatWork::Client::RoomMethods
+  # Get the list of all chats on your account
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms
+  # @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 [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
+  #   [
+  #     {
+  #       "room_id": 123,
+  #       "name": "Group Chat Name",
+  #       "type": "group",
+  #       "role": "admin",
+  #       "sticky": false,
+  #       "unread_num": 10,
+  #       "mention_num": 1,
+  #       "mytask_num": 0,
+  #       "message_num": 122,
+  #       "file_num": 10,
+  #       "task_num": 17,
+  #       "icon_path": "https://example.com/ico_group.png",
+  #       "last_update_time": 1298905200
+  #     }
+  #   ]
+  def get_rooms(&block)
+    get("/rooms", &block)
+  end
+
+  # rubocop:disable Metrics/ParameterLists
+
+  # Create a new group chat
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param description [String] Description of the group chat
+  # @param icon_preset [String] Type of the group chat icon (group, check, document, meeting, event, project, business,
+  #                             study, security, star, idea, heart, magcup, beer, music, sports, travel)
+  # @param members_admin_ids [Array<Integer>, String] List of user IDs who will be given administrator permission for the group chat.
+  #                                                   At least one user must be specified as an administrator.
+  # @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.
+  # @param name [String] Title of the group chat.
+  # @param link [Boolean] whether create invitation link
+  # @param link_code [String] link path (default. random string)
+  # @param link_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
+  #   {
+  #     "room_id": 1234
+  #   }
+  def create_room(description: nil, icon_preset: nil, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, name:,
+                  link: nil, link_code: nil, link_need_acceptance: nil, &block)
+    params = {
+      description:          description,
+      icon_preset:          icon_preset,
+      members_admin_ids:    Array(members_admin_ids).join(","),
+      name:                 name,
+      link:                 boolean_to_integer(link),
+      link_need_acceptance: boolean_to_integer(link_need_acceptance),
+      link_code:            link_code,
+    }
+    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
+
+    post("/rooms", params, &block)
+  end
+
+  # rubocop:enable Metrics/ParameterLists
+
+  # Get chat name, icon, and Type (my, direct, or group)
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   {
+  #     "room_id": 123,
+  #     "name": "Group Chat Name",
+  #     "type": "group",
+  #     "role": "admin",
+  #     "sticky": false,
+  #     "unread_num": 10,
+  #     "mention_num": 1,
+  #     "mytask_num": 0,
+  #     "message_num": 122,
+  #     "file_num": 10,
+  #     "task_num": 17,
+  #     "icon_path": "https://example.com/ico_group.png",
+  #     "last_update_time": 1298905200,
+  #     "description": "room description text"
+  #   }
+  def find_room(room_id:, &block)
+    get("/rooms/#{room_id}", &block)
+  end
+
+  # Change the title and icon type of the specified chat
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param description [String] Description of the group chat
+  # @param icon_preset [String] Type of the group chat icon (group, check, document, meeting, event, project, business,
+  #                             study, security, star, idea, heart, magcup, beer, music, sports, travel)
+  # @param name [String] Title of 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
+  #   {
+  #     "room_id": 1234
+  #   }
+  def update_room(room_id:, description: nil, icon_preset: nil, name: nil, &block)
+    put("/rooms/#{room_id}", description: description, icon_preset: icon_preset, name: name, &block)
+  end
+
+  # Leave/Delete a group chat
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param action_type [String] leave from a room or delete a room (leave, delete)
+  #
+  # @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)
+  def destroy_room(room_id:, action_type:, &block)
+    delete("/rooms/#{room_id}", action_type: action_type, &block)
+  end
+end

data/lib/chatwork/client/task_methods.rb

@@ -0,0 +1,109 @@
+module ChatWork::Client::TaskMethods
+  # Get the list of tasks associated with the specified chat
+  #
+  # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param account_id [Integer]
+  # @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
+  #   [
+  #     {
+  #       "task_id": 3,
+  #       "account": {
+  #         "account_id": 123,
+  #         "name": "Bob",
+  #         "avatar_image_url": "https://example.com/abc.png"
+  #       },
+  #       "assigned_by_account": {
+  #         "account_id": 456,
+  #         "name": "Anna",
+  #         "avatar_image_url": "https://example.com/def.png"
+  #       },
+  #       "message_id": "13",
+  #       "body": "buy milk",
+  #       "limit_time": 1384354799,
+  #       "status": "open"
+  #     }
+  #   ]
+  def get_tasks(room_id:, account_id:, assigned_by_account_id: nil, status: nil, &block)
+    get("/rooms/#{room_id}/tasks", account_id: account_id, assigned_by_account_id: assigned_by_account_id, status: status, &block)
+  end
+
+  # Add a new task to the chat
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-tasks
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param body    [String] Task description
+  # @param to_ids [Array<Integer>, String] Account ID of the person/people responsible to complete the task
+  # @param limit  [Time, Integer] When the task is due
+  #
+  # @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
+  #   {
+  #     "task_ids": [123,124]
+  #   }
+  def create_task(room_id:, body:, to_ids:, limit: nil, &block)
+    params = {
+      body:   body,
+      to_ids: Array(to_ids).join(","),
+    }
+    params[:limit] = limit.to_i if limit
+
+    post("/rooms/#{room_id}/tasks", params, &block)
+  end
+
+  # Get information about the specified task
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-tasks-task_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param task_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
+  #   {
+  #     "task_id": 3,
+  #     "account": {
+  #       "account_id": 123,
+  #       "name": "Bob",
+  #       "avatar_image_url": "https://example.com/abc.png"
+  #     },
+  #     "assigned_by_account": {
+  #       "account_id": 456,
+  #       "name": "Anna",
+  #       "avatar_image_url": "https://example.com/def.png"
+  #     },
+  #     "message_id": "13",
+  #     "body": "buy milk",
+  #     "limit_time": 1384354799,
+  #     "status": "open"
+  #   }
+  def find_task(room_id:, task_id:, &block)
+    get("/rooms/#{room_id}/tasks/#{task_id}", &block)
+  end
+end

data/lib/chatwork/contacts.rb

@@ -1,12 +1,14 @@
 module ChatWork
   module Contacts
-    extend EntityMethods
-
     # Get the list of your contacts
     #
     # @see http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts
     # @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 [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
@@ -22,8 +24,8 @@ module ChatWork
     #       "avatar_image_url": "https://example.com/abc.png"
     #     }
     #   ]
-    def self.get
-      _get("/contacts")
+    def self.get(&block)
+      ChatWork.client.get_contacts(&block)
     end
   end
 end

data/lib/chatwork/converter.rb

@@ -0,0 +1,18 @@
+module ChatWork
+  module Converter
+    def hash_compact(hash)
+      hash.reject { |_k, v| v.nil? }
+    end
+
+    def boolean_to_integer(value)
+      case value
+      when true
+        1
+      when false
+        0
+      else
+        value
+      end
+    end
+  end
+end

data/lib/chatwork/file.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module File
-    extend EntityMethods
-
     # Get the list of files associated with the specified chat
     #
     # @param room_id [Integer]
@@ -10,6 +8,10 @@ module ChatWork
     # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files
     # @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 [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
@@ -27,8 +29,8 @@ module ChatWork
     #       "upload_time": 1384414750
     #     }
     #   ]
-    def self.get(room_id:, account_id:)
-      _get("/rooms/#{room_id}/files", account_id: account_id)
+    def self.get(room_id:, account_id:, &block)
+      ChatWork.client.get_files(room_id: room_id, account_id: account_id, &block)
     end
 
     # Get information about the specified file
@@ -41,6 +43,10 @@ module ChatWork
     # @param create_download_url [Boolean] whether or not to create a download link.
     #                                      If set to true, download like will be created for 30 seconds
     #
+    # @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
@@ -56,8 +62,8 @@ module ChatWork
     #     "filesize": 2232,
     #     "upload_time": 1384414750
     #   }
-    def self.find(room_id:, file_id:, create_download_url: nil)
-      _get("/rooms/#{room_id}/files/#{file_id}", create_download_url: boolean_to_integer(create_download_url))
+    def self.find(room_id:, file_id:, create_download_url: nil, &block)
+      ChatWork.client.find_file(room_id: room_id, file_id: file_id, create_download_url: create_download_url, &block)
     end
   end
 end

data/lib/chatwork/incoming_request.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module IncomingRequest
-    extend EntityMethods
-
     # You can get the list of contact approval request you received
     #
     # (*This method returns up to 100 entries. We are planning to implement pagination to support larger number of data retrieval)
@@ -9,6 +7,10 @@ module ChatWork
     # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#GET-incoming_requests
     # @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 [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
@@ -25,8 +27,8 @@ module ChatWork
     #       "avatar_image_url": "https://example.com/abc.png"
     #     }
     #   ]
-    def self.get
-      _get("/incoming_requests")
+    def self.get(&block)
+      ChatWork.client.get_incoming_requests(&block)
     end
 
     # You can approve a contact approval request you received
@@ -36,6 +38,10 @@ module ChatWork
     #
     # @param request_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
@@ -49,8 +55,8 @@ module ChatWork
     #     "department": "Marketing",
     #     "avatar_image_url": "https://example.com/abc.png"
     #   }
-    def self.update(request_id:)
-      _put("/incoming_requests/#{request_id}")
+    def self.update(request_id:, &block)
+      ChatWork.client.update_incoming_request(request_id: request_id, &block)
     end
 
     # You can decline a contact approval request you received
@@ -59,8 +65,12 @@ module ChatWork
     # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
     #
     # @param request_id [Integer]
-    def self.destroy(request_id:)
-      _delete("/incoming_requests/#{request_id}")
+    #
+    # @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)
+    def self.destroy(request_id:, &block)
+      ChatWork.client.destroy_incoming_request(request_id: request_id, &block)
     end
 
     class << self