noko 0.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e20acde5d6a8996729182c545b3f02493b6c6d4456c57e7f802a4afbbb23d10
-  data.tar.gz: 015f207bc374bf4711717bf8c7633bcba0dc469737083541e2886705230d0afb
+  metadata.gz: afa40cf652f7da2b1c9feb0424800d941d997991c6c4b910c46975c5c22c5fae
+  data.tar.gz: 56adb6ca37608d673058f13b9349d200ea376d217ea2b15ad4170baf124a2404
 SHA512:
-  metadata.gz: a2f31aa33be6bf23e2391b9697723cd87075ed525a7a0051512f56e6e3dc5dadfabca1f4cdcf880d43ec08179e9eb712e5a21754bc3a6e1949b5c7303f32dc5f
-  data.tar.gz: 0fa8b0ceafc2eddb3b8456b4bf4f2877cd408ea8aac3d7eb9fe841a792bbf63b229bcd95b91778d5983c489b06d7f5ce619abacfe5984c0855eb031fb9151dfe
+  metadata.gz: 16d9ec8b0b3ae50cc931e2326691dd4ac8c3a3865c46ef996f61ecb915db88038209daf8f17da9e28d61912ff8f7abbed22c9520fb1001347f4c709372a20a77
+  data.tar.gz: 022b303e0a7b4f61410b7a4a9c2ef467e9e8173b971140d3bb8df764c31f88e60e5fe68a45b2f50e3a66a8d9c36e95db6a1de67775d8fb659b015b380cd61560

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2019 TIMCRAFT
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# noko
+
+[![Gem Version](https://badge.fury.io/rb/noko.svg)](https://badge.fury.io/rb/noko) [![Build Status](https://api.travis-ci.org/timcraft/noko.svg?branch=master)](https://travis-ci.org/timcraft/noko)
+
+
+Ruby client for [Version 2 of the Noko/Freckle API](https://developer.nokotime.com/v2/).
+
+
+## Install
+
+Install using RubyGems:
+
+```
+$ gem install noko
+```
+
+Add it to your Gemfile and install using Bundler:
+
+```ruby
+gem 'noko'
+```
+
+Clone the repository:
+
+```
+git clone git@github.com:timcraft/noko.git
+```
+
+
+## Quick start
+
+```ruby
+require 'noko'
+
+noko = Noko::Client.new(token: 'YOUR PERSONAL ACCESS TOKEN')
+
+noko.get_projects.each do |project|
+  puts project.name
+end
+```

data/lib/noko.rb

@@ -0,0 +1,11 @@
+require 'noko/client'
+require 'noko/client/account'
+require 'noko/client/current_user'
+require 'noko/client/entries'
+require 'noko/client/expenses'
+require 'noko/client/invoices'
+require 'noko/client/project_groups'
+require 'noko/client/projects'
+require 'noko/client/tags'
+require 'noko/client/timers'
+require 'noko/client/users'

data/lib/noko/client.rb

@@ -0,0 +1,83 @@
+require 'noko/version'
+require 'noko/errors'
+require 'noko/link_header'
+require 'noko/params'
+require 'noko/record'
+require 'net/http'
+require 'json'
+
+module Noko
+  class Client
+    def initialize(options = {})
+      if options.key?(:access_token)
+        @auth_header, @auth_value = 'Authorization', "token #{options[:access_token]}"
+      else
+        @auth_header, @auth_value = 'X-NokoToken', options.fetch(:token)
+      end
+
+      @user_agent = options.fetch(:user_agent) { "noko/#{VERSION} ruby/#{RUBY_VERSION}" }
+
+      @host = 'api.nokotime.com'
+
+      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
+
+      @http.use_ssl = true
+    end
+
+    def get(path, params = nil)
+      request(Net::HTTP::Get.new(Params.join(path, params)))
+    end
+
+    private
+
+    def post(path, attributes)
+      request(Net::HTTP::Post.new(path), attributes)
+    end
+
+    def put(path, attributes = nil)
+      request(Net::HTTP::Put.new(path), attributes)
+    end
+
+    def delete(path)
+      request(Net::HTTP::Delete.new(path))
+    end
+
+    def request(http_request, body_object = nil)
+      http_request['User-Agent'] = @user_agent
+      http_request[@auth_header] = @auth_value
+
+      if body_object
+        http_request['Content-Type'] = 'application/json'
+        http_request.body = JSON.generate(body_object)
+      end
+
+      parse(@http.request(http_request))
+    end
+
+    def parse(http_response)
+      case http_response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        if http_response['Content-Type'] && http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse(http_response.body, symbolize_names: true, object_class: Record).tap do |object|
+            if http_response['Link']
+              object.singleton_class.module_eval { attr_accessor :link }
+              object.link = LinkHeader.parse(http_response['Link'])
+            end
+          end
+        else
+          http_response.body
+        end
+      when Net::HTTPBadRequest
+        object = JSON.parse(http_response.body, symbolize_names: true)
+
+        raise Error, object.fetch(:message)
+      when Net::HTTPUnauthorized
+        raise AuthenticationError
+      else
+        raise Error, "unexpected #{http_response.code} response from #{@host}"
+      end
+    end
+  end
+end

data/lib/noko/client/account.rb

@@ -0,0 +1,7 @@
+module Noko
+  class Client
+    def get_account
+      get('/v2/account')
+    end
+  end
+end

data/lib/noko/client/current_user.rb

@@ -0,0 +1,19 @@
+module Noko
+  class Client
+    def get_current_user
+      get('/v2/current_user')
+    end
+
+    def get_current_user_entries(params = nil)
+      get('/v2/current_user/entries', params)
+    end
+
+    def get_current_user_expenses(params = nil)
+      get('/v2/current_user/expenses', params)
+    end
+
+    def update_current_user(attributes)
+      put('/v2/current_user', attributes)
+    end
+  end
+end

data/lib/noko/client/entries.rb

@@ -0,0 +1,23 @@
+module Noko
+  class Client
+    def get_entries(params = nil)
+      get('/v2/entries', params)
+    end
+
+    def get_entry(id)
+      get("/v2/entries/#{id}")
+    end
+
+    def create_entry(attributes)
+      post('/v2/entries', attributes)
+    end
+
+    def update_entry(id, attributes)
+      put("/v2/entries/#{id}", attributes)
+    end
+
+    def delete_entry(id)
+      delete("/v2/entries/#{id}")
+    end
+  end
+end

data/lib/noko/client/expenses.rb

@@ -0,0 +1,23 @@
+module Noko
+  class Client
+    def get_expenses(params = nil)
+      get('/v2/expenses', params)
+    end
+
+    def get_expense(id)
+      get("/v2/expenses/#{id}")
+    end
+
+    def create_expense(attributes)
+      post('/v2/expenses', attributes)
+    end
+
+    def update_expense(id, attributes)
+      put("/v2/expenses/#{id}", attributes)
+    end
+
+    def delete_expense(id)
+      delete("/v2/expenses/#{id}")
+    end
+  end
+end

data/lib/noko/client/invoices.rb

@@ -0,0 +1,39 @@
+module Noko
+  class Client
+    def get_invoices(params = nil)
+      get('/v2/invoices', params)
+    end
+
+    def get_invoice(id)
+      get("/v2/invoices/#{id}")
+    end
+
+    def create_invoice(attributes)
+      post('/v2/invoices', attributes)
+    end
+
+    def update_invoice(id, attributes)
+      put("/v2/invoices/#{id}", attributes)
+    end
+
+    def mark_invoice_paid(id)
+      put("/v2/invoices/#{id}/paid")
+    end
+
+    def mark_invoice_unpaid(id)
+      put("/v2/invoices/#{id}/unpaid")
+    end
+
+    def get_invoice_entries(id, params = nil)
+      get("/v2/invoices/#{id}/entries", params)
+    end
+
+    def get_invoice_expenses(id, params = nil)
+      get("/v2/invoices/#{id}/expenses", params)
+    end
+
+    def delete_invoice(id)
+      delete("/v2/invoices/#{id}")
+    end
+  end
+end

data/lib/noko/client/project_groups.rb

@@ -0,0 +1,31 @@
+module Noko
+  class Client
+    def get_project_groups(params = nil)
+      get('/v2/project_groups', params)
+    end
+
+    def get_project_group(id)
+      get("/v2/project_groups/#{id}")
+    end
+
+    def create_project_group(attributes)
+      post('/v2/project_groups', attributes)
+    end
+
+    def get_project_group_entries(id, params = nil)
+      get("/v2/project_groups/#{id}/entries", params)
+    end
+
+    def get_project_group_projects(id, params = nil)
+      get("/v2/project_groups/#{id}/projects", params)
+    end
+
+    def update_project_group(id, attributes)
+      put("/v2/project_groups/#{id}", attributes)
+    end
+
+    def delete_project_group(id)
+      delete("/v2/project_groups/#{id}")
+    end
+  end
+end

data/lib/noko/client/projects.rb

@@ -0,0 +1,55 @@
+module Noko
+  class Client
+    def get_projects(params = nil)
+      get('/v2/projects', params)
+    end
+
+    def get_project(id)
+      get("/v2/projects/#{id}")
+    end
+
+    def create_project(attributes)
+      post('/v2/projects', attributes)
+    end
+
+    def get_project_entries(id, params = nil)
+      get("/v2/projects/#{id}/entries", params)
+    end
+
+    def get_project_expenses(id, params = nil)
+      get("/v2/projects/#{id}/expenses", params)
+    end
+
+    def update_project(id, attributes)
+      put("/v2/projects/#{id}", attributes)
+    end
+
+    def merge_projects(id, project_id)
+      put("/v2/projects/#{id}/merge", project_id: project_id)
+    end
+
+    def delete_project(id)
+      delete("/v2/projects/#{id}")
+    end
+
+    def archive_project(id)
+      put("/v2/projects/#{id}/archive")
+    end
+
+    def unarchive_project(id)
+      put("/v2/projects/#{id}/unarchive")
+    end
+
+    def archive_projects(project_ids)
+      put('/v2/projects/archive', project_ids: project_ids)
+    end
+
+    def unarchive_projects(project_ids)
+      put('/v2/projects/unarchive', project_ids: project_ids)
+    end
+
+    def delete_projects(project_ids)
+      put('/v2/projects/delete', project_ids: project_ids)
+    end
+  end
+end

data/lib/noko/client/tags.rb

@@ -0,0 +1,35 @@
+module Noko
+  class Client
+    def get_tags(params = nil)
+      get('/v2/tags', params)
+    end
+
+    def create_tags(names)
+      post('/v2/tags', names: names)
+    end
+
+    def get_tag(id)
+      get("/v2/tags/#{id}")
+    end
+
+    def get_tag_entries(id, params = nil)
+      get("/v2/tags/#{id}/entries", params)
+    end
+
+    def update_tag(id, attributes)
+      put("/v2/tags/#{id}", attributes)
+    end
+
+    def merge_tags(id, tag_id)
+      put("/v2/tags/#{id}/merge", tag_id: tag_id)
+    end
+
+    def delete_tag(id)
+      delete("/v2/tags/#{id}")
+    end
+
+    def delete_tags(tag_ids)
+      put('/v2/tags/delete', tag_ids: tag_ids)
+    end
+  end
+end

data/lib/noko/client/timers.rb

@@ -0,0 +1,31 @@
+module Noko
+  class Client
+    def get_timers(params = nil)
+      get('/v2/timers', params)
+    end
+
+    def get_timer(project_id)
+      get("/v2/projects/#{project_id}/timer")
+    end
+
+    def update_timer(project_id, attributes)
+      put("/v2/projects/#{project_id}/timer", attributes)
+    end
+
+    def start_timer(project_id)
+      put("/v2/projects/#{project_id}/timer/start")
+    end
+
+    def pause_timer(project_id)
+      put("/v2/projects/#{project_id}/timer/pause")
+    end
+
+    def log_timer(project_id, attributes = {})
+      put("/v2/projects/#{project_id}/timer/log", attributes)
+    end
+
+    def discard_timer(project_id)
+      delete("/v2/projects/#{project_id}/timer")
+    end
+  end
+end