ruconomic 0.9.12 → 0.9.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 213c1cd50f2a4ec2abed8729c4e8fe8e82c3342a
-  data.tar.gz: e98905303834acfd7c2aa0c284507f0571efe179
+  metadata.gz: f7cef861a618b0e6ac0caebb03a6f01ab6b8df45
+  data.tar.gz: df1d3875ce8cc8d9647dd347d7323b98c8ce76be
 SHA512:
-  metadata.gz: c5c2bc669172acb021fc118780ada1a788544e1c8fb1eca83d2d1e0509717d087885b4d9b9af2d5f0453dc0cd2fffb377cbba7489bd6dc8af1f637291c210814
-  data.tar.gz: 797388114ce6e57459f5cb9692a5c7c84a8f7c7345ed53e65514c54a8c94a88537ab57509acfb7b7a6dfe83e7498bb20bd90c3044f813413c2f6cd6713a089e7
+  metadata.gz: c3571616a5ac4954aa312eea60e611d761a30e33d9baa7215b27dec28ef16e4bc636f259db81f69bbb0b28c5f08fcbd3af376012d55f814f3e6e6e8ef7e75187
+  data.tar.gz: 7a27d759d3f6a6a7efc40106ba84c5aa3f1d46b41bf69044162740420ba477fe8046e76bc8d8da4ede73b1ab44aac4f605aff7ab7b705ca0d49794b702713ac9

data/README.md

@@ -2,7 +2,7 @@
 
 The ruconomic gem provides a lightweight, speedy and easy-to-use ruby wrapper for the [e-conomic](http://www.e-conomic.com) SOAP web service - it will build, parse and transport some XML and little else. For a more full SOAPedelic experience, have a look at [rconomic](https://github.com/lokalebasen/rconomic).
 
-This gem is intended to be a crowd source project. The [e-conomic webservice](https://api.e-conomic.com/secure/api1/EconomicWebService.asmx) implements ~1500 operations(!), and all those operations are mapped to ruby classes and methods under ```lib/ruconomic/api``` - but not fully implemented. As always, the best way to understand is to [browse the source](https://github.com/coherify/ruconomic/tree/master/lib/ruconomic/api).
+This gem is intended to be a crowd source project. The [e-conomic webservice](https://api.e-conomic.com/secure/api1/EconomicWebService.asmx) implements ~1500 operations(!), and all those operations are mapped to ruby classes and methods under `lib/ruconomic/api` - but not fully implemented. As always, the best way to understand is to [browse the source](https://github.com/coherify/ruconomic/tree/master/lib/ruconomic/api).
 
 So, the idea is that we [add functionality](https://github.com/coherify/ruconomic#contributing) as needed.
 
@@ -71,7 +71,11 @@ end
 
 ## Documentation
 
-You can find the latest API documentation at [http://rdoc.info/github/coherify/ruconomic/index](http://rdoc.info/github/coherify/ruconomic/index) or generate your own copy with ```bundle install && bundle exec yardoc``` after cloning the repository.
+You can find the latest API documentation at http://rdoc.info/github/coherify/ruconomic/index or generate your own copy with `bundle install && bundle exec yardoc` after cloning the repository.
+
+## Testing
+
+Run the minitest suite with `bundle exec rake`
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
 
+FileList["lib/tasks/*.rake"].each do |task|
+  import task
+end

data/lib/ruconomic/api/cash_book.rb

@@ -39,8 +39,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:cash_book_get_data_response] \
-          [:cash_book_get_data_result]
+        response.fetch(:cash_book_get_data_response, :cash_book_get_data_result)
       end
 
       # Returns cash book data objects for a given set of cash book handles.
@@ -62,7 +61,7 @@ module Ruconomic
       def self.get_all
         response = invoke('CashBook_GetAll')
 
-        response.to_hash[:cash_book_get_all_response][:cash_book_get_all_result]
+        response.fetch(:cash_book_get_all_response, :cash_book_get_all_result)
       end
 
       # Returns a handle for the cash book with the given number.
@@ -151,8 +150,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:cash_book_get_entries_response] \
-          [:cash_book_get_entries_result]
+        response.fetch(:cash_book_get_entries_response, :cash_book_get_entries_result)
       end
 
       # Delete all entries from a cash book. Action that cannot be undone.

data/lib/ruconomic/api/current_invoice.rb

@@ -279,8 +279,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:current_invoice_get_text_line1_response] \
-          [:current_invoice_get_text_line1_result]
+        response.fetch(:current_invoice_get_text_line1_response, :current_invoice_get_text_line1_result)
       end
 
       # Set the primary line of a current invoice.
@@ -296,7 +295,7 @@ module Ruconomic
           message.add 'value', text
         end
 
-        response.to_hash[:current_invoice_set_text_line1]
+        response.fetch(:current_invoice_set_text_line1)
       end
 
       # Gets the secondary line of text of a current invoice.
@@ -324,7 +323,7 @@ module Ruconomic
           message.add 'value', text
         end
 
-        response.to_hash[:current_invoice_set_text_line2]
+        response.fetch(:current_invoice_set_text_line2)
       end
 
       # Gets the other reference of a current invoice.
@@ -498,6 +497,7 @@ module Ruconomic
             data.add_optional('DebtorCountry', invoice_data.dig(:debtor_country))
             data.add_optional('DebtorEan', invoice_data.dig(:debtor_ean))
             data.add_handle('AttentionHandle', invoice_data.dig(:attention_handle, :id), 'Id')
+            data.add_handle('YourReferenceHandle', invoice_data.dig(:your_reference_handle, :id), 'Id')
             data.add('Date', invoice_data.dig(:date))
             data.add_handle('TermOfPaymentHandle', invoice_data.dig(:term_of_payment_handle, :id), 'Id')
             data.add('DueDate', invoice_data.dig(:due_date))
@@ -573,7 +573,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:current_invoice_get_data_response][:current_invoice_get_data_result]
+        response.fetch(:current_invoice_get_data_response, :current_invoice_get_data_result)
       end
 
       # Returns current invoice data objects for a given set of current invoice handles.
@@ -599,7 +599,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:current_invoice_create_response][:current_invoice_create_result][:id]
+        response.fetch(:current_invoice_create_response, :current_invoice_create_result, :id)
       end
 
       # Returns handles for all current invoices.
@@ -609,7 +609,7 @@ module Ruconomic
       def self.get_all
         response = invoke('CurrentInvoice_GetAll')
 
-        response.to_hash[:current_invoice_get_all_response][:current_invoice_get_all_result]
+        response.fetch(:current_invoice_get_all_response, :current_invoice_get_all_result)
       end
 
       # Returns handles for the current invoices which have the given employee as OurReference.
@@ -682,7 +682,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:current_invoice_book_response][:current_invoice_book_result][:number]
+        response.fetch(:current_invoice_book_response, :current_invoice_book_result, :number)
       end
 
       # Books a current invoice.
@@ -709,7 +709,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:current_invoice_delete_response]
+        response.fetch(:current_invoice_delete_response)
       end
 
       # Gets handles for the lines of a current invoice.
@@ -1110,7 +1110,7 @@ module Ruconomic
           message.add 'value', due_date
         end
 
-        response.to_hash[:current_invoice_set_due_date_response]
+        response.fetch(:current_invoice_set_due_date_response)
       end
 
       # Gets the currency of a current invoice.

data/lib/ruconomic/api/debtor.rb

@@ -307,8 +307,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:debtor_update_from_data_response] \
-          [:debtor_update_from_data_result][:number]
+        response.fetch(:debtor_update_from_data_response, :debtor_update_from_data_result, :number)
       end
 
       # Returns a debtor data object for a given debtor.
@@ -323,7 +322,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:debtor_get_data_response][:debtor_get_data_result]
+        response.fetch(:debtor_get_data_response, :debtor_get_data_result)
       end
 
       # Returns debtor data objects for a given set of debtor handles.
@@ -828,7 +827,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:debtor_get_term_of_payment_response][:debtor_get_term_of_payment_result][:id]
+        response.fetch(:debtor_get_term_of_payment_response, :debtor_get_term_of_payment_result, :id)
       end
 
       # Sets the layout of a debtor. The value may be omitted.
@@ -855,7 +854,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:debtor_get_layout_response][:debtor_get_layout_result][:id]
+        response.fetch(:debtor_get_layout_response, :debtor_get_layout_result, :id)
       end
 
       # Gets a handle for the attention of a debtor.
@@ -971,7 +970,7 @@ module Ruconomic
           message.add 'vatZone', vat_zone
         end
 
-        response.to_hash[:debtor_create_response][:debtor_create_result][:number]
+        response.fetch(:debtor_create_response, :debtor_create_result, :number)
       end
 
       # Return handles for all debtors

data/lib/ruconomic/api/invoice.rb

@@ -192,7 +192,7 @@ module Ruconomic
       def self.get_all
         response = invoke('Invoice_GetAll')
 
-        response.to_hash[:invoice_get_all_response][:invoice_get_all_result]
+        response.fetch(:invoice_get_all_response, :invoice_get_all_result)
       end
 
       # Returns a handle for the invoice with the given number.
@@ -304,7 +304,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:invoice_get_pdf_response][:invoice_get_pdf_result]
+        response.fetch(:invoice_get_pdf_response, :invoice_get_pdf_result)
       end
 
       # Gets an OIO XML string representing an invoice.
@@ -331,7 +331,7 @@ module Ruconomic
           end
         end
 
-        response.to_hash[:invoice_get_data_response][:invoice_get_data_result]
+        response.fetch(:invoice_get_data_response, :invoice_get_data_result)
       end
 
       # Returns invoice data objects for a given set of invoice handles.

data/lib/ruconomic/api/invoice_line.rb

@@ -3,6 +3,31 @@ module Ruconomic
     module InvoiceLine
       extend Ruconomic::WebService
 
+      def self.find_by_invoice_list(invoice_numbers)
+        response = invoke('InvoiceLine_FindByInvoiceList') do |message|
+          message.add 'invoiceHandles' do |handles|
+            invoice_numbers.each do |invoice_number|
+              handles.add 'InvoiceHandle' do |handle|
+                handle.add 'Number', invoice_number
+              end
+            end
+          end
+        end
+
+        result = response.to_hash.dig(
+          :invoice_line_find_by_invoice_list_response,
+          :invoice_line_find_by_invoice_list_result,
+          :invoice_line_handle
+        )
+
+        case result
+        when Array
+          result
+        when Hash
+          [result]
+        end
+      end
+
       # Returns an invoice line data object for a given invoice line.
       # Parameters: entityHandle: A handle for the invoice line.
       #
@@ -18,12 +43,31 @@ module Ruconomic
       # Returns invoice line data objects for a given set of invoice line handles.
       # Parameters: entityHandles: An array of the invoice line handles.
       #
-      # @note TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
       # @see https://api.e-conomic.com/secure/api1/EconomicWebService.asmx?op=InvoiceLine_GetDataArray
       # @return [Hash] The body content of the SOAP response.
-      def self.get_data_array
+      def self.get_data_array(invoice_line_handles)
         response = invoke('InvoiceLine_GetDataArray') do |message|
-          raise "TODO: This method was autogenerated from the WSDL - see https://github.com/coherify/ruconomic#contributing"
+          message.add 'entityHandles' do |handles|
+            invoice_line_handles.each do |invoice_line_handle|
+              handles.add 'InvoiceLineHandle' do |handle|
+                handle.add 'Id', invoice_line_handle.fetch(:id)
+                handle.add 'Number', invoice_line_handle.fetch(:number)
+              end
+            end
+          end
+        end
+
+        result = response.to_hash.dig(
+          :invoice_line_get_data_array_response,
+          :invoice_line_get_data_array_result,
+          :invoice_line_data
+        )
+
+        case result
+        when Array
+          result
+        when Hash
+          [result]
         end
       end
 

data/lib/ruconomic/soap/document.rb

@@ -4,6 +4,7 @@ require "ruconomic/soap/node"
 module Ruconomic
   module SOAP
     class Document < LibXML::XML::Document
+      class KeyError < StandardError; end
       
       def initialize(xml_version = "1.0")
         super(xml_version)
@@ -29,6 +30,25 @@ module Ruconomic
         h[:Envelope][:body] 
       end
 
+      # Fetches a subnode as a hash. Errors if the path does not exist
+      # To be backwards compatible, it returns nil instead of error if the last part of the path is not found
+      def fetch(*path)
+        path.each.with_index.reduce(to_hash) do |hash, (key, index)|
+          case hash
+          when Hash
+            hash.fetch(key) do
+              if index == path.size - 1
+                nil
+              else
+                raise KeyError, "No such key path #{path.inspect} in document #{to_hash.inspect}"
+              end
+            end
+          else
+            raise KeyError, "Key path #{path.inspect} does not represent a hash in document #{to_hash.inspect}"
+          end
+        end
+      end
+
       # We want #string to return a Ruconomic::SOAP::Document and not a LibXML::XML::Document
       def self.string(value, options = {})
         document = Ruconomic::SOAP::Document.new

data/lib/ruconomic/version.rb

@@ -1,3 +1,3 @@
 module Ruconomic
-  VERSION = "0.9.12"
+  VERSION = "0.9.13"
 end

data/lib/tasks/test.rake

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/test_*.rb']
+end
+desc "Run tests"
+
+task default: :test

data/test/soap/test_document.rb

@@ -0,0 +1,52 @@
+require "minitest/autorun"
+require "ruconomic/soap/document"
+
+module Ruconomic
+  module SOAP
+    describe Document do
+      describe "fetch" do
+        it "gets existing subnode" do
+          node = Node.new("foo")
+          node.add("bar", "baz")
+          document = Document.new
+          document << node
+
+          assert_equal("baz", document.fetch(:foo, :bar))
+          assert_equal({bar: "baz"}, document.fetch(:foo))
+        end
+
+        it "returns nil if it is the last path part that does not match" do
+          node = Node.new("foo")
+          node.add("bar", "baz")
+          document = Document.new
+          document << node
+
+          assert_nil(document.fetch(:bogus))
+          assert_nil(document.fetch(:foo, :bogus))
+        end
+
+        it "errors on missing key" do
+          node = Node.new("foo")
+          node.add("bar", "baz")
+          document = Document.new
+          document << node
+
+          assert_raises(Document::KeyError) do
+            document.fetch(:bogus, :foo)
+          end
+        end
+
+        it "errors on middle value not being a hash" do
+          node = Node.new("foo")
+          node.add("bar", "baz")
+          document = Document.new
+          document << node
+
+          assert_raises(Document::KeyError) do
+            document.fetch(:foo, :bar, :baz)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruconomic
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.9.13
 platform: ruby
 authors:
 - Tonni Tølbøll Lund Aagesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-26 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -189,7 +189,9 @@ files:
 - lib/ruconomic/soap/node.rb
 - lib/ruconomic/version.rb
 - lib/ruconomic/web_service.rb
+- lib/tasks/test.rake
 - ruconomic.gemspec
+- test/soap/test_document.rb
 homepage: https://github.com/coherify/ruconomic
 licenses:
 - MIT
@@ -210,9 +212,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Lightweight, speedy and easy-to-use ruby wrapper for the e-conomic.com SOAP
   web service
-test_files: []
+test_files:
+- test/soap/test_document.rb