rconomic 0.4 → 0.4.1

data/lib/economic/proxies/creditor_proxy.rb

@@ -1,60 +1,13 @@
 require 'economic/proxies/entity_proxy'
+require 'economic/proxies/actions/find_by_ci_number'
+require 'economic/proxies/actions/find_by_handle_with_number'
+require 'economic/proxies/actions/find_by_number'
 
 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
+    include FindByCiNumber
+    include FindByHandleWithNumber
+    include FindByNumber
 
     def create_simple(opts)
       response = session.request(entity_class.soap_action('Create')) do

data/lib/economic/proxies/current_invoice_line_proxy.rb

@@ -11,7 +11,7 @@ module Economic
 
     # Gets data for CurrentInvoiceLine from the API
     def find(handle)
-      handle = Entity::Handle.new(:number => handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.build(:number => handle) unless handle.is_a?(Entity::Handle)
       super(handle)
     end
 

data/lib/economic/proxies/current_invoice_proxy.rb

@@ -1,7 +1,9 @@
 require 'economic/proxies/entity_proxy'
+require 'economic/proxies/actions/find_by_date_interval'
 
 module Economic
   class CurrentInvoiceProxy < EntityProxy
+    include FindByDateInterval
 
     # Returns a new, unpersisted Economic::CurrentInvoice
     def build(properties = {})
@@ -10,23 +12,6 @@ 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,
-          :order! => ['first', 'last']
-        }
-      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

data/lib/economic/proxies/debtor_contact_proxy.rb

@@ -12,7 +12,7 @@ module Economic
 
     # Gets data for DebtorContact from the API
     def find(handle)
-      handle = Entity::Handle.new(:id => handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.build(:id => handle) unless handle.is_a?(Entity::Handle)
       super(handle)
     end
 
@@ -61,4 +61,4 @@ module Economic
     end
 
   end
-end
+end

data/lib/economic/proxies/debtor_proxy.rb

@@ -1,60 +1,13 @@
 require 'economic/proxies/entity_proxy'
+require 'economic/proxies/actions/find_by_ci_number'
+require 'economic/proxies/actions/find_by_handle_with_number'
+require 'economic/proxies/actions/find_by_number'
 
 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
-      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[:debtor_handle]].flatten.reject(&:blank?)
-
-      # Create partial Debtor entities
-      handles.collect do |handle|
-        debtor = build
-        debtor.partial = true
-        debtor.persisted = true
-        debtor.handle = handle
-        debtor.number = handle[:number]
-        debtor
-      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
+    include FindByCiNumber
+    include FindByHandleWithNumber
+    include FindByNumber
 
     # Returns the next available debtor number
     def next_available_number

data/lib/economic/proxies/entity_proxy.rb

@@ -3,9 +3,12 @@ module Economic
     class << self
       # Returns the class this Proxy is a proxy for
       def entity_class
+        Economic.const_get(self.entity_class_name)
+      end
+
+      def entity_class_name
         proxy_class_name = name.split('::').last
-        entity_class_name = proxy_class_name.sub(/Proxy$/, '')
-        Economic.const_get(entity_class_name)
+        proxy_class_name.sub(/Proxy$/, '')
       end
     end
 
@@ -25,21 +28,17 @@ module Economic
     # 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) }
+      handles = response.values.flatten.collect { |handle| Entity::Handle.build(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
+        entity_data = get_data_array(handles)
 
         # Build Entity objects and add them to the proxy
-        entity_data["#{entity_class.key}_data".intern].each do |data|
+        entity_data.each do |data|
           entity = build(data)
           entity.persisted = true
         end
@@ -65,9 +64,14 @@ module Economic
       self.class.entity_class
     end
 
+    # Returns the name of the class this proxy manages
+    def entity_class_name
+      self.class.entity_class_name
+    end
+
     # 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)
+      handle = Entity::Handle.new(handle)
       entity_hash = get_data(handle)
       entity = build(entity_hash)
       entity.persisted = true
@@ -76,7 +80,7 @@ module Economic
 
     # Gets data for Entity from the API. Returns Hash with the response data
     def get_data(handle)
-      handle = Entity::Handle.new(handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.new(handle)
 
       entity_hash = session.request(entity_class.soap_action(:get_data)) do
         soap.body = {
@@ -105,5 +109,17 @@ module Economic
       items.size
     end
 
+  protected
+
+    # Fetches all data for the given handles. Returns Array with hashes of entity data
+    def get_data_array(handles)
+      return [] unless handles && handles.any?
+
+      entity_class_name_for_soap_request = entity_class.name.split('::').last
+      response = session.request(entity_class.soap_action(:get_data_array)) do
+        soap.body = {'entityHandles' => {"#{entity_class_name_for_soap_request}Handle" => handles.collect(&:to_hash)}}
+      end
+      [response["#{entity_class.key}_data".intern]].flatten
+    end
   end
 end

data/lib/economic/proxies/invoice_proxy.rb

@@ -1,32 +1,10 @@
 require 'economic/proxies/entity_proxy'
+require 'economic/proxies/actions/find_by_date_interval'
+require 'economic/proxies/actions/find_by_handle_with_number'
 
 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,
-          :order! => ['first', 'last']
-        }
-      end
-
-      handles = [ response[:invoice_handle] ].flatten.reject(&:blank?)
-
-      handles.collect do |handle|
-        find(handle[:number])
-      end
-    end
+    include FindByDateInterval
+    include FindByHandleWithNumber
   end
 end

data/lib/rconomic/version.rb

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

data/spec/economic/cash_book_entry_spec.rb

@@ -17,4 +17,12 @@ describe Economic::CashBookEntry do
       subject.proxy.session.should == session
     end
   end
+
+  describe "#save" do
+    it 'should save it' do
+      savon.stubs('CashBookEntry_CreateFromData').returns(:success)
+      subject.save
+    end
+  end
+
 end

data/spec/economic/current_invoice_line_spec.rb

@@ -8,6 +8,33 @@ describe Economic::CurrentInvoiceLine do
     Economic::CurrentInvoiceLine.ancestors.should include(Economic::Entity)
   end
 
+  describe "equality" do
+    it "should not be equal when both are newly created" do
+      line1 = Economic::CurrentInvoiceLine.new({})
+      line2 = Economic::CurrentInvoiceLine.new({})
+
+      line1.should_not == line2
+    end
+
+    it "should not be equal when numbers are different" do
+      line1 = Economic::CurrentInvoiceLine.new({:number => 1})
+      line2 = Economic::CurrentInvoiceLine.new({:number => 2})
+
+      line1.should_not == line2
+    end
+  end
+
+  describe "#invoice=" do
+    it "changes the invoice_handle" do
+      invoice = Economic::CurrentInvoice.new(:id => 42)
+
+      subject.invoice = invoice
+
+      subject.invoice.should == invoice
+      subject.invoice_handle.should == invoice.handle
+    end
+  end
+
   describe ".proxy" do
     it "should return a CurrentInvoiceLineProxy" do
       subject.proxy.should be_instance_of(Economic::CurrentInvoiceLineProxy)

data/spec/economic/current_invoice_spec.rb

@@ -37,6 +37,23 @@ describe Economic::CurrentInvoice do
         savon.stubs('CurrentInvoice_CreateFromData').returns(:success)
       end
 
+      it "updates id with the created id" do
+        subject.save
+        subject.id.should == 42
+      end
+
+      it "updates handle with the created id" do
+        invoice = Economic::CurrentInvoice.new({})
+        invoice.session = session
+
+        # This line memoizes the handle with the wrong/old id (0). This is what
+        # we're testing changes
+        invoice.handle.id.should == 0
+
+        invoice.save
+        invoice.handle.should == Economic::Entity::Handle.new(:id => 42)
+      end
+
       context "when invoice has lines" do
         before :each do
           2.times do
@@ -105,7 +122,13 @@ describe Economic::CurrentInvoice do
   end
 
   describe "#attention" do
-    let(:contact) { (c = Economic::DebtorContact.new).tap { c.session = session }}
+    let(:contact) {
+      c = Economic::DebtorContact.new(
+        :handle => Economic::Entity::Handle.new({:id => 12, :number => 34})
+      )
+      c.session = session
+      c
+    }
 
     it "should be set- and gettable" do
       subject.attention = contact

data/spec/economic/entity/handle_spec.rb

@@ -19,6 +19,15 @@ describe Economic::Entity::Handle do
       handle_a.should_not == handle_d
     end
 
+    it "should not equal if both are empty" do
+      Economic::Entity::Handle.new({}).should_not == Economic::Entity::Handle.new({})
+    end
+
+    it "should be equal if both are the same object" do
+      handle = Economic::Entity::Handle.new({})
+      handle.should == handle
+    end
+
     describe "CashBookEntry handles" do
       let(:handle_a) { Economic::Entity::Handle.new(:id1 => 1, :id2 => 2) }
 
@@ -38,7 +47,6 @@ describe Economic::Entity::Handle do
         end
       end
     end
-
   end
 
   describe ".new" do
@@ -126,12 +134,54 @@ describe Economic::Entity::Handle do
     end
   end
 
+  describe ".build" do
+    it "returns nil when given nil" do
+      Economic::Entity::Handle.build(nil).should be_nil
+    end
+
+    it "returns empty handle when hash is empty" do
+      Economic::Entity::Handle.build({}).should be_empty
+    end
+
+    it "returns nil when hash has no values" do
+      Economic::Entity::Handle.build({:id => nil, :number => nil}).should be_empty
+    end
+
+    it "returns handle when hash has values" do
+      Economic::Entity::Handle.build({:id2 => 42}).should == Economic::Entity::Handle.new({:id2 => 42})
+    end
+
+    it "returns a given handle" do
+      handle = Economic::Entity::Handle.new({})
+      Economic::Entity::Handle.build(handle).should === handle
+    end
+  end
+
+  describe "#empty?" do
+    it "returns true when handle has no values" do
+      Economic::Entity::Handle.new({}).should be_empty
+    end
+
+    it "returns false when handle has a value" do
+      Economic::Entity::Handle.new({:serial_number => 12}).should_not be_empty
+    end
+  end
+
   describe ".to_hash" do
-    subject { Economic::Entity::Handle.new({:id => 42, :number => 37}) }
+    subject { Economic::Entity::Handle.new({:id => 42, :number => 37, :serial_number => 7}) }
 
     it "should return a handle for putting into the body of a SOAP request" do
-      subject.to_hash.should == {'Id' => 42, 'Number' => 37}
+      subject.to_hash.should == {'Id' => 42, 'Number' => 37, 'SerialNumber' => 7}
+    end
+
+    it "includes only the named value in the hash" do
+      subject.to_hash(:id).should == {'Id' => 42}
+    end
+
+    it "includes only the named values in the hash" do
+      subject.to_hash([:id, :serial_number]).should == {'Id' => 42, 'SerialNumber' => 7}
     end
   end
+
 end
 

data/spec/economic/entity_spec.rb

@@ -1,7 +1,7 @@
 require './spec/spec_helper'
 
 class SpecEntity < Economic::Entity
-  has_properties :foo, :baz
+  has_properties :id, :foo, :baz
 
   def existing_method; end
 
@@ -64,8 +64,8 @@ describe Economic::Entity do
         subject.has_properties :id, :number, :handle
       end
 
-      it "does not clobber existing methods" do
-        subject.expects(:define_method).with('existing_method').never
+      it "does clobber existing methods" do
+        subject.expects(:define_method).with('existing_method')
         subject.has_properties :existing_method
       end
 
@@ -215,33 +215,61 @@ describe Economic::Entity do
   end
 
   describe "equality" do
+    subject { SpecEntity.new }
+    let(:other) { SpecEntity.new }
+
     context "when other is nil do" do
-      let(:other) { nil }
+      it { should_not == nil }
+    end
+
+    context "when both handles are empty" do
+      it "returns false" do
+        subject.handle = Economic::Entity::Handle.new({})
+        other.handle = Economic::Entity::Handle.new({})
+
+        subject.should_not == other
+      end
+    end
+
+    context "when self handle isn't present" do
+      it "returns false" do
+        subject.handle = nil
+        subject.should_not == other
+      end
+    end
 
-      it "should return true" do
+    context "when other handle isn't present" do
+      it "returns false" do
+        other.handle = nil
         subject.should_not == other
       end
     end
 
     context "when other handle is equal" do
-      context "when other is same class" do
-        let(:other) { Economic::Entity.new(:session => session, :handle => subject.handle) }
+      let(:handle) { Economic::Entity::Handle.new(:id => 42) }
+      subject { Economic::Debtor.new(:handle => handle) }
+
+      context "when other is another class" do
+        it "should return false" do
+          other = Economic::CashBook.new(:handle => handle)
+          subject.should_not == other
+        end
+      end
 
+      context "when other is same class" do
         it "should return true" do
+          other = Economic::Debtor.new(:handle => handle)
           subject.should == other
         end
       end
 
       context "when other is child class" do
-        let(:other) { Economic::Debtor.new(:session => session, :handle => subject.handle) }
-
         it "should return true" do
-          subject.should == other
+          one = Economic::Entity.new(:handle => handle)
+          other = SpecEntity.new(:handle => handle)
+          one.should == other
         end
       end
     end
-
-
-
   end
 end

data/spec/economic/proxies/cash_book_entry_proxy_spec.rb

@@ -26,13 +26,6 @@ describe Economic::CashBookEntryProxy do
     end
   end
 
-  describe "#save" do
-    it 'should save it' do
-      savon.stubs('CashBookEntry_CreateFromData').returns(:success)
-      subject.build.save
-    end
-  end
-
   describe "#create_finance_voucher" do
     it 'should create a finance voucher and return the created cash book entry' do
       savon.stubs('CashBookEntry_CreateFinanceVoucher').returns(:success)

data/spec/economic/proxies/current_invoice_proxy_spec.rb

@@ -64,31 +64,26 @@ describe Economic::CurrentInvoiceProxy do
   end
 
   describe ".find_by_date_interval" do
+    let(:from) { Time.now - 60 }
+    let(:unto) { Time.now }
 
     it "should be able to return a single current invoice" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('CurrentInvoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:single)
-      savon.expects('CurrentInvoice_GetData').returns(:success)
+      savon.expects('CurrentInvoice_GetDataArray').returns(:single)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 1
       results.first.should be_instance_of(Economic::CurrentInvoice)
     end
 
     it "should be able to return multiple invoices" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('CurrentInvoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:many)
-      savon.expects('CurrentInvoice_GetData').returns(:success)
-      savon.expects('CurrentInvoice_GetData').returns(:success)
+      savon.expects('CurrentInvoice_GetDataArray').returns(:multiple)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 2
       results.first.should be_instance_of(Economic::CurrentInvoice)
     end
 
     it "should be able to return nothing" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('CurrentInvoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:none)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 0

data/spec/economic/proxies/debtor_proxy_spec.rb

@@ -61,7 +61,7 @@ describe Economic::DebtorProxy do
       result.number.should == 1
       result.partial.should be_true
       result.persisted.should be_true
-      result.handle.should == Economic::Entity::Handle.new({ :number => 1 })
+      result.handle.should == Economic::Entity::Handle.new({:number => 1})
     end
 
     it "returns nil when there is no debtor" do

data/spec/economic/proxies/invoice_proxy_spec.rb

@@ -41,31 +41,26 @@ describe Economic::InvoiceProxy do
   end  
 
   describe ".find_by_date_interval" do
+    let(:from) { Time.now - 60 }
+    let(:unto) { Time.now }
 
     it "should be able to return a single current invoice" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('Invoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:single)
-      savon.expects('Invoice_GetData').returns(:success)
+      savon.expects('Invoice_GetDataArray').returns(:single)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 1
       results.first.should be_instance_of(Economic::Invoice)
     end
 
     it "should be able to return multiple invoices" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('Invoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:many)
-      savon.expects('Invoice_GetData').returns(:success)
-      savon.expects('Invoice_GetData').returns(:success)
+      savon.expects('Invoice_GetDataArray').returns(:multiple)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 2
       results.first.should be_instance_of(Economic::Invoice)
     end
 
     it "should be able to return nothing" do
-      from = Time.now - 60
-      unto = Time.now
       savon.expects('Invoice_FindByDateInterval').with('first' => from.iso8601, 'last' => unto.iso8601, :order! => ['first', 'last']).returns(:none)
       results = subject.find_by_date_interval(from, unto)
       results.size.should == 0