chatwork 0.7.0 → 0.8.0

data/lib/chatwork/room.rb

@@ -1,12 +1,14 @@
 module ChatWork
   module Room
-    extend EntityMethods
-
     # 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
@@ -27,8 +29,8 @@ module ChatWork
     #       "last_update_time": 1298905200
     #     }
     #   ]
-    def self.get
-      _get("/rooms")
+    def self.get(&block)
+      ChatWork.client.get_rooms(&block)
     end
 
     # rubocop:disable Metrics/ParameterLists
@@ -50,6 +52,10 @@ module ChatWork
     # @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
@@ -57,20 +63,19 @@ module ChatWork
     #     "room_id": 1234
     #   }
     def self.create(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)
-      params = {
+                    link: nil, link_code: nil, link_need_acceptance: nil, &block)
+      ChatWork.client.create_room(
         description:          description,
         icon_preset:          icon_preset,
-        members_admin_ids:    Array(members_admin_ids).join(","),
+        members_admin_ids:    members_admin_ids,
+        members_member_ids:   members_member_ids,
+        members_readonly_ids: members_readonly_ids,
         name:                 name,
-        link:                 boolean_to_integer(link),
-        link_need_acceptance: boolean_to_integer(link_need_acceptance),
+        link:                 link,
         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)
+        link_need_acceptance: link_need_acceptance,
+        &block
+      )
     end
 
     # rubocop:enable Metrics/ParameterLists
@@ -82,6 +87,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
@@ -101,8 +110,8 @@ module ChatWork
     #     "last_update_time": 1298905200,
     #     "description": "room description text"
     #   }
-    def self.find(room_id:)
-      _get("/rooms/#{room_id}")
+    def self.find(room_id:, &block)
+      ChatWork.client.find_room(room_id: room_id, &block)
     end
 
     # Change the title and icon type of the specified chat
@@ -116,14 +125,18 @@ module ChatWork
     #                             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 self.update(room_id:, description: nil, icon_preset: nil, name: nil)
-      _put("/rooms/#{room_id}", description: description, icon_preset: icon_preset, name: name)
+    def self.update(room_id:, description: nil, icon_preset: nil, name: nil, &block)
+      ChatWork.client.update_room(room_id: room_id, description: description, icon_preset: icon_preset, name: name, &block)
     end
 
     # Leave/Delete a group chat
@@ -133,8 +146,12 @@ module ChatWork
     #
     # @param room_id [Integer]
     # @param action_type [String] leave from a room or delete a room (leave, delete)
-    def self.destroy(room_id:, action_type:)
-      _delete("/rooms/#{room_id}", action_type: action_type)
+    #
+    # @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(room_id:, action_type:, &block)
+      ChatWork.client.destroy_room(room_id: room_id, action_type: action_type, &block)
     end
   end
 end

data/lib/chatwork/task.rb

@@ -1,7 +1,5 @@
 module ChatWork
   module Task
-    extend EntityMethods
-
     # 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)
@@ -14,6 +12,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
@@ -36,8 +38,8 @@ module ChatWork
     #       "status": "open"
     #     }
     #   ]
-    def self.get(room_id:, account_id:, assigned_by_account_id: nil, status: nil)
-      _get("/rooms/#{room_id}/tasks", account_id: account_id, assigned_by_account_id: assigned_by_account_id, status: status)
+    def self.get(room_id:, account_id:, assigned_by_account_id: nil, status: nil, &block)
+      ChatWork.client.get_tasks(room_id: room_id, account_id: account_id, assigned_by_account_id: assigned_by_account_id, status: status, &block)
     end
 
     # Add a new task to the chat
@@ -50,20 +52,18 @@ module ChatWork
     # @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 self.create(room_id:, body:, to_ids:, limit: nil)
-      params = {
-        body:   body,
-        to_ids: Array(to_ids).join(","),
-      }
-      params[:limit] = limit.to_i if limit
-
-      _post("/rooms/#{room_id}/tasks", params)
+    def self.create(room_id:, body:, to_ids:, limit: nil, &block)
+      ChatWork.client.create_task(room_id: room_id, body: body, to_ids: to_ids, limit: limit, &block)
     end
 
     # Get information about the specified task
@@ -74,6 +74,10 @@ module ChatWork
     # @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
@@ -94,8 +98,8 @@ module ChatWork
     #     "limit_time": 1384354799,
     #     "status": "open"
     #   }
-    def self.find(room_id:, task_id:)
-      _get("/rooms/#{room_id}/tasks/#{task_id}")
+    def self.find(room_id:, task_id:, &block)
+      ChatWork.client.find_task(room_id: room_id, task_id: task_id, &block)
     end
   end
 end

data/lib/chatwork/token.rb

@@ -15,13 +15,7 @@ module ChatWork
     #     "scope" => "users.all:read rooms.all:read_write contacts.all:read_write",
     #   }
     def self.refresh_access_token(refresh_token, scope = [])
-      params = {
-        grant_type:    "refresh_token",
-        refresh_token: refresh_token,
-      }
-      params[:scope] = scope.join(" ") unless scope.empty?
-
-      ChatWork.oauth_client.post("/token", params)
+      ChatWork.oauth_client.refresh_access_token(refresh_token, scope)
     end
   end
 end

data/lib/chatwork/version.rb

@@ -1,3 +1,3 @@
 module ChatWork
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

data/spec/lib/chatwork/client/contacts_methods_spec.rb

@@ -0,0 +1,11 @@
+describe ChatWork::Client::ContactsMethods do
+  describe "#get_contacts", type: :api do
+    subject { client.get_contacts(&block) }
+
+    before do
+      stub_chatwork_request(:get, "/contacts")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/contacts"
+  end
+end

data/spec/lib/chatwork/client/file_methods_spec.rb

@@ -0,0 +1,37 @@
+describe ChatWork::Client::FileMethods do
+  describe "#get_files", type: :api do
+    subject { client.get_files(room_id: room_id, account_id: account_id, &block) }
+
+    before do
+      stub_chatwork_request(:get, "/rooms/#{room_id}/files", "/rooms/{room_id}/files")
+    end
+
+    let(:room_id)    { 123 }
+    let(:account_id) { 101 }
+
+    it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/files"
+  end
+
+  describe "#find_file", type: :api do
+    subject { client.find_file(room_id: room_id, file_id: file_id, create_download_url: create_download_url, &block) }
+
+    before do
+      stub_chatwork_request(:get, "/rooms/#{room_id}/files/#{file_id}", "/rooms/{room_id}/files/{file_id}")
+    end
+
+    let(:room_id) { 123 }
+    let(:file_id) { 101 }
+
+    context "when force is Integer" do
+      let(:create_download_url) { 1 }
+
+      it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/files/{file_id}"
+    end
+
+    context "when force is boolean" do
+      let(:create_download_url) { true }
+
+      it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/files/{file_id}"
+    end
+  end
+end

data/spec/lib/chatwork/client/incoming_request_methods_spec.rb

@@ -0,0 +1,35 @@
+describe ChatWork::Client::IncomingRequestMethods do
+  describe "#get_incoming_requests", type: :api do
+    subject { client.get_incoming_requests(&block) }
+
+    before do
+      stub_chatwork_request(:get, "/incoming_requests")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/incoming_requests"
+  end
+
+  describe "#update_incoming_request", type: :api do
+    subject { client.update_incoming_request(request_id: request_id, &block) }
+
+    let(:request_id) { 123 }
+
+    before do
+      stub_chatwork_request(:put, "/incoming_requests/#{request_id}", "/incoming_requests/{request_id}")
+    end
+
+    it_behaves_like :a_chatwork_api, :put, "/incoming_requests/{request_id}"
+  end
+
+  describe "#destroy_incoming_request", type: :api do
+    subject { client.destroy_incoming_request(request_id: request_id, &block) }
+
+    let(:request_id) { 123 }
+
+    before do
+      stub_chatwork_request(:delete, "/incoming_requests/#{request_id}", "/incoming_requests/{request_id}", 204)
+    end
+
+    it_behaves_like :a_chatwork_api, :delete, "/incoming_requests/{request_id}", 204
+  end
+end

data/spec/lib/chatwork/client/invitation_link_methods_spec.rb

@@ -0,0 +1,71 @@
+describe ChatWork::Client::InvitationLinkMethods do
+  describe "#get_invitation_link", type: :api do
+    subject { client.get_invitation_link(room_id: room_id, &block) }
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:get, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/link"
+  end
+
+  describe "#create_invitation_link", type: :api do
+    subject do
+      client.create_invitation_link(
+        room_id:         room_id,
+        code:            code,
+        description:     description,
+        need_acceptance: need_acceptance,
+        &block
+      )
+    end
+
+    let(:room_id)         { 123 }
+    let(:code)            { "unique-link-name" }
+    let(:description)     { "This is a public room for topic A." }
+    let(:need_acceptance) { true }
+
+    before do
+      stub_chatwork_request(:post, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :post, "/rooms/{room_id}/link"
+  end
+
+  describe "#update_invitation_link", type: :api do
+    subject do
+      client.update_invitation_link(
+        room_id:         room_id,
+        code:            code,
+        description:     description,
+        need_acceptance: need_acceptance,
+        &block
+      )
+    end
+
+    let(:room_id)         { 123 }
+    let(:code)            { "another_link_name" }
+    let(:description)     { "Public room for everybody" }
+    let(:need_acceptance) { false }
+
+    before do
+      stub_chatwork_request(:put, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :put, "/rooms/{room_id}/link"
+  end
+
+  describe "#destroy_invitation_link", type: :api do
+    subject { client.destroy_invitation_link(room_id: room_id, &block) }
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:delete, "/rooms/#{room_id}/link", "/rooms/{room_id}/link")
+    end
+
+    it_behaves_like :a_chatwork_api, :delete, "/rooms/{room_id}/link"
+  end
+end

data/spec/lib/chatwork/client/me_methods_spec.rb

@@ -0,0 +1,21 @@
+describe ChatWork::Client::MeMethods do
+  describe "get_me", type: :api do
+    subject { client.get_me(&block) }
+
+    before do
+      stub_chatwork_request(:get, "/me")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/me"
+
+    context "when unauthorized" do
+      before do
+        stub_chatwork_request(:get, "/me", "/me", 401)
+      end
+
+      let(:block) { nil }
+
+      it { expect { subject }.to raise_error(ChatWork::APIError, "Invalid API token") }
+    end
+  end
+end

data/spec/lib/chatwork/client/member_methods_spec.rb

@@ -0,0 +1,47 @@
+describe ChatWork::Client::MemberMethods do
+  describe "#get_members", type: :api do
+    subject { client.get_members(room_id: room_id, &block) }
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:get, "/rooms/#{room_id}/members", "/rooms/{room_id}/members")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/members"
+  end
+
+  describe "#update_all_members", type: :api do
+    subject do
+      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
+
+    let(:room_id) { 123 }
+
+    before do
+      stub_chatwork_request(:put, "/rooms/#{room_id}/members", "/rooms/{room_id}/members")
+    end
+
+    context "with String" do
+      let(:members_admin_ids)    { "123,542,1001" }
+      let(:members_member_ids)   { "21,344" }
+      let(:members_readonly_ids) { "15,103" }
+
+      it_behaves_like :a_chatwork_api, :put, "/rooms/{room_id}/members"
+    end
+
+    context "with Array" do
+      let(:members_admin_ids)    { [123, 542, 1001] }
+      let(:members_member_ids)   { [21, 344] }
+      let(:members_readonly_ids) { [15, 103] }
+
+      it_behaves_like :a_chatwork_api, :put, "/rooms/{room_id}/members"
+    end
+  end
+end