rconomic 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTMxZDg2MjQyNWQ5ZmY1MWIzZmI3YmFhNWZkYmJkODBjOTJkMTc1OQ==
+    ZGU5ZmVjMDNkNDJlMzI0ODc3OWQ5NmVmNjhiM2UzNjY2NDQ1MjMzOQ==
   data.tar.gz: !binary |-
-    ZGYxYjM4MjI1N2E1MmM4ZWY4ZWJhZTVlMWRkOWZmM2E4MmVkNWNlMA==
+    ZWFjN2EyNGExYTNiZTNhNWM3Mzk0YTNhOTg2ODgxNWJhOGMxODY2Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MGFlMzg5YTc1MDZhOTA2NjdjMmJlYWFjMGQzZWE4NjlkY2Y4OTJjYTQ1Yzkx
-    MWQ0OTY2YjRlNmZjODljZjk2ZDBiOTg0N2U1OTgwZGZhYjM2MzkyY2ExM2Nk
-    ZGE1NTkyZjg2NWEyNzM0MTJiMmE0NzVhOTY1ZDI0ZjhjOWNiYmU=
+    NDMzYWQwOWMzYTE4NzUwNjA2YTBlMzJhZTA2ZjdjOTZhYmUzOTE2NmU5YzAx
+    NWU5OWYyYmI0YzA2MWFmMTliZGFjNzY0MDc4YjgxYThjMTIzMTQyOTE5Yjg5
+    YzU1ZTE4ZmM4OWM0ODcyNmNmM2JjZmMxMDdlZmU1MzdkMzgxYTQ=
   data.tar.gz: !binary |-
-    NmJkOTk0MmExOTgwYmIwMGQyMGNkMjdhODUwZTY5MWY1OGQwYzNlNGJmMGNh
-    NjU1ZjdkYWVmNTNmYjJlYzcyZjRiZmMxYTRiNzUzZWRhODZlNWE5MzAwY2Rh
-    NDA3YTFlODExYjM0NjFiZGUyNjM3MDk4YjNmNTM3M2FlNWNkZGM=
+    N2Q2MzYxYTIxZmVmZWRlNDhiMDg3ZjE5N2U2MWI0NzJiM2RlODdmNjBlNGVk
+    NTgwZGRmMDI2YzczZGI5OGM2NmUzNjRhOTFjZjkwY2ZhYjBlOWU0MGE2YmM5
+    Y2NkYTQ5N2RlOGE5Zjg0NjliZDEyNzE5MzQwN2RmZTllODc4NWM=

data/.travis.yml

@@ -1,9 +1,8 @@
 # Specify which ruby versions you wish to run your tests on, each version will be used
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ree
+  - 2.0.0
 
 # Specify the recipients for email notification
 notifications:

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
+  gem 'coveralls', :require => false
   gem 'rake'
   gem 'savon_spec', '0.1.6'
 end

data/README.md

@@ -5,7 +5,8 @@ Ruby wrapper for the [e-conomic](http://www.e-conomic.co.uk) SOAP API, that aims
 
 E-conomic is a web-based accounting system. For their marketing speak, see [http://www.e-conomic.co.uk/about/](). More details about their API at [http://www.e-conomic.com/developer]().
 
-[![Build Status](https://secure.travis-ci.org/lokalebasen/rconomic.png?branch=master)](http://travis-ci.org/lokalebasen/rconomic)
+[![Build Status](https://secure.travis-ci.org/lokalebasen/rconomic.png?branch=master)](http://travis-ci.org/lokalebasen/rconomic) [![Coverage Status](https://coveralls.io/repos/lokalebasen/rconomic/badge.png?branch=master)](https://coveralls.io/r/lokalebasen/rconomic?branch=master) [![Code Climate](https://codeclimate.com/github/lokalebasen/rconomic.png)](https://codeclimate.com/github/lokalebasen/rconomic)
+
 
 Usage example
 -------------
@@ -87,10 +88,14 @@ Not even remotely... For now, limited to a small subset of all the [available op
     -------------------+--------+------+--------+-------
     CashBook           | X      | X    | X      | X
     CashBookEntry      | X      | X    | X      | X
+    Creditor           | X      | X    | X      | X
+    CreditorContact    | X      | X    | X      | X
+    CreditorEntry      | X      | X    | X      | X
     CurrentInvoice     | X      | X    | X      | X
     CurrentInvoiceLine | X      | X    | X      | X
     Debtor             | X      | X    | X      | X
     DebtorContact      | X      | X    | X      | X
+    DebtorEntry        | X      | X    | X      | X
     Entry              | X      | X    | X      | X
     Invoice            | X      | X    |        |
 

data/lib/economic/account.rb

@@ -13,13 +13,11 @@ module Economic
     protected
     
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
-
-      data['Handle'] = handle.to_hash
-      data['Name'] = handle.number
-      data['Number'] = number
-      
-      return data
+      {
+        'Handle' => handle.to_hash,
+        'Name' => handle.number,
+        'Number' => number
+      }
     end
   end
 end

data/lib/economic/cash_book.rb

@@ -18,22 +18,20 @@ module Economic
 
     # Books all entries in the cashbook. Returns book result.
     def book
-      response = session.request(soap_action(:book)) do
-        soap.body = { "cashBookHandle" => handle.to_hash }
-      end
+      response = request(:book, {
+        "cashBookHandle" => handle.to_hash
+      })
       response[:number].to_i
     end
 
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
-
-      data['Handle'] = handle.to_hash
-      data['Name'] = name
-      data['Number'] = number
-
-      return data
+      {
+        'Handle' => handle.to_hash,
+        'Name' => name,
+        'Number' => number
+      }
     end
   end
 end

data/lib/economic/cash_book_entry.rb

@@ -74,7 +74,7 @@ module Economic
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Handle'] = handle.to_hash unless handle.empty?
       data['Id1'] = id1 unless id1.blank?

data/lib/economic/creditor.rb

@@ -36,7 +36,7 @@ module Economic
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Handle'] = handle.to_hash
       data['Number'] = handle.number

data/lib/economic/creditor_contact.rb

@@ -9,7 +9,7 @@ module Economic
   # Examples
   #
   #   # Find contact
-  #   contact = economic.contacts.find(5)
+  #   contact = economic.contacts.find(:id => 5)
   #
   #   # Creating a contact
   #   contact = creditor.contacts.build
@@ -42,7 +42,7 @@ module Economic
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Handle'] = handle.to_hash
       data['Id'] = id unless id.blank?

data/lib/economic/current_invoice.rb

@@ -70,9 +70,9 @@ module Economic
     #
     # Returns the resulting Economic::Invoice object
     def book
-      response = session.request soap_action(:book) do
-        soap.body = { "currentInvoiceHandle" => handle.to_hash }
-      end
+      response = request(:book, {
+        "currentInvoiceHandle" => handle.to_hash
+      })
 
       # Find the created Invoice
       session.invoices.find(response[:number])
@@ -83,13 +83,10 @@ module Economic
     #
     # Returns the resulting Economic::Invoice object
     def book_with_number(number)
-      response = session.request soap_action(:book_with_number) do
-        soap.body = {
-          "currentInvoiceHandle" => handle.to_hash,
-          "number" => number,
-          :order! => ["currentInvoiceHandle", "number"]
-        }
-      end
+      response = request(:book_with_number, {
+        "currentInvoiceHandle" => handle.to_hash,
+        "number" => number
+      })
 
       # Find the created Invoice
       session.invoices.find(response[:number])
@@ -134,10 +131,10 @@ module Economic
 
     protected
 
-    # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
-    # to be sent via SOAP
+    # Returns Hash with the properties of CurrentInvoice in the correct order,
+    # camelcased and ready to be sent via SOAP
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Id'] = id
       data['DebtorHandle'] = debtor.handle.to_hash unless debtor.blank?

data/lib/economic/current_invoice_line.rb

@@ -47,10 +47,10 @@ module Economic
 
     protected
 
-    # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
-    # to be sent via SOAP
+    # Returns Hash with the properties of CurrentInvoice in the correct order,
+    # camelcased and ready to be sent via SOAP
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Number'] = 0 # Doesn't seem to be used
       data['InvoiceHandle'] = invoice.handle.to_hash unless invoice.blank?

data/lib/economic/debtor.rb

@@ -44,7 +44,7 @@ module Economic
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Handle'] = handle.to_hash
       data['Number'] = handle.number

data/lib/economic/debtor_contact.rb

@@ -9,7 +9,7 @@ module Economic
   # Examples
   #
   #   # Find contact
-  #   contact = economic.contacts.find(5)
+  #   contact = economic.contacts.find(:id => 5)
   #
   #   # Creating a contact
   #   contact = debtor.contacts.build
@@ -42,7 +42,7 @@ module Economic
     protected
 
     def build_soap_data
-      data = ActiveSupport::OrderedHash.new
+      data = {}
 
       data['Handle'] = handle.to_hash
       data['Id'] = handle.id

data/lib/economic/entity.rb

@@ -52,7 +52,7 @@ module Economic
       end
 
       # Returns the E-conomic API action name to call
-      def soap_action(action)
+      def soap_action_name(action)
         class_name = self.name
         class_name_without_modules = class_name.split('::').last
         "#{class_name_without_modules.snakecase}_#{action.to_s.snakecase}".intern
@@ -133,15 +133,13 @@ module Economic
 
     # Deletes entity permanently from E-conomic.
     def destroy
-      handleKey = "#{camel_back(class_name)}Handle"
-      response = session.request soap_action(:delete) do
-        soap.body = { handleKey => handle.to_hash }
-      end
+      handleKey = "#{Support::String.camel_back(class_name)}Handle"
+      response = request(:delete, {handleKey => handle.to_hash})
 
       @persisted = false
       @partial = true
 
-      response 
+      response
     end
 
     # Updates properties of Entity with the values from hash
@@ -170,9 +168,9 @@ module Economic
     end
 
     def create
-      response = session.request soap_action(:create_from_data) do
-        soap.body = {'data' => build_soap_data}
-      end
+      response = request(:create_from_data, {
+        'data' => build_soap_data
+      })
 
       if response
         @number = response[:number]
@@ -192,9 +190,9 @@ module Economic
     end
 
     def update
-      response = session.request soap_action(:update_from_data) do
-        soap.body = {'data' => build_soap_data}
-      end
+      response = request(:update_from_data, {
+        'data' => build_soap_data
+      })
 
       @persisted = true
       @partial = false
@@ -202,20 +200,22 @@ module Economic
       return response
     end
 
-    # Returns OrderedHash with the data structure to send to the API
+    # Returns Hash with the data structure to send to the API
     def build_soap_data
+      raise NotImplementedError, "Subclasses of Economic::Entity must implement `build_soap_data`"
     end
 
-    def soap_action(action)
-      self.class.soap_action(action)
+    # Requests an action from the API endpoint
+    def request(action, data = nil)
+      session.request(soap_action_name(action), data)
     end
 
-    def class_name
-      self.class.to_s.split("::").last
+    def soap_action_name(action)
+      self.class.soap_action_name(action)
     end
 
-    def camel_back(name)
-      name[0,1].downcase + name[1..-1]
+    def class_name
+      self.class.to_s.split("::").last
     end
 
     def initialize_defaults

data/lib/economic/invoice.rb

@@ -35,9 +35,9 @@ module Economic
     end
 
     def remainder
-      session.request(soap_action(:get_remainder)) do
-        soap.body = { "invoiceHandle" => handle.to_hash }
-      end
+      request(:get_remainder, {
+        "invoiceHandle" => handle.to_hash
+      })
     end
 
     # Returns the PDF version of Invoice as a String.
@@ -48,9 +48,9 @@ module Economic
     #     file << invoice.pdf
     #   end
     def pdf
-      response = session.request soap_action(:get_pdf) do
-        soap.body = { "invoiceHandle" => handle.to_hash }
-      end
+      response = request(:get_pdf, {
+        "invoiceHandle" => handle.to_hash
+      })
 
       Base64.decode64(response)
     end

data/lib/economic/proxies/account_proxy.rb

@@ -3,11 +3,9 @@ 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
+      response = request('FindByName', {
+        'name' => name
+      })
       
       handle = response[:account_handle]
       
@@ -19,4 +17,4 @@ module Economic
       
     end
   end
-end
+end

data/lib/economic/proxies/actions/find_by_ci_number.rb

@@ -2,11 +2,9 @@ module FindByCiNumber
   # 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 handles from e-conomic
-    response = session.request entity_class.soap_action('FindByCINumber') do
-      soap.body = {
-        'ciNumber' => ci_number
-      }
-    end
+    response = request(:find_by_ci_number, {
+      'ciNumber' => ci_number
+    })
 
     # Make sure we always have an array of handles even if the result only contains one
     handle_key = "#{entity_class_name.downcase}_handle".intern

data/lib/economic/proxies/actions/find_by_date_interval.rb

@@ -3,13 +3,10 @@ module Economic
 
     # Returns entity objects 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
+      response = request(:find_by_date_interval, {
+        'first' => from.iso8601,
+        'last' => unto.iso8601
+      })
 
       handle_key = "#{Support::String.underscore(entity_class_name)}_handle".intern
       handles = [ response[handle_key] ].flatten.reject(&:blank?).collect do |handle|

data/lib/economic/proxies/actions/find_by_name.rb

@@ -0,0 +1,71 @@
+module Economic
+  module Proxies
+    module Actions
+      class FindByName
+        attr_reader :name
+
+        def initialize(caller, name)
+          @caller = caller
+          @name = name
+        end
+
+        def call
+          contacts = build_partial_contact_entities(handles_from_endpoint)
+          scope_to_owner(contacts)
+        end
+
+        private
+
+        def build(*options)
+          @caller.build(options)
+        end
+
+        def build_partial_contact_entities(handles)
+          handles.collect do |handle|
+            contact = build
+            contact.partial = true
+            contact.persisted = true
+            contact.handle = handle
+            contact.id = handle[:id]
+            contact.number = handle[:number]
+            contact
+          end
+        end
+
+        def handles_from_endpoint
+          [response[handle_key]].flatten.reject(&:blank?)
+        end
+
+        def handle_key
+          (Support::String.underscore(@caller.class.entity_class_name) + "_handle").to_sym
+        end
+
+        def owner
+          @caller.owner
+        end
+
+        def request(action, data)
+          @caller.request(action, data)
+        end
+
+        def response
+          request('FindByName', {'name' => name})
+        end
+
+        def scope_to_owner(contacts)
+          if owner.is_a?(Session)
+            contacts
+          else
+            owner_type = Support::String.underscore(
+              Support::String.demodulize(owner.class.name)
+            )
+            contacts.select do |contact|
+              contact.get_data
+              contact.send(owner_type) == owner
+            end
+          end
+        end
+      end
+    end
+  end
+end