teamwork_api 0.1.0 → 0.1.1

data/spec/teamwork_api/api/companies_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::API::Companies do
+  subject { TeamworkApi::Client.new('http://localhost:3000', 'xxx') }
+
+  describe '#companies' do
+    before do
+      stub_get(
+        'http://localhost:3000/companies.json'
+      ).to_return(
+        body: fixture('companies.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.companies
+      expect(a_get('http://localhost:3000/companies.json')).to have_been_made
+    end
+
+    it 'returns companies' do
+      companies = subject.companies
+      expect(companies).to be_an Array
+      expect(companies.first).to be_a Hash
+    end
+  end
+
+  describe '#company' do
+    before do
+      stub_get(
+        'http://localhost:3000/companies/999.json'
+      ).to_return(
+        body: fixture('company.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.company(999)
+      expect(
+        a_get('http://localhost:3000/companies/999.json')
+      ).to have_been_made
+    end
+
+    it 'returns a single company' do
+      company = subject.company(999)
+      expect(company).to be_a Hash
+    end
+  end
+
+  describe '#company_by_name' do
+    before do
+      stub_get(
+        'http://localhost:3000/companies.json'
+      ).to_return(
+        body: fixture('companies.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'returns the named company' do
+      company = subject.company_by_name('Company One')
+      expect(company).to be_a Hash
+      expect(company['name']).to eq 'Company One'
+    end
+  end
+end

data/spec/teamwork_api/api/people_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::API::People do
+  subject { TeamworkApi::Client.new('http://localhost:3000', 'xxx') }
+
+  describe '#people' do
+    before do
+      stub_get(
+        'http://localhost:3000/people.json'
+      ).to_return(
+        body: fixture('people.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.people
+      expect(a_get('http://localhost:3000/people.json')).to have_been_made
+    end
+
+    it 'returns the requested people' do
+      people = subject.people
+      expect(people).to be_an Array
+      people.each { |g| expect(g).to be_a Hash }
+    end
+  end
+
+  describe '#person' do
+    before do
+      stub_get(
+        'http://localhost:3000/people/1.json'
+      ).to_return(
+        body: fixture('person.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.person(1)
+      expect(
+        a_get('http://localhost:3000/people/1.json')
+      ).to have_been_made
+    end
+
+    it 'returns a single person' do
+      person = subject.person(1)
+      expect(person).to be_a Hash
+    end
+  end
+
+  describe 'add_person_to_project' do
+    it 'adds person to project' do
+      stub_put('http://localhost:3000/projects/999/people.json')
+      subject.add_person_to_project(999, 1)
+
+      expect(
+        a_put(
+          'http://localhost:3000/projects/999/people.json'
+        ).with(body: { add: { userIdList: 1 } })
+      ).to have_been_made
+    end
+  end
+
+  describe '#set_permissions' do
+    it 'sets permissions for person on project' do
+      stub_put('http://localhost:3000/projects/999/people/1.json')
+      subject.set_permissions(999, 1, 'project-administrator': true)
+
+      expect(
+        a_put(
+          'http://localhost:3000/projects/999/people/1.json'
+        ).with(body: { permissions: { 'project-administrator': true } })
+      ).to have_been_made
+    end
+  end
+end

data/spec/teamwork_api/api/project_owner_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::API::ProjectOwner do
+  subject { TeamworkApi::Client.new('http://localhost:3000', 'xxx') }
+
+  describe '#project_owner' do
+    before do
+      stub_get(
+        'http://localhost:3000/projects/1.json?project%5B' \
+        'include_project_owner%5D=true'
+      ).to_return(
+        body: fixture('project_owner.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.project_owner(1)
+      expect(
+        a_get(
+          'http://localhost:3000/projects/1.json'
+        ).with(
+          query: { project: { include_project_owner: true } }
+        )
+      ).to have_been_made
+    end
+
+    it 'returns the project owner' do
+      owner = subject.project_owner(1)
+      expect(owner).to be_a Hash
+    end
+  end
+end

data/spec/teamwork_api/api/projects_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::API::Projects do
+  subject { TeamworkApi::Client.new('http://localhost:3000', 'xxx') }
+
+  describe '#create_project' do
+    before do
+      stub_post(
+        'http://localhost:3000/projects.json'
+      ).to_return(
+        body: fixture('create_project.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.create_project(name: 'My Project')
+      expect(a_post('http://localhost:3000/projects.json')).to have_been_made
+    end
+
+    it 'returns the project id' do
+      id = subject.create_project(name: 'My Project')
+      expect(id).to eq 323_605
+    end
+  end
+
+  describe '#update_project' do
+    before do
+      stub_put(
+        'http://localhost:3000/projects/1.json'
+      ).to_return(
+        body: fixture('update.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.update_project(1, name: 'My renamed Project')
+      expect(a_put('http://localhost:3000/projects/1.json')).to have_been_made
+    end
+
+    it 'returns ok' do
+      response = subject.update_project(1, name: 'My renamed Project')
+      expect(response.body).to eq('STATUS' => 'OK')
+    end
+  end
+
+  describe '#projects' do
+    before do
+      stub_get(
+        'http://localhost:3000/projects.json'
+      ).to_return(
+        body: fixture('projects.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.projects
+      expect(a_get('http://localhost:3000/projects.json')).to have_been_made
+    end
+
+    it 'returns the requested projects' do
+      projects = subject.projects
+      expect(projects).to be_an Array
+      projects.each { |g| expect(g).to be_a Hash }
+    end
+  end
+
+  describe '#project' do
+    before do
+      stub_get(
+        'http://localhost:3000/projects/1.json'
+      ).to_return(
+        body: fixture('project.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.project(1)
+      expect(
+        a_get('http://localhost:3000/projects/1.json')
+      ).to have_been_made
+    end
+
+    it 'returns a single project' do
+      project = subject.project(1)
+      expect(project).to be_a Hash
+    end
+  end
+
+  describe '#delete_project' do
+    before do
+      stub_delete(
+        'http://localhost:3000/projects/1.json'
+      ).to_return(
+        body: fixture('delete.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.delete_project(1)
+      expect(
+        a_delete('http://localhost:3000/projects/1.json')
+      ).to have_been_made
+    end
+
+    it 'returns ok' do
+      response = subject.delete_project(1)
+      expect(response.body).to eq('STATUS' => 'OK')
+    end
+  end
+end

data/spec/teamwork_api/api/task_lists_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::API::TaskLists do
+  subject { TeamworkApi::Client.new('http://localhost:3000', 'xxx') }
+
+  describe '#create_task_list' do
+    before do
+      stub_post(
+        'http://localhost:3000/projects/1/tasklists.json'
+      ).to_return(
+        body: fixture('create_task_list.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.create_task_list(1, name: 'My list')
+      expect(
+        a_post('http://localhost:3000/projects/1/tasklists.json')
+      ).to have_been_made
+    end
+
+    it 'returns the task list id' do
+      id = subject.create_task_list(1, name: 'My list')
+      expect(id).to eq 1_234
+    end
+  end
+
+  describe '#task_lists' do
+    before do
+      stub_get(
+        'http://localhost:3000/tasklists.json'
+      ).to_return(
+        body: fixture('task_lists.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.task_lists
+      expect(a_get('http://localhost:3000/tasklists.json')).to have_been_made
+    end
+
+    it 'returns the requested task lists' do
+      task_lists = subject.task_lists
+      expect(task_lists).to be_an Array
+      task_lists.each { |tl| expect(tl).to be_a Hash }
+    end
+  end
+
+  describe '#task_list' do
+    before do
+      stub_get(
+        'http://localhost:3000/tasklists/1.json'
+      ).to_return(
+        body: fixture('task_list.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.task_list(1)
+      expect(
+        a_get('http://localhost:3000/tasklists/1.json')
+      ).to have_been_made
+    end
+
+    it 'returns a single task list' do
+      task_list = subject.task_list(1)
+      expect(task_list).to be_a Hash
+    end
+  end
+
+  describe '#delete_task_list' do
+    before do
+      stub_delete(
+        'http://localhost:3000/tasklists/1.json'
+      ).to_return(
+        body: fixture('delete.json'),
+        headers: { content_type: 'application/json' }
+      )
+    end
+
+    it 'requests the correct resource' do
+      subject.delete_task_list(1)
+      expect(
+        a_delete('http://localhost:3000/tasklists/1.json')
+      ).to have_been_made
+    end
+
+    it 'returns ok' do
+      response = subject.delete_task_list(1)
+      expect(response.body).to eq('STATUS' => 'OK')
+    end
+  end
+end

data/spec/teamwork_api/client_spec.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TeamworkApi::Client do
+  subject { TeamworkApi::Client.new('http://localhost:3000') }
+
+  describe '.new' do
+    it 'requires a host argument' do
+      expect { TeamworkApi::Client.new }.to raise_error ArgumentError
+    end
+
+    it 'defaults api key to nil' do
+      expect(subject.api_key).to be_nil
+    end
+
+    it 'accepts an api key argument' do
+      client = TeamworkApi::Client.new('http://localhost:3000', 'test')
+      expect(client.api_key).to eq('test')
+    end
+  end
+
+  describe '#api_key' do
+    it 'is publically accessible' do
+      subject.api_key = 'test_d7fd0429940'
+      expect(subject.api_key).to eq('test_d7fd0429940')
+    end
+  end
+
+  describe '#host' do
+    it 'is publically readable' do
+      expect(subject.host).to eq('http://localhost:3000')
+    end
+
+    it 'is not publically writeable' do
+      expect(subject).not_to respond_to(:host=)
+    end
+  end
+
+  describe '#connection' do
+    it 'looks like a Faraday connection' do
+      expect(subject.send(:connection)).to respond_to :run_request
+    end
+
+    it 'memorizes the connection' do
+      c1 = subject.send(:connection)
+      c2 = subject.send(:connection)
+      expect(c1.object_id).to eq(c2.object_id)
+    end
+  end
+
+  describe '#delete' do
+    before do
+      stub_delete(
+        'http://localhost:3000/test/delete'
+      ).with(query: { deleted: 'object' })
+      subject.api_key = 'test_d7fd0429940'
+    end
+
+    it 'allows custom delete requests' do
+      subject.delete('/test/delete', deleted: 'object')
+      expect(
+        a_delete(
+          'http://localhost:3000/test/delete'
+        ).with(query: { deleted: 'object' })
+      ).to have_been_made
+    end
+
+    context 'when using a host with a subdirectory' do
+      subject { TeamworkApi::Client.new('http://localhost:3000/forum') }
+
+      before do
+        stub_delete(
+          'http://localhost:3000/forum/test/delete'
+        ).with(query: { deleted: 'object' })
+      end
+
+      it 'allows custom delete requests' do
+        subject.delete('/test/delete', deleted: 'object')
+        expect(
+          a_delete(
+            'http://localhost:3000/forum/test/delete'
+          ).with(query: { deleted: 'object' })
+        ).to have_been_made
+      end
+    end
+  end
+
+  describe '#post' do
+    before do
+      stub_post(
+        'http://localhost:3000/test/post'
+      ).with(body: { created: 'object' })
+      subject.api_key = 'test_d7fd0429940'
+    end
+
+    it 'allows custom post requests' do
+      subject.post('/test/post', created: 'object')
+      expect(
+        a_post(
+          'http://localhost:3000/test/post'
+        ).with(body: { created: 'object' })
+      ).to have_been_made
+    end
+
+    context 'when using a host with a subdirectory' do
+      subject { TeamworkApi::Client.new('http://localhost:3000/forum') }
+
+      before do
+        stub_post(
+          'http://localhost:3000/forum/test/post'
+        ).with(body: { created: 'object' })
+      end
+
+      it 'allows custom post requests' do
+        subject.post('/test/post', created: 'object')
+        expect(
+          a_post(
+            'http://localhost:3000/forum/test/post'
+          ).with(body: { created: 'object' })
+        ).to have_been_made
+      end
+    end
+  end
+
+  describe '#put' do
+    before do
+      stub_put(
+        'http://localhost:3000/test/put'
+      ).with(body: { updated: 'object' })
+      subject.api_key = 'test_d7fd0429940'
+    end
+
+    it 'allows custom put requests' do
+      subject.put('/test/put', updated: 'object')
+      expect(
+        a_put(
+          'http://localhost:3000/test/put'
+        ).with(body: { updated: 'object' })
+      ).to have_been_made
+    end
+
+    context 'when using a host with a subdirectory' do
+      subject { TeamworkApi::Client.new('http://localhost:3000/subd') }
+
+      before do
+        stub_put(
+          'http://localhost:3000/subd/test/put'
+        ).with(body: { updated: 'object' })
+      end
+
+      it 'allows custom post requests' do
+        subject.put('/test/put', updated: 'object')
+        expect(
+          a_put(
+            'http://localhost:3000/subd/test/put'
+          ).with(body: { updated: 'object' })
+        ).to have_been_made
+      end
+    end
+  end
+
+  describe '#request' do
+    it 'catches 500 errors' do
+      connection =
+        instance_double(Faraday::Connection, headers: {}, basic_auth: '')
+      allow(
+        connection
+      ).to receive(
+        :get
+      ).and_return(
+        OpenStruct.new(env: { body: 'error page html' }, status: 500)
+      )
+      allow(subject).to receive(:connection).and_return(connection)
+      expect {
+        subject.send(:request, :get, '/test')
+      }.to raise_error TeamworkApi::Error
+    end
+
+    it 'catches Faraday errors' do
+      allow(
+        subject
+      ).to receive(
+        :connection
+      ).and_raise(Faraday::Error::ClientError.new('BOOM!'))
+      expect {
+        subject.send(:request, :get, '/test')
+      }.to raise_error TeamworkApi::Error
+    end
+
+    it 'catches JSON::ParserError errors' do
+      allow(
+        subject
+      ).to receive(
+        :connection
+      ).and_raise(JSON::ParserError.new('unexpected token'))
+      expect {
+        subject.send(:request, :get, '/test')
+      }.to raise_error TeamworkApi::Error
+    end
+  end
+end