eol-client 1.0.0

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eol.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eol/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "eol-client"
+  spec.authors       = ["Ahmad Hassan"]
+  spec.email         = ["er.ahmad.hassan@gmail.com"]
+
+  spec.summary       = "API wrapper for Exact Online"
+  spec.homepage      = "https://github.com/ahmadhasankhan/eol"
+  spec.licenses      = %w[MIT]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = %w[lib]
+  spec.version       = Eol::Version.to_s
+
+  spec.add_dependency "activeresource"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday", [">= 0.12.1"]
+  spec.add_dependency "mechanize", ">= 2.7.5"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "listen"
+  spec.add_development_dependency "mutant-rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "ruby_dep"
+  spec.add_development_dependency "rubycritic"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+  spec.add_development_dependency "webmock"
+end
+# rubocop:enable Metrics/BlockLength

data/jenkins.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+export RAILS_ENV=test
+export COVERAGE=true
+
+bundle install
+
+if [[ -d coverage ]]; then
+  echo "Removing old coverage report"
+  rm -r coverage
+fi
+
+echo "--- Check style"
+
+rubocop
+
+if [[ $? -ne 0 ]]; then
+  echo "--- Style checks failed."
+  exit 1
+fi
+
+echo "--- Doing a static analysis"
+
+rubycritic app lib config
+
+echo "--- Running RSpec"
+
+rspec --color spec --format progress --format html --out rspec.html
+rspec=$?
+
+if [[ $rspec -ne 0 ]]; then
+  echo "--- Some tests have failed."
+  exit 1
+fi

data/lib/eol.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "eol/version"
+require "eol/api"
+require "eol/config"
+require "eol/response"
+require "eol/client"
+require "eol/resource"
+require "eol/result_set"
+require "eol/sanitizer"
+require "eol/resources/aging_receivables_list"
+require "eol/resources/receivables_list"
+require "eol/resources/shared_sales_attributes"
+require "eol/resources/base_entry_line"
+require "eol/resources/bank_entry"
+require "eol/resources/bank_entry_line"
+require "eol/resources/bank_account"
+require "eol/resources/contact"
+require "eol/resources/sales_invoice"
+require "eol/resources/sales_invoice_line"
+require "eol/resources/printed_sales_invoice"
+require "eol/resources/layout"
+require "eol/resources/journal"
+require "eol/resources/sales_item_prices"
+require "eol/resources/item"
+require "eol/resources/item_group"
+require "eol/resources/account"
+require "eol/resources/address"
+require "eol/resources/gl_account"
+require "eol/resources/sales_entry"
+require "eol/resources/sales_entry_line"
+require "eol/resources/sales_order"
+require "eol/resources/sales_order_line"
+require "eol/resources/project"
+require "eol/resources/time_transaction"
+require "eol/resources/purchase_entry"
+require "eol/resources/purchase_entry_line"
+require "eol/resources/costunit"
+require "eol/resources/costcenter"
+require "eol/resources/transaction"
+require "eol/resources/transaction_line"
+require "eol/resources/document"
+require "eol/resources/document_attachment"
+require "eol/resources/mailbox"
+require "eol/resources/vat_code"
+require "eol/resources/general_journal_entry"
+require "eol/resources/general_journal_entry_line"
+require "eol/resources/payment_condition"
+require "eol/resources/goods_delivery"
+require "eol/resources/goods_delivery_line"
+require "eol/resources/division"
+require "eol/resources/user"
+
+module Eol
+  extend Config
+
+  def self.client(options = {})
+    Eol::Client.new(options)
+  end
+
+  # Delegate to eol::Client
+  def self.method_missing(method, *args, &block)
+    super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to eol::Client
+  def self.respond_to?(method, include_all = false)
+    client.respond_to?(method, include_all) || super
+  end
+
+  def self.info(msg)
+    logger.info(msg)
+  end
+
+  def self.error(msg)
+    logger.error(msg)
+  end
+end

data/lib/eol/api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require File.expand_path("../request", __FILE__)
+require File.expand_path("../config", __FILE__)
+require File.expand_path("../oauth", __FILE__)
+
+module Eol
+  # @private
+  class API
+    # @private
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options = {})
+      options = Eol.options.merge(options)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send key
+      end
+      conf
+    end
+
+    include Request
+    include OAuth
+  end
+end

data/lib/eol/client.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Eol
+  class Client < API
+    def connection
+      Faraday.new do |faraday|
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/eol/config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "active_resource/threadsafe_attributes"
+require "logger"
+
+module Eol
+  module Config
+    include ThreadsafeAttributes
+    # An array of valid keys in the options hash
+    VALID_OPTIONS_KEYS = %i(
+      access_token
+      adapter
+      client_id
+      client_secret
+      connection_options
+      redirect_uri
+      response_format
+      user_agent
+      endpoint
+      division
+      base_url
+      refresh_token
+      logger
+    ).freeze
+
+    # By default, don't set a user access token
+    DEFAULT_ACCESS_TOKEN = ""
+
+    DEFAULT_REFRESH_TOKEN = ""
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, client id should be set in .env
+    DEFAULT_CLIENT_ID = ""
+
+    # By default, client secret should be set in .env
+    DEFAULT_CLIENT_SECRET = ""
+
+    # By default, don't set any connection options
+    DEFAULT_CONNECTION_OPTIONS = {}.freeze
+
+    DEFAULT_BASE_URL = "https://start.exactonline.nl"
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "api/v1"
+
+    # the division code you want to connect with
+    DEFAULT_DIVISION = ""
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    DEFAULT_FORMAT = :json
+
+    DEFAULT_REDIRECT_URI = "https://www.getpostman.com/oauth2/callback"
+
+    # By default, don't set user agent
+    DEFAULT_USER_AGENT = nil
+
+    # An array of valid request/response formats
+    VALID_FORMATS = [:json].freeze
+
+    DEFAULT_LOGGER = ::Logger.new(STDOUT)
+
+    # @private
+    threadsafe_attribute(*VALID_OPTIONS_KEYS)
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.access_token       = DEFAULT_ACCESS_TOKEN
+      self.adapter            = DEFAULT_ADAPTER
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.redirect_uri       = DEFAULT_REDIRECT_URI
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.division           = DEFAULT_DIVISION
+      self.base_url           = DEFAULT_BASE_URL
+      self.response_format    = DEFAULT_FORMAT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.refresh_token      = DEFAULT_REFRESH_TOKEN
+      self.logger             = DEFAULT_LOGGER
+    end
+  end
+end

data/lib/eol/exception.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Eol
+  class BadRequestException < StandardError
+    def initialize(response, parsed)
+      @response = response
+      @parsed = parsed
+      super(message)
+    end
+
+    def message
+      if @parsed.error_message.present?
+        "code #{@response.status}: #{@parsed.error_message}"
+      else
+        @response.inspect
+      end
+    end
+  end
+
+  class UnauthorizedException < StandardError; end
+end

data/lib/eol/oauth.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "mechanize"
+require "uri"
+require "json"
+
+require File.expand_path("../utils", __FILE__)
+require File.expand_path("../response", __FILE__)
+
+# from https://developers.exactonline.com/#Example retrieve access token.html
+
+# This whole class is going to be replaced due to Exact Online's new policies.
+# https://support.exactonline.com/community/s/knowledge-base#All-All-HNO-Concept-general-security-gen-auth-totpc
+
+module Eol
+  # rubocop:disable Metrics/ModuleLength
+  module OAuth
+    def authorized?
+      # Do a test call, return false if 401 or any error code
+      response = Eol.get("/Current/Me", no_division: true)
+      response.results.first.present?
+    rescue BadRequestException
+      Eol.error "Not yet authorized"
+      return false
+    end
+
+    def authorize_division
+      get("/Current/Me", no_division: true).results.first.current_division
+    end
+
+    # Return URL for OAuth authorization
+    def authorize_url(options = {})
+      options[:response_type] ||= "code"
+      options[:redirect_uri] ||= redirect_uri
+      params = authorization_params.merge(options)
+      uri = URI("#{base_url}/api/oauth2/auth/")
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+
+    # Return an access token from authorization
+    def get_access_token(code, _options = {})
+      conn = Faraday.new(url: base_url) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+      params = access_token_params(code)
+      conn.post do |req|
+        req.url "/api/oauth2/token"
+        req.body = params
+        req.headers["Accept"] = "application/json"
+      end
+    end
+
+    # Return an access token from authorization via refresh token
+    def get_refresh_token(refresh_token)
+      conn = Faraday.new(url: config[:base_url]) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+
+      params = refresh_access_token_params(refresh_token)
+
+      conn.post do |req|
+        req.url "/api/oauth2/token"
+        req.body = params
+        req.headers["Accept"] = "application/json"
+        req.headers["Content-Type"] = "application/x-www-form-urlencoded"
+      end
+    end
+
+    private
+
+    def authorization_params
+      {
+        client_id: client_id
+      }
+    end
+
+    def access_token_params(code)
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: "authorization_code",
+        code: code,
+        redirect_uri: redirect_uri
+      }
+    end
+
+    def refresh_access_token_params(code)
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: "refresh_token",
+        refresh_token: code
+      }
+    end
+  end
+
+  class OauthResponse < Response
+    def body
+      JSON.parse(@response.body)
+    end
+
+    def access_token
+      body["access_token"]
+    end
+
+    def division
+      body["division"]
+    end
+
+    def refresh_token
+      body["refresh_token"]
+    end
+  end
+end