rconomic 0.1.0

data/.travis.yml

@@ -0,0 +1,11 @@
+# Specify which ruby versions you wish to run your tests on, each version will be used
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - rbx
+
+# Specify the recipients for email notification
+notifications:
+  recipients:
+    - jakob@mentalized.net

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'savon_spec', '0.1.6'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rconomic (0.1.0)
+      activesupport (~> 3.0)
+      savon (= 0.9.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.9)
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    httpi (0.9.5)
+      rack
+    mocha (0.9.12)
+    nokogiri (1.5.0)
+    nori (1.0.2)
+    rack (1.3.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    savon (0.9.5)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 1.0)
+    savon_spec (0.1.6)
+      mocha (>= 0.9.8)
+      rspec (>= 2.0.0)
+      savon (>= 0.8.0)
+    wasabi (1.0.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rconomic!
+  savon_spec (= 0.1.6)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Lokalebasen.dk A/S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+r-conomic
+=========
+
+Ruby wrapper for the [e-conomic](http://www.e-conomic.co.uk) SOAP API, that aims at making working with the API bearable.
+
+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.co.uk/integration/integration-partner/]().
+
+
+Usage example
+-------------
+
+    economic = Economic::Session.new(123456, 'API', 'passw0rd')
+    economic.connect
+    
+    # Find a debtor:
+    debtor = economic.debtors.find(101)
+    
+    # Creating a debtor:
+    debtor = economic.debtors.build
+    
+    debtor.number = economic.debtors.next_available_number
+    debtor.debtor_group_handle = { :number => 1 }
+    debtor.name = 'Bob'
+    debtor.vat_zone = 'HomeCountry' # HomeCountry, EU, Abroad
+    debtor.currency_handle = { :code => 'DKK' }
+    debtor.price_group_handle = { :number => 1 }
+    debtor.is_accessible = true
+    debtor.ci_number = '12345678'
+    debtor.term_of_payment_handle = { :id => 1 }
+    debtor.layout_handle = { :id => 16 }
+    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
+    
+    invoice_line = Economic::CurrentInvoiceLine.new
+    invoice_line.description = 'Line on invoice'
+    invoice_line.unit_handle = { :number => 1 }
+    invoice_line.product_handle = { :number => 101 }
+    invoice_line.quantity = 12
+    invoice_line.unit_net_price = 19.95
+    invoice.lines << invoice_line
+    
+    invoice.save
+
+
+How to enable e-conomic API access
+----------------------------------
+
+You need to enable API access in e-conomic before you can, well, use the API. Otherwise you'll be getting access denied errors when connecting.
+
+Just follow the instructions on [e-copedia](http://wiki.e-conomic.co.uk/add-on-modules/) to enable the API Add-on module.
+
+
+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
+    -------------------+--------+------+-------
+    Debtor             | X      | X    | X
+    CurrentInvoice     | X      | X    | X
+    CurrentInvoiceLine | X      | X    | X
+
+
+Credits
+-------
+
+Sponsored by [Lokalebasen.dk](http://lokalebasen.dk)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/economic/current_invoice.rb

@@ -0,0 +1,78 @@
+require 'economic/entity'
+
+module Economic
+
+  # Current invoices are invoices that are not yet booked. They are therefore not read-only.
+  #
+  # http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICurrentInvoice.html
+  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
+
+    def initialize(properties = {})
+      super
+    end
+
+    # Returns the current invoice lines of CurrentInvoice
+    def lines
+      @lines ||= CurrentInvoiceLineProxy.new(self)
+    end
+
+    def initialize_defaults
+      self.id = 0
+      self.date = Time.now
+      self.term_of_payment_handle = nil
+      self.due_date = nil
+      self.currency_handle = nil
+      self.exchange_rate = 100 # Why am _I_ inputting this?
+      self.is_vat_included = nil
+      self.layout_handle = nil
+      self.delivery_date = nil
+      self.net_amount = 0
+      self.vat_amount = 0
+      self.gross_amount = 0
+      self.margin = 0
+      self.margin_as_percent = 0 # Why do I have to input both Margin and MarginAsPercent? Shouldn't powerful Windows machines running ASP.NET be able to compute this?
+    end
+
+    # Returns OrderedHash 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['Id'] = id
+      data['DebtorHandle'] = { 'Number' => debtor_handle[:number] } unless debtor_handle.blank?
+      data['DebtorName'] = debtor_name
+      data['DebtorAddress'] = debtor_address unless debtor_address.blank?
+      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['Date'] = date.iso8601 unless date.blank?
+      data['TermOfPaymentHandle'] = { 'Id' => term_of_payment_handle[:id] } unless term_of_payment_handle.blank?
+      data['DueDate'] = due_date.iso8601 unless due_date.blank?
+      data['CurrencyHandle'] = { 'Code' => currency_handle[:code] } unless currency_handle.blank?
+      data['ExchangeRate'] = exchange_rate
+      data['IsVatIncluded'] = is_vat_included
+      data['LayoutHandle'] = { 'Id' => layout_handle[:id] } unless layout_handle.blank?
+      data['DeliveryDate'] = delivery_date ? delivery_date.iso8601 : nil
+      data['NetAmount'] = net_amount
+      data['VatAmount'] = vat_amount
+      data['GrossAmount'] = gross_amount
+      data['Margin'] = margin
+      data['MarginAsPercent'] = margin_as_percent
+
+      return data
+    end
+
+    def save
+      result = super
+      id = result[:id]
+
+      self.lines.each do |invoice_line|
+        invoice_line.session = session
+        invoice_line.invoice_handle = { :id => id }
+        invoice_line.save
+      end
+    end
+  end
+
+end

data/lib/economic/current_invoice_line.rb

@@ -0,0 +1,47 @@
+require 'economic/entity'
+require 'economic/current_invoice'
+
+module Economic
+
+  class CurrentInvoiceLine < Entity
+    has_properties :invoice_handle, :description, :delivery_date, :unit_handle, :product_handle, :quantity, :unit_net_price, :discount_as_percent, :unit_cost_price, :total_net_amount, :total_margin, :margin_as_percent
+
+    def initialize_defaults
+      self.invoice_handle = nil
+      self.description = nil
+      self.delivery_date = nil
+      self.unit_handle = nil
+      self.product_handle = nil
+      self.quantity = nil
+      self.unit_net_price = nil
+      self.discount_as_percent = 0
+      self.unit_cost_price = 0
+      self.total_net_amount = nil
+      self.total_margin = 0
+      self.margin_as_percent = 0
+    end
+
+    # Returns OrderedHash 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['Number'] = 0 # Doesn't seem to be used
+      data['InvoiceHandle'] = { 'Id' => invoice_handle[:id] } unless invoice_handle.blank?
+      data['Description'] = description unless description.blank?
+      data['DeliveryDate'] = delivery_date
+      data['UnitHandle'] = { 'Number' => unit_handle[:number] } unless unit_handle.blank?
+      data['ProductHandle'] = { 'Number' => product_handle[:number] } unless product_handle.blank?
+      data['Quantity'] = quantity unless quantity.blank?
+      data['UnitNetPrice'] = unit_net_price unless unit_net_price.blank?
+      data['DiscountAsPercent'] = discount_as_percent unless discount_as_percent.blank?
+      data['UnitCostPrice'] = unit_cost_price unless unit_cost_price.blank?
+      data['TotalNetAmount'] = total_net_amount
+      data['TotalMargin'] = total_margin unless total_margin.blank?
+      data['MarginAsPercent'] = margin_as_percent unless margin_as_percent.blank?
+
+      return data
+    end
+  end
+
+end

data/lib/economic/debtor.rb

@@ -0,0 +1,51 @@
+require 'economic/entity'
+
+module Economic
+
+  class Debtor < Entity
+    has_properties :handle, :number, :debtor_group_handle, :name, :vat_zone, :currency_handle, :price_group_handle, :is_accessible, :ean, :public_entry_number, :email, :telephone_and_fax_number, :website, :address, :postal_code, :city, :country, :credit_maximum, :vat_number, :county, :ci_number, :term_of_payment_handle, :layout_handle, :attention_handle, :your_reference_handle, :our_reference_handle, :balance
+
+    # Provides access to the current invoices - ie invoices that haven't yet been booked
+    def current_invoices
+      @current_invoices ||= CurrentInvoiceProxy.new(self)
+    end
+
+    protected
+
+    def build_soap_data
+      data = ActiveSupport::OrderedHash.new
+
+      data['Handle'] = { 'Number' => number }
+      data['Number'] = number
+      data['DebtorGroupHandle'] = { 'Number' => debtor_group_handle[:number] } unless debtor_group_handle.blank?
+      data['Name'] = name
+      data['VatZone'] = vat_zone
+      data['CurrencyHandle'] = { 'Code' => currency_handle[:code] } unless currency_handle.blank?
+      data['PriceGroupHandle'] = { 'Number' => price_group_handle[:number] } unless price_group_handle.blank?
+      data['IsAccessible'] = is_accessible
+      data['Ean'] = ean unless ean.blank?
+      data['PublicEntryNumber'] = public_entry_number unless public_entry_number.blank?
+      data['Email'] = email unless email.blank?
+      data['TelephoneAndFaxNumber'] = telephone_and_fax_number unless telephone_and_fax_number.blank?
+      data['Website'] = website unless website.blank?
+      data['Address'] = address unless address.blank?
+      data['PostalCode'] = postal_code unless postal_code.blank?
+      data['City'] = city unless city.blank?
+      data['Country'] = country unless country.blank?
+      data['CreditMaximum'] = credit_maximum unless credit_maximum.blank?
+      data['VatNumber'] = vat_number unless vat_number.blank?
+      data['County'] = county unless county.blank?
+      data['CINumber'] = ci_number unless ci_number.blank?
+      data['TermOfPaymentHandle'] = { 'Id' => term_of_payment_handle[:id] } unless term_of_payment_handle.blank?
+      data['LayoutHandle'] = { 'Id' => layout_handle[:id] } unless layout_handle.blank?
+      data['AttentionHandle'] = attention_handle unless attention_handle.blank?
+      data['YourReferenceHandle'] = your_reference_handle unless your_reference_handle.blank?
+      data['OurReferenceHandle'] = our_reference_handle unless our_reference_handle.blank?
+      data['Balance'] = balance unless balance.blank?
+
+      return data
+    end
+
+  end
+
+end