rconomic 0.2.1 → 0.3

data/.travis.yml

@@ -2,6 +2,7 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - ree
   - rbx
 

data/Gemfile

@@ -5,4 +5,11 @@ gemspec
 group :test do
   gem 'rake'
   gem 'savon_spec', '0.1.6'
-end
+end
+
+# Not required to develop rconomic, but useful. See file
+# mappings in Guardfile
+group :guard do
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rconomic (0.1.0)
+    rconomic (0.3)
       activesupport (~> 3.0)
       savon (= 0.9.5)
 
@@ -13,6 +13,10 @@ GEM
       gyoku (>= 0.4.0)
     builder (3.0.0)
     diff-lcs (1.1.2)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.0)
+      guard (>= 0.8.4)
     gyoku (0.4.4)
       builder (>= 2.1.2)
     httpi (0.9.5)
@@ -42,6 +46,7 @@ GEM
       mocha (>= 0.9.8)
       rspec (>= 2.0.0)
       savon (>= 0.8.0)
+    thor (0.14.6)
     wasabi (1.0.0)
       nokogiri (>= 1.4.0)
 
@@ -49,6 +54,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard
+  guard-rspec
   rake
   rconomic!
   savon_spec (= 0.1.6)

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2, :cli => "--color", :all_after_pass => false, :all_on_start => false, :keep_failed => false do
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -31,11 +31,11 @@ Usage example
     debtor.save
     
     # Create invoice for debtor:
-    invoice = economic.current_invoices.build
-    invoice.date = Time.now
-    invoice.due_date = Time.now + 15
-    invoice.exchange_rate = 100
-    invoice.is_vat_included = false
+    current_invoice = economic.current_invoices.build
+    current_invoice.date = Time.now
+    current_invoice.due_date = Time.now + 15
+    current_invoice.exchange_rate = 100
+    current_invoice.is_vat_included = false
     
     invoice_line = Economic::CurrentInvoiceLine.new
     invoice_line.description = 'Line on invoice'
@@ -43,9 +43,31 @@ Usage example
     invoice_line.product_handle = { :number => 101 }
     invoice_line.quantity = 12
     invoice_line.unit_net_price = 19.95
-    invoice.lines << invoice_line
-    
-    invoice.save
+    current_invoice.lines << invoice_line
+
+    current_invoice.save
+
+    # You can delete it by doing:
+    # current_invoice.destroy
+
+    invoice = current_invoice.book
+
+    # Create a debtor payment
+
+    cash_book = economic.cash_books.all.last # Or find it by its number
+
+    # The reason debtor payments are done this way is because we don't want to specify the voucher number. If we build the cash book entry ourselves,
+    # without specifying the voucher number, the API will complain. This way, E-Conomics will assign a voucher number for us.
+
+    cash_book_entry = cash_book.entries.create_debtor_payment(:debtor_handle => debtor.handle, :contra_account_handle => { :number => '1920' })
+    cash_book_entry.cash_book_entry_type = "DebtorPayment" # For some reason, we need to specify this.
+    cash_book_entry.amount = -123.45
+    cash_book_entry.currency_handle = { "Code" => "DKK" }
+    cash_book_entry.debtor_invoice_number = invoice.number
+    cash_book_entry.text = "Payment, invoice #{ invoice.number }"
+    cash_book_entry.save
+
+    cash_book.book
 
 
 How to enable e-conomic API access
@@ -61,12 +83,15 @@ It doesn't do everything
 
 Not even remotely... For now, limited to a small subset of all the [available operations](https://www.e-conomic.com/secure/api1/EconomicWebService.asmx):
 
-                       | Create | Read | Update
-    -------------------+--------+------+-------
-    CurrentInvoice     | X      | X    | X
-    CurrentInvoiceLine | X      | X    | X
-    Debtor             | X      | X    | X
-    DebtorContact      | X      | X    | X
+                       | Create | Read | Update | Delete
+    -------------------+--------+------+--------+-------
+    CashBook           | X      | X    | X      | X
+    CashBookEntry      | X      | X    | X      | X
+    CurrentInvoice     | X      | X    | X      | X
+    CurrentInvoiceLine | X      | X    | X      | X
+    Debtor             | X      | X    | X      | X
+    DebtorContact      | X      | X    | X      | X
+    Invoice            | X      | X    |        |
 
 
 Credits

data/lib/economic/account.rb

@@ -0,0 +1,25 @@
+require 'economic/entity'
+
+module Economic
+  class Account < Entity
+    has_properties :name, :number, :balance, :block_direct_entries, :contra_account, :debit_credit, :department, :distribution_key, :is_accessible, :opening_account, :total_from, :type, :vat_account
+    
+    
+    def handle
+      Handle.new({:name => @name})
+    end
+    
+    
+    protected
+    
+    def build_soap_data
+      data = ActiveSupport::OrderedHash.new
+
+      data['Handle'] = handle.to_hash
+      data['Name'] = handle.number
+      data['Number'] = number
+      
+      return data
+    end
+  end
+end

data/lib/economic/cash_book.rb

@@ -0,0 +1,39 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a cash book in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICashBook.html
+  class CashBook < Entity
+    has_properties :name, :number
+
+    def handle
+      Handle.new({:number => @number})
+    end
+
+    def entries
+      CashBookEntryProxy.new(self)
+    end
+
+    # 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[: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
+    end
+  end
+end

data/lib/economic/cash_book_entry.rb

@@ -0,0 +1,111 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a cash book in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICashBook.html
+  class CashBookEntry < Entity
+    has_properties :id1,
+                   :id2,
+                   :account_handle,
+                   :amount,
+                   :amount_default_currency,
+                   :bank_payment_creditor_id,
+                   :bank_payment_creditor_invoice_id,
+                   :bank_payment_type_handle,
+                   :capitalise_handle,
+                   :cash_book_handle,
+                   :contra_account_handle,
+                   :contra_vat_account_handle,
+                   :cost_type_handle,
+                   :creditor_handle,
+                   :creditor_invoice_number,
+                   :currency_handle,
+                   :date,
+                   :debtor_handle,
+                   :debtor_invoice_number,
+                   :department_handle,
+                   :distribution_key_handle,
+                   :due_date,
+                   :employee_handle,
+                   :end_date,
+                   :project_handle,
+                   :start_date,
+                   :text,
+                   :cash_book_entry_type,
+                   :vat_account_handle,
+                   :voucher_number
+
+    def initialize_defaults
+      self.account_handle = nil
+      self.amount = 0
+      self.amount_default_currency = 0
+      self.bank_payment_creditor_id = 0
+      self.bank_payment_creditor_invoice_id = 0
+      self.bank_payment_type_handle = nil
+      self.capitalise_handle = nil
+      self.cash_book_handle = nil
+      self.contra_account_handle = nil
+      self.contra_vat_account_handle = nil
+      self.cost_type_handle = nil
+      self.creditor_handle = nil
+      self.creditor_invoice_number = nil
+      self.currency_handle = nil
+      self.date = Time.now
+      self.debtor_handle = nil
+      self.debtor_invoice_number = nil
+      self.department_handle = nil
+      self.distribution_key_handle = nil
+      self.due_date = nil
+      self.employee_handle = nil
+      self.end_date = nil
+      self.project_handle = nil
+      self.start_date = Time.now
+      self.text = ""
+      self.cash_book_entry_type = ""
+      self.vat_account_handle = nil
+      self.voucher_number = 0
+    end
+
+    def handle
+      Handle.new(:id1 => @id1, :id2 => @id2)
+    end
+
+    def build_soap_data
+      data = ActiveSupport::OrderedHash.new
+
+      data['Handle'] = handle.to_hash
+      data['Type'] = cash_book_entry_type unless cash_book_entry_type.blank?
+      data['CashBookHandle'] = { 'Number' => cash_book_handle[:number] } unless cash_book_handle.blank?
+      data['DebtorHandle'] = { 'Number' => debtor_handle[:number] } unless debtor_handle.blank?
+      data['CreditorHandle'] = { 'Number' => creditor_handle[:number] } unless creditor_handle.blank?
+      data['AccountHandle'] = { 'Number' => account_handle[:number] } unless account_handle.blank?
+      data['ContraAccountHandle'] = { 'Number' => contra_account_handle[:number] } unless contra_account_handle.blank?
+      data['Date'] = date
+      data['VoucherNumber'] = voucher_number
+      data['Text'] = text
+      data['AmountDefaultCurrency'] = amount_default_currency
+      data['CurrencyHandle'] = { 'Code' => currency_handle[:code] } unless currency_handle.blank?
+      data['Amount'] = amount
+      data['VatAccountHandle'] = { 'Number' => vat_account_handle[:number] } unless vat_account_handle.blank?
+      data['ContraVatAccountHandle'] = { 'Number' => contra_vat_account_handle[:number] } unless contra_vat_account_handle.blank?
+      data['DebtorInvoiceNumber'] = debtor_invoice_number unless debtor_invoice_number.blank?
+      data['CreditorInvoiceNumber'] = creditor_invoice_number unless creditor_invoice_number.blank?
+      data['DueDate'] = due_date
+      data['DepartmentHandle'] = { 'Number' => department_handle[:number] } unless department_handle.blank?
+      data['DistributionKeyHandle'] = { 'Number' => distribution_key_handle[:number] } unless distribution_key_handle.blank?
+      data['ProjectHandle'] = { 'Number' => project_handle[:number] } unless project_handle.blank?
+      data['CostTypeHandle'] = { 'Number' => cost_type_handle[:number] } unless cost_type_handle.blank?
+      data['BankPaymentTypeHandle'] = { 'Number' => bank_payment_type_handle[:number] } unless bank_payment_type_handle.blank?
+      data['BankPaymentCreditorId'] = bank_payment_creditor_id
+      data['BankPaymentCreditorInvoiceId'] = bank_payment_creditor_invoice_id
+      data['CapitaliseHandle'] = { 'Number' => capitalise_handle[:number] } unless capitalise_handle.blank?
+      data['StartDate'] = start_date
+      data['EndDate'] = end_date
+      data['EmployeeHandle'] = { 'Number' => employee_handle[:number] } unless employee_handle.blank?
+
+      return data
+    end
+  end
+end

data/lib/economic/current_invoice.rb

@@ -26,12 +26,40 @@ module Economic
   #
   #   invoice.save
   class CurrentInvoice < Entity
-    has_properties :id, :debtor_handle, :debtor_name, :debtor_address, :debtor_postal_code, :debtor_city, :debtor_country, :date, :term_of_payment_handle, :due_date, :currency_handle, :exchange_rate, :is_vat_included, :layout_handle, :delivery_date, :net_amount, :vat_amount, :gross_amount, :margin, :margin_as_percent
+    has_properties :id, :debtor_handle, :debtor_name, :debtor_address, :debtor_postal_code, :debtor_city, :debtor_country, :attention_handle, :date, :term_of_payment_handle, :due_date, :currency_handle, :exchange_rate, :is_vat_included, :layout_handle, :delivery_date, :net_amount, :vat_amount, :gross_amount, :margin, :margin_as_percent, :heading
 
     def initialize(properties = {})
       super
     end
 
+    def attention
+      return nil if attention_handle.blank?
+      @attention ||= session.contacts.find(attention_handle)
+    end
+
+    def attention=(contact)
+      self.attention_handle = contact.handle
+      @attention = contact
+    end
+
+    def attention_handle=(handle)
+      @attention = nil unless handle == @attention_handle
+      @attention_handle = handle
+    end
+
+    # Books a current invoice. An invoice number greater than all other invoice numbers will be
+    # assigned to the resulting Economic::Invoice.
+    #
+    # Returns the resulting Economic::Invoice object
+    def book
+      response = session.request soap_action(:book) do
+        soap.body = { "currentInvoiceHandle" => handle.to_hash }
+      end
+
+      # Find the created Invoice
+      session.invoices.find(response[:number])
+    end
+
     def debtor
       return nil if debtor_handle.blank?
       @debtor ||= session.debtors.find(debtor_handle)
@@ -66,6 +94,7 @@ module Economic
       self.is_vat_included = nil
       self.layout_handle = nil
       self.delivery_date = nil
+      self.heading = nil
       self.net_amount = 0
       self.vat_amount = 0
       self.gross_amount = 0
@@ -85,6 +114,7 @@ module Economic
       data['DebtorPostalCode'] = debtor_postal_code unless debtor_postal_code.blank?
       data['DebtorCity'] = debtor_city unless debtor_city.blank?
       data['DebtorCountry'] = debtor_country unless debtor_country.blank?
+      data['AttentionHandle'] = { 'Id' => attention_handle[:id] } unless attention_handle.blank?
       data['Date'] = date.iso8601 unless date.blank?
       data['TermOfPaymentHandle'] = { 'Id' => term_of_payment_handle[:id] } unless term_of_payment_handle.blank?
       data['DueDate'] = (due_date.blank? ? nil : due_date.iso8601)
@@ -93,6 +123,7 @@ module Economic
       data['IsVatIncluded'] = is_vat_included
       data['LayoutHandle'] = { 'Id' => layout_handle[:id] } unless layout_handle.blank?
       data['DeliveryDate'] = delivery_date ? delivery_date.iso8601 : nil
+      data['Heading'] = heading unless heading.blank?
       data['NetAmount'] = net_amount
       data['VatAmount'] = vat_amount
       data['GrossAmount'] = gross_amount
@@ -114,4 +145,4 @@ module Economic
     end
   end
 
-end
+end

data/lib/economic/current_invoice_line.rb

@@ -68,4 +68,4 @@ module Economic
     end
   end
 
-end
+end

data/lib/economic/debtor.rb

@@ -31,11 +31,12 @@ module Economic
       Handle.new({:number => @number})
     end
 
+    # Returns the Debtors contacts
     def contacts
       @contacts ||= DebtorContactProxy.new(self)
     end
 
-    # Provides access to the current invoices - ie invoices that haven't yet been booked
+    # Provides access to the current invoices for Debtor - ie invoices that haven't yet been booked
     def current_invoices
       @current_invoices ||= CurrentInvoiceProxy.new(self)
     end

data/lib/economic/debtor_contact.rb

@@ -22,7 +22,7 @@ module Economic
 
     def debtor
       return nil if debtor_handle.blank?
-      @debtor ||= session.debtors.find(debtor_handle)
+      @debtor ||= session.debtors.find(debtor_handle[:number])
     end
 
     def debtor=(debtor)

data/lib/economic/entity/handle.rb

@@ -0,0 +1,66 @@
+class Economic::Entity
+  class Handle
+    attr_accessor :id, :id1, :id2, :number
+
+    def initialize(hash)
+      verify_sanity_of_arguments!(hash)
+      hash = prepare_hash_argument(hash) unless hash.is_a?(self.class)
+
+      @id = hash[:id].to_i if hash[:id]
+      @id1 = hash[:id1].to_i if hash[:id1]
+      @id2 = hash[:id2].to_i if hash[:id2]
+      @number = hash[:number].to_i if hash[:number]
+    end
+
+    def to_hash
+      hash = {}
+      hash['Id'] = id unless id.blank?
+      hash['Id1'] = id1 unless id1.blank?
+      hash['Id2'] = id2 unless id2.blank?
+      hash['Number'] = number unless number.blank?
+      hash
+    end
+
+    def [](key)
+      {:id => @id, :id1 => @id1, :id2 => @id2, :number => @number}[key]
+    end
+
+    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
+    end
+
+  private
+
+    # Raises exceptions if hash doesn't contain values we can use to construct a new handle
+    def verify_sanity_of_arguments!(hash)
+      return if hash.is_a?(self.class)
+
+      if hash.nil? || (!hash.respond_to?(:to_i) && (!hash.respond_to?(:keys) && !hash.respond_to?(:values)))
+        raise ArgumentError.new("Expected Number, Hash or Economic::Entity::Handle - got #{hash.inspect}")
+      end
+
+      if hash.respond_to?(:keys)
+        unknown_keys = hash.keys - [:id, :id1, :id2, :number, "Number", "Id", "Id1", "Id2"]
+        raise ArgumentError.new("Unknown keys in handle: #{unknown_keys.inspect}") unless unknown_keys.empty?
+
+        not_to_iable = hash.select { |k, v| !v.respond_to?(:to_i) }
+        raise ArgumentError.new("All values must respond to to_i. #{not_to_iable.inspect} didn't") unless not_to_iable.empty?
+      end
+    end
+
+    # Examples
+    #
+    #   prepare_hash_argument(12) #=> {:id => 12}
+    #   prepare_hash_argument(:id => 12) #=> {:id => 12}
+    #   prepare_hash_argument('Id' => 12) #=> {:id => 12}
+    #   prepare_hash_argument('Id' => 12, 'Number' => 13) #=> {:id => 12, :number => 13}
+    def prepare_hash_argument(hash)
+      hash = {:id => hash.to_i} if hash.respond_to?(:to_i) unless hash.blank?
+      hash[:id] ||= hash['Id']
+      hash[:number] ||= hash['Number']
+      hash
+    end
+  end
+end

data/lib/economic/entity.rb

@@ -1,31 +1,7 @@
+require 'economic/entity/handle'
+
 module Economic
   class Entity
-    class Handle
-      attr_accessor :id, :number
-
-      def initialize(hash)
-        @id = hash[:id]
-        @number = hash[:number]
-      end
-
-      def to_hash
-        hash = {}
-        hash['Id'] = id unless id.blank?
-        hash['Number'] = number unless number.blank?
-        hash
-      end
-
-      def [](key)
-        {:id => @id, :number => @number}[key]
-      end
-
-      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
-      end
-    end
-
     # Internal accessors
     attr_accessor :persisted, :session, :partial
 
@@ -71,6 +47,17 @@ module Economic
         class_name_without_modules = class_name.split('::').last
         "#{class_name_without_modules.snakecase}_#{action.to_s.snakecase}".intern
       end
+
+      # Returns a symbol based on the name of the entity. Used to request and read data responses.
+      #
+      #   Entity.key #=> :entity
+      #   CurrentInvoice.key #=> :current_invoice
+      def key
+        key = self.name
+        key = Economic::Support::String.demodulize(key)
+        key = Economic::Support::String.underscore(key)
+        key.intern
+      end
     end
 
     def handle
@@ -90,12 +77,12 @@ module Economic
 
     # Updates Entity with its data from the API
     def get_data
-      response = proxy.get_data(number)
+      response = proxy.get_data(handle)
       self.update_properties(response)
       self.partial = false
       self.persisted = true
     end
-
+    
     # Returns the number of Entity. This does not trigger a load from the API even if Entity is partial
     def number
       @number
@@ -106,13 +93,6 @@ module Economic
       @id
     end
 
-    def handle
-      handle = {}
-      handle[:id] = id unless id.blank?
-      handle[:number] = number unless number.blank?
-      handle
-    end
-
     # Returns true if CurrentInvoiceLine has been persisted in e-conomic
     def persisted?
       !!@persisted
@@ -141,6 +121,19 @@ module Economic
       create_or_update
     end
 
+    # 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
+
+      @persisted = false
+      @partial = true
+
+      response 
+    end
+
     # Updates properties of Entity with the values from hash
     def update_properties(hash)
       hash.each do |key, value|
@@ -169,6 +162,8 @@ module Economic
       if response
         @number = response[:number]
         @id = response[:id]
+        @id1 = response[:id1]
+        @id2 = response[:id2]
       end
 
       @persisted = true
@@ -196,6 +191,14 @@ module Economic
       self.class.soap_action(action)
     end
 
+    def class_name
+      self.class.to_s.split("::").last
+    end
+
+    def camel_back(name)
+      name[0,1].downcase + name[1..-1]
+    end
+
   end
 
-end
+end

data/lib/economic/invoice.rb

@@ -0,0 +1,58 @@
+require 'economic/entity'
+
+module Economic
+  class Invoice < Entity
+    has_properties :number, :net_amount, :vat_amount, :due_date, :debtor_handle, :debtor_name, :debtor_name, :debtor_address, :debtor_postal_code, :debtor_city, :debtor_country, :debtor_ean, :attention_handle, :heading
+
+    def attention
+      return nil if attention_handle.blank?
+      @attention ||= session.contacts.find(attention_handle)
+    end
+
+    def attention=(contact)
+      self.attention_handle = contact.handle
+      @attention = contact
+    end
+
+    def attention_handle=(handle)
+      @attention = nil unless handle == @attention_handle
+      @attention_handle = handle
+    end
+
+    def debtor
+      return nil if debtor_handle.blank?
+      @debtor ||= session.debtors.find(debtor_handle)
+    end
+
+    def debtor=(debtor)
+      self.debtor_handle = debtor.handle
+      @debtor = debtor
+    end
+
+    def debtor_handle=(handle)
+      @debtor = nil unless handle == @debtor_handle
+      @debtor_handle = handle
+    end
+
+    def remainder
+      session.request(soap_action(:get_remainder)) do
+        soap.body = { "invoiceHandle" => handle.to_hash }
+      end
+    end
+
+    # Returns the PDF version of Invoice as a String.
+    #
+    # To get it as a file you can do:
+    #
+    #   File.open("invoice.pdf", 'wb') do |file|
+    #     file << invoice.pdf
+    #   end
+    def pdf
+      response = session.request soap_action(:get_pdf) do
+        soap.body = { "invoiceHandle" => handle.to_hash }
+      end
+
+      Base64.decode64(response)
+    end
+  end
+end