twinfieldrb 0.3.0

data/lib/twinfield/browse/transaction/general_ledger.rb

@@ -0,0 +1,144 @@
+module Twinfield
+  module Browse
+    module Transaction
+      class GeneralLedger < Twinfield::AbstractModel
+        extend Twinfield::Helpers::Parsers
+        include Twinfield::Helpers::TransactionMatch
+
+        attr_accessor :number, :yearperiod, :currency, :value, :status, :dim1, :dim2, :key, :code
+
+        class << self
+          def initialize_from_columns_response_row(transaction_xml)
+            new(
+              number: transaction_xml.css("td[field='fin.trs.head.number']").text,
+              yearperiod: transaction_xml.css("td[field='fin.trs.head.yearperiod']").text,
+              currency: transaction_xml.css("td[field='fin.trs.head.curcode']").text,
+              value: transaction_xml.css("td[field='fin.trs.line.valuesigned']").text&.to_f,
+              status: transaction_xml.css("td[field='fin.trs.head.status']").text,
+              dim1: transaction_xml.css("td[field='fin.trs.line.dim1']").text,
+              dim2: transaction_xml.css("td[field='fin.trs.line.dim2']").text,
+              key: transaction_xml.css("key").text.gsub(/\s/, ""),
+              code: transaction_xml.css("td[field='fin.trs.head.code']").text
+            )
+          end
+
+          def find(customer_code: nil, invoice_number: nil, code: nil, number: nil)
+            where(customer_code: customer_code, invoice_number: invoice_number, code: code, number: number).first
+          end
+
+          # @param years: range
+          #
+          def where(years: ((Date.today.year - 30)..Date.today.year), dim1: nil, dim2: nil)
+            build_request = %(
+              <column>
+                  <field>fin.trs.head.yearperiod</field>
+                  <label>Periode</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{years.first}/01</from>
+                  <to>#{years.last}/12</to>
+                  <finderparam/>
+              </column>
+              <column>
+                  <field>fin.trs.line.dim1</field>
+                  <label>Grootboek</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{dim1}</from>
+                  <to>#{dim1}</to>
+                  <finderparam/>
+              </column>
+              <column>
+                  <field>fin.trs.line.dim2</field>
+                  <label>Kostenplaats</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{dim2}</from>
+                  <to>#{dim2}</to>
+                </column>
+                <column>
+                  <field>fin.trs.head.code</field>
+                  <label>Dagboek</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>equal</operator>
+                  <from/>
+                  <to/>
+                  <finderparam>hidden=1</finderparam>
+                </column>
+                <column>
+                  <field>fin.trs.head.number</field>
+                  <label>Boekst.nr.</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.head.curcode</field>
+                  <label>Valuta</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>none</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.line.valuesigned</field>
+                  <label>Bedrag</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.head.status</field>
+                  <label>Status</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>equal</operator>
+                  <from>normal</from>
+                  <to/>
+                  <finderparam/>
+                </column>
+                )
+
+            response = Twinfield::Api::Process.request(:process_xml_string) do
+              %(
+                <columns code="000">
+                  #{build_request}
+                </columns>
+              )
+            end
+
+            xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+            xml.css("tr").map do |transaction_xml|
+              Twinfield::Browse::Transaction::GeneralLedger.initialize_from_columns_response_row(transaction_xml)
+            end
+          end
+        end
+
+        def initialize(number: nil, yearperiod: nil, currency: "EUR", value: nil, status: nil, dim1: nil, dim2: nil, key: nil, code: nil)
+          self.number = number
+          self.yearperiod = yearperiod
+          self.currency = currency
+          self.value = value
+          self.status = status
+          self.dim1 = dim1
+          self.dim2 = dim2
+          self.key = key
+          self.code = code
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/configuration.rb

@@ -0,0 +1,49 @@
+require "base64"
+require "json"
+
+module Twinfield
+  # Used for configuration of the Twinfield gem.
+
+  class Configuration
+    class Error < StandardError
+    end
+    attr_accessor :session_type # Twinfield::Api::OAuthSession or Twinfield::Api::Session
+
+    # in case Twinfield::Api::Session is used
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :organisation
+    attr_accessor :company
+
+    # in case Twinfield::Api::OAuthSession is used
+    attr_accessor :cluster
+    attr_accessor :access_token
+
+    # Log level, e.g. :info, :debug; currently only forwarded to Savon
+    attr_accessor :log_level
+    attr_accessor :logger
+
+    def to_logon_hash
+      {
+        "user" => @username,
+        "password" => @password,
+        "organisation" => @organisation
+      }
+    end
+
+    def access_token_expired?
+      Time.at(JSON.parse(Base64.decode64(access_token.split(".")[1]))["exp"]) < Time.now
+    rescue => e
+      raise Twinfield::Configuration::Error, "No valid access token provided (#{e.message})"
+    end
+
+    def session_class
+      case session_type
+      when "Twinfield::Api::OAuthSession"
+        Twinfield::Api::OAuthSession
+      else
+        Twinfield::Api::Session
+      end
+    end
+  end
+end

data/lib/twinfield/create/cost_center.rb

@@ -0,0 +1,39 @@
+module Twinfield
+  module Create
+    class CostCenter
+      attr_accessor :name, :code
+
+      def initialize(hash = {})
+        hash.each { |k, v| send(:"#{k}=", CGI.escapeHTML(v)) }
+      end
+
+      def save
+        response = Twinfield::Api::Process.request do
+          %(
+            <dimension>
+              <office>#{Twinfield.configuration.company}</office>
+              <type>KPL</type>
+              <name>#{name}</name>
+              <code>#{code}</code>
+            </dimension>
+          )
+        end
+
+        xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+        if xml.at_css("dimension").attributes["result"].value == "1"
+          {
+            code: code,
+            status: 1
+          }
+        else
+          {
+            code: code,
+            status: 0,
+            messages: xml.css("[msg]").map { |x| x.attributes["msg"].value }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/create/creditor.rb

@@ -0,0 +1,88 @@
+module Twinfield
+  module Create
+    class Creditor
+      attr_accessor :bank_description, :bank_iban, :bank_country, :country, :financials_duedays,
+        :iban, :invoice_address, :invoice_city, :invoice_country, :invoice_name,
+        :invoice_zipcode, :name, :shortname, :code, :bank_biccode, :vatcode,
+        :invoice_contact_name
+
+      def initialize(hash = {})
+        # Escape all the things.
+        hash.each do |k, v|
+          val = if v.is_a?(String)
+            CGI.escapeHTML(v)
+          elsif v.is_a?(Hash)
+            v.each_with_object({}) { |(k1, v1), h|
+              h[k1] = CGI.escapeHTML(v1)
+            }
+          else
+            v
+          end
+
+          send(:"#{k}=", val)
+        end
+      end
+
+      def save
+        response = Twinfield::Api::Process.request do
+          %(
+            <dimension>
+              <office>#{Twinfield.configuration.company}</office>
+              <type>CRD</type>
+              <code>#{code}</code>
+              <name>#{name}</name>
+              <shortname>#{shortname}</shortname>
+              <financials>
+                <duedays>#{financials_duedays}</duedays>
+              </financials>
+              <addresses>
+                <address type="invoice">
+                  <name>#{invoice_name}</name>
+                  <country>#{invoice_country}</country>
+                  <city>#{invoice_city}</city>
+                  <postcode>#{invoice_zipcode}</postcode>
+                  <field1>#{invoice_contact_name}</field1>
+                  <field2>#{invoice_address}</field2>
+                  <field4>#{vatcode}</field4>
+                </address>
+              </addresses>
+              #{bank_xml}
+            </dimension>
+          )
+        end
+
+        xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+        if xml.at_css("dimension").attributes["result"].value == "1"
+          {
+            code: code,
+            status: 1
+          }
+        else
+          {
+            code: code,
+            status: 0,
+            messages: xml.css("[msg]").map { |x| x.attributes["msg"].value }
+          }
+        end
+      end
+
+      protected
+
+      def bank_xml
+        if bank_iban.present?
+          %(
+            <banks>
+              <bank>
+                <ascription>#{bank_description}</ascription>
+                <iban>#{bank_iban}</iban>
+                <biccode>#{bank_biccode}</biccode>
+                <country>#{bank_country}</country>
+              </bank>
+            </banks>
+          )
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/create/debtor.rb

@@ -0,0 +1,88 @@
+module Twinfield
+  module Create
+    class Debtor
+      attr_accessor :bank_description, :bank_iban, :bank_country, :country, :financials_duedays,
+        :iban, :invoice_address, :invoice_city, :invoice_country, :invoice_name,
+        :invoice_zipcode, :name, :shortname, :code, :bank_biccode, :vatcode,
+        :invoice_contact_name
+
+      def initialize(hash = {})
+        # Escape all the things.
+        hash.each do |k, v|
+          val = if v.is_a?(String)
+            CGI.escapeHTML(v)
+          elsif v.is_a?(Hash)
+            v.each_with_object({}) { |(k1, v1), h|
+              h[k1] = CGI.escapeHTML(v1)
+            }
+          else
+            v
+          end
+
+          send(:"#{k}=", val)
+        end
+      end
+
+      def save
+        response = Twinfield::Api::Process.request do
+          %(
+            <dimension>
+              <office>#{Twinfield.configuration.company}</office>
+              <type>DEB</type>
+              <code>#{code}</code>
+              <name>#{name}</name>
+              <shortname>#{shortname}</shortname>
+              <financials>
+                <duedays>#{financials_duedays}</duedays>
+              </financials>
+              <addresses>
+                <address type="invoice">
+                  <name>#{invoice_name}</name>
+                  <country>#{invoice_country}</country>
+                  <city>#{invoice_city}</city>
+                  <postcode>#{invoice_zipcode}</postcode>
+                  <field1>#{invoice_contact_name}</field1>
+                  <field2>#{invoice_address}</field2>
+                  <field4>#{vatcode}</field4>
+                </address>
+              </addresses>
+              #{bank_xml}
+            </dimension>
+          )
+        end
+
+        xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+        if xml.at_css("dimension").attributes["result"].value == "1"
+          {
+            code: code,
+            status: 1
+          }
+        else
+          {
+            code: code,
+            status: 0,
+            messages: xml.css("[msg]").map { |x| x.attributes["msg"].value }
+          }
+        end
+      end
+
+      protected
+
+      def bank_xml
+        if bank_iban.present?
+          %(
+            <banks>
+              <bank>
+                <ascription>#{bank_description}</ascription>
+                <iban>#{bank_iban}</iban>
+                <biccode>#{bank_biccode}</biccode>
+                <country>#{bank_country}</country>
+              </bank>
+            </banks>
+          )
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/create/error.rb

@@ -0,0 +1,30 @@
+module Twinfield
+  module Create
+    class Error < StandardError
+      attr_accessor :object
+
+      def initialize message, object:
+        super(message)
+        self.object = object
+      end
+    end
+
+    class Finalized < Error
+      attr_accessor :object
+
+      def initialize message, object:
+        super
+        self.object = object
+      end
+    end
+
+    class EmptyInvoice < Error
+      attr_accessor :object
+
+      def initialize message, object:
+        super
+        self.object = object
+      end
+    end
+  end
+end

data/lib/twinfield/create/general_ledger.rb

@@ -0,0 +1,39 @@
+module Twinfield
+  module Create
+    class GeneralLedger
+      attr_accessor :name, :code
+
+      def initialize(hash = {})
+        hash.each { |k, v| send(:"#{k}=", CGI.escapeHTML(v)) }
+      end
+
+      def save
+        response = Twinfield::Api::Process.request do
+          %(
+            <dimension>
+              <office>#{Twinfield.configuration.company}</office>
+              <type>PNL</type>
+              <name>#{name}</name>
+              <code>#{code}</code>
+            </dimension>
+          )
+        end
+
+        xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+        if xml.at_css("dimension").attributes["result"].value == "1"
+          {
+            code: code,
+            status: 1
+          }
+        else
+          {
+            code: code,
+            status: 0,
+            messages: xml.css("[msg]").map { |x| x.attributes["msg"].value }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/create/transaction.rb

@@ -0,0 +1,97 @@
+module Twinfield
+  module Create
+    # Create a transaction
+    #
+    # In Twinfield there is a clear distinction between sales invoices and sales transactions. Sales invoices are the invoices, which will be sent to customers. Sales transactions are the related financial transactions that will be posted in the accounting part of Twinfield.
+    #
+    class Transaction
+      attr_writer :destiny, :autobalancevat, :raisewarning
+      attr_accessor :code, :number, :currency, :date, :duedate, :invoicenumber, :lines
+
+      def destiny
+        @destiny || "temporary"
+      end
+
+      def raisewarning
+        @raisewarning || false
+      end
+
+      def autobalancevat
+        @autobalancevat || true
+      end
+
+      def initialize(hash = {})
+        # Escape all the things.
+        hash.each do |k, v|
+          val = if v.is_a?(String)
+            CGI.escapeHTML(v)
+          elsif v.is_a?(Hash)
+            v.each_with_object({}) { |(k1, v1), h|
+              h[k1] = CGI.escapeHTML(v1)
+            }
+          else
+            v
+          end
+
+          send(:"#{k}=", val)
+        end
+      end
+
+      def generate_lines
+        xml_lines = lines.map do |line|
+          %(
+            <line type="#{line[:type]}" id="#{line[:id]}" >
+              <dim1>#{line[:dim1]}</dim1>
+              <dim2>#{line[:dim2]}</dim2>
+              <dim3>#{line[:dim3]}</dim3>
+              <value>#{line[:value]}</value>
+              #{"<vatvalue>#{line[:vatvalue]}</vatvalue>" if line[:vatvalue]}
+              <debitcredit>#{line[:debitcredit]}</debitcredit>
+              <description>#{CGI.escapeHTML(line[:description]) if line[:description]}</description>
+              #{"<vatcode>#{line[:vatcode]}</vatcode>" if line[:vatcode]}
+            </line>
+          )
+        end
+
+        xml_lines.join("")
+      end
+
+      def save
+        response = Twinfield::Api::Process.request do
+          %(
+            <transaction destiny="#{destiny}" raisewarning="#{raisewarning}" autobalancevat="#{autobalancevat}">
+              <header>
+                <code>#{code}</code>
+                #{"<number>#{number}</number>" if number}
+                <currency>#{currency}</currency>
+                <date>#{date.strftime("%Y%m%d")}</date>
+                <duedate>#{duedate.strftime("%Y%m%d")}</duedate>
+                <invoicenumber>#{invoicenumber}</invoicenumber>
+                <office>#{Twinfield.configuration.company}</office>
+              </header>
+              <lines>
+                #{generate_lines}
+              </lines>
+            </transaction>
+          )
+        end
+
+        xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+        if xml.at_css("transaction").attributes["result"].value == "1"
+          {
+            code: invoicenumber,
+            status: 1,
+            twinfield_number: xml.at_css("number").content
+          }
+        else
+          {
+            code: invoicenumber,
+            status: 0,
+            messages: xml.css("[msg]").map { |x| x.attributes["msg"].value }
+          }
+        end
+      end
+    end
+  end
+end