rconomic 0.2.1 → 0.3

data/lib/economic/proxies/account_proxy.rb

@@ -0,0 +1,22 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class AccountProxy < EntityProxy
+    def find_by_name(name)
+      response = session.request entity_class.soap_action('FindByName') do
+        soap.body = {
+          'name' => name
+        }
+      end
+      
+      handle = response[:account_handle]
+      
+      entity = build(response)
+      entity.name = name
+      entity.number = handle[:number]
+      entity.persisted = true
+      entity
+      
+    end
+  end
+end

data/lib/economic/proxies/cash_book_entry_proxy.rb

@@ -0,0 +1,53 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class CashBookEntryProxy < EntityProxy
+    def all
+      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)
+        end
+      end
+      self
+    end
+
+    # Creates a finance voucher and returns the cash book entry.
+    # Example:
+    #   cash_book.entries.create_finance_voucher(
+    #     :account_handle        => { :number => 1010 },
+    #     :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)
+    end
+
+    # Creates a debtor payment and returns the cash book entry.
+    # Example:
+    #   cash_book.entries.create_debtor_payment(
+    #     :debtor_handle         => { :number => 1 },
+    #     :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] }
+        }
+      end
+
+      find(response)
+    end
+  end
+end

data/lib/economic/proxies/cash_book_proxy.rb

@@ -0,0 +1,47 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class CashBookProxy < EntityProxy
+    def find_by_name(name)
+      response = session.request entity_class.soap_action('FindByName') do
+        soap.body = {
+          'name' => name
+        }
+      end
+
+      cash_book = build
+      cash_book.partial = true
+      cash_book.persisted = true
+      cash_book.number = response[:number]
+      cash_book
+
+    end
+    
+    def all
+      response = session.request entity_class.soap_action('GetAll')
+
+      handles = [response[:cash_book_handle]].flatten.reject(&:blank?)
+      cash_books = []
+      handles.each do |handle|
+        cash_books << get_name(handle[:number])
+      end
+      
+      cash_books
+    end
+    
+    def get_name(id)
+      response = session.request entity_class.soap_action("GetName") do
+        soap.body = {
+          'cashBookHandle' => {
+            'Number' => id
+          }
+        }
+      end
+
+      cash_book = build
+      cash_book.number = id
+      cash_book.name = response
+      cash_book
+    end
+  end
+end

data/lib/economic/proxies/current_invoice_line_proxy.rb

@@ -9,6 +9,12 @@ module Economic
       invoice_line
     end
 
+    # Gets data for CurrentInvoiceLine from the API
+    def find(handle)
+      handle = Entity::Handle.new(:number => handle) unless handle.is_a?(Entity::Handle)
+      super(handle)
+    end
+
   private
 
     # Initialize properties in invoice_line with values from owner
@@ -18,4 +24,4 @@ module Economic
     end
 
   end
-end
+end

data/lib/economic/proxies/current_invoice_proxy.rb

@@ -2,6 +2,7 @@ require 'economic/proxies/entity_proxy'
 
 module Economic
   class CurrentInvoiceProxy < EntityProxy
+
     # Returns a new, unpersisted Economic::CurrentInvoice
     def build(properties = {})
       invoice = super
@@ -9,6 +10,22 @@ module Economic
       invoice
     end
 
+    # Returns Economic::CurrentInvoice object for a given interval of days.
+    def find_by_date_interval(from, unto)
+      response = session.request entity_class.soap_action("FindByDateInterval") do
+        soap.body = {
+          'first' => from.iso8601,
+          'last' => unto.iso8601
+        }
+      end
+
+      handles = [ response[:current_invoice_handle] ].flatten.reject(&:blank?)
+
+      handles.collect do |handle|
+        find(handle[:id])
+      end
+    end
+
   private
 
     # Initialize properties in invoice with values from owner
@@ -28,4 +45,4 @@ module Economic
     end
 
   end
-end
+end

data/lib/economic/proxies/debtor_contact_proxy.rb

@@ -11,21 +11,47 @@ module Economic
     end
 
     # Gets data for DebtorContact from the API
-    def find(id)
-      # This is basically EntityProxy::find duplicated so we can pass id to the API instead of
-      # Number...
-      entity_hash = session.request entity_class.soap_action(:get_data)  do
+    def find(handle)
+      handle = Entity::Handle.new(:id => handle) unless handle.is_a?(Entity::Handle)
+      super(handle)
+    end
+
+    # Returns DebtorContact that have the given name. The objects will only be partially loaded
+    def find_by_name(name)
+      # Get a list of DebtorContactHandles from e-conomic
+      response = session.request entity_class.soap_action('FindByName') do
         soap.body = {
-          'entityHandle' => {
-            'Id' => id
-          }
+          'name' => name
         }
       end
-      entity = build(entity_hash)
-      entity.persisted = true
-      entity
+
+      # Make sure we always have an array of handles even if the result only contains one
+      handles = [response[:debtor_contact_handle]].flatten.reject(&:blank?)
+
+      # Create partial DebtorContact entities
+      contacts = handles.collect do |handle|
+        debtor_contact = build
+        debtor_contact.partial = true
+        debtor_contact.persisted = true
+        debtor_contact.handle = handle
+        debtor_contact.id = handle[:id]
+        debtor_contact.number = handle[:number]
+        debtor_contact
+      end
+
+      if owner.is_a?(Debtor)
+        # Scope to the owner
+        contacts.select do |debtor_contact|
+          debtor_contact.get_data
+          debtor_contact.debtor.handle == owner.handle
+        end
+      else
+        contacts
+      end
+
     end
 
+
   private
 
     # Initialize properties in contact with values from owner. Returns contact.

data/lib/economic/proxies/debtor_proxy.rb

@@ -2,6 +2,17 @@ require 'economic/proxies/entity_proxy'
 
 module Economic
   class DebtorProxy < EntityProxy
+
+    # Fetches Debtor 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 Debtors that have the given ci_number. The Debtor objects will only be partially loaded
     def find_by_ci_number(ci_number)
       # Get a list of DebtorHandles from e-conomic
@@ -25,9 +36,29 @@ module Economic
       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
+        debtor = build
+        debtor.partial = true
+        debtor.persisted = true
+        debtor.handle = response
+        debtor.number = response[:number].to_i
+        debtor
+      end
+    end
+
     # Returns the next available debtor number
     def next_available_number
       session.request Debtor.soap_action(:get_next_available_number)
     end
   end
-end
+end

data/lib/economic/proxies/entity_proxy.rb

@@ -22,6 +22,32 @@ module Economic
       owner.session
     end
 
+    # Fetches all entities from the API.
+    def all
+      response = session.request(entity_class.soap_action(:get_all))
+      handles = response.values.flatten.collect { |handle| Entity::Handle.new(handle) }
+
+      if handles.size == 1
+        # Fetch data for single entity
+        find(handles.first)
+      elsif handles.size > 1
+        entity_class_name = entity_class.name.split('::').last
+
+        # Fetch all data for all the entities
+        entity_data = session.request(entity_class.soap_action(:get_data_array)) do
+          soap.body = {'entityHandles' => {"#{entity_class_name}Handle" => handles.collect(&:to_hash)}}
+        end
+
+        # Build Entity objects and add them to the proxy
+        entity_data["#{entity_class.key}_data".intern].each do |data|
+          entity = build(data)
+          entity.persisted = true
+        end
+      end
+
+      self
+    end
+
     # Returns a new, unpersisted Economic::Entity
     def build(properties = {})
       entity = self.class.entity_class.new(:session => session)
@@ -41,7 +67,7 @@ module Economic
 
     # Fetches Entity data from API and returns an Entity initialized with that data
     def find(handle)
-      handle = Entity::Handle.new(:number => handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.new(handle) unless handle.is_a?(Entity::Handle)
       entity_hash = get_data(handle)
       entity = build(entity_hash)
       entity.persisted = true
@@ -50,7 +76,8 @@ module Economic
 
     # Gets data for Entity from the API. Returns Hash with the response data
     def get_data(handle)
-      handle = Entity::Handle.new(:number => handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.new(handle) unless handle.is_a?(Entity::Handle)
+
       entity_hash = session.request(entity_class.soap_action(:get_data)) do
         soap.body = {
           'entityHandle' => handle.to_hash
@@ -79,4 +106,4 @@ module Economic
     end
 
   end
-end
+end

data/lib/economic/proxies/invoice_proxy.rb

@@ -0,0 +1,31 @@
+require 'economic/proxies/entity_proxy'
+
+module Economic
+  class InvoiceProxy < EntityProxy
+    # Gets data for Invoice from the 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 Economic::Invoice objects for invoices in a given interval of days.
+    def find_by_date_interval(from, unto)
+      response = session.request entity_class.soap_action("FindByDateInterval") do
+        soap.body = {
+          'first' => from.iso8601,
+          'last' => unto.iso8601
+        }
+      end
+
+      handles = [ response[:invoice_handle] ].flatten.reject(&:blank?)
+
+      handles.collect do |handle|
+        find(handle[:number])
+      end
+    end
+  end
+end

data/lib/economic/session.rb

@@ -37,11 +37,28 @@ module Economic
     def current_invoices
       @current_invoices ||= CurrentInvoiceProxy.new(self)
     end
+    
+    # Provides access to the invoices
+    def invoices
+      @invoices ||= InvoiceProxy.new(self)
+    end
 
     # Provides access to the debtors
     def debtors
       @debtors ||= DebtorProxy.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 request(action, &block)
       response = client.request :economic, action, &block
@@ -61,4 +78,4 @@ module Economic
       self
     end
   end
-end
+end

data/lib/economic/support/string.rb

@@ -0,0 +1,19 @@
+module Economic
+  module Support
+    module String
+      def self.demodulize(class_name_in_module)
+        class_name_in_module.to_s.gsub(/^.*::/, '')
+      end
+
+      def self.underscore(camel_cased_word)
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+    end
+  end
+end

data/lib/rconomic/version.rb

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

data/lib/rconomic.rb

@@ -3,25 +3,33 @@ require 'time'
 require 'savon'
 require 'active_support/ordered_hash'
 
+require 'economic/support/string'
 require 'economic/session'
+
 require 'economic/debtor'
 require 'economic/debtor_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/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/invoice_proxy'
+require 'economic/proxies/cash_book_proxy'
+require 'economic/proxies/cash_book_entry_proxy'
+require 'economic/proxies/account_proxy'
 
 # http://www.e-conomic.com/apidocs/Documentation/index.html
 # https://www.e-conomic.com/secure/api1/EconomicWebService.asmx
 #
 # TODO
 #
-# * Memoization via ActiveSupport?
 # * Basic validations; ie check for nil values before submitting to API
-# * Better Handle handling
 
 module Economic
 end

data/spec/economic/cash_book_entry_spec.rb

@@ -0,0 +1,20 @@
+require './spec/spec_helper'
+
+describe Economic::CashBookEntry do
+  let(:session) { make_session }
+  subject { Economic::CashBookEntry.new(:session => session) }
+
+  it "inherits from Economic::Entity" do
+    Economic::CashBookEntry.ancestors.should include(Economic::Entity)
+  end
+
+  describe ".proxy" do
+    it "should return a CashBookEntryProxy" do
+      subject.proxy.should be_instance_of(Economic::CashBookEntryProxy)
+    end
+
+    it "should return a proxy owned by session" do
+      subject.proxy.session.should == session
+    end
+  end
+end

data/spec/economic/cash_book_spec.rb

@@ -0,0 +1,34 @@
+require './spec/spec_helper'
+
+describe Economic::CashBook do
+  let(:session) { make_session }
+  subject { (i = Economic::CashBook.new( :id => 512, :number => 32 )).tap { i.session = session } }
+
+  it "inherits from Economic::Entity" do
+    Economic::CashBook.superclass.should == Economic::Entity
+  end
+
+  describe "class methods" do
+    subject { Economic::CashBook }
+
+    describe ".proxy" do
+      it "should return CashBookProxy" do
+        subject.proxy.should == Economic::CashBookProxy
+      end
+    end
+  end
+
+  describe "#entries" do
+    it 'should return a cash book entry proxy' do
+      subject.entries.should be_a(Economic::CashBookEntryProxy)
+      subject.entries.owner.should == subject
+    end
+  end
+
+  describe "#book" do
+    it 'should book the cash book and return an invoice number' do
+      savon.expects("CashBook_Book").with('cashBookHandle' => { 'Number' => 32 }).returns(:success)
+      subject.book.should == 832
+    end
+  end
+end

data/spec/economic/current_invoice_spec.rb

@@ -2,7 +2,7 @@ require './spec/spec_helper'
 
 describe Economic::CurrentInvoice do
   let(:session) { make_session }
-  subject { (i = Economic::CurrentInvoice.new).tap { i.session = session } }
+  subject { (i = Economic::CurrentInvoice.new( :id => 512 )).tap { i.session = session } }
 
   it "inherits from Economic::Entity" do
     Economic::CurrentInvoice.ancestors.should include(Economic::Entity)
@@ -15,6 +15,12 @@ describe Economic::CurrentInvoice do
     end
   end
 
+  describe ".key" do
+    it "should == :current_invoice" do
+      Economic::CurrentInvoice.key.should == :current_invoice
+    end
+  end
+
   describe ".proxy" do
     it "should return a CurrentInvoiceProxy" do
       subject.proxy.should be_instance_of(Economic::CurrentInvoiceProxy)
@@ -66,4 +72,41 @@ describe Economic::CurrentInvoice do
       end
     end
   end
+
+  describe "#book" do
+    before :each do
+      savon.stubs('CurrentInvoice_Book').returns(:success)
+      savon.stubs('Invoice_GetData').returns(:success)
+    end
+
+    it 'should book the current invoice and return the created invoice object' do
+      savon.expects("Invoice_GetData").with('entityHandle' => { 'Number' => 328 }).returns(:success)
+      subject.book.should be_instance_of(Economic::Invoice)
+    end
+
+    it 'should request with the right key for handle' do
+      savon.expects("CurrentInvoice_Book").with('currentInvoiceHandle' => { 'Id' => 512 }).returns(:success)
+      subject.book
+    end
+  end
+
+  describe "#attention" do
+    let(:contact) { (c = Economic::DebtorContact.new).tap { c.session = session }}
+
+    it "should be set- and gettable" do
+      subject.attention = contact
+      subject.attention_handle.should == contact.handle
+      subject.attention.should == contact
+    end
+  end
+
+  describe "#debtor" do
+    let(:debtor) { (c = Economic::Debtor.new).tap { c.session = session }}
+
+    it "should be set- and gettable" do
+      subject.debtor = debtor
+      subject.debtor_handle.should == debtor.handle
+      subject.debtor.should == debtor
+    end
+  end
 end

data/spec/economic/debtor_contact_spec.rb

@@ -40,12 +40,12 @@ describe Economic::DebtorContact do
       end
 
       it "returns a Debtor" do
-        session.debtors.expects(:find).with(handle).returns(Economic::Debtor.new)
+        session.debtors.expects(:find).with(42).returns(Economic::Debtor.new)
         subject.debtor.should be_instance_of(Economic::Debtor)
       end
 
       it "only looks up the debtor the first time" do
-        session.debtors.expects(:find).with(handle).returns(Economic::Debtor.new)
+        session.debtors.expects(:find).with(42).returns(Economic::Debtor.new)
         subject.debtor.should === subject.debtor
       end
     end

data/spec/economic/debtor_spec.rb

@@ -16,6 +16,12 @@ describe Economic::Debtor do
         subject.proxy.should == Economic::DebtorProxy
       end
     end
+
+    describe ".key" do
+      it "should == :debtor" do
+        Economic::Debtor.key.should == :debtor
+      end
+    end
   end
 
   context "when saving" do