rconomic 0.5.2 → 0.6.0

data/lib/economic/proxies/entry_proxy.rb

@@ -1,12 +1,10 @@
-require 'economic/proxies/entity_proxy'
+require "economic/proxies/entity_proxy"
 
 module Economic
   class EntryProxy < EntityProxy
     def find_by_date_interval(from_date, to_date)
-      response = request('FindByDateInterval', {
-        'fromDate' => from_date,
-        'toDate'   => to_date
-      })
+      response = request("FindByDateInterval", "fromDate" => from_date,
+                                               "toDate" => to_date)
 
       build_array(response)
     end
@@ -17,25 +15,21 @@ module Economic
     #   max_number = 2**31 - 1  # Maximum int32.
     #
     def find_by_serial_number_interval(min_number, max_number)
-      response = request('FindBySerialNumberInterval', {
-        'minNumber' => min_number,
-        'maxNumber' => max_number
-      })
+      response = request("FindBySerialNumberInterval", "minNumber" => min_number,
+                                                       "maxNumber" => max_number)
 
       build_array(response)
     end
 
     def get_last_used_serial_number
-      response = request('GetLastUsedSerialNumber')
+      response = request("GetLastUsedSerialNumber")
       response.to_i
     end
 
     def find(serial_number)
-      response = request('GetData', {
-        'entityHandle' => {
-          'SerialNumber' => serial_number
-         }
-      })
+      response = request("GetData", "entityHandle" => {
+                           "SerialNumber" => serial_number
+                         })
 
       build(response)
     end
@@ -47,7 +41,7 @@ module Economic
       #   [{:serial_number=>"1"}, {:serial_number=>"2"}]  # Many results.
       #   {:serial_number=>"1"}                           # One result.
       #   nil                                             # No results.
-      entry_handles = [ response[:entry_handle] ].flatten.compact
+      entry_handles = [response[:entry_handle]].flatten.compact
 
       entry_handles.map do |entry_handle|
         entry_handle[:serial_number].to_i

data/lib/economic/proxies/invoice_proxy.rb

@@ -1,6 +1,6 @@
-require 'economic/proxies/entity_proxy'
-require 'economic/proxies/actions/find_by_date_interval'
-require 'economic/proxies/actions/find_by_handle_with_number'
+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

data/lib/economic/proxies/order_proxy.rb

@@ -1,6 +1,6 @@
-require 'economic/proxies/entity_proxy'
-require 'economic/proxies/actions/find_by_date_interval'
-require 'economic/proxies/actions/find_by_handle_with_number'
+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 OrderProxy < EntityProxy

data/lib/economic/proxies/product_proxy.rb

@@ -0,0 +1,11 @@
+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 ProductProxy < EntityProxy
+    include FindByHandleWithNumber
+    include FindByNumber
+  end
+end

data/lib/economic/session.rb

@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module Economic
   # The Economic::Session contains details and behaviors for a current
@@ -8,45 +8,62 @@ module Economic
 
     def_delegators :endpoint, :logger=, :log_level=, :log=
 
-    attr_accessor :agreement_number, :user_name, :password
-    attr_reader :authentication_token
+    attr_accessor :agreement_number, :user_name, :password, :app_identifier
+    attr_reader :authentication_cookies
 
-    def initialize(agreement_number = nil, user_name = nil, password = nil)
+    def initialize(agreement_number = nil, user_name = nil, password = nil, app_identifier = nil)
       self.agreement_number = agreement_number
       self.user_name = user_name
       self.password = password
+      self.app_identifier = app_identifier
       yield endpoint if block_given?
     end
 
+    # Connect/authenticate with an API token and app id
+    #
+    # Reference: http://techtalk.e-conomic.com/why-were-implementing-a-new-api-connection-model/
+    #
+    # ==== Attributes
+    #
+    # * +private_app_id+ - The App ID created in your developer agreement
+    # * +access_id+ - The Access ID or token for your App ID
+    #
     def connect_with_token(private_app_id, access_id)
       endpoint.call(
         :connect_with_token,
-        {
-          :token => access_id,
-          :appToken => private_app_id
-        }
+        :token => access_id,
+        :appToken => private_app_id
       ) do |response|
-        store_authentication_token(response)
+        store_authentication_cookies(response)
       end
     end
 
-    def connect_with_credentials(agreement_number, user_name, password)
+    # Connect/authenticate with credentials
+    #
+    # ==== Attributes
+    #
+    # * +agreement_number+ - your economic agreement number
+    # * +user_name+ - your username
+    # * +password+ - your passsword
+    # * +app_identifier+ - A string identifiying your application, as described in http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
+    #
+    def connect_with_credentials(agreement_number, user_name, password, app_identifier = nil)
+      self.app_identifier = app_identifier if app_identifier
+
       endpoint.call(
         :connect,
-        {
-          :agreementNumber => agreement_number,
-          :userName => user_name,
-          :password => password
-        }
+        :agreementNumber => agreement_number,
+        :userName => user_name,
+        :password => password
       ) do |response|
-        store_authentication_token(response)
+        store_authentication_cookies(response)
       end
     end
 
     # Authenticates with E-conomic using credentials
     # Assumes ::new was called with credentials as arguments.
     def connect
-      connect_with_credentials(self.agreement_number, self.user_name, self.password)
+      connect_with_credentials(agreement_number, user_name, password, app_identifier)
     end
 
     # Provides access to the DebtorContacts
@@ -104,9 +121,18 @@ module Economic
       @entries ||= EntryProxy.new(self)
     end
 
+    # Provides access to products
+    def products
+      @products ||= ProductProxy.new(self)
+    end
+
+    def company
+      @company ||= CompanyProxy.new(self)
+    end
+
     # Requests an action from the API endpoint
     def request(soap_action, data = nil)
-      endpoint.call(soap_action, data, authentication_token)
+      endpoint.call(soap_action, data, authentication_cookies)
     end
 
     # Returns self - used by proxies to access the session of their owner
@@ -116,13 +142,14 @@ module Economic
 
     # Returns the SOAP endpoint to connect to
     def endpoint
-      @endpoint ||= Economic::Endpoint.new
+      @endpoint ||= Economic::Endpoint.new(app_identifier)
     end
 
     private
 
-    def store_authentication_token(response)
-      @authentication_token = response.http.cookies
+    def store_authentication_cookies(response)
+      cookies = response.http.cookies
+      @authentication_cookies = cookies
     end
   end
 end

data/lib/economic/support/string.rb

@@ -2,18 +2,18 @@ module Economic
   module Support
     module String
       def self.camel_back(name)
-        name[0,1].downcase + name[1..-1]
+        name[0, 1].downcase + name[1..-1]
       end
 
       def self.demodulize(class_name_in_module)
-        class_name_in_module.to_s.gsub(/^.*::/, '')
+        class_name_in_module.to_s.gsub(/^.*::/, "")
       end
 
       def self.underscore(camel_cased_word)
         word = camel_cased_word.to_s.dup
-        word.gsub!(/::/, '/')
-        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.gsub!(/::/, "/")
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
         word.tr!("-", "_")
         word.downcase!
         word

data/lib/rconomic/version.rb

@@ -1,3 +1,3 @@
 module Rconomic
-  VERSION = "0.5.2"
+  VERSION = "0.6.0".freeze
 end

data/lib/rconomic.rb

@@ -1,41 +1,47 @@
 # Dependencies
-require 'time'
-require 'savon'
+require "time"
+require "savon"
+require "savon_ext/request"
 
-require 'economic/support/string'
-require 'economic/session'
+require "economic/support/string"
+require "economic/session"
 
-require 'economic/debtor'
-require 'economic/debtor_contact'
-require 'economic/creditor'
-require 'economic/creditor_contact'
-require 'economic/current_invoice'
-require 'economic/current_invoice_line'
-require 'economic/invoice'
-require 'economic/order'
-require 'economic/cash_book'
-require 'economic/cash_book_entry'
-require 'economic/account'
-require 'economic/debtor_entry'
-require 'economic/creditor_entry'
-require 'economic/entry'
+require "economic/debtor"
+require "economic/debtor_contact"
+require "economic/creditor"
+require "economic/creditor_contact"
+require "economic/current_invoice"
+require "economic/current_invoice_line"
+require "economic/invoice"
+require "economic/order"
+require "economic/cash_book"
+require "economic/cash_book_entry"
+require "economic/account"
+require "economic/debtor_entry"
+require "economic/creditor_entry"
+require "economic/entry"
+require "economic/product"
+require "economic/company"
 
-require 'economic/proxies/current_invoice_proxy'
-require 'economic/proxies/current_invoice_line_proxy'
-require 'economic/proxies/debtor_proxy'
-require 'economic/proxies/debtor_contact_proxy'
-require 'economic/proxies/creditor_proxy'
-require 'economic/proxies/creditor_contact_proxy'
-require 'economic/proxies/invoice_proxy'
-require 'economic/proxies/order_proxy'
-require 'economic/proxies/cash_book_proxy'
-require 'economic/proxies/cash_book_entry_proxy'
-require 'economic/proxies/account_proxy'
-require 'economic/proxies/debtor_entry_proxy'
-require 'economic/proxies/creditor_entry_proxy'
-require 'economic/proxies/entry_proxy'
+require "economic/proxies/current_invoice_proxy"
+require "economic/proxies/current_invoice_line_proxy"
+require "economic/proxies/debtor_proxy"
+require "economic/proxies/debtor_contact_proxy"
+require "economic/proxies/creditor_proxy"
+require "economic/proxies/creditor_contact_proxy"
+require "economic/proxies/invoice_proxy"
+require "economic/proxies/order_proxy"
+require "economic/proxies/cash_book_proxy"
+require "economic/proxies/cash_book_entry_proxy"
+require "economic/proxies/account_proxy"
+require "economic/proxies/debtor_entry_proxy"
+require "economic/proxies/creditor_entry_proxy"
+require "economic/proxies/entry_proxy"
+require "economic/proxies/product_proxy"
+require "economic/proxies/company_proxy"
 
-require 'economic/proxies/actions/find_by_name'
+require "economic/proxies/actions/debtor_contact/all"
+require "economic/proxies/actions/find_by_name"
 
 # http://www.e-conomic.com/apidocs/Documentation/index.html
 # https://www.e-conomic.com/secure/api1/EconomicWebService.asmx
@@ -46,4 +52,3 @@ require 'economic/proxies/actions/find_by_name'
 
 module Economic
 end
-

data/lib/savon_ext/request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Savon
+  class SOAPRequest < HTTPRequest
+    def build(options = {})
+      configure_proxy
+      configure_timeouts
+      configure_headers options[:soap_action]
+      configure_cookies options[:cookies]
+      configure_ssl
+      configure_auth
+      configure_redirect_handling
+
+      @http_request
+    end
+  end
+end

data/rconomic.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require 'rconomic/version'
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "rconomic/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'rconomic'
+  s.name        = "rconomic"
   s.summary     = "Wrapper for e-conomic.dk's SOAP API."
   s.description = <<-EOS
                   Ruby wrapper for the e-conomic SOAP API, that aims at making working with the API bearable.
@@ -11,15 +11,16 @@ Gem::Specification.new do |s|
                   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/.
                   EOS
   s.authors     = ["Jakob Skjerning"]
-  s.email       = 'jakob@mentalized.net'
-  s.homepage    = 'https://github.com/lokalebasen/rconomic'
-  s.license     = 'MIT'
+  s.email       = "jakob@mentalized.net"
+  s.homepage    = "https://github.com/substancelab/rconomic"
+  s.license     = "MIT"
   s.version     = Rconomic::VERSION
   s.platform    = Gem::Platform::RUBY
 
   s.add_runtime_dependency "savon", "~> 2.2"
+  s.add_development_dependency "rspec", "> 3.0"
 
-  s.files         = `git ls-files`.split("\n").reject { |filename| ['.gitignore'].include?(filename) }
+  s.files         = `git ls-files`.split("\n").reject { |filename| [".gitignore"].include?(filename) }
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = ["lib"]
 end

data/spec/economic/account_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::Account do
   let(:session) { make_session }
@@ -9,8 +9,8 @@ describe Economic::Account do
   end
 
   describe "#save" do
-    it 'should save it' do
-      stub_request('Account_CreateFromData', nil, :success)
+    it "should save it" do
+      stub_request("Account_CreateFromData", nil, :success)
       subject.save
     end
 

data/spec/economic/cash_book_entry_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::CashBookEntry do
   let(:session) { make_session }
@@ -19,8 +19,8 @@ describe Economic::CashBookEntry do
   end
 
   describe "#save" do
-    it 'should save it' do
-      stub_request('CashBookEntry_CreateFromData', nil, :success)
+    it "should save it" do
+      stub_request("CashBookEntry_CreateFromData", nil, :success)
       subject.save
     end
 
@@ -46,5 +46,28 @@ describe Economic::CashBookEntry do
       )
       subject.save
     end
+
+    it "can build a CashBookEntry with a CreditorHandle" do
+      time = Time.now
+      subject.date = subject.start_date = time
+      subject.creditor_handle = Economic::Entity::Handle.new(:number => 12)
+      mock_request(
+        :cash_book_entry_create_from_data, {
+          "data" => {
+            "CreditorHandle" => {"Number" => 12},
+            "Date" => time,
+            "VoucherNumber" => 0,
+            "Text" => "",
+            "AmountDefaultCurrency" => 0,
+            "Amount" => 0,
+            "DueDate" => nil,
+            "StartDate" => time,
+            "EndDate" => nil
+          }
+        },
+        :success
+      )
+      subject.save
+    end
   end
 end

data/spec/economic/cash_book_spec.rb

@@ -1,8 +1,8 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::CashBook do
   let(:session) { make_session }
-  subject { (i = Economic::CashBook.new( :id => 512, :number => 32 )).tap { i.session = session } }
+  subject { (i = Economic::CashBook.new(:id => 512, :number => 32)).tap { i.session = session } }
 
   it "inherits from Economic::Entity" do
     expect(Economic::CashBook.superclass).to eq(Economic::Entity)
@@ -19,15 +19,15 @@ describe Economic::CashBook do
   end
 
   describe "#entries" do
-    it 'should return a cash book entry proxy' do
+    it "should return a cash book entry proxy" do
       expect(subject.entries).to be_a(Economic::CashBookEntryProxy)
       expect(subject.entries.owner).to eq(subject)
     end
   end
 
   describe "#book" do
-    it 'should book the cash book and return an invoice number' do
-      mock_request("CashBook_Book", {'cashBookHandle' => { 'Number' => 32 }}, :success)
+    it "should book the cash book and return an invoice number" do
+      mock_request("CashBook_Book", {"cashBookHandle" => {"Number" => 32}}, :success)
       expect(subject.book).to eq(832)
     end
   end
@@ -37,8 +37,8 @@ describe Economic::CashBook do
       subject.persisted = true
     end
 
-    it 'should save it' do
-      stub_request('CashBook_UpdateFromData', nil, :success)
+    it "should save it" do
+      stub_request("CashBook_UpdateFromData", nil, :success)
       subject.save
     end
 

data/spec/economic/company_spec.rb

@@ -0,0 +1,20 @@
+require "./spec/spec_helper"
+
+describe Economic::Company do
+  let(:session) { make_session }
+  subject { Economic::Company.new(:session => session) }
+
+  it "inherits from Economic::Entity" do
+    expect(Economic::Company.ancestors).to include(Economic::Entity)
+  end
+
+  describe ".proxy" do
+    it "should return a CompanyProxy" do
+      expect(subject.proxy).to be_instance_of(Economic::CompanyProxy)
+    end
+
+    it "should return a proxy owned by session" do
+      expect(subject.proxy.session).to eq(session)
+    end
+  end
+end

data/spec/economic/creditor_contact_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::CreditorContact do
   let(:session) { make_session }
@@ -42,7 +42,7 @@ describe Economic::CreditorContact do
     end
 
     context "when creditor_handle is set" do
-      let(:handle) { Economic::CreditorContact::Handle.new({:number => 42}) }
+      let(:handle) { Economic::CreditorContact::Handle.new(:number => 42) }
 
       before :each do
         subject.creditor_handle = handle
@@ -83,8 +83,8 @@ describe Economic::CreditorContact do
       end
 
       it "should clear cached creditor and fetch the new creditor from API" do
-        stub_request('Creditor_GetData', nil, :success)
-        subject.creditor_handle = Economic::Creditor::Handle.new({:number => 1234})
+        stub_request("Creditor_GetData", nil, :success)
+        subject.creditor_handle = Economic::Creditor::Handle.new(:number => 1234)
         expect(subject.creditor).to be_instance_of(Economic::Creditor)
       end
     end
@@ -111,5 +111,4 @@ describe Economic::CreditorContact do
       expect(subject.proxy.session).to eq(session)
     end
   end
-
 end

data/spec/economic/creditor_entry_spec.rb

@@ -0,0 +1,20 @@
+require "./spec/spec_helper"
+
+describe Economic::CreditorEntry do
+  let(:session) { make_session }
+  subject { Economic::CreditorEntry.new(:session => session) }
+
+  it "inherits from Economic::Entity" do
+    expect(subject).to be_a(Economic::Entity)
+  end
+
+  describe "#proxy" do
+    it "should return a CreditorEntryProxy" do
+      expect(subject.proxy).to be_instance_of(Economic::CreditorEntryProxy)
+    end
+
+    it "should return a proxy owned by session" do
+      expect(subject.proxy.session).to eq(session)
+    end
+  end
+end

data/spec/economic/creditor_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::Creditor do
   let(:session) { make_session }
@@ -50,8 +50,8 @@ describe Economic::Creditor do
   end
 
   describe "#save" do
-    it 'should save it' do
-      stub_request('Creditor_CreateFromData', nil, :success)
+    it "should save it" do
+      stub_request("Creditor_CreateFromData", nil, :success)
       subject.save
     end
 

data/spec/economic/current_invoice_line_spec.rb

@@ -1,4 +1,4 @@
-require './spec/spec_helper'
+require "./spec/spec_helper"
 
 describe Economic::CurrentInvoiceLine do
   let(:session) { make_session }
@@ -17,8 +17,8 @@ describe Economic::CurrentInvoiceLine do
     end
 
     it "should not be equal when numbers are different" do
-      line1 = Economic::CurrentInvoiceLine.new({:number => 1})
-      line2 = Economic::CurrentInvoiceLine.new({:number => 2})
+      line1 = Economic::CurrentInvoiceLine.new(:number => 1)
+      line2 = Economic::CurrentInvoiceLine.new(:number => 2)
 
       expect(line1).not_to eq(line2)
     end