chatwork 0.5.0 → 0.6.0

data/lib/chatwork/my_task.rb

@@ -1,13 +1,41 @@
 module ChatWork
-  class MyTask < Entity
-    install_class_operations :get
+  module MyTask
+    extend EntityMethods
 
-    def self.path
-      "/my/tasks"
-    end
-
-    def path
-      "/my/tasks"
+    # 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)
+    #
+    # @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 self.get(assigned_by_account_id: nil, status: nil)
+      _get("/my/tasks", assigned_by_account_id: assigned_by_account_id, status: status)
     end
   end
 end

data/lib/chatwork/oauth_client.rb

@@ -1,10 +1,10 @@
-require 'base64'
+require "base64"
 
 module ChatWork
   class OAuthClient < BaseClient
     def initialize(client_id, client_secret, oauth_api_base)
-      signature = Base64.encode64("#{client_id}:#{client_secret}").gsub("\n", "")
-      super(oauth_api_base, "", {'Authorization' => "Basic #{signature}"})
+      signature = Base64.encode64("#{client_id}:#{client_secret}").delete("\n")
+      super(oauth_api_base, "", { "Authorization" => "Basic #{signature}" })
     end
   end
 end

data/lib/chatwork/room.rb

@@ -1,13 +1,126 @@
 module ChatWork
-  class Room < Entity
-    install_class_operations :create, :get
+  module Room
+    extend EntityMethods
 
-    def self.path
-      "/rooms"
+    # 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
+    #
+    # @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 self.get
+      _get("/rooms")
     end
 
-    def path
-      "/rooms"
+    # 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.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "room_id": 1234
+    #   }
+    def self.create(description: nil, icon_preset: nil, members_admin_ids:, members_member_ids: nil, members_readonly_ids: nil, name:)
+      params = {
+        description:       description,
+        icon_preset:       icon_preset,
+        members_admin_ids: Array(members_admin_ids).join(","),
+        name:              name,
+      }
+      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)
+    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]
+    #
+    # @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 self.find(room_id:)
+      _get("/rooms/#{room_id}")
+    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.
+    def self.update(room_id:, description: nil, icon_preset: nil, name: nil)
+      _put("/rooms/#{room_id}", description: description, icon_preset: icon_preset, name: name)
+    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)
+    def self.destroy(room_id:, action_type:)
+      _delete("/rooms/#{room_id}", action_type: action_type)
     end
   end
 end

data/lib/chatwork/task.rb

@@ -1,9 +1,101 @@
 module ChatWork
-  class Task < Entity
-    install_class_operations :get, :create
+  module Task
+    extend EntityMethods
 
-    def self.path
-      "/rooms/%d/tasks"
+    # 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)
+    #
+    # @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 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)
+    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
+    #
+    # @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)
+    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]
+    #
+    # @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 self.find(room_id:, task_id:)
+      _get("/rooms/#{room_id}/tasks/#{task_id}")
     end
   end
 end

data/lib/chatwork/token.rb

@@ -1,5 +1,5 @@
 module ChatWork
-  class Token
+  module Token
     # refresh access_token with refresh_token
     #
     # @param refresh_token [String]
@@ -23,7 +23,7 @@ module ChatWork
       params[:scope] = scope.join(" ") unless scope.empty?
 
       response = ChatWork.oauth_client.post("/token", params)
-      raise response if response.kind_of?(Exception)
+      raise response if response.is_a?(Exception)
       response
     end
   end

data/lib/chatwork/version.rb

@@ -1,3 +1,3 @@
 module ChatWork
-  VERSION = "0.5.0"
+  VERSION = "0.6.0".freeze
 end

data/spec/lib/chatwork/chatwork_error_spec.rb

@@ -1,26 +1,28 @@
 describe ChatWork::ChatWorkError do
-  describe '.from_response' do
+  describe ".from_response" do
     subject { ChatWork::ChatWorkError.from_response(status, body, headers) }
 
     context "with WWW-Authenticate header" do
       let(:status) { 401 }
 
       let(:body) do
-        <<-JSON
-          {"errors":["Invalid API Token"]}
-        JSON
+        json =
+          <<-JSON
+            {"errors":["Invalid API Token"]}
+          JSON
+        Hashie::Mash.new(JSON.parse(json))
       end
 
       let(:headers) do
         {
-          'WWW-Authenticate' => 'Bearer error="invalid_token", error_description="The access token expired"'
+          "WWW-Authenticate" => 'Bearer error="invalid_token", error_description="The access token expired"',
         }
       end
 
       it { should be_an_instance_of ChatWork::AuthenticateError }
-      its(:error) { should eq 'invalid_token' }
-      its(:error_description) { should eq 'The access token expired' }
-      its(:error_response) { should eq ['Invalid API Token'] }
+      its(:error) { should eq "invalid_token" }
+      its(:error_description) { should eq "The access token expired" }
+      its(:error_response) { should eq ["Invalid API Token"] }
     end
   end
 end

data/spec/lib/chatwork/client_spec.rb

@@ -1,34 +1,34 @@
 describe ChatWork::Client do
-  describe '#initialize' do
+  describe "#initialize" do
     subject { ChatWork::Client.new(api_key, access_token, api_base, api_version) }
 
     let(:api_key)      { nil }
     let(:access_token) { nil }
-    let(:api_base)     { 'https://api.chatwork.com/' }
-    let(:api_version)  { '/v2' }
+    let(:api_base)     { "https://api.chatwork.com/" }
+    let(:api_version)  { "/v2" }
 
-    context 'with api_key' do
-      let(:api_key) { 'my_api_key' }
+    context "with api_key" do
+      let(:api_key) { "my_api_key" }
 
-      it 'client has X-ChatWorkToken header' do
+      it "client has X-ChatWorkToken header" do
         connection = subject.instance_variable_get(:@conn)
 
-        expect(connection.headers['X-ChatWorkToken']).to eq "my_api_key"
+        expect(connection.headers["X-ChatWorkToken"]).to eq "my_api_key"
       end
     end
 
-    context 'with access_token' do
-      let(:access_token) { 'my_access_token' }
+    context "with access_token" do
+      let(:access_token) { "my_access_token" }
 
-      it 'client has Authorization header' do
+      it "client has Authorization header" do
         connection = subject.instance_variable_get(:@conn)
 
-        expect(connection.headers['Authorization']).to eq "Bearer my_access_token"
+        expect(connection.headers["Authorization"]).to eq "Bearer my_access_token"
       end
     end
 
-    context 'without both api_key and access_token' do
-      it { expect { subject }.to raise_error 'Either api_key or access_token is required' }
+    context "without both api_key and access_token" do
+      it { expect { subject }.to raise_error "Either api_key or access_token is required" }
     end
   end
-end
+end

data/spec/lib/chatwork/contacts_spec.rb

@@ -0,0 +1,11 @@
+describe ChatWork::Contacts do
+  describe ".get", type: :api do
+    subject { ChatWork::Contacts.get }
+
+    before do
+      stub_chatwork_request(:get, "/contacts")
+    end
+
+    it_behaves_like :a_chatwork_api, :get, "contacts"
+  end
+end

data/spec/lib/chatwork/entity_methods_spec.rb

@@ -0,0 +1,21 @@
+describe ChatWork::EntityMethods do
+  include ChatWork::EntityMethods
+
+  describe "#boolean_to_integer" do
+    subject { boolean_to_integer(value) }
+
+    using RSpec::Parameterized::TableSyntax
+
+    where(:value, :expected) do
+      false | 0
+      true  | 1
+      0     | 0
+      1     | 1
+      nil   | nil
+    end
+
+    with_them do
+      it { should eq expected }
+    end
+  end
+end

data/spec/lib/chatwork/file_spec.rb

@@ -0,0 +1,37 @@
+describe ChatWork::File do
+  describe ".get", type: :api do
+    subject { ChatWork::File.get(room_id: room_id, account_id: account_id) }
+
+    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", type: :api do
+    subject { ChatWork::File.find(room_id: room_id, file_id: file_id, create_download_url: create_download_url) }
+
+    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