rconomic 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88080f5222fecd57d855c891b03926bd416340e2
-  data.tar.gz: aa89d4fde45914d91730bcff8f26ac867db0852a
+  metadata.gz: fa5df738699c252506f1f3acf8370d0e265687a6
+  data.tar.gz: c780fb9db1d1fbaf997f20c8a58eb35739be1c41
 SHA512:
-  metadata.gz: 223fce8862fd04d5a4540fef0d5c087b77169a8e47c114f3b7db701bab9bf87391587f2ce1bdaa5caa9503dbbea7047462b7783d2f9b4ed6368d6d0475aae704
-  data.tar.gz: fb814fb6c65aa4cf5a2decc5d0faa88d5a9216dc83a81e121d253454665351cfb9dc694e2e3d86a7a5449cf964d8293b7d8959b0fb8fa9fa300f705eb80da067
+  metadata.gz: e13a3d7745b0e2133bca3bb7effc1af8d1dd9df0886bd41d1b4b8f9fb58eccb26fce658cfe1737562775e591f96279f6cd78384d2ef14f15b9f821c3dce21e83
+  data.tar.gz: e52198ad2f4475c71e0034a509ca8d277d4c2915beea248bdf00cac9e4dfd85b20a8609028b47270518607338430486cf8cd68c6c8d11f85a9752d01e16c822c

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'db/schema.rb'
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/FileName:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -1,10 +1,21 @@
 # Specify which ruby versions you wish to run your tests on, each version will be used
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - jruby
+  - 2.1.8
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.7.0
 
 # Specify the recipients for email notification
 notifications:
   recipients:
     - jakob@mentalized.net
+
+addons:
+  code_climate:
+    repo_token: 6746eb72f5d9759f7d83ea90e8f49e3f01480d3b8f6334eea9e7cd9991c41ea4
+
+matrix:
+  include:
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.ruby-2.0

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.6.0 [April 30, 2017]
+
+### Added
+
+* Support for getting all contacts for a given debtor (@nielsbuus)
+* Basic implementation of products (@traels)
+* Ability to create CreditorInvoice entries (@prognostikos)
+* Properties for "past due" status of invoices (@skelboe)
+* Support to get company data (@adriacidre)
+* Support X-EconomicAppIdentifier (@prognostikos)
+* Fixed an issue where X-EconomicAppIdentifier wasn't set properly (@olepalm)
+
+### Changes
+
+* The source code has a new home at https://github.com/substancelab/rconomic
+* Non-existing methods removed from the documentation (@koppen)
+* Handle Numbers can now be String as well as numbers (@traels)
+* Fixed authentication when using legacy Connect (@koppen)
+
+### Removed
+
+* We no longer officially support Ruby 1.9.3. rconomic might still work on
+  legacy rubies, but we aren't testing it.

data/Gemfile

@@ -3,13 +3,14 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'coveralls', :require => false
-  gem 'rake'
+  gem "codeclimate-test-reporter", :require => false
+  gem "rake"
+  gem "simplecov", :require => false
 end
 
 # Not required to develop rconomic, but useful. See file
 # mappings in Guardfile
 group :guard do
-  gem 'guard'
-  gem 'guard-rspec'
+  gem "guard"
+  gem "guard-rspec"
 end

data/Guardfile

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

data/README.md

@@ -5,14 +5,17 @@ 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/](http://www.e-conomic.co.uk/about/). More details about their API at [http://www.e-conomic.com/developer](http://www.e-conomic.com/developer).
 
-[![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)
+[![Build Status](https://travis-ci.org/substancelab/rconomic.svg?branch=master)](https://travis-ci.org/substancelab/rconomic) [![Test Coverage](https://codeclimate.com/github/substancelab/rconomic/badges/coverage.svg)](https://codeclimate.com/github/substancelab/rconomic/coverage) [![Code Climate](https://codeclimate.com/github/substancelab/rconomic/badges/gpa.svg)](https://codeclimate.com/github/substancelab/rconomic)
 
 
 Usage example
 -------------
 
     economic = Economic::Session.new
-    economic.connect_with_credentials(123456, 'API', 'passw0rd')
+
+    # After 16 November 2015, you must supply an 'Application ID' with #connect_with_credentials
+    # As described here: http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
+    economic.connect_with_credentials(123456, 'API', 'passw0rd', 'my awesome integration v1.0.0')
 
     # Or connect using a Private app ID and an access ID provided by the "Grant Access"
     # As described here: http://www.e-conomic.com/developer/tutorials
@@ -20,7 +23,7 @@ Usage example
     economic.connect_with_token 'the_private_app_id', 'the_access_id_you_got_from_the_grant'
 
     # Find a debtor:
-    debtor = economic.debtors.find(101)
+    debtor = economic.debtors.find(:id => 101)
 
     # Creating a debtor:
     debtor = economic.debtors.build
@@ -75,6 +78,20 @@ Usage example
 
     cash_book.book
 
+    # Find a product:
+    product = economic.products.find(1234)
+
+    # Creating a product:
+    product = economic.products.build
+    product.number = 'ESC2014-LED-DISPLAY'
+    product.product_group_handle = { :number => 1 }
+    product.name = '100 meter LED display'
+    product.sales_price = 999999
+    product.cost_price = 100000
+    product.recommended_price = 999999
+    product.is_accessible = true
+    product.volume = 1
+    product.save
 
 How to enable e-conomic API access
 ----------------------------------
@@ -93,7 +110,9 @@ 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
+    Company            | X      | X    | X      | X
     Creditor           | X      | X    | X      | X
+    CreditorEntry      | X      | X    |        |
     CreditorContact    | X      | X    | X      | X
     CreditorEntry      | X      | X    | X      | X
     CurrentInvoice     | X      | X    | X      | X
@@ -103,7 +122,7 @@ Not even remotely... For now, limited to a small subset of all the [available op
     DebtorEntry        | X      | X    | X      | X
     Entry              | X      | X    | X      | X
     Invoice            | X      | X    |        |
-
+    Product            | X      | X    | X      | X
 
 Credits
 -------

data/Rakefile

@@ -1,13 +1,13 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require 'rconomic' # You know what to do.
+  require "irb"
+  require "irb/completion"
+  require "rconomic" # You know what to do.
   ARGV.clear
   IRB.start
 end

data/gemfiles/Gemfile.ruby-2.0

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "nokogiri", "< 1.7"
+gem "rack", "< 2.0"
+
+gemspec :path => "../"
+
+group :test do
+  gem "codeclimate-test-reporter", :require => false
+  gem "rake"
+  gem "simplecov", :require => false
+end

data/lib/economic/account.rb

@@ -1,18 +1,18 @@
-require 'economic/entity'
+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.build({:name => @name})
+      Handle.build(:name => @name)
     end
 
     protected
 
     def fields
       [
-        ["Handle", :handle, Proc.new { |handle| handle.to_hash }, :required],
+        ["Handle", :handle, proc { |handle| handle.to_hash }, :required],
         ["Name", :name, nil, :required],
         ["Number", :number, nil, :required]
       ]

data/lib/economic/cash_book.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+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
@@ -9,7 +8,7 @@ module Economic
     has_properties :name, :number
 
     def handle
-      @handle || Handle.new({:number => @number})
+      @handle || Handle.new(:number => @number)
     end
 
     def entries
@@ -18,9 +17,7 @@ module Economic
 
     # Books all entries in the cashbook. Returns book result.
     def book
-      response = request(:book, {
-        "cashBookHandle" => handle.to_hash
-      })
+      response = request(:book, "cashBookHandle" => handle.to_hash)
       response[:number].to_i
     end
 
@@ -28,7 +25,7 @@ module Economic
 
     def fields
       [
-        ["Handle", :handle, Proc.new { |h| h.to_hash }, :required],
+        ["Handle", :handle, proc { |h| h.to_hash }, :required],
         ["Name", :name, nil, :required],
         ["Number", :number, nil, :required]
       ]

data/lib/economic/cash_book_entry.rb

@@ -1,4 +1,4 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
   # Represents a cash book in E-conomic.
@@ -37,33 +37,12 @@ module Economic
       :voucher_number
 
     defaults(
-      :account_handle => nil,
       :amount => 0,
       :amount_default_currency => 0,
-      :bank_payment_creditor_id => nil,
-      :bank_payment_creditor_invoice_id => nil,
-      :bank_payment_type_handle => nil,
-      :capitalise_handle => nil,
-      :cash_book_handle => nil,
-      :contra_account_handle => nil,
-      :contra_vat_account_handle => nil,
-      :cost_type_handle => nil,
-      :creditor_handle => nil,
-      :creditor_invoice_number => nil,
-      :currency_handle => nil,
       :date => Time.now,
-      :debtor_handle => nil,
-      :debtor_invoice_number => nil,
-      :department_handle => nil,
-      :distribution_key_handle => nil,
-      :due_date => nil,
-      :employee_handle => nil,
-      :end_date => nil,
-      :project_handle => nil,
       :start_date => Time.now,
       :text => "",
       :type => "",
-      :vat_account_handle => nil,
       :voucher_number => 0
     )
 
@@ -74,14 +53,15 @@ module Economic
     protected
 
     def fields
-      to_hash = Proc.new { |handle| handle.to_hash }
+      to_hash = proc { |handle| handle.to_hash }
       [
-        ["Handle", :handle, Proc.new { |v| v.to_hash }],
+        ["Handle", :handle, proc { |v| v.to_hash }],
         ["Id1", :id1],
         ["Id2", :id2],
         ["Type", :type],
         ["CashBookHandle", :cash_book_handle, to_hash],
         ["DebtorHandle", :debtor_handle, to_hash],
+        ["CreditorHandle", :creditor_handle, to_hash],
         ["AccountHandle", :account_handle, to_hash],
         ["ContraAccountHandle", :contra_account_handle, to_hash],
         ["Date", :date, nil, :required],

data/lib/economic/company.rb

@@ -0,0 +1,61 @@
+require "economic/entity"
+
+module Economic
+  # Represents a creditor in E-conomic.
+  #
+  # API documentation: https://api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=Company_GetData
+  #
+  # Examples
+  #
+  #   # Get company:
+  #   creditor = economic.company.get
+  #
+  class Company < Entity
+    has_properties :number,
+      :base_currency_handle,
+      :name,
+      :address_1,
+      :address_2,
+      :postal_code,
+      :city,
+      :country,
+      :telephone_number,
+      :fax_number,
+      :mobile_number,
+      :contact,
+      :website,
+      :email,
+      :c_i_number,
+      :vat_number,
+      :sign_up_date
+    def handle
+      @handle || Handle.build(:number => @number)
+    end
+
+    protected
+
+    def fields
+      to_hash = proc { |h| h.to_hash }
+      [
+        ["Handle", :handle, to_hash, :required],
+        ["Number", :number, nil, :required],
+        ["BaseCurrencyHandle", :base_currency_handle, to_hash],
+        ["Name", :name],
+        ["Address1", :address_1],
+        ["Address2", :address_2],
+        ["PostalCode", :postal_code],
+        ["City", :city],
+        ["Country", :country],
+        ["TelephoneNumber", :telephone_number],
+        ["FaxNumber", :fax_number],
+        ["MobileNumber", :mobile_number],
+        ["Contact", :contact],
+        ["WebSite", :website],
+        ["Email", :email],
+        ["CINumber", :c_i_number],
+        ["VatNumber", :vat_number],
+        ["SignUpDate", :sign_up_date]
+      ]
+    end
+  end
+end

data/lib/economic/creditor.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a creditor in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditor.html
@@ -13,7 +12,7 @@ module Economic
   #
   #   # Creating a creditor:
   #   creditor = economic.creditors.build
-  #   creditor.number = economic.creditors.next_available_number
+  #   creditor.number = 42
   #   creditor.creditor_group_handle = { :number => 1 }
   #   creditor.name = 'Apple Inc'
   #   creditor.vat_zone = 'HomeCountry' # HomeCountry, EU, Abroad
@@ -25,7 +24,7 @@ module Economic
     has_properties :number, :creditor_group_handle, :name, :vat_zone, :currency_handle, :term_of_payment_handle, :is_accessible, :ci_number, :email, :address, :postal_code, :city, :country, :bank_account, :attention_handle, :your_reference_handle, :our_reference_handle, :default_payment_type_handle, :default_payment_creditor_id, :county, :auto_contra_account_handle
 
     def handle
-      @handle || Handle.build({:number => @number})
+      @handle || Handle.build(:number => @number)
     end
 
     # Returns the Creditors contacts
@@ -36,7 +35,7 @@ module Economic
     protected
 
     def fields
-      to_hash = Proc.new { |h| h.to_hash }
+      to_hash = proc { |h| h.to_hash }
       [
         ["Handle", :handle, to_hash, :required],
         ["Number", :number, nil, :required],

data/lib/economic/creditor_contact.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a creditor contact.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditorContact.html
@@ -36,20 +35,20 @@ module Economic
     end
 
     def handle
-      @handle || Handle.build({:id => @id})
+      @handle || Handle.build(:id => @id)
     end
 
     protected
 
     def fields
-      to_hash = Proc.new { |handle| handle.to_hash }
+      to_hash = proc { |handle| handle.to_hash }
       # SOAP field, entity method, formatter proc, required?
       [
-        ["Handle", :handle, Proc.new { |v| v.to_hash }, :required],
+        ["Handle", :handle, proc { |v| v.to_hash }, :required],
         ["Id", :id, nil],
         ["CreditorHandle", :creditor_handle, to_hash],
         ["Name", :name],
-        ["Number", :handle, Proc.new { |v| v.number }, :required],
+        ["Number", :handle, proc { |v| v.number }, :required],
         ["TelephoneNumber", :telephone_number],
         ["Email", :email],
         ["Comments", :comments],

data/lib/economic/creditor_entry.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a creditor entry in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditorEntry.html
@@ -21,5 +20,4 @@ module Economic
       :type,
       :voucher_number
   end
-
 end

data/lib/economic/current_invoice.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # CurrentInvoices are invoices that are not yet booked. They are therefore not
   # read-only.
   #
@@ -55,19 +54,12 @@ module Economic
     defaults(
       :id => 0,
       :date => Time.now,
-      :term_of_payment_handle => nil,
-      :due_date => nil,
-      :currency_handle => nil,
-      :exchange_rate => 100, # Why am _I_ inputting this?
-      :is_vat_included => nil,
-      :layout_handle => nil,
-      :delivery_date => nil,
-      :heading => nil,
+      :exchange_rate => 100,
       :net_amount => 0,
       :vat_amount => 0,
       :gross_amount => 0,
       :margin => 0,
-      :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?
+      :margin_as_percent => 0
     )
 
     def initialize(properties = {})
@@ -94,9 +86,7 @@ module Economic
     #
     # Returns the resulting Economic::Invoice object
     def book
-      response = request(:book, {
-        "currentInvoiceHandle" => handle.to_hash
-      })
+      response = request(:book, "currentInvoiceHandle" => handle.to_hash)
 
       # Find the created Invoice
       session.invoices.find(response[:number])
@@ -107,10 +97,11 @@ module Economic
     #
     # Returns the resulting Economic::Invoice object
     def book_with_number(number)
-      response = request(:book_with_number, {
+      response = request(
+        :book_with_number,
         "currentInvoiceHandle" => handle.to_hash,
         "number" => number
-      })
+      )
 
       # Find the created Invoice
       session.invoices.find(response[:number])
@@ -155,11 +146,13 @@ module Economic
     protected
 
     def fields
-      date_formatter = Proc.new { |date| date.respond_to?(:iso8601) ? date.iso8601 : nil }
-      to_hash = Proc.new { |handle| handle.to_hash }
+      date_formatter = proc { |date|
+        date.respond_to?(:iso8601) ? date.iso8601 : nil
+      }
+      to_hash = proc { |handle| handle.to_hash }
       [
         ["Id", :id, nil, :required],
-        ["DebtorHandle", :debtor, Proc.new { |d| d.handle.to_hash }],
+        ["DebtorHandle", :debtor, proc { |d| d.handle.to_hash }],
         ["DebtorName", :debtor_name, nil, :required],
         ["DebtorAddress", :debtor_address],
         ["DebtorPostalCode", :debtor_postal_code],
@@ -175,8 +168,8 @@ module Economic
         ["LayoutHandle", :layout_handle, to_hash],
         ["DeliveryDate", :delivery_date, date_formatter, :required],
         ["Heading", :heading],
-        ['TextLine1', :text_line1],
-        ['TextLine2', :text_line2],
+        ["TextLine1", :text_line1],
+        ["TextLine2", :text_line2],
         ["NetAmount", :net_amount, nil, :required],
         ["VatAmount", :vat_amount, nil, :required],
         ["GrossAmount", :gross_amount, nil, :required],

data/lib/economic/current_invoice_line.rb

@@ -1,8 +1,7 @@
-require 'economic/entity'
-require 'economic/current_invoice'
+require "economic/entity"
+require "economic/current_invoice"
 
 module Economic
-
   # Represents a current invoice line.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICurrentInvoiceLine.html
@@ -24,16 +23,8 @@ module Economic
       :margin_as_percent
 
     defaults(
-      :invoice_handle => nil,
-      :description => nil,
-      :delivery_date => nil,
-      :unit_handle => nil,
-      :product_handle => nil,
-      :quantity => nil,
-      :unit_net_price => nil,
       :discount_as_percent => 0,
       :unit_cost_price => 0,
-      :total_net_amount => nil,
       :total_margin => 0,
       :margin_as_percent => 0
     )
@@ -60,9 +51,9 @@ module Economic
     protected
 
     def fields
-      to_hash = Proc.new { |h| h.to_hash }
+      to_hash = proc { |h| h.to_hash }
       [
-        ["Number", :number, Proc.new { 0 }, :required], # Doesn't seem to be used
+        ["Number", :number, proc { 0 }, :required], # Doesn't seem to be used
         ["InvoiceHandle", :invoice_handle, to_hash],
         ["Description", :description],
         ["DeliveryDate", :delivery_date, nil, :required],