bugherd_client 0.0.6 → 0.0.8

data/spec/bugherd_client/client_spec.rb

@@ -1,22 +1,74 @@
 require 'spec_helper'
 
+describe(BugherdClient::Client) do
+  let(:client_klass) { BugherdClient::Client }
+  context 'supported_versions' do
 
-describe BugherdClient::Client do
+    it 'should list API_VERSIONS 1 and 2' do
+      expect(BugherdClient::Client::API_VERSIONS).to eq([1,2])
+    end
 
-  it "should list API_VERSIONS 1 and 2" do
-    BugherdClient::Client::API_VERSIONS.should include(1)
-    BugherdClient::Client::API_VERSIONS.should include(2)
   end
 
-  context "default options" do
-  
-    it "should have a default api_version of 2" do
-      BugherdClient::Client::DEFAULT_OPTIONS[:api_version].should eq(2)
+  context 'default_options' do
+    it 'should have a default api_version of 2' do
+      expect(client_klass::DEFAULT_OPTIONS[:api_version]).to eq(2)
+    end
+
+
+    it 'should have an api_rate_limiting_token that defaults to x' do
+      expect(client_klass::DEFAULT_OPTIONS[:api_rate_limiting_token]).to eq('x')
+    end
+
+    it 'should have a base_url with https as scheme and www.bugherd.com as host' do
+      u = URI.parse(client_klass::DEFAULT_OPTIONS[:base_url])
+      expect(u.scheme).to eq('https')
+      expect(u.host).to eq('www.bugherd.com')
     end
 
-    it "should have an api_rate_limiting_token that defaults to x" do
-      BugherdClient::Client::DEFAULT_OPTIONS[:api_rate_limiting_token].should eq('x')
+  end
+
+  context '#initialize' do
+    it 'should set options when taking a block' do
+      client = BugherdClient::Client.new do |c|
+        c.username = 'user'
+        c.password = 'pass'
+        c.api_key  = 'foo'
+        c.debug    = false
+      end
+
+      expect(client.options[:username]).to  eq('user')
+      expect(client.options[:password]).to  eq('pass')
+      expect(client.options[:api_key]).to   eq('foo')
+      expect(client.options[:debug]).to     eq(false)
     end
 
+    it 'should create debug logging when the debug flag is set' do
+      expect(RestClient.log).to eq(nil)
+      client = BugherdClient::Client.new(api_key: 'apikey', debug: true)
+      expect(RestClient.log.level).to eq(Logger::DEBUG)
+    end
   end
-end
+
+  context 'initialization_errors' do
+
+    it 'should raise an error when no api_key or username and password is passed' do
+      expect {
+        c = BugherdClient::Client.new
+      }.to raise_error(BugherdClient::Errors::InvalidOption)
+    end
+
+    it 'should raise an error when a username but no password is passed' do
+      expect {
+        c = BugherdClient::Client.new(username: 'bob')
+      }.to raise_error(BugherdClient::Errors::InvalidOption)
+    end
+
+    it 'should raise an error when an invalid api_version is passed' do
+      expect {
+        c = BugherdClient::Client.new(api_version: 99)
+      }.to raise_error(BugherdClient::Errors::InvalidOption)
+    end
+  end
+
+end

data/spec/bugherd_client/v2/organization_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'http_helper'
+
+
+describe(BugherdClient::Resources::V2::Organization) do
+
+  let(:client) do
+      client = BugherdClient::Client.new(api_key: 'testing')
+  end
+
+  context 'get', vcr: { cassette_name: "organizations_get", record: :new_episodes } do
+
+    it 'should return the id and name of the organization' do
+      response = client.organizations.get
+      expect(response.id).to    eq(21203)
+      expect(response.name).to  eq('testCloud')
+    end
+
+  end
+
+end

data/spec/bugherd_client/v2/project_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'http_helper'
+
+describe(BugherdClient::Resources::V2::Project) do
+
+  let(:client) do
+    client = BugherdClient::Client.new(api_key: 'testing')
+  end
+
+  context 'all', vcr: { cassette_name: "projects_all", record: :new_episodes } do
+    it 'should return a list of projects containing id and name' do
+      response = client.projects.all
+      expect(response).to    be_an(Array)
+      expect(response.count).to eq(2)
+
+      p1 = response.first
+      expect(p1.id).to eq(40093)
+      expect(p1.name).to eq('MyTestProject')
+    end
+  end
+
+  context 'find_success', vcr: { cassette_name: "projects_find_success", record: :new_episodes } do
+    it 'should return a project when the project exists' do
+      response = client.projects.find(40093)
+
+      expect(response.id).to        eq(40093)
+      expect(response.name).to      eq('MyTestProject')
+      expect(response.devurl).to    be_a(String)
+      expect(response.api_key).to   be_a(String)
+      expect(response.is_active).to eq(true)
+      expect(response.members).to   be_an(Array)
+      expect(response.guests).to    be_an(Array)
+
+      m = response.members.first
+      expect(m.id).to             eq(50190)
+      expect(m.display_name).to   eq('John Faucett')
+
+      g = response.guests.first
+      expect(g.id).to             eq(50536)
+      expect(g.display_name).to   eq('tilman.bahls@testcloud.de')
+    end
+  end
+
+  context 'find_failure', vcr: { cassette_name: "projects_find_failure", record: :new_episodes } do
+    it 'should raise an error when project does not exist' do
+      expect {
+        client.projects.find(1)
+      }.to raise_error(BugherdClient::Errors::HttpRequestError, /404 Resource Not Found/)
+    end
+  end
+
+  context 'active', vcr: { cassette_name: "projects_active", record: :new_episodes } do
+    it 'should return all active projects' do
+      response  = client.projects.active
+
+      expect(response).to    be_an(Array)
+      expect(response.count).to eq(2)
+
+      p1 = response.first
+      expect(p1.id).to eq(40093)
+      expect(p1.name).to eq('MyTestProject')
+    end
+  end
+
+
+end

data/spec/bugherd_client/v2/task_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'http_helper'
+
+describe(BugherdClient::Resources::V2::Project) do
+
+  let(:client) do
+    client = BugherdClient::Client.new(api_key: 'testing')
+  end
+  let(:project_id) { 40093 }
+
+  context 'all', vcr: { cassette_name: 'tasks_all', record: :new_episodes } do
+    it 'should return a list of tasks in a project' do
+      tasks = client.tasks.all(project_id)
+      expect(tasks).to be_an(Array)
+      expect(tasks.count).to eq(7)
+      t = tasks.first
+
+      expect(t).to            have_key(:id)
+      expect(t).to            have_key(:created_at)
+      expect(t).to            have_key(:updated_at)
+      expect(t).to            have_key(:local_task_id)
+      expect(t).to            have_key(:priority_id)
+      expect(t).to            have_key(:assigned_to_id)
+      expect(t).to            have_key(:status_id)
+      expect(t).to            have_key(:description)
+      expect(t).to            have_key(:tag_names)
+      expect(t.tag_names).to  be_an(Array)
+      expect(t).to            have_key(:external_id)
+      expect(t).to            have_key(:requester_id)
+      expect(t).to            have_key(:requester_email)
+    end
+  end
+
+  context 'find_success', vcr: { cassette_name: 'tasks_find_success', record: :new_episodes } do
+    let(:task_id) { 1035995 }
+    it 'should return a task when it exists' do
+      t = client.tasks.find(project_id, task_id)
+
+      expect(t).to  have_key(:id)
+      expect(t).to  have_key(:created_at)
+      expect(t).to  have_key(:updated_at)
+      expect(t).to  have_key(:priority)
+      expect(t).to  have_key(:status)
+    end
+  end
+end

data/spec/bugherd_client/v2/user_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'http_helper'
+
+describe(BugherdClient::Resources::V2::User) do
+
+  let(:client) do
+    client = BugherdClient::Client.new(api_key: 'testing')
+  end
+
+  context 'all', vcr: { cassette_name: 'users_all', record: :new_episodes } do
+    it 'should return a list of all users in an organization' do
+      users = client.users.all
+      expect(users).to be_an(Array)
+
+      u = users.first
+      expect(u).to  have_key(:id)
+      expect(u).to  have_key(:email)
+      expect(u).to  have_key(:display_name)
+      expect(u).to  have_key(:avatar_url)
+    end
+  end
+
+  context 'members', vcr: { cassette_name: 'members_all', record: :new_episodes } do
+    it 'should return a list of all members in an organization' do
+      members = client.users.members
+      expect(members).to be_an(Array)
+
+      m = members.first
+
+      expect(m).to  have_key(:id)
+      expect(m).to  have_key(:email)
+      expect(m).to  have_key(:display_name)
+      expect(m).to  have_key(:avatar_url)
+    end
+  end
+
+  context 'guests', vcr: { cassette_name: 'guests_all', record: :new_episodes } do
+    it 'should return a list of all guests in an organization' do
+      guests = client.users.guests
+      expect(guests).to be_an(Array)
+
+      g = guests.first
+
+      expect(g).to  have_key(:id)
+      expect(g).to  have_key(:email)
+      expect(g).to  have_key(:display_name)
+      expect(g).to  have_key(:avatar_url)
+    end
+  end
+end

data/spec/bugherd_client/v2/webhook_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'http_helper'
+
+
+describe(BugherdClient::Resources::V2::Organization) do
+
+  let(:client) do
+    client = BugherdClient::Client.new(api_key: 'testing')
+  end
+
+  context 'all', vcr: { cassette_name: "webhooks_all", record: :new_episodes } do
+
+    it 'should return a list of webhooks' do
+      response = client.webhooks.all
+      expect(response).to    be_an(Array)
+    end
+
+  end
+
+end

data/spec/cassettes/guests_all.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://testing:x@www.bugherd.com/api_v2/users/guests
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      X-Rack-Cache:
+      - miss
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 16 Dec 2014 12:27:10 GMT
+      Status:
+      - 200 OK
+      X-Request-Id:
+      - bab0226b3420f0cdc6015723754f638b
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+      X-Runtime:
+      - '0.030071'
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - '"e408b3684383aaaccd5350fe2fed42a5"'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - X-Mapping-fjhppofk=E1227771D62C08D6CA46945339FEFF4D; path=/
+      - landing=%7B%22utm_source%22%3Anull%2C%22utm_medium%22%3Anull%2C%22utm_campaign%22%3Anull%2C%22utm_term%22%3Anull%2C%22utm_content%22%3Anull%2C%22path%22%3A%22%2Fapi_v2%2Fusers%2Fguests%22%2C%22referer%22%3Anull%2C%22remote_ip%22%3A%2290.156.0.165%22%2C%22time%22%3A%222014-12-16T12%3A27%3A10%2B00%3A00%22%7D;
+        path=/; expires=Sat, 16-Dec-2034 12:27:10 GMT
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      X-Powered-By:
+      - cloud66
+    body:
+      encoding: UTF-8
+      string: '{"users":[{"id":50536,"email":"tilman.bahls@testcloud.de","display_name":"tilman.bahls@testcloud.de","avatar_url":"https://bugherd-attachments.s3.amazonaws.com/zpyio6vsupbtvt82ofjx6w%2Favatar.png"}],"meta":{"count":1}}'
+    http_version:
+  recorded_at: Tue, 16 Dec 2014 12:27:10 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/members_all.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://testing:x@www.bugherd.com/api_v2/users/members
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Type:
+      - application/json
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      X-Rack-Cache:
+      - miss
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 16 Dec 2014 12:27:09 GMT
+      Status:
+      - 200 OK
+      X-Request-Id:
+      - 304c41dfb4b07ed826ab349971fc7e2f
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+      X-Runtime:
+      - '0.039134'
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - '"1cf31ec801872c093ed5e65c6a445d44"'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - X-Mapping-fjhppofk=F79505634CB879F90FD744F06F62BF75; path=/
+      - landing=%7B%22utm_source%22%3Anull%2C%22utm_medium%22%3Anull%2C%22utm_campaign%22%3Anull%2C%22utm_term%22%3Anull%2C%22utm_content%22%3Anull%2C%22path%22%3A%22%2Fapi_v2%2Fusers%2Fmembers%22%2C%22referer%22%3Anull%2C%22remote_ip%22%3A%2290.156.0.165%22%2C%22time%22%3A%222014-12-16T12%3A27%3A09%2B00%3A00%22%7D;
+        path=/; expires=Sat, 16-Dec-2034 12:27:09 GMT
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      X-Powered-By:
+      - cloud66
+    body:
+      encoding: UTF-8
+      string: '{"users":[{"id":50194,"email":"jan.schwenzien@testcloud.de","display_name":"Jan
+        Schwenzien","avatar_url":"https://www.bugherd.com/images/sidebar/avatar-generic.png"},{"id":50190,"email":"john.faucett@testcloud.de","display_name":"John
+        Faucett","avatar_url":"https://www.bugherd.com/images/sidebar/avatar-generic.png"}],"meta":{"count":2}}'
+    http_version:
+  recorded_at: Tue, 16 Dec 2014 12:27:09 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/organizations_get.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://testing:x@www.bugherd.com/api_v2/organization
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      X-Rack-Cache:
+      - miss
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 16 Dec 2014 10:12:33 GMT
+      Status:
+      - 200 OK
+      X-Request-Id:
+      - a4556a70c2d77eacc98719a9cf1db61a
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+      X-Runtime:
+      - '0.031217'
+      X-Content-Type-Options:
+      - nosniff
+      Etag:
+      - '"2268e965d1b289cb0de8af3514b1993c"'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - X-Mapping-fjhppofk=F79505634CB879F90FD744F06F62BF75; path=/
+      - landing=%7B%22utm_source%22%3Anull%2C%22utm_medium%22%3Anull%2C%22utm_campaign%22%3Anull%2C%22utm_term%22%3Anull%2C%22utm_content%22%3Anull%2C%22path%22%3A%22%2Fapi_v2%2Forganization%22%2C%22referer%22%3Anull%2C%22remote_ip%22%3A%2290.156.0.165%22%2C%22time%22%3A%222014-12-16T10%3A12%3A33%2B00%3A00%22%7D;
+        path=/; expires=Sat, 16-Dec-2034 10:12:33 GMT
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      X-Powered-By:
+      - cloud66
+    body:
+      encoding: UTF-8
+      string: '{"organization":{"id":21203,"name":"testCloud"}}'
+    http_version:
+  recorded_at: Tue, 16 Dec 2014 10:12:33 GMT
+recorded_with: VCR 2.9.3