eol-client 1.0.0

data/lib/eol/parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Eol
+  class Parser
+    attr_accessor :parsed_json
+
+    def initialize(json)
+      @parsed_json = JSON.parse(json)
+    rescue JSON::ParserError => e
+      Eol.error "There was an error parsing the response"
+      Eol.error "#{e.class}: #{e.message}"
+      @parsed_json = ""
+      @error_message = ""
+    end
+
+    def results
+      result["results"] if result && result["results"]
+    end
+
+    def metadata
+      result["__metadata"] if result && result["__metadata"]
+    end
+
+    def result
+      parsed_json["d"]
+    end
+
+    def next_page_url
+      result && result["__next"]
+    end
+
+    def error_message
+      @error_message ||= begin
+        parsed_json["error"]["message"]["value"] if parsed_json["error"]
+      end
+    end
+
+    def first_result
+      results[0]
+    end
+  end
+end

data/lib/eol/request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Eol
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    private
+
+    def build_path(path, options)
+      unless options[:use_raw_path]
+        path = "#{division}/#{path}" unless options[:no_division]
+        path = "#{endpoint}/#{path}" unless options[:no_endpoint]
+        path = "#{options[:url] || base_url}/#{path}"
+      end
+      path
+    end
+
+    def add_headers(options = {})
+      content_type = options[:content_type] || "application/#{response_format}"
+      headers = {}
+      headers["Content-Type"] = content_type
+      headers["Accept"] = content_type
+      headers["Authorization"] = "Bearer #{access_token}" if access_token
+      headers
+    end
+
+    # Perform an HTTP request
+    def request(method, path, options = {})
+      path = build_path(path, options)
+
+      response = connection.send(method) do |request|
+        case method
+        when :post, :put
+          request.url path
+          request.body = options[:body] || options[:params].to_json
+        when :get, :delete
+          request.url path
+        end
+        request.headers = add_headers(options)
+      end
+      Response.new(response)
+    end
+  end
+end

data/lib/eol/resource.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require File.expand_path("../utils", __FILE__)
+require File.expand_path("../exception", __FILE__)
+require File.expand_path("../uri", __FILE__)
+require File.expand_path("../sanitizer", __FILE__)
+
+module Eol
+  module Resource
+    include UriMethods
+    include Sanitizer
+
+    attr_accessor :attributes, :url
+    attr_reader :response
+
+    def initialize(attributes = {})
+      @attributes = Utils.normalize_hash(attributes)
+      @filters = []
+      @query = []
+    end
+
+    def id
+      @attributes[:id]
+    end
+
+    def find_all(options = {})
+      @order_by = options[:order_by]
+      @select = options[:select]
+      response = get(uri(%i[order select]))
+      response&.results
+    end
+
+    # Pass filters in an array, for example 'filters: [:id, :name]'
+    def find_by(options = {})
+      @filters = options[:filters]
+      @order_by = options[:order_by]
+      @select = options[:select]
+      response = get(uri(%i[order select filters]))
+      response&.results
+    end
+
+    def find
+      return nil unless id?
+      response = get(uri([:id]))
+      response&.results&.first
+    end
+
+    # Normally use the url method (which applies the filters) but sometimes you only want to use the base path or other paths
+    def get(uri = self.uri)
+      @response = Eol.get(URI.unescape(uri.to_s))
+    end
+
+    def valid?
+      mandatory_attributes.all? do |attribute|
+        @attributes.key? attribute
+      end
+    end
+
+    def id?
+      !@attributes[:id].nil?
+    end
+
+    def save
+      attributes_to_submit = sanitize
+      if valid?
+        return @response = Eol.post(base_path, params: attributes_to_submit) unless id?
+        return @response = Eol.put(basic_identifier_uri, params: attributes_to_submit)
+      else
+        Eol.error("Invalid Resource #{self.class.name}, attributes: #{@attributes.inspect}")
+        Eol::Response.new(Faraday::Response.new(status: 400, body: "Invalid Request"))
+      end
+    end
+
+    def delete
+      return nil unless id?
+      Eol.delete(basic_identifier_uri)
+    end
+
+    # Getter/Setter for resource
+    def method_missing(method, *args, &block)
+      yield if block
+      if /^(\w+)=$/ =~ method
+        set_attribute($1, args[0])
+      else
+        nil unless @attributes[method.to_sym]
+      end
+      @attributes[method.to_sym]
+    end
+
+    private
+
+    def set_attribute(attribute, value)
+      @attributes[attribute.to_sym] = value if valid_attribute?(attribute)
+    end
+
+    def valid_attribute?(attribute)
+      valid_attributes.include?(attribute.to_sym)
+    end
+
+    def valid_attributes
+      @valid_attributes ||= mandatory_attributes.inject(other_attributes, :<<)
+    end
+  end
+end

data/lib/eol/resources/account.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Eol
+  class Account
+    # An account needs a name
+    include Eol::Resource
+
+    def base_path
+      "crm/Accounts"
+    end
+
+    def mandatory_attributes
+      %i[name]
+    end
+
+    # https//start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=CRMAccounts
+    # rubocop:disable Metrics/MethodLength
+    def other_attributes
+      %i[
+        accountant account_manager activity_sector
+        activity_sub_sector address_line1 address_line2
+        address_line3 blocked business_type can_drop_ship
+        chamber_of_commerce city code code_at_supplier
+        company_size consolidation_scenario controlled_date
+        cost_paid country credit_line_purchase credit_line_sales
+        discount_purchase discount_sales email end_date fax
+        intra_stat_area intra_stat_delivery_term intra_stat_system
+        intra_stat_transaction_a intra_stat_transaction_b
+        intra_stat_transport_method invoice_acount invoice_attachment_type
+        invoicing_method is_accountant is_agency is_competitor is_mailing
+        is_pilot is_reseller is_sales is_supplier language latitude
+        lead_source logo logo_file_name longitude main_contact
+        payment_condition_purchase payment_condition_sales phone
+        phone_extension postcode price_list purchase_currency
+        purchase_lead_days purchase_VAT_code recipient_of_commissions
+        remarks reseller sales_currency sales_tax_schedule sales_VAT_code
+        search_code security_level seperate_inv_per_project seperate_inv_per_subscription
+        shipping_lead_days shipping_method start_date state status
+        VAT_liability VAT_number website
+      ]
+    end
+  end
+end

data/lib/eol/resources/address.rb

@@ -0,0 +1,36 @@
+module Eol
+  class Address
+    # An account needs a name
+    include Eol::Resource
+
+    def base_path
+      "crm/Addresses"
+    end
+
+    def mandatory_attributes
+      [:type]
+    end
+
+    # https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=CRMAddresses
+    def other_attributes # rubocop:disable Metrics/MethodLength
+      [
+        :account, :account_is_supplier, :account_name,
+        :address_line1, :address_line2, :address_line3, 
+        :city, :contact, :contact_name, 
+        :country, :country_name, :created, 
+        :creator, :creator_full_name, :division,
+        :fax, :free_bool_field_01, :free_bool_field_02,
+        :free_bool_field_03, :free_bool_field_04, :free_bool_field_05,
+        :free_date_field_01, :free_date_field_02, :free_date_field_03, 
+        :free_date_field_04, :free_date_field_05, :free_number_field_01,
+        :free_number_field_02, :free_number_field_03, :free_number_field_04,
+        :free_number_field_05, :free_text_field_01, :free_text_field_02,
+        :free_text_field_03, :free_text_field_04, :free_text_field_05,
+        :mailbox, :main, :modified, :modifier, :modifier_full_name, 
+        :nic_number, :notes, :phone, :phone_extension, :postcode,
+        :state, :state_description, :type, 
+        :warehouse, :warehouse_code, :warehouse_description
+      ]
+    end
+  end
+end

data/lib/eol/resources/aging_receivables_list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Eol
+  # We can use the AgingReceivablesList to change the status of SalesInvoices from
+  # Open to 'Verwerkt' while at the same time sending a PDF of the invoice to the
+  # end user by e-mail.
+  #
+  # This endpoint only supports the POST method.
+  #
+  class AgingReceivablesList
+    include Eol::Resource
+
+    def valid_actions
+      %i[get]
+    end
+
+    def base_path
+      "read/financial/AgingReceivablesList"
+    end
+
+    def mandatory_attributes
+      []
+    end
+
+    # https//start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=SalesInvoiceAgingReceivablesLists
+    def other_attributes
+      %i[
+        account_id account_code account_name age_group1 age_group1_amount age_group1_description
+        age_group2 age_group2_amount age_group2_description age_group3 age_group3_amount age_group3_description
+        age_group4 age_group4_amount age_group4_description currency_code total_amount
+      ]
+    end
+  end
+end

data/lib/eol/resources/bank_account.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Eol
+  class BankAccount
+    # An account needs a name
+    include Eol::Resource
+
+    def valid_actions
+      %i[get]
+    end
+
+    def base_path
+      "crm/BankAccounts"
+    end
+
+    def mandatory_attributes
+      %i[account]
+    end
+
+    # https//start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=CRMAccounts
+    # rubocopdisable Metrics/MethodLength
+    def other_attributes
+      %i[
+        id account account_name bank
+        bank_account bank_description
+        bank_account_holder_name BIC_code
+        description division format IBAN
+        type type_description main
+      ]
+    end
+  end
+end

data/lib/eol/resources/bank_entry.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Eol
+  class BankEntry
+    include Eol::Resource
+
+    def base_path
+      "financialtransaction/BankEntries"
+    end
+
+    def mandatory_attributes
+      %i[journal_code bank_entry_lines]
+    end
+
+    def other_attributes
+      %i[
+        currency bank_statement_document closing_balance_FC entry_number
+        financial_period financial_year opening_balance_FC
+      ]
+    end
+  end
+end

data/lib/eol/resources/bank_entry_line.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Eol
+  class BankEntryLine < Eol::BaseEntryLine
+    # A sales entry line belongs to a sales entry
+    include Eol::Resource
+
+    def base_path
+      "financialtransaction/BankEntryLines"
+    end
+
+    def other_attributes
+      %i[
+        account amount_VATFC asset cost_center cost_unit date
+        description notes document exchange_rate our_ref
+        project quantity VAT_code VAT_percentage VAT_type
+      ]
+    end
+  end
+end

data/lib/eol/resources/base_entry_line.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Eol
+  class BaseEntryLine
+    include Eol::Resource
+
+    def mandatory_attributes
+      %i[amount_FC GL_account entry_ID]
+    end
+
+    def other_attributes
+      %i[
+        serial_number asset cost_center cost_unit description notes
+        project quantity serial_number subscription tracking_number
+        VAT_amount_FC VAT_base_amount_DC VAT_base_amount_FC VAT_code
+        VAT_percentage account date
+      ]
+    end
+  end
+end

data/lib/eol/resources/cash_entry.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Eol
+  class CashEntry
+    include Eol::Resource
+
+    def base_path
+      "financialtransaction/CashEntries"
+    end
+
+    def mandatory_attributes
+      %i[journal_code cash_entry_lines]
+    end
+
+    def other_attributes
+      %i[
+        currency closing_balance_FC entry_number
+        financial_period financial_year openening_balance_FC
+      ]
+    end
+  end
+end