noko 0.0.0 → 1.4.0

data/test/noko/client/projects_test.rb

@@ -0,0 +1,99 @@
+require_relative '../client_test'
+
+class ClientProjectsTest < ClientTest
+  def test_get_projects
+    expect_request(:get, "#{base_url}/projects").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_projects
+  end
+
+  def test_get_projects_encodes_params
+    expect_request(:get, "#{base_url}/projects?billable=true")
+
+    client.get_projects(billable: true)
+  end
+
+  def test_get_project
+    expect_request(:get, "#{base_url}/projects/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_project(id)
+  end
+
+  def test_create_project
+    expect_request(:post, "#{base_url}/projects").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_project(name: 'Gear GmbH')
+  end
+
+  def test_get_project_entries
+    expect_request(:get, "#{base_url}/projects/#{id}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_project_entries(id)
+  end
+
+  def test_get_project_entries_encodes_params
+    expect_request(:get, "#{base_url}/projects/#{id}/entries?billable=true")
+
+    client.get_project_entries(id, billable: true)
+  end
+
+  def test_get_project_expenses
+    expect_request(:get, "#{base_url}/projects/#{id}/expenses").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_project_expenses(id)
+  end
+
+  def test_get_project_expenses_encodes_params
+    expect_request(:get, "#{base_url}/projects/#{id}/expenses?invoiced=true")
+
+    client.get_project_expenses(id, invoiced: true)
+  end
+
+  def test_update_project
+    expect_request(:put, "#{base_url}/projects/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_project(id, color: '#ff9898')
+  end
+
+  def test_merge_projects
+    expect_request(:put, "#{base_url}/projects/#{id}/merge").with(json_request.merge(body: '{"project_id":5678}')).to_return(status: 204)
+
+    assert_equal :no_content, client.merge_projects(id, 5678)
+  end
+
+  def test_delete_project
+    expect_request(:delete, "#{base_url}/projects/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_project(id)
+  end
+
+  def test_archive_project
+    expect_request(:put, "#{base_url}/projects/#{id}/archive").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.archive_project(id)
+  end
+
+  def test_unarchive_project
+    expect_request(:put, "#{base_url}/projects/#{id}/unarchive").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.unarchive_project(id)
+  end
+
+  def test_archive_projects
+    expect_request(:put, "#{base_url}/projects/archive").with(json_request.merge(body: '{"project_ids":[123]}')).to_return(status: 204)
+
+    assert_equal :no_content, client.archive_projects([id])
+  end
+
+  def test_unarchive_projects
+    expect_request(:put, "#{base_url}/projects/unarchive").with(json_request.merge(body: '{"project_ids":[123]}')).to_return(status: 204)
+
+    assert_equal :no_content, client.unarchive_projects([id])
+  end
+
+  def test_delete_projects
+    expect_request(:put, "#{base_url}/projects/delete").with(json_request.merge(body: '{"project_ids":[123]}')).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_projects([id])
+  end
+end

data/test/noko/client/response_test.rb

@@ -0,0 +1,39 @@
+require_relative '../client_test'
+
+class ClientResponseTest < ClientTest
+  def response(headers)
+    {headers: json_response_headers.merge(headers), body: '[]'}
+  end
+
+  def test_rel_next_link
+    link = '<https://api.nokotime.com/v2/entries?page=3>; rel="next"'
+
+    expect_request(:get, "#{base_url}/entries").to_return(response('Link' => link))
+
+    assert_equal '/v2/entries?page=3', client.get_entries.link.next
+  end
+
+  def test_rel_prev_link
+    link = '<https://api.nokotime.com/v2/entries?page=2>; rel="prev"'
+
+    expect_request(:get, "#{base_url}/entries").to_return(response('Link' => link))
+
+    assert_equal '/v2/entries?page=2', client.get_entries.link.prev
+  end
+
+  def test_rel_last_link
+    link = '<https://api.nokotime.com/v2/entries?page=50>; rel="last"'
+
+    expect_request(:get, "#{base_url}/entries").to_return(response('Link' => link))
+
+    assert_equal '/v2/entries?page=50', client.get_entries.link.last
+  end
+
+  def test_rel_first_link
+    link = '<https://api.nokotime.com/v2/entries?page=1>; rel="first"'
+
+    expect_request(:get, "#{base_url}/entries").to_return(response('Link' => link))
+
+    assert_equal '/v2/entries?page=1', client.get_entries.link.first
+  end
+end

data/test/noko/client/tags_test.rb

@@ -0,0 +1,63 @@
+require_relative '../client_test'
+
+class ClientTagsTest < ClientTest
+  def test_get_tags
+    expect_request(:get, "#{base_url}/tags").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_tags
+  end
+
+  def test_get_tags_encodes_params
+    expect_request(:get, "#{base_url}/tags?billable=true")
+
+    client.get_tags(billable: true)
+  end
+
+  def test_create_tags
+    expect_request(:post, "#{base_url}/tags").with(json_request).to_return(json_array_response.merge(status: 201))
+
+    assert_equal [], client.create_tags(%w[freckle])
+  end
+
+  def test_get_tag
+    expect_request(:get, "#{base_url}/tags/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_tag(id)
+  end
+
+  def test_get_tag_entries
+    expect_request(:get, "#{base_url}/tags/#{id}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_tag_entries(id)
+  end
+
+  def test_get_tag_entries_encodes_params
+    expect_request(:get, "#{base_url}/tags/#{id}/entries?billable=true")
+
+    client.get_tag_entries(id, billable: true)
+  end
+
+  def test_update_tag
+    expect_request(:put, "#{base_url}/tags/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_tag(id, name: 'freckle')
+  end
+
+  def test_merge_tags
+    expect_request(:put, "#{base_url}/tags/#{id}/merge").with(json_request.merge(body: '{"tag_id":5678}')).to_return(status: 204)
+
+    assert_equal :no_content, client.merge_tags(id, 5678)
+  end
+
+  def test_delete_tag
+    expect_request(:delete, "#{base_url}/tags/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_tag(id)
+  end
+
+  def test_delete_tags
+    expect_request(:put, "#{base_url}/tags/delete").with(json_request.merge(body: '{"tag_ids":[123]}')).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_tags([id])
+  end
+end

data/test/noko/client/timers_test.rb

@@ -0,0 +1,57 @@
+require_relative '../client_test'
+
+class ClientTimersTest < ClientTest
+  def test_get_timers
+    expect_request(:get, "#{base_url}/timers").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_timers
+  end
+
+  def test_get_timers_encodes_params
+    expect_request(:get, "#{base_url}/timers?billable=true")
+
+    client.get_timers(billable: true)
+  end
+
+  def test_get_timers_encodes_ids
+    expect_request(:get, "#{base_url}/timers?projects=123,456,789")
+
+    client.get_timers(projects: ids)
+  end
+
+  def test_get_timer
+    expect_request(:get, "#{base_url}/projects/#{id}/timer").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_timer(id)
+  end
+
+  def test_update_timer
+    expect_request(:put, "#{base_url}/projects/#{id}/timer").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_timer(id, description: 'Notes go here')
+  end
+
+  def test_start_timer
+    expect_request(:put, "#{base_url}/projects/#{id}/timer/start").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.start_timer(id)
+  end
+
+  def test_pause_timer
+    expect_request(:put, "#{base_url}/projects/#{id}/timer/pause").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.pause_timer(id)
+  end
+
+  def test_log_timer
+    expect_request(:put, "#{base_url}/projects/#{id}/timer/log").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.log_timer(id, description: 'Serious #development work')
+  end
+
+  def test_discard_timer
+    expect_request(:delete, "#{base_url}/projects/#{id}/timer").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.discard_timer(id)
+  end
+end

data/test/noko/client/users_test.rb

@@ -0,0 +1,75 @@
+require_relative '../client_test'
+
+class ClientUsersTest < ClientTest
+  def test_get_users
+    expect_request(:get, "#{base_url}/users").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_users
+  end
+
+  def test_get_users_encodes_params
+    expect_request(:get, "#{base_url}/users?name=John")
+
+    client.get_users(name: 'John')
+  end
+
+  def test_get_user
+    expect_request(:get, "#{base_url}/users/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_user(id)
+  end
+
+  def test_get_user_entries
+    expect_request(:get, "#{base_url}/users/#{id}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_user_entries(id)
+  end
+
+  def test_get_user_entries_encodes_params
+    expect_request(:get, "#{base_url}/users/#{id}/entries?billable=true")
+
+    client.get_user_entries(id, billable: true)
+  end
+
+  def test_get_user_expenses
+    expect_request(:get, "#{base_url}/users/#{id}/expenses").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_user_expenses(id)
+  end
+
+  def test_get_user_expenses_encodes_params
+    expect_request(:get, "#{base_url}/users/#{id}/expenses?invoiced=true")
+
+    client.get_user_expenses(id, invoiced: true)
+  end
+
+  def test_create_user
+    expect_request(:post, "#{base_url}/users").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_user(email: 'alice@example.com')
+  end
+
+  def test_update_user
+    expect_request(:put, "#{base_url}/users/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_user(id, role: 'leader')
+  end
+
+  def test_delete_user
+    expect_request(:delete, "#{base_url}/users/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_user(id)
+  end
+
+  def test_reactivate_user
+    expect_request(:put, "#{base_url}/users/#{id}/activate").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.reactivate_user(id)
+  end
+
+  def test_deactivate_user
+    expect_request(:put, "#{base_url}/users/#{id}/deactivate").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.deactivate_user(id)
+  end
+end

data/test/noko/client_test.rb

@@ -0,0 +1,59 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'noko'
+
+class ClientTest < Minitest::Test
+  def token
+    'token-xxx'
+  end
+
+  def id
+    123
+  end
+
+  def ids
+    %w[123 456 789]
+  end
+
+  def base_url
+    'https://api.nokotime.com/v2'
+  end
+
+  def auth_header
+    {headers: {'X-NokoToken' => token}}
+  end
+
+  def json_request
+    {headers: {'X-NokoToken' => token, 'Content-Type' => 'application/json'}, body: /\A{.+}\z/}
+  end
+
+  def json_response_headers
+    {'Content-Type' => 'application/json;charset=utf-8'}
+  end
+
+  def json_response
+    {headers: json_response_headers, body: '{}'}
+  end
+
+  def json_array_response
+    {headers: json_response_headers, body: '[]'}
+  end
+
+  attr_accessor :client
+  attr_accessor :request
+
+  def setup
+    WebMock.reset!
+
+    self.client = Noko::Client.new(token: token)
+    self.request = nil
+  end
+
+  def teardown
+    assert_requested(request) if request
+  end
+
+  def expect_request(*args)
+    self.request = stub_request(*args)
+  end
+end

data/test/noko/record_test.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'noko'
+
+class RecordTest < Minitest::Test
+  def id
+    123
+  end
+
+  attr_accessor :record
+
+  def setup
+    self.record = Noko::Record.new(project_id: id)
+  end
+
+  def test_square_brackets_returns_attribute_values
+    assert_equal id, record[:project_id]
+  end
+
+  def test_method_missing_returns_attribute_values
+    assert_equal id, record.project_id
+  end
+
+  def test_to_h_returns_attributes_hash
+    attributes = {project_id: id}
+
+    assert_equal attributes, record.to_h
+  end
+end

metadata

@@ -1,23 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: noko
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
-dependencies: []
-description: Ruby client library for the Noko API
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Ruby client for Version 2 of the Noko/Freckle API
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://nokotime.com
+files:
+- LICENSE.txt
+- README.md
+- lib/noko.rb
+- lib/noko/client.rb
+- lib/noko/client/account.rb
+- lib/noko/client/current_user.rb
+- lib/noko/client/entries.rb
+- lib/noko/client/expenses.rb
+- lib/noko/client/invoices.rb
+- lib/noko/client/project_groups.rb
+- lib/noko/client/projects.rb
+- lib/noko/client/tags.rb
+- lib/noko/client/timers.rb
+- lib/noko/client/users.rb
+- lib/noko/errors.rb
+- lib/noko/link_header.rb
+- lib/noko/params.rb
+- lib/noko/record.rb
+- lib/noko/version.rb
+- noko.gemspec
+- test/noko/client/account_test.rb
+- test/noko/client/current_user_test.rb
+- test/noko/client/entries_test.rb
+- test/noko/client/errors_test.rb
+- test/noko/client/expenses_test.rb
+- test/noko/client/invoices_test.rb
+- test/noko/client/options_test.rb
+- test/noko/client/project_groups_test.rb
+- test/noko/client/projects_test.rb
+- test/noko/client/response_test.rb
+- test/noko/client/tags_test.rb
+- test/noko/client/timers_test.rb
+- test/noko/client/users_test.rb
+- test/noko/client_test.rb
+- test/noko/record_test.rb
+homepage: https://github.com/timcraft/noko
 licenses:
 - MIT
 metadata: {}
@@ -29,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -39,5 +116,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Ruby client library for the Noko (née Freckle) v2 API
+summary: Ruby client for Version 2 of the Noko/Freckle API
 test_files: []