chatwork 0.7.0 → 0.8.0

data/lib/chatwork/client/incoming_request_methods.rb

@@ -0,0 +1,77 @@
+module ChatWork::Client::IncomingRequestMethods
+  # 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)
+  #
+  # @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
+  #   [
+  #     {
+  #       "request_id": 123,
+  #       "account_id": 363,
+  #       "message": "hogehoge",
+  #       "name": "John Smith",
+  #       "chatwork_id": "tarochatworkid",
+  #       "organization_id": 101,
+  #       "organization_name": "Hello Company",
+  #       "department": "Marketing",
+  #       "avatar_image_url": "https://example.com/abc.png"
+  #     }
+  #   ]
+  def get_incoming_requests(&block)
+    get("/incoming_requests", &block)
+  end
+
+  # You can approve a contact approval request you received
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#PUT-incoming_requests-request_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   {
+  #     "account_id": 363,
+  #     "room_id": 1234,
+  #     "name": "John Smith",
+  #     "chatwork_id": "tarochatworkid",
+  #     "organization_id": 101,
+  #     "organization_name": "Hello Company",
+  #     "department": "Marketing",
+  #     "avatar_image_url": "https://example.com/abc.png"
+  #   }
+  def update_incoming_request(request_id:, &block)
+    put("/incoming_requests/#{request_id}", &block)
+  end
+
+  # You can decline a contact approval request you received
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#DELETE-incoming_requests-request_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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)
+  def destroy_incoming_request(request_id:, &block)
+    delete("/incoming_requests/#{request_id}", &block)
+  end
+
+  alias_method :approve_incoming_request, :update_incoming_request
+  alias_method :decline_incoming_request, :destroy_incoming_request
+end

data/lib/chatwork/client/invitation_link_methods.rb

@@ -0,0 +1,110 @@
+module ChatWork::Client::InvitationLinkMethods
+  # Get invitation link
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-link
+  # @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
+  #   {
+  #     "public": true,
+  #     "url": "https://example.chatwork.com/g/randomcode42",
+  #     "need_acceptance": true,
+  #     "description": "Link description text"
+  #   }
+  def get_invitation_link(room_id:, &block)
+    get("/rooms/#{room_id}/link", &block)
+  end
+
+  # Create invitation link
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-link
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param code [String] link path (default. random string)
+  # @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
+  #   {
+  #     "public": true,
+  #     "url": "https://example.chatwork.com/g/unique-link-name",
+  #     "need_acceptance": true,
+  #     "description": "This is a public room for topic A."
+  #   }
+  def create_invitation_link(room_id:, code: nil, description: nil, need_acceptance: nil, &block)
+    params = {
+      code:            code,
+      description:     description,
+      need_acceptance: boolean_to_integer(need_acceptance),
+    }
+    post("/rooms/#{room_id}/link", params, &block)
+  end
+
+  # Update invitation link
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-link
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param code [String] link path (default. random string)
+  # @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
+  #   {
+  #     "public": true,
+  #     "url": "https://example.chatwork.com/g/another_link_name",
+  #     "need_acceptance": false,
+  #     "description": "Public room for everybody"
+  #   }
+  def update_invitation_link(room_id:, code: nil, description: nil, need_acceptance: nil, &block)
+    params = {
+      code:            code,
+      description:     description,
+      need_acceptance: boolean_to_integer(need_acceptance),
+    }
+    put("/rooms/#{room_id}/link", params, &block)
+  end
+
+  # Delete invitation link
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#DELETE-rooms-room_id-link
+  # @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
+  #   {
+  #     "public": false
+  #   }
+  def destroy_invitation_link(room_id:, &block)
+    delete("/rooms/#{room_id}/link", &block)
+  end
+end

data/lib/chatwork/client/me_methods.rb

@@ -0,0 +1,38 @@
+module ChatWork::Client::MeMethods
+  # 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
+  #   {
+  #     "account_id": 123,
+  #     "room_id": 322,
+  #     "name": "John Smith",
+  #     "chatwork_id": "tarochatworkid",
+  #     "organization_id": 101,
+  #     "organization_name": "Hello Company",
+  #     "department": "Marketing",
+  #     "title": "CMO",
+  #     "url": "http://mycompany.example.com",
+  #     "introduction": "Self Introduction",
+  #     "mail": "taro@example.com",
+  #     "tel_organization": "XXX-XXXX-XXXX",
+  #     "tel_extension": "YYY-YYYY-YYYY",
+  #     "tel_mobile": "ZZZ-ZZZZ-ZZZZ",
+  #     "skype": "myskype_id",
+  #     "facebook": "myfacebook_id",
+  #     "twitter": "mytwitter_id",
+  #     "avatar_image_url": "https://example.com/abc.png",
+  #     "login_mail": "account@example.com"
+  #   }
+  def get_me(&block)
+    get("/me", &block)
+  end
+end

data/lib/chatwork/client/member_methods.rb

@@ -0,0 +1,64 @@
+module ChatWork::Client::MemberMethods
+  # 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
+  # @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 [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
+  #   [
+  #     {
+  #       "account_id": 123,
+  #       "role": "member",
+  #       "name": "John Smith",
+  #       "chatwork_id": "tarochatworkid",
+  #       "organization_id": 101,
+  #       "organization_name": "Hello Company",
+  #       "department": "Marketing",
+  #       "avatar_image_url": "https://example.com/abc.png"
+  #     }
+  #   ]
+  def get_members(room_id:, &block)
+    get("/rooms/#{room_id}/members", &block)
+  end
+
+  # Change associated members of group chat at once
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-members
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @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.
+  #
+  # @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
+  #   {
+  #     "admin": [123, 542, 1001],
+  #     "member": [10, 103],
+  #     "readonly": [6, 11]
+  #   }
+  def update_all_members(room_id:, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, &block)
+    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, &block)
+  end
+end

data/lib/chatwork/client/message_methods.rb

@@ -0,0 +1,178 @@
+module ChatWork::Client::MessageMethods
+  # 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.
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   [
+  #     {
+  #       "message_id": "5",
+  #       "account": {
+  #         "account_id": 123,
+  #         "name": "Bob",
+  #         "avatar_image_url": "https://example.com/ico_avatar.png"
+  #       },
+  #       "body": "Hello Chatwork!",
+  #       "send_time": 1384242850,
+  #       "update_time": 0
+  #     }
+  #   ]
+  def get_messages(room_id:, force: nil, &block)
+    get("/rooms/#{room_id}/messages", force: boolean_to_integer(force), &block)
+  end
+
+  # Add new message to the chat
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-messages
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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 create_message(room_id:, body:, &block)
+    post("/rooms/#{room_id}/messages", body: body, &block)
+  end
+
+  # Mark messages as read
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-read
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   {
+  #     "unread_num": 461,
+  #     "mention_num": 0
+  #   }
+  def read_message(room_id:, message_id: nil, &block)
+    put("/rooms/#{room_id}/messages/read", message_id: message_id, &block)
+  end
+
+  # Mark messages as unread
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-unread
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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
+  #   {
+  #     "unread_num": 3,
+  #     "mention_num": 0
+  #   }
+  def unread_message(room_id:, message_id:, &block)
+    put("/rooms/#{room_id}/messages/unread", message_id: message_id, &block)
+  end
+
+  # Get information about the specified message
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-messages-message_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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": "5",
+  #     "account": {
+  #       "account_id": 123,
+  #       "name": "Bob",
+  #       "avatar_image_url": "https://example.com/ico_avatar.png"
+  #     },
+  #     "body": "Hello Chatwork!",
+  #     "send_time": 1384242850,
+  #     "update_time": 0
+  #   }
+  def find_message(room_id:, message_id:, &block)
+    get("/rooms/#{room_id}/messages/#{message_id}", &block)
+  end
+
+  # Update the specified message
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-message_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @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 update_message(room_id:, message_id:, body:, &block)
+    put("/rooms/#{room_id}/messages/#{message_id}", body: body, &block)
+  end
+
+  # Destroy the specified message
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#PUT-rooms-room_id-messages-message_id
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @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 destroy_message(room_id:, message_id:, &block)
+    delete("/rooms/#{room_id}/messages/#{message_id}", &block)
+  end
+end