noko 0.0.0 → 1.4.0

data/lib/noko/client/users.rb

@@ -0,0 +1,39 @@
+module Noko
+  class Client
+    def get_users(params = nil)
+      get('/v2/users', params)
+    end
+
+    def get_user(id)
+      get("/v2/users/#{id}")
+    end
+
+    def get_user_entries(id, params = nil)
+      get("/v2/users/#{id}/entries", params)
+    end
+
+    def get_user_expenses(id, params = nil)
+      get("/v2/users/#{id}/expenses", params)
+    end
+
+    def create_user(attributes)
+      post('/v2/users', attributes)
+    end
+
+    def update_user(id, attributes)
+      put("/v2/users/#{id}", attributes)
+    end
+
+    def delete_user(id)
+      delete("/v2/users/#{id}")
+    end
+
+    def reactivate_user(id)
+      put("/v2/users/#{id}/activate")
+    end
+
+    def deactivate_user(id)
+      put("/v2/users/#{id}/deactivate")
+    end
+  end
+end

data/lib/noko/errors.rb

@@ -0,0 +1,5 @@
+module Noko
+  class Error < StandardError; end
+
+  class AuthenticationError < Error; end
+end

data/lib/noko/link_header.rb

@@ -0,0 +1,16 @@
+require 'noko/record'
+require 'uri'
+
+module Noko
+  module LinkHeader # :nodoc:
+    extend self
+
+    REGEXP = /<([^>]+)>; rel="(\w+)"/
+
+    def parse(string)
+      string.scan(REGEXP).each_with_object(Record.new) do |(uri, rel), record|
+        record[rel.to_sym] = URI.parse(uri).request_uri
+      end
+    end
+  end
+end

data/lib/noko/params.rb

@@ -0,0 +1,27 @@
+require 'cgi'
+
+module Noko
+  module Params # :nodoc:
+    extend self
+
+    def join(path, params = nil)
+      return path if params.nil? || params.empty?
+
+      path + '?' + encode(params)
+    end
+
+    def encode(params)
+      params.map { |k, v| "#{escape(k)}=#{array_escape(v)}" }.join('&')
+    end
+
+    private
+
+    def array_escape(object)
+      Array(object).map { |value| escape(value) }.join(',')
+    end
+
+    def escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/noko/record.rb

@@ -0,0 +1,31 @@
+module Noko
+  class Record
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+    def [](name)
+      @attributes[name]
+    end
+
+    def []=(name, value)
+      @attributes[name] = value
+    end
+
+    def method_missing(name, *args, &block)
+      if @attributes.has_key?(name) && args.empty? && block.nil?
+        return @attributes[name]
+      else
+        super name, *args, &block
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @attributes.has_key?(name)
+    end
+
+    def to_h
+      @attributes
+    end
+  end
+end

data/lib/noko/version.rb

@@ -0,0 +1,3 @@
+module Noko
+  VERSION = '1.4.0'
+end

data/noko.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = 'noko'
+  s.version = '1.4.0'
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Tim Craft']
+  s.email = ['mail@timcraft.com']
+  s.homepage = 'https://github.com/timcraft/noko'
+  s.description = 'Ruby client for Version 2 of the Noko/Freckle API'
+  s.summary = 'Ruby client for Version 2 of the Noko/Freckle API'
+  s.files = Dir.glob('{lib,test}/**/*') + %w(LICENSE.txt README.md noko.gemspec)
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency('rake', '~> 12')
+  s.add_development_dependency('webmock', '~> 3.0')
+  s.add_development_dependency('minitest', '~> 5.0')
+  s.require_path = 'lib'
+end

data/test/noko/client/account_test.rb

@@ -0,0 +1,9 @@
+require_relative '../client_test'
+
+class ClientAccountTest < ClientTest
+  def test_get_account
+    expect_request(:get, "#{base_url}/account").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_account
+  end
+end

data/test/noko/client/current_user_test.rb

@@ -0,0 +1,39 @@
+require_relative '../client_test'
+
+class ClientCurrentUserTest < ClientTest
+  def test_get_current_user
+    expect_request(:get, "#{base_url}/current_user").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_current_user
+  end
+
+  def test_get_current_user_entries
+    expect_request(:get, "#{base_url}/current_user/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_current_user_entries
+  end
+
+  def test_get_current_user_entries_encodes_params
+    expect_request(:get, "#{base_url}/current_user/entries?billable=true")
+
+    client.get_current_user_entries(billable: true)
+  end
+
+  def test_get_current_user_expenses
+    expect_request(:get, "#{base_url}/current_user/expenses").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_current_user_expenses
+  end
+
+  def test_get_current_user_expenses_encodes_params
+    expect_request(:get, "#{base_url}/current_user/expenses?invoiced=true")
+
+    client.get_current_user_expenses(invoiced: true)
+  end
+
+  def test_update_current_user
+    expect_request(:put, "#{base_url}/current_user").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_current_user(week_start: 'monday')
+  end
+end

data/test/noko/client/entries_test.rb

@@ -0,0 +1,45 @@
+require_relative '../client_test'
+
+class ClientEntriesTest < ClientTest
+  def test_get_entries
+    expect_request(:get, "#{base_url}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_entries
+  end
+
+  def test_get_entries_encodes_params
+    expect_request(:get, "#{base_url}/entries?billable=true")
+
+    client.get_entries(billable: true)
+  end
+
+  def test_get_entries_encodes_project_ids
+    expect_request(:get, "#{base_url}/entries?project_ids=123,456,789")
+
+    client.get_entries(project_ids: ids)
+  end
+
+  def test_get_entry
+    expect_request(:get, "#{base_url}/entries/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_entry(id)
+  end
+
+  def test_create_entry
+    expect_request(:post, "#{base_url}/entries").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_entry(date: Date.today, minutes: 60)
+  end
+
+  def test_update_entry
+    expect_request(:put, "#{base_url}/entries/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_entry(id, minutes: 120)
+  end
+
+  def test_delete_entry
+    expect_request(:delete, "#{base_url}/entries/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_entry(id)
+  end
+end

data/test/noko/client/errors_test.rb

@@ -0,0 +1,27 @@
+require_relative '../client_test'
+
+class ClientErrorsTest < ClientTest
+  def test_bad_request_errors
+    message = 'The Project cannot be deleted because it has entries, expenses, or invoices.'
+
+    response = json_response.merge(status: 400, body: %({"message":"#{message}"}))
+
+    stub_request(:delete, "#{base_url}/projects/#{id}").to_return(response)
+
+    exception = assert_raises(Noko::Error) do
+      client.delete_project(id)
+    end
+
+    assert_includes exception.message, message
+  end
+
+  def test_authentication_errors
+    response = json_response.merge(status: 401)
+
+    stub_request(:get, "#{base_url}/entries").to_return(response)
+
+    assert_raises(Noko::AuthenticationError) do
+      client.get_entries
+    end
+  end
+end

data/test/noko/client/expenses_test.rb

@@ -0,0 +1,45 @@
+require_relative '../client_test'
+
+class ClientExpensesTest < ClientTest
+  def test_get_expenses
+    expect_request(:get, "#{base_url}/expenses").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_expenses
+  end
+
+  def test_get_expenses_encodes_params
+    expect_request(:get, "#{base_url}/expenses?invoiced=true")
+
+    client.get_expenses(invoiced: true)
+  end
+
+  def test_get_expenses_encodes_ids
+    expect_request(:get, "#{base_url}/expenses?project_ids=123,456,789")
+
+    client.get_expenses(project_ids: ids)
+  end
+
+  def test_get_expense
+    expect_request(:get, "#{base_url}/expenses/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_expense(id)
+  end
+
+  def test_create_expense
+    expect_request(:post, "#{base_url}/expenses").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_expense(date: Date.today, project_id: id, price: '14.55')
+  end
+
+  def test_update_expense
+    expect_request(:put, "#{base_url}/expenses/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_expense(id, price: '19.99')
+  end
+
+  def test_delete_expense
+    expect_request(:delete, "#{base_url}/expenses/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_expense(id)
+  end
+end

data/test/noko/client/invoices_test.rb

@@ -0,0 +1,75 @@
+require_relative '../client_test'
+
+class ClientInvoicesTest < ClientTest
+  def test_get_invoices
+    expect_request(:get, "#{base_url}/invoices").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_invoices
+  end
+
+  def test_get_invoices_encodes_params
+    expect_request(:get, "#{base_url}/invoices?state=unpaid")
+
+    client.get_invoices(state: :unpaid)
+  end
+
+  def test_get_invoice
+    expect_request(:get, "#{base_url}/invoices/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_invoice(id)
+  end
+
+  def test_create_invoice
+    expect_request(:post, "#{base_url}/invoices").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_invoice(invoice_date: Date.today)
+  end
+
+  def test_update_invoice
+    expect_request(:put, "#{base_url}/invoices/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_invoice(id, reference: 'AB 0001')
+  end
+
+  def test_mark_invoice_paid
+    expect_request(:put, "#{base_url}/invoices/#{id}/paid").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.mark_invoice_paid(id)
+  end
+
+  def test_mark_invoice_unpaid
+    expect_request(:put, "#{base_url}/invoices/#{id}/unpaid").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.mark_invoice_unpaid(id)
+  end
+
+  def test_get_invoice_entries
+    expect_request(:get, "#{base_url}/invoices/#{id}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_invoice_entries(id)
+  end
+
+  def test_get_invoice_entries_encodes_params
+    expect_request(:get, "#{base_url}/invoices/#{id}/entries?billable=true")
+
+    client.get_invoice_entries(id, billable: true)
+  end
+
+  def test_get_invoice_expenses
+    expect_request(:get, "#{base_url}/invoices/#{id}/expenses").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_invoice_expenses(id)
+  end
+
+  def test_get_invoice_expenses_encodes_params
+    expect_request(:get, "#{base_url}/invoices/#{id}/expenses?invoiced=false")
+
+    client.get_invoice_expenses(id, invoiced: false)
+  end
+
+  def test_delete_invoice
+    expect_request(:delete, "#{base_url}/invoices/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_invoice(id)
+  end
+end

data/test/noko/client/options_test.rb

@@ -0,0 +1,27 @@
+require_relative '../client_test'
+
+class ClientOptionsTest < ClientTest
+  def user_agent
+    'account.nokotime.com'
+  end
+
+  def access_token
+    'oauth2-access-token'
+  end
+
+  def test_user_agent_option
+    client = Noko::Client.new(token: token, user_agent: user_agent)
+
+    expect_request(:get, "#{base_url}/entries").with(headers: {'User-Agent' => user_agent})
+
+    client.get_entries
+  end
+
+  def test_access_token_option
+    client = Noko::Client.new(access_token: access_token)
+
+    expect_request(:get, "#{base_url}/entries").with(headers: {'Authorization' => 'token oauth2-access-token'})
+
+    client.get_entries
+  end
+end

data/test/noko/client/project_groups_test.rb

@@ -0,0 +1,63 @@
+require_relative '../client_test'
+
+class ClientProjectGroupsTest < ClientTest
+  def test_get_project_groups
+    expect_request(:get, "#{base_url}/project_groups").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_project_groups
+  end
+
+  def test_get_project_groups_encodes_params
+    expect_request(:get, "#{base_url}/project_groups?name=Sprockets")
+
+    client.get_project_groups(name: 'Sprockets')
+  end
+
+  def test_get_project_group
+    expect_request(:get, "#{base_url}/project_groups/#{id}").with(auth_header).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.get_project_group(id)
+  end
+
+  def test_create_project_group
+    expect_request(:post, "#{base_url}/project_groups").with(json_request).to_return(json_response.merge(status: 201))
+
+    assert_instance_of Noko::Record, client.create_project_group(name: 'Sprockets, Inc.')
+  end
+
+  def test_get_project_group_entries
+    expect_request(:get, "#{base_url}/project_groups/#{id}/entries").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_project_group_entries(id)
+  end
+
+  def test_get_project_group_entries_encodes_params
+    expect_request(:get, "#{base_url}/project_groups/#{id}/entries?billable=true")
+
+    client.get_project_group_entries(id, billable: true)
+  end
+
+  def test_get_project_group_projects
+    expect_request(:get, "#{base_url}/project_groups/#{id}/projects").with(auth_header).to_return(json_array_response)
+
+    assert_equal [], client.get_project_group_projects(id)
+  end
+
+  def test_get_project_group_projects_encodes_params
+    expect_request(:get, "#{base_url}/project_groups/#{id}/projects?billable=true")
+
+    client.get_project_group_projects(id, billable: true)
+  end
+
+  def test_update_project_group
+    expect_request(:put, "#{base_url}/project_groups/#{id}").with(json_request).to_return(json_response)
+
+    assert_instance_of Noko::Record, client.update_project_group(id, name: 'Sprockets, Inc.')
+  end
+
+  def test_delete_project_group
+    expect_request(:delete, "#{base_url}/project_groups/#{id}").with(auth_header).to_return(status: 204)
+
+    assert_equal :no_content, client.delete_project_group(id)
+  end
+end