rconomic 0.3 → 0.4

data/lib/economic/entity/handle.rb

@@ -28,7 +28,7 @@ class Economic::Entity
     def ==(other)
       return false if other.nil?
       return false unless other.respond_to?(:id) && other.respond_to?(:number)
-      self.id == other.id && self.number == other.number
+      self.id == other.id && self.number == other.number && self.id1 == other.id1 && self.id2 == other.id2
     end
 
   private

data/lib/economic/entity.rb

@@ -71,10 +71,6 @@ module Economic
       @partial = true
     end
 
-    def initialize_defaults
-      nil
-    end
-
     # Updates Entity with its data from the API
     def get_data
       response = proxy.get_data(handle)
@@ -144,6 +140,11 @@ module Economic
       end
     end
 
+    def ==(other)
+      return false if other.nil?
+      self.handle == other.handle && other.is_a?(self.class)
+    end
+
   protected
 
     def create_or_update
@@ -199,6 +200,9 @@ module Economic
       name[0,1].downcase + name[1..-1]
     end
 
+    def initialize_defaults
+      nil
+    end
   end
 
 end

data/lib/economic/entry.rb

@@ -0,0 +1,26 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents an entry in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IEntry.html
+
+  class Entry < Entity
+    has_properties :handle,
+      :serial_number,
+      :account_handle,
+      :amount,
+      :amount_default_currency,
+      :currency_handle,
+      :date,
+      :text,
+      :type,
+      :department_handle,
+      :distribution_key_handle,
+      :vat_account_handle,
+      :voucher_number,
+      :project_handle,
+      :document_handle
+  end
+end

data/lib/economic/proxies/cash_book_entry_proxy.rb

@@ -6,6 +6,7 @@ module Economic
       entity_hash = session.request(CashBookProxy.entity_class.soap_action(:get_entries)) do
         soap.body = { "cashBookHandle" => owner.handle.to_hash }
       end
+
       if entity_hash != {}
         [ entity_hash.values.first ].flatten.each do |id_hash|
           find(id_hash)
@@ -21,15 +22,7 @@ module Economic
     #     :contra_account_handle => { :number => 1011 }
     #   )
     def create_finance_voucher(handles)
-      response = session.request(entity_class.soap_action('CreateFinanceVoucher')) do
-        soap.body = {
-          'cashBookHandle'      => { 'Number' => owner.handle[:number] },
-          'accountHandle'       => { 'Number'  => handles[:account_handle][:number] },
-          'contraAccountHandle' => { 'Number'  => handles[:contra_account_handle][:number] }
-        }
-      end
-
-      find(response)
+      create_cash_book_entry_for_handles(handles, 'CreateFinanceVoucher')
     end
 
     # Creates a debtor payment and returns the cash book entry.
@@ -39,15 +32,60 @@ module Economic
     #     :contra_account_handle => { :number => 1510 }
     #   )
     def create_debtor_payment(handles)
-      response = session.request(entity_class.soap_action('CreateDebtorPayment')) do
-        soap.body = {
-          "cashBookHandle"      => { 'Number' => owner.handle[:number] },
-          "debtorHandle"        => { 'Number' => handles[:debtor_handle][:number] },
-          "contraAccountHandle" => { 'Number' => handles[:contra_account_handle][:number] }
-        }
+      create_cash_book_entry_for_handles(handles, 'CreateDebtorPayment')
+    end
+
+    # Creates a creditor payment and returns the cash book entry.
+    # Example:
+    #   cash_book.entries.create_creditor_payment(
+    #     :creditor_handle       => { :number => 1 },
+    #     :contra_account_handle => { :number => 1510 }
+    #   )
+    def create_creditor_payment(handles)
+      create_cash_book_entry_for_handles(handles, 'CreateCreditorPayment')
+    end
+
+    # Creates a creditor invoice and returns the cash book entry.
+    # Example:
+    #   cash_book.entries.create_creditor_invoice(
+    #     :creditor_handle       => { :number => 1 },
+    #     :contra_account_handle => { :number => 1510 }
+    #   )
+    def create_creditor_invoice(handles)
+      create_cash_book_entry_for_handles(handles, 'CreateCreditorInvoice')
+    end
+
+    def set_due_date(id, date)
+      session.request(entity_class.soap_action("SetDueDate")) do
+        soap.body = { 'cashBookEntryHandle' => { 'Id1' => owner.handle[:number], 'Id2' => id }, :value => date }
+      end
+    end
+
+    protected
+
+    def create_cash_book_entry_for_handles(handles, action, foobar = nil)
+      handle_name = handle_name_for_action(action)
+      handle_key = Economic::Support::String.underscore(handle_name).intern
+
+      response = session.request(entity_class.soap_action(action)) do
+        data = ActiveSupport::OrderedHash.new
+        data["cashBookHandle"] = { 'Number' => owner.handle[:number] }
+        data[handle_name] = { 'Number'  => handles[handle_key][:number] } if handles[handle_key]
+        data["contraAccountHandle"] = { 'Number'  => handles[:contra_account_handle][:number] } if handles[:contra_account_handle]
+        soap.body = data
       end
 
       find(response)
     end
+
+    def handle_name_for_action(action_name)
+      {
+        'CreateFinanceVoucher' => 'accountHandle',
+        'CreateDebtorPayment' => 'debtorHandle',
+        'CreateCreditorInvoice' => 'creditorHandle',
+        'CreateCreditorPayment' => 'creditorHandle'
+      }[action_name]
+    end
+
   end
 end

data/lib/economic/proxies/creditor_contact_proxy.rb

@@ -0,0 +1,64 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class CreditorContactProxy < EntityProxy
+
+    # Returns a new, unpersisted Economic::CreditorContact
+    def build(properties = {})
+      contact = super
+      initialize_properties_with_values_from_owner(contact) if owner.is_a?(Creditor)
+      contact
+    end
+
+    # Gets data for CreditorContact from the API
+    def find(handle)
+      handle = Entity::Handle.new(:id => handle) unless handle.is_a?(Entity::Handle)
+      super(handle)
+    end
+
+    # Returns CreditorContact that have the given name. The objects will only be partially loaded
+    def find_by_name(name)
+      # Get a list of CreditorContactHandles from e-conomic
+      response = session.request entity_class.soap_action('FindByName') do
+        soap.body = {
+          'name' => name
+        }
+      end
+
+      # Make sure we always have an array of handles even if the result only contains one
+      handles = [response[:creditor_contact_handle]].flatten.reject(&:blank?)
+
+      # Create partial CreditorContact entities
+      contacts = handles.collect do |handle|
+        creditor_contact = build
+        creditor_contact.partial = true
+        creditor_contact.persisted = true
+        creditor_contact.handle = handle
+        creditor_contact.id = handle[:id]
+        creditor_contact.number = handle[:number]
+        creditor_contact
+      end
+
+      if owner.is_a?(Creditor)
+        # Scope to the owner
+        contacts.select do |creditor_contact|
+          creditor_contact.get_data
+          creditor_contact.creditor.handle == owner.handle
+        end
+      else
+        contacts
+      end
+
+    end
+
+
+  private
+
+    # Initialize properties in contact with values from owner. Returns contact.
+    def initialize_properties_with_values_from_owner(contact)
+      contact.creditor = owner
+      contact
+    end
+
+  end
+end

data/lib/economic/proxies/creditor_entry_proxy.rb

@@ -0,0 +1,42 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class CreditorEntryProxy < EntityProxy
+    def find_by_invoice_number(invoice_number)
+      response = session.request(entity_class.soap_action('FindByInvoiceNumber')) do
+        soap.body = {
+          'invoiceNumber' => invoice_number
+        }
+      end
+
+      response[:creditor_entry_handle].map do |creditor_entry_handle|
+        # Kinda ugly, but we get an array instead of a hash when there's only one result. :)
+        Hash[*creditor_entry_handle.to_a.flatten][:serial_number].to_i
+      end
+    end
+
+    def find(serial_number)
+      response = session.request(entity_class.soap_action('GetData')) do
+        soap.body = {
+          'entityHandle' => {
+            'SerialNumber' => serial_number
+           }
+        }
+      end
+
+      build(response)
+    end
+
+    def match(*serial_numbers)
+      response = session.request(entity_class.soap_action('MatchEntries')) do
+        soap.body = {
+          :entries => {
+            "CreditorEntryHandle" => serial_numbers.map { |serial_number|
+              { "SerialNumber" => serial_number }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/economic/proxies/creditor_proxy.rb

@@ -0,0 +1,73 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class CreditorProxy < EntityProxy
+
+    # Fetches Creditor from API
+    def find(handle)
+      handle = if handle.respond_to?(:to_i)
+        Entity::Handle.new(:number => handle.to_i)
+      else
+        Entity::Handle.new(handle)
+      end
+      super(handle)
+    end
+
+    # Returns Creditors that have the given ci_number. The Creditor objects will only be partially loaded
+    def find_by_ci_number(ci_number)
+      # Get a list of CreditorHandles from e-conomic
+      response = session.request(entity_class.soap_action('FindByCINumber')) do
+        soap.body = {
+          'ciNumber' => ci_number
+        }
+      end
+
+      # Make sure we always have an array of handles even if the result only contains one
+      handles = [response[:creditor_handle]].flatten.reject(&:blank?)
+
+      # Create partial Creditor entities
+      handles.collect do |handle|
+        creditor = build
+        creditor.partial = true
+        creditor.persisted = true
+        creditor.handle = handle
+        creditor.number = handle[:number]
+        creditor
+      end
+    end
+
+    # Returns handle with a given number.
+    def find_by_number(number)
+      response = session.request(entity_class.soap_action('FindByNumber')) do
+        soap.body = {
+          'number' => number
+        }
+      end
+
+      if response == {}
+        nil
+      else
+        creditor = build
+        creditor.partial = true
+        creditor.persisted = true
+        creditor.handle = response
+        creditor.number = response[:number].to_i
+        creditor
+      end
+    end
+
+    def create_simple(opts)
+      response = session.request(entity_class.soap_action('Create')) do
+        soap.body = {
+          'number' => opts[:number],
+          'creditorGroupHandle' => { 'Number' => opts[:creditor_group_handle][:number] },
+          :name => opts[:name],
+          :vatZone => opts[:vat_zone]
+        }
+      end
+
+      find(response)
+    end
+
+  end
+end

data/lib/economic/proxies/current_invoice_proxy.rb

@@ -15,7 +15,8 @@ module Economic
       response = session.request entity_class.soap_action("FindByDateInterval") do
         soap.body = {
           'first' => from.iso8601,
-          'last' => unto.iso8601
+          'last' => unto.iso8601,
+          :order! => ['first', 'last']
         }
       end
 

data/lib/economic/proxies/debtor_entry_proxy.rb

@@ -0,0 +1,32 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class DebtorEntryProxy < EntityProxy
+    def find_by_invoice_number(from, to = from)
+      response = session.request(entity_class.soap_action('FindByInvoiceNumber')) do
+        soap.body = {
+          'from'  => from,
+          'to'    => to,
+          :order! => [ 'from', 'to' ]
+        }
+      end
+
+      response[:debtor_entry_handle].map do |debtor_entry_handle|
+        # Kinda ugly, but we get an array instead of a hash when there's only one result. :)
+        Hash[*debtor_entry_handle.to_a.flatten][:serial_number].to_i
+      end
+    end
+
+    def match(*serial_numbers)
+      response = session.request(entity_class.soap_action('MatchEntries')) do
+        soap.body = {
+          :entries => {
+            "DebtorEntryHandle" => serial_numbers.map { |serial_number|
+              { "SerialNumber" => serial_number }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/economic/proxies/entity_proxy.rb

@@ -48,7 +48,7 @@ module Economic
       self
     end
 
-    # Returns a new, unpersisted Economic::Entity
+    # Returns a new, unpersisted Economic::Entity that has been added to Proxy
     def build(properties = {})
       entity = self.class.entity_class.new(:session => session)
 
@@ -65,7 +65,7 @@ module Economic
       self.class.entity_class
     end
 
-    # Fetches Entity data from API and returns an Entity initialized with that data
+    # Fetches Entity data from API and returns an Entity initialized with that data added to Proxy
     def find(handle)
       handle = Entity::Handle.new(handle) unless handle.is_a?(Entity::Handle)
       entity_hash = get_data(handle)

data/lib/economic/proxies/entry_proxy.rb

@@ -0,0 +1,63 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class EntryProxy < EntityProxy
+    def find_by_date_interval(from_date, to_date)
+      response = session.request(entity_class.soap_action('FindByDateInterval')) do
+        soap.body = {
+          'fromDate' => from_date,
+          'toDate'   => to_date
+        }
+      end
+
+      build_array(response)
+    end
+
+    # Undocumented tip: if you only care about the min_number, pass in the maximum
+    # possible value as max_number so you don't have to call `get_last_used_serial_number`:
+    #
+    #   max_number = 2**31 - 1  # Maximum int32.
+    #
+    def find_by_serial_number_interval(min_number, max_number)
+      response = session.request(entity_class.soap_action('FindBySerialNumberInterval')) do
+        soap.body = {
+          'minNumber' => min_number,
+          'maxNumber' => max_number
+        }
+      end
+
+      build_array(response)
+    end
+
+    def get_last_used_serial_number
+      response = session.request(entity_class.soap_action('GetLastUsedSerialNumber'))
+      response.to_i
+    end
+
+    def find(serial_number)
+      response = session.request(entity_class.soap_action('GetData')) do
+        soap.body = {
+          'entityHandle' => {
+            'SerialNumber' => serial_number
+           }
+        }
+      end
+
+      build(response)
+    end
+
+    private
+
+    def build_array(response)
+      # The response[:entry_handle] format may be any of
+      #   [{:serial_number=>"1"}, {:serial_number=>"2"}]  # Many results.
+      #   {:serial_number=>"1"}                           # One result.
+      #   nil                                             # No results.
+      entry_handles = [ response[:entry_handle] ].flatten.compact
+
+      entry_handles.map do |entry_handle|
+        entry_handle[:serial_number].to_i
+      end
+    end
+  end
+end

data/lib/economic/proxies/invoice_proxy.rb

@@ -17,7 +17,8 @@ module Economic
       response = session.request entity_class.soap_action("FindByDateInterval") do
         soap.body = {
           'first' => from.iso8601,
-          'last' => unto.iso8601
+          'last' => unto.iso8601,
+          :order! => ['first', 'last']
         }
       end
 

data/lib/economic/session.rb

@@ -37,7 +37,7 @@ module Economic
     def current_invoices
       @current_invoices ||= CurrentInvoiceProxy.new(self)
     end
-    
+
     # Provides access to the invoices
     def invoices
       @invoices ||= InvoiceProxy.new(self)
@@ -47,19 +47,36 @@ module Economic
     def debtors
       @debtors ||= DebtorProxy.new(self)
     end
-    
+
+    # Provides access to creditors
+    def creditors
+      @creditors ||= CreditorProxy.new(self)
+    end
+
     def cash_books
       @cash_books ||= CashBookProxy.new(self)
     end
-    
+
     def cash_book_entries
       @cash_book_entries ||= CashBookEntryProxy.new(self)
     end
-    
+
     def accounts
       @accounts ||= AccountProxy.new(self)
     end
 
+    def debtor_entries
+      @debtor_entries ||= DebtorEntryProxy.new(self)
+    end
+
+    def creditor_entries
+      @creditor_entries ||= CreditorEntryProxy.new(self)
+    end
+
+    def entries
+      @entries ||= EntryProxy.new(self)
+    end
+
     def request(action, &block)
       response = client.request :economic, action, &block
       response_hash = response.to_hash

data/lib/economic/support/string.rb

@@ -14,6 +14,11 @@ module Economic
         word.downcase!
         word
       end
+
+      def self.snakecase(word)
+        # Use the method from Savon::CoreExt::String.snakecase
+        word.snakecase
+      end
     end
   end
 end

data/lib/rconomic/version.rb

@@ -1,3 +1,3 @@
 module Rconomic
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/lib/rconomic.rb

@@ -8,21 +8,31 @@ require 'economic/session'
 
 require 'economic/debtor'
 require 'economic/debtor_contact'
+require 'economic/creditor'
+require 'economic/creditor_contact'
 require 'economic/current_invoice'
 require 'economic/current_invoice_line'
 require 'economic/invoice'
 require 'economic/cash_book'
 require 'economic/cash_book_entry'
 require 'economic/account'
+require 'economic/debtor_entry'
+require 'economic/creditor_entry'
+require 'economic/entry'
 
 require 'economic/proxies/current_invoice_proxy'
 require 'economic/proxies/current_invoice_line_proxy'
 require 'economic/proxies/debtor_proxy'
 require 'economic/proxies/debtor_contact_proxy'
+require 'economic/proxies/creditor_proxy'
+require 'economic/proxies/creditor_contact_proxy'
 require 'economic/proxies/invoice_proxy'
 require 'economic/proxies/cash_book_proxy'
 require 'economic/proxies/cash_book_entry_proxy'
 require 'economic/proxies/account_proxy'
+require 'economic/proxies/debtor_entry_proxy'
+require 'economic/proxies/creditor_entry_proxy'
+require 'economic/proxies/entry_proxy'
 
 # http://www.e-conomic.com/apidocs/Documentation/index.html
 # https://www.e-conomic.com/secure/api1/EconomicWebService.asmx

data/rconomic.gemspec

@@ -17,10 +17,15 @@ Gem::Specification.new do |s|
   s.version     = Rconomic::VERSION
   s.platform    = Gem::Platform::RUBY
 
+  # As long as we use Savon 0.9.5, we need to tie down the max version
+  # of gyoku as 0.4.5 is not backwards compatible. If we update Savon,
+  # we should remove the gyoku constraint.
   s.add_runtime_dependency "savon", "0.9.5"
+  s.add_runtime_dependency "gyoku", "0.4.4"
+
   s.add_runtime_dependency "activesupport", "~> 3.0"
 
   s.files         = `git ls-files`.split("\n").reject { |filename| ['.gitignore'].include?(filename) }
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = ["lib"]
-end
+end