eol-client 1.0.0

data/lib/eol/response.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require File.expand_path("../parser", __FILE__)
+require File.expand_path("../utils", __FILE__)
+
+module Eol
+  class Response
+    attr_accessor :status_code, :response
+    attr_writer :body
+
+    def initialize(response)
+      @response = response
+      raise_and_log_error if fail?
+    end
+
+    def success?
+      @response.success? || SUCCESS_CODES.include?(status)
+    end
+
+    def body
+      @response.body
+    end
+
+    def parsed
+      Parser.new(body)
+    end
+
+    def result
+      Eol::ResultSet.new(parsed)
+    end
+
+    def results
+      Eol::ResultSet.new(parsed)
+    end
+
+    def status
+      @response.status
+    end
+
+    def fail?
+      ERROR_CODES.include? status
+    end
+
+    def error_message
+      parsed.error_message
+    end
+
+    def log_error
+      message = "An error occured, the response had status #{status}. The content of the error was: #{error_message}"
+      Eol.error(message)
+    end
+
+    SUCCESS_CODES = [
+      201, 202, 203, 204, 301, 302, 303, 304
+    ].freeze
+
+    ERROR_CODES = [
+      400, 401, 402, 403, 404, 500, 501, 502, 503
+    ].freeze
+
+    UNAUTHORIZED_CODES = [
+      400, 401, 402, 403
+    ].freeze
+
+    private
+
+    def raise_and_log_error
+      log_error
+      raise BadRequestException.new(@response, parsed)
+    end
+  end
+end

data/lib/eol/result_set.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Eol
+  class ResultSet
+    attr_reader :records
+
+    def initialize(parsed_response)
+      @parsed_response = parsed_response
+
+      @records = if @parsed_response.results
+                   @parsed_response.results.map do |attributes|
+                     resource_class.send(:new, attributes)
+                   end
+                 else
+                   [resource_class.send(:new, @parsed_response.result)]
+                 end
+    end
+
+    def next_page
+      return unless next_page_url
+      next_page = Eol.get(next_page_url, use_raw_path: true)
+      return unless next_page
+
+      response = Eol::Response.new(next_page)
+      response.results
+    end
+
+    def first
+      records.first
+    end
+
+    protected
+
+    def next_page_url
+      @parsed_response.next_page_url
+    end
+
+    def type
+      if @parsed_response.metadata
+        c_type = @parsed_response.metadata["type"]
+      elsif @parsed_response.results.any?
+        c_type = @parsed_response.results.first["__metadata"]["type"]
+      end
+      c_type.split(".").last
+    end
+
+    def resource_class
+      @resource_class ||= begin
+        constant_name = type.classify
+        raise NameError unless constant_name =~ /\A[a-zA-Z0-9]+\z/
+
+        klass = Eol.const_get(constant_name, false)
+        raise NameError unless klass.included_modules.include?(Eol::Resource)
+
+        klass
+      rescue NameError
+        Eol.info("Unknown resource encountered, proceed as usual but further resource details might have to be implemented")
+        Class.new { include Eol::Resource }
+      end
+    end
+  end
+end

data/lib/eol/sanitizer.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/time"
+require "active_support/core_ext/time/zones"
+module Eol
+  module Resource
+    module Sanitizer
+      # Parse the attributes for to post to the API
+      def sanitize
+        to_submit = {}
+        @attributes.each do |key, value|
+          next if key == :id || !valid_attribute?(key)
+          key = Utils.parse_key(key)
+          submit_value = sanitize_relationship(value)
+          to_submit[key] = submit_value
+        end
+        to_submit
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def sanitize_relationship(value)
+        if value.is_a?(Eol::Resource)
+          value.id # Turn relation into ID
+        elsif value.is_a?(Array)
+          sanitize_has_many(value)
+        elsif value.is_a?(Time) || value.is_a?(Date) || value.is_a?(DateTime)
+          sanitize_date_time(value)
+        elsif value.is_a?(String) && value.match(/(Date\()/)
+          number = value.scan(/\d+/).first.to_i / 1000.0
+          Time.zone = ActiveSupport::TimeZone.new("Europe/Amsterdam")
+          sanitize_date_time(Time.zone.at(number))
+        else
+          value
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def sanitize_date_time(value)
+        value.strftime("%Y-%m-%d")
+      end
+
+      def sanitize_has_many(value)
+        submit_value = []
+        value.each do |e|
+          submit_value << e.sanitize
+        end
+        submit_value
+      end
+    end
+  end
+end

data/lib/eol/uri.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Eol
+  module Resource
+    module UriMethods
+      def base_path
+        Utils.collection_path self.class.name
+      end
+
+      def uri(options = {})
+        options.each do |option|
+          send("apply_#{option}".to_sym)
+        end
+        uri = if options.include?(:id)
+                URI("#{base_path}(guid'#{id}')")
+              else
+                URI(base_path)
+              end
+        uri.query = URI.encode_www_form(@query)
+        uri
+      end
+
+      def base_filter(attribute)
+        values = @attributes[attribute]
+        values = [values] unless values.is_a?(Array)
+
+        filters = values.map do |value|
+          if value.is_a?(Hash)
+            value.map do |key, val|
+              "#{query_attribute(attribute)} #{key} #{sanitize_value(val)}"
+            end
+          else
+            "#{query_attribute(attribute)} eq #{sanitize_value(value)}"
+          end
+        end.flatten
+
+        ["$filter", filters.join(" or ")]
+      end
+
+      # Sanitize an attribute in symbol format to the ExactOnline style
+      def query_attribute(attribute)
+        if attribute == :id
+          attribute.to_s.upcase
+        else
+          Utils.camelize(attribute)
+        end
+      end
+
+      # Convert a value to something usable in an ExactOnline request
+      def sanitize_value(value)
+        case value
+        when String
+          if value =~ /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/
+            "guid'#{value}'"
+          else
+            "'#{value}'"
+          end
+
+        when Date, Time
+          "datetime'#{value.strftime('%FT%TZ')}'"
+
+        else
+          value
+        end
+      end
+
+      def apply_filters
+        return unless @filters
+        @filters.each do |filter|
+          @query << base_filter(filter)
+        end
+      end
+
+      def basic_identifier_uri
+        "#{base_path}(guid'#{id}')"
+      end
+
+      def apply_order
+        @query << ["$orderby", Utils.camelize(@order_by.to_s)] if @order_by
+      end
+
+      def apply_select
+        @query << ["$select", @select.map { |s| Utils.camelize(s) }.join(",")] if @select
+      end
+    end
+  end
+end

data/lib/eol/utils.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Eol
+  module Utils
+    def self.demodulize(class_name_in_module)
+      class_name_in_module.to_s.sub(/^.*::/, "")
+    end
+
+    def self.pluralize(word)
+      word.to_s.sub(/([^s])$/, '\1s')
+    end
+
+    def self.modulize(class_name)
+      "Eol::#{class_name}"
+    end
+
+    def self.collection_path(class_name)
+      (Utils.pluralize Utils.demodulize class_name).downcase
+    end
+
+    def self.camelize(word, uppercase_first_letter = true)
+      if uppercase_first_letter
+        word.to_s.gsub(%r{/\/(.?)/}) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      else
+        word[0] + Utils.camelize(word)[1..-1]
+      end
+    end
+
+    def self.normalize_hash_key(key)
+      if key.is_a? String
+        key = key.gsub(/::/, "/")
+        key = key.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        key = key.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        key = key.tr("-", "_")
+        key = key.downcase
+        return key.to_sym
+      end
+      key
+    end
+
+    def self.normalize_hash(hash)
+      Hash[hash.map { |k, v| [Utils.normalize_hash_key(k), v] }] if hash
+    end
+
+    def self.parse_key(key)
+      "VATCode" if key.casecmp "vat_code"
+      Utils.camelize(key)
+    end
+  end
+end

data/lib/eol/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Eol
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].compact.join(".")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,356 @@
+--- !ruby/object:Gem::Specification
+name: eol-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ahmad Hassan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_dep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubycritic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- er.ahmad.hassan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yaml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eol.gemspec
+- jenkins.sh
+- lib/eol.rb
+- lib/eol/api.rb
+- lib/eol/client.rb
+- lib/eol/config.rb
+- lib/eol/exception.rb
+- lib/eol/oauth.rb
+- lib/eol/parser.rb
+- lib/eol/request.rb
+- lib/eol/resource.rb
+- lib/eol/resources/account.rb
+- lib/eol/resources/address.rb
+- lib/eol/resources/aging_receivables_list.rb
+- lib/eol/resources/bank_account.rb
+- lib/eol/resources/bank_entry.rb
+- lib/eol/resources/bank_entry_line.rb
+- lib/eol/resources/base_entry_line.rb
+- lib/eol/resources/cash_entry.rb
+- lib/eol/resources/cash_entry_line.rb
+- lib/eol/resources/contact.rb
+- lib/eol/resources/costcenter.rb
+- lib/eol/resources/costunit.rb
+- lib/eol/resources/division.rb
+- lib/eol/resources/document.rb
+- lib/eol/resources/document_attachment.rb
+- lib/eol/resources/general_journal_entry.rb
+- lib/eol/resources/general_journal_entry_line.rb
+- lib/eol/resources/gl_account.rb
+- lib/eol/resources/goods_delivery.rb
+- lib/eol/resources/goods_delivery_line.rb
+- lib/eol/resources/item.rb
+- lib/eol/resources/item_group.rb
+- lib/eol/resources/journal.rb
+- lib/eol/resources/layout.rb
+- lib/eol/resources/mailbox.rb
+- lib/eol/resources/payment_condition.rb
+- lib/eol/resources/printed_sales_invoice.rb
+- lib/eol/resources/project.rb
+- lib/eol/resources/purchase_entry.rb
+- lib/eol/resources/purchase_entry_line.rb
+- lib/eol/resources/receivables_list.rb
+- lib/eol/resources/sales_entry.rb
+- lib/eol/resources/sales_entry_line.rb
+- lib/eol/resources/sales_invoice.rb
+- lib/eol/resources/sales_invoice_line.rb
+- lib/eol/resources/sales_item_prices.rb
+- lib/eol/resources/sales_order.rb
+- lib/eol/resources/sales_order_line.rb
+- lib/eol/resources/shared_sales_attributes.rb
+- lib/eol/resources/time_transaction.rb
+- lib/eol/resources/transaction.rb
+- lib/eol/resources/transaction_line.rb
+- lib/eol/resources/user.rb
+- lib/eol/resources/vat_code.rb
+- lib/eol/response.rb
+- lib/eol/result_set.rb
+- lib/eol/sanitizer.rb
+- lib/eol/uri.rb
+- lib/eol/utils.rb
+- lib/eol/version.rb
+homepage: https://github.com/ahmadhasankhan/eol
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: API wrapper for Exact Online
+test_files: []