tripletexer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66ce0e7589da08bb03238b69a831ac8d35692865
+  data.tar.gz: 52d3c8c42e5695d1775efadf6eae9daf64463fda
+SHA512:
+  metadata.gz: 3b39f1a23c84628acff62e3ca07cf26a7dad630437577241a0e28f6843d2b5e0285c51458b7b6a961c5cf38b6e3195b5c8c5566a661a5a3d851586c946e0d1de
+  data.tar.gz: 1910c4776bb6a92fd01f54c79ad0bc1f99dd17a9650ea930f545b8e4faac17d547ba16106f6a140523ded934f4133ce09c325302b89232a5712b92da40c562d4

data/LICENSE

@@ -0,0 +1,26 @@
+BSD 2-Clause License
+
+Copyright (c) 2017, Aldis Berjoza <aldis@berjoza.lv>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,35 @@
+# Tripletexer - ruby client for tripletex.no API v2
+
+## Getting started
+Add tripletexer to your Gemfile
+```ruby
+gem 'tripletexer', '~> 0.1.0'
+```
+run bundle install
+
+## Using tripletexer
+
+Tripletex.no API documentation can be found here: https://tripletex.no/v2-docs/
+
+This gem tries to fallow patterns of tripletex.no documentation, however not completely.
+
+```ruby
+client = Tripletexer.new
+
+# start new session
+client.token.session.create('your_consumer_token', 'your_employee_token')
+
+client.invoice.search(Date.new(2017), Time.now.to_date).each do |invoice|
+  # do something with invoice
+end
+
+# revoke token
+client.token.session.destroy
+```
+
+When tipletex.no API returns a list tripletexer gem returns an instance of
+enumerator, this way you never have to deal with pagination.
+
+## TODO
+
+Write some tests

data/lib/tripletexer.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+%w[
+  tripletexer/version.rb
+  tripletexer/errors.rb
+  tripletexer/connection.rb
+  tripletexer/format_helpers.rb
+  tripletexer/endpoints.rb
+  tripletexer/endpoints/abstract_endpoint.rb
+  tripletexer/endpoints/activity.rb
+  tripletexer/endpoints/address.rb
+  tripletexer/endpoints/company.rb
+  tripletexer/endpoints/contact.rb
+  tripletexer/endpoints/country.rb
+  tripletexer/endpoints/currency.rb
+  tripletexer/endpoints/customer.rb
+  tripletexer/endpoints/customer/category.rb
+  tripletexer/endpoints/department.rb
+  tripletexer/endpoints/employee.rb
+  tripletexer/endpoints/employee/entitlement.rb
+  tripletexer/endpoints/inventory.rb
+  tripletexer/endpoints/invoice.rb
+  tripletexer/endpoints/invoice/payment_type.rb
+  tripletexer/endpoints/ledger.rb
+  tripletexer/endpoints/ledger/account.rb
+  tripletexer/endpoints/ledger/accounting_period.rb
+  tripletexer/endpoints/ledger/annual_account.rb
+  tripletexer/endpoints/ledger/close_group.rb
+  tripletexer/endpoints/ledger/posting.rb
+  tripletexer/endpoints/ledger/vat_type.rb
+  tripletexer/endpoints/ledger/voucher.rb
+  tripletexer/endpoints/ledger/voucher_type.rb
+  tripletexer/endpoints/order.rb
+  tripletexer/endpoints/order/orderline.rb
+  tripletexer/endpoints/product.rb
+  tripletexer/endpoints/project.rb
+  tripletexer/endpoints/project/category.rb
+  tripletexer/endpoints/supplier.rb
+  tripletexer/endpoints/timesheet.rb
+  tripletexer/endpoints/timesheet/entry.rb
+  tripletexer/endpoints/timesheet/time_clock.rb
+  tripletexer/endpoints/token.rb
+  tripletexer/endpoints/token/consumer.rb
+  tripletexer/endpoints/token/session.rb
+].each do |file|
+  require File.expand_path(file, __dir__)
+end
+
+class Tripletexer
+  def initialize(object_class: Hash, proxy: nil, token: nil)
+    @object_class = object_class
+    @proxy = proxy
+    connection.token = token if token
+  end
+
+  def activity
+    Tripletexer::Endpoints::Activity.new(connection)
+  end
+
+  def address
+    Tripletexer::Endpoints::Address.new(connection)
+  end
+
+  def company
+    Tripletexer::Endpoints::Company.new(connection)
+  end
+
+  def contact
+    Tripletexer::Endpoints::Contact.new(connection)
+  end
+
+  def country
+    Tripletexer::Endpoints::Country.new(connection)
+  end
+
+  def currency
+    Tripletexer::Endpoints::Currency.new(connection)
+  end
+
+  def customer
+    Tripletexer::Endpoints::Customer.new(connection)
+  end
+
+  def department
+    Tripletexer::Endpoints::Department.new(connection)
+  end
+
+  def employee
+    Tripletexer::Endpoints::Employee.new(connection)
+  end
+
+  def inventory
+    Tripletexer::Endpoints::Inventory.new(connection)
+  end
+
+  def invoice
+    Tripletexer::Endpoints::Invoice.new(connection)
+  end
+
+  def ledger
+    Tripletexer::Endpoints::Ledger.new(connection)
+  end
+
+  def order
+    Tripletexer::Endpoints::Order.new(connection)
+  end
+
+  def product
+    Tripletexer::Endpoints::Product.new(connection)
+  end
+
+  def project
+    Tripletexer::Endpoints::Project.new(connection)
+  end
+
+  def supplier
+    Tripletexer::Endpoints::Supplier.new(connection)
+  end
+
+  def timesheet
+    Tripletexer::Endpoints::Timesheet.new(connection)
+  end
+
+  def token
+    Tripletexer::Endpoints::Token.new(connection)
+  end
+
+  private
+
+  attr_accessor :object_class, :proxy
+
+  def connection
+    @connection ||= Tripletexer::Connection.new(object_class: object_class, proxy: proxy)
+  end
+
+end

data/lib/tripletexer/connection.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+class Tripletexer::Connection
+  ENDPOINT = 'https://tripletex.no/'
+
+  attr_reader :token
+
+  def initialize(object_class: Hash, proxy: nil)
+    @object_class = object_class
+    @proxy = proxy
+  end
+
+  def connection
+    return @connection if token && @connection
+    @connection = init_connection
+  end
+
+  def reset
+    @token = nil
+    @connection = nil
+    nil
+  end
+
+  def token=(new_token)
+    reset
+    @token = new_token
+  end
+
+  private
+
+  attr_reader :object_class, :proxy
+
+  def init_connection
+    Faraday.new(url: ENDPOINT) do |faraday|
+      faraday.response :logger
+      faraday.response :json, parser_options: { object_class: object_class }, content_type: %r[/json$]
+      faraday.headers = {
+        'Content-Type': 'application/json'
+      }
+      faraday.adapter :patron
+      faraday.basic_auth(0, token) if token
+      faraday.proxy = proxy if proxy # https://github.com/lostisland/faraday/issues/733
+    end
+  end
+end

data/lib/tripletexer/endpoints.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+module Tripletexer::Endpoints; end

data/lib/tripletexer/endpoints/abstract_endpoint.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+
+module Tripletexer::Endpoints
+  class AbstractEndpoint
+    include ::Tripletexer::FormatHelpers
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    private
+
+    attr_reader :connection
+
+    def find_entities(path, params, &block)
+      Enumerator.new do |enum_yielder|
+        request_params = params.dup
+        begin
+          result = get(path, request_params, &block)
+
+          result['values'].each do |value|
+            enum_yielder.yield(value)
+          end
+
+          request_params['from'] = result['from'] + result['count']
+        end until result['fullResultSize'] <= request_params['from']
+      end
+    end
+
+    def find_entity(path, params = {})
+      get(path, params)['value']
+    end
+
+    def create_entity(path, body, params = {})
+      post(path, params) do |req|
+        req.body = normalize_body(body)
+      end['value']
+    end
+
+    def update_entity(path, body, params = {})
+      put(path, params) do |req|
+        req.body = normalize_body(body)
+      end['value']
+    end
+
+    def create_entities(path, body, params = {})
+      post(path, params) do |req|
+        req.body = normalize_body(body)
+      end['values']
+    end
+
+    def update_entities(path, body, params = {})
+      put(path, params) do |req|
+        req.body = normalize_body(body)
+      end['values']
+    end
+
+    def get(path, *args, &block)
+      call(:get, path, *args, &block)
+    end
+
+    def post(path, *args, &block)
+      call(:post, path, *args, &block)
+    end
+
+    def put(path, *args, &block)
+      call(:put, path, *args, &block)
+    end
+
+    def delete(path, *args, &block)
+      call(:delete, path, *args, &block)
+    end
+
+    def call(method, path, *args, &block)
+      normalized_path = URI.escape(path)
+      response = connection.connection.public_send(method, normalized_path, *args, &block)
+      handle_response(response)
+    end
+
+    def handle_response(response)
+      body = response.body
+      case response.status
+      when 200, 201, 204
+        body
+      when 400, 422
+        raise ::Tripletexer::Errors::BadRequest, body
+      when 401
+        raise ::Tripletexer::Errors::Unauthorized, body
+      when 403
+        raise ::Tripletexer::Errors::Forbidden, body
+      when 404
+        raise ::Tripletexer::Errors::NotFound, body
+      when 409
+        raise ::Tripletexer::Errors::Conflict, body
+      when 500
+        raise ::Tripletexer::Errors::InternalError, body
+      else
+        raise NotImplementedError, "don't know how to handle #{response.status} http status code"
+      end
+    end
+
+  end
+end

data/lib/tripletexer/endpoints/activity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Tripletexer::Endpoints
+  class Activity < AbstractEndpoint
+
+    # https://tripletex.no/v2-docs/#!/activity/search
+    def search(params = {})
+      find_entities('/v2/activity', params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/activity/getForTimeSheet
+    def get_for_time_sheet(project_id, params = {})
+      final_params = params.merge('projectId' => project_id)
+      find_entities('/v2/activity/>forTimeSheet', final_params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/activity/get
+    def find(id, params = {})
+      find_entity("/v2/activity/#{id}", params)
+    end
+  end
+end

data/lib/tripletexer/endpoints/address.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Tripletexer::Endpoints
+  class Address < AbstractEndpoint
+
+    # https://tripletex.no/v2-docs/#!/address/search
+    def search(params = {})
+      find_entities('/v2/address', params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/address/get
+    def find(id, params = {})
+      find_entity("/v2/address/#{id}", params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/address/put
+    def update(id, body)
+      update_entity("/v2/address/#{id}", body)
+    end
+
+  end
+end

data/lib/tripletexer/endpoints/company.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Tripletexer::Endpoints
+  class Company < AbstractEndpoint
+
+    # https://tripletex.no/v2-docs/#!/company/getWithLoginAccess
+    def with_login_access(params = {})
+      find_entities('/v2/company/>withLoginAccess', params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/company/get
+    def find(id, params = {})
+      find_entity("/v2/company/#{id}", params)
+    end
+
+  end
+end

data/lib/tripletexer/endpoints/contact.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Tripletexer::Endpoints
+  class Contact < AbstractEndpoint
+
+    # https://tripletex.no/v2-docs/#!/contact/search
+    def search(params = {})
+      find_entities('/v2/contact', params)
+    end
+
+    # https://tripletex.no/v2-docs/#!/contact/post
+    def create(body)
+      cerate_entity('/v2/contact', body)
+    end
+
+    # https://tripletex.no/v2-docs/#!/contact/get
+    def find(id, params = {})
+      find_entity("/v2/contact/#{id}", params)
+    end
+
+  end
+end