chatwork 0.5.0 → 0.6.0

data/lib/chatwork/entity_methods.rb

@@ -0,0 +1,36 @@
+module ChatWork
+  module EntityMethods
+    private
+
+      def _get(path, params = {}, &block)
+        ChatWork.client.get(path, hash_compact(params), &block)
+      end
+
+      def _post(path, params = {}, &block)
+        ChatWork.client.post(path, hash_compact(params), &block)
+      end
+
+      def _put(path, params = {}, &block)
+        ChatWork.client.put(path, hash_compact(params), &block)
+      end
+
+      def _delete(path, params = {}, &block)
+        ChatWork.client.delete(path, hash_compact(params), &block)
+      end
+
+      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

@@ -0,0 +1,63 @@
+module ChatWork
+  module File
+    extend EntityMethods
+
+    # Get the list of files associated with the specified chat
+    #
+    # @param room_id [Integer]
+    # @param account_id [Integer]
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @return [Array<Hashie::Mash>]
+    #
+    # @example response format
+    #   [
+    #     {
+    #       "file_id": 3,
+    #       "account": {
+    #         "account_id": 123,
+    #         "name": "Bob",
+    #         "avatar_image_url": "https://example.com/ico_avatar.png"
+    #       },
+    #       "message_id": "22",
+    #       "filename": "README.md",
+    #       "filesize": 2232,
+    #       "upload_time": 1384414750
+    #     }
+    #   ]
+    def self.get(room_id:, account_id:)
+      _get("/rooms/#{room_id}/files", account_id: account_id)
+    end
+
+    # Get information about the specified file
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#GET-rooms-room_id-files-file_id
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    # @param file_id [Integer]
+    # @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
+    #
+    # @return [Array<Hashie::Mash>]
+    #
+    # @example response format
+    #   {
+    #     "file_id":3,
+    #     "account": {
+    #       "account_id":123,
+    #       "name":"Bob",
+    #       "avatar_image_url": "https://example.com/ico_avatar.png"
+    #     },
+    #     "message_id": "22",
+    #     "filename": "README.md",
+    #     "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))
+    end
+  end
+end

data/lib/chatwork/incoming_request.rb

@@ -0,0 +1,71 @@
+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)
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_incoming_requests.html#GET-incoming_requests
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @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 self.get
+      _get("/incoming_requests")
+    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]
+    #
+    # @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 self.update(request_id:)
+      _put("/incoming_requests/#{request_id}")
+    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]
+    def self.destroy(request_id:)
+      _delete("/incoming_requests/#{request_id}")
+    end
+
+    class << self
+      alias_method :approve, :update
+      alias_method :decline, :destroy
+    end
+  end
+end

data/lib/chatwork/me.rb

@@ -1,13 +1,38 @@
 module ChatWork
-  class Me < Entity
-    install_class_operations :get
+  module Me
+    extend EntityMethods
 
-    def self.path
-      "/me"
-    end
-
-    def path
-      "/me"
+    # Get your account information
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_me.html#GET-me
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @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 self.get
+      _get("/me")
     end
   end
 end

data/lib/chatwork/member.rb

@@ -1,9 +1,60 @@
 module ChatWork
-  class Member < Entity
-    install_class_operations :get
+  module Member
+    extend EntityMethods
 
-    def self.path
-      "/rooms/%d/members"
+    # 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]
+    #
+    # @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 self.get(room_id:)
+      _get("/rooms/#{room_id}/members")
+    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.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    # {
+    #   "admin": [123, 542, 1001],
+    #   "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)
     end
   end
 end

data/lib/chatwork/message.rb

@@ -1,13 +1,154 @@
 module ChatWork
-  class Message < Entity
-    install_class_operations :create, :get
+  module Message
+    extend EntityMethods
 
-    def self.path
-      "/rooms/%d/messages"
+    # 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.
+    #
+    # @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 self.get(room_id:, force: nil)
+      _get("/rooms/#{room_id}/messages", force: boolean_to_integer(force))
     end
 
-    def path
-      "/rooms/%d/messages"
+    # 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
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "message_id": "1234"
+    #   }
+    def self.create(room_id:, body:)
+      _post("/rooms/#{room_id}/messages", body: body)
+    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]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "unread_num": 461,
+    #     "mention_num": 0
+    #   }
+    def self.read(room_id:, message_id: nil)
+      _put("/rooms/#{room_id}/messages/read", message_id: message_id)
+    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]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "unread_num": 3,
+    #     "mention_num": 0
+    #   }
+    def self.unread(room_id:, message_id:)
+      _put("/rooms/#{room_id}/messages/unread", message_id: message_id)
+    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]
+    #
+    # @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 self.find(room_id:, message_id:)
+      _get("/rooms/#{room_id}/messages/#{message_id}")
+    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
+    #
+    # @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)
+    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]
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "message_id": "1234"
+    #   }
+    def self.destroy(room_id:, message_id:)
+      _delete("/rooms/#{room_id}/messages/#{message_id}")
     end
   end
 end

data/lib/chatwork/my_status.rb

@@ -0,0 +1,25 @@
+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
+    #
+    # @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 self.get
+      _get("/my/status")
+    end
+  end
+end