clearbooks 0.16.3 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 540a736e7bc2040a84a2a925faef7060ece6f179
-  data.tar.gz: 6b74558286b48bea1b1e7864e35ce83a8996c684
+  metadata.gz: 1af8b71d438200221b895de81c10918c5117b585
+  data.tar.gz: b048420193610f53fc13a4a15fb380c001a1fe5f
 SHA512:
-  metadata.gz: 6d8fdc185c2d7fac8b79113c40f4a17282f556f9a62e60fe00b633eae0f2f25f7c20799838ffb05c23961df875d7a57da60bc1a20039348f887faa07b3ea99cb
-  data.tar.gz: c85174c759dc0de9031108c2972407148ffb2c8b38b129b55c943c4d315547c83c1988c1f41d509777344b25293f38cabd889a1dfa64722c066b2d8e812288de
+  metadata.gz: eaac89d853482b6ef0ccbf848ec664814e69b87c3ef3d634623acaef5758283978c33ad6520ddeaa6619d2ae6eda690bf003746f2703969434e66cddea2758ab
+  data.tar.gz: 887c194c5d7ff22c6c35d48c199262685c7c72a0ec11e76bfdd457a70c0c0b28674568ecb941bccc6e14f09e15697649dfdd1f074030ed3cdf96beece20c5b2f

data/README.md

@@ -1,5 +1,5 @@
 # Clearbooks
-Version 0.16.3
+Version 0.18.1
 
 [![Gem Version](https://badge.fury.io/rb/clearbooks.svg)](http://badge.fury.io/rb/clearbooks)
 [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://img.shields.io/badge/license-MIT-brightgreen.svg)
@@ -191,6 +191,24 @@ Clearbooks.create_invoice Clearbooks::Invoice.new(
 ```
 Reference: https://www.clearbooks.co.uk/support/api/docs/soap/createinvoice/
 
+### Clearbooks.void_invoice
+
+Example:
+
+```ruby
+Clearbooks.void_invoice(
+    'purchases',    # 'purchases' or 'sales'
+    10              # Invoice id
+) # Clearbooks.void_invoice
+
+# returns a Hash:
+
+    {
+        :@success   => true,
+        :@msg       => 'Some status message'
+    }
+```
+
 ## Managing entities
 ### Clearbooks.list_entities
 
@@ -226,6 +244,24 @@ Clearbooks.create_entity Clearbooks::Entity.new(
 ```
 Full list of options: https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
 
+### Clearbooks.update_entity
+
+Example:
+
+```ruby
+Clearbooks.update_entity Clearbooks::Entity.new(
+    id: 10,
+    company_name: 'Company',
+    contact_name: 'John Doe',
+    supplier: {
+       default_account_code: '1001001', # See Clearbooks.list_account_codes
+       default_credit_terms: 30,
+       default_vat_rate: 0
+   }
+) # Clearbooks::Entity.new
+```
+Full list of options: https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
+
 ### Clearbooks.delete_entity
 
 Example:
@@ -450,7 +486,7 @@ Here is a current listing of all tasks:
 
 
 ```
-rake build                  # Build clearbooks-0.16.3.gem into the pkg directory
+rake build                  # Build clearbooks-0.18.1.gem into the pkg directory
 rake cucumber:pretty        # Run Cucumber features
 rake cucumber:progress      # Run Cucumber features
 rake default                # Show the default task when executing rake without arguments
@@ -458,8 +494,8 @@ rake docs:generate          # Generate Yardoc documentation for this project
 rake docs:graph             # Generate Yard Graphs for this project
 rake guard:default          # Execute Ruby Guard
 rake help                   # Shows the usage help screen
-rake install                # Build and install clearbooks-0.16.3.gem into system gems
-rake install:local          # Build and install clearbooks-0.16.3.gem into system gems without network access
+rake install                # Build and install clearbooks-0.18.1.gem into system gems
+rake install:local          # Build and install clearbooks-0.18.1.gem into system gems without network access
 rake man:build              # Build the manual pages
 rake man:clean              # Clean up from the built man pages
 rake measurement:benchmark  # When executing rake tasks measure elapsed time, used with other tasks
@@ -470,7 +506,7 @@ rake readme                 # Generate proper README file from templates
 rake readme:all             # Generate proper README file from templates
 rake readme:subdirs         # Builds generates readme files in all sub-directories
 rake readme:topdir          # Generate top level README file from template
-rake release                # Create tag v0.16.3 and build and push clearbooks-0.16.3.gem to Rubygems
+rake release                # Create tag v0.18.1 and build and push clearbooks-0.18.1.gem to Rubygems
 rake spec                   # RSpec Core Tasks
 rake todo                   # Look for TODO and FIXME tags in the code
 rake version                # Git Tag number of this repo
@@ -496,7 +532,7 @@ thor :docs:generate          # Generate Yardoc documentation for this project
 thor :docs:graph             # Generate Yard Graphs for this project
 thor :guard:default          # Execute Ruby Guard
 thor :help                   # Shows the usage help screen
-thor :install                # Build and install clearbooks-0.16.3 .gem into system gems
+thor :install                # Build and install clearbooks-0.18.1 .gem into system gems
 thor :man:build              # Build the manual pages
 thor :man:clean              # Clean up from the built man pages
 thor :measurement:benchmark  # When executing rake tasks measure elapsed time, used with other tasks
@@ -547,3 +583,4 @@ some basic assistance in finding the right person in charge of this section of t
 Please refer to the COPYING.md and LICENSE.md file.
 Unless otherwise stated in those files all remains protected and copyrighted by Bjoern Rennhak
 (bjoern AT greylon DOT com).
+

data/lib/clearbooks/core_ext/hash.rb

@@ -42,6 +42,16 @@ class Hash
     end
   end # }}}
 
+  # @fn         def camelize_keys {{{
+  # @brief      Converts keys to camel case
+  def camelize_keys
+    self.inject(Hash.new) do |h, (k, v)|
+      kk = k.to_s.camelize :lower
+      kk = kk.to_sym if k.is_a? Symbol
+      h[kk] = v
+      h
+    end
+  end # }}}
 end
 
 

data/lib/clearbooks/library/client.rb

@@ -19,31 +19,50 @@ module Clearbooks
 
     extend Savon::Model
 
-    client  wsdl:         Clearbooks.config.wsdl,
-            log:          Clearbooks.config.log,
-            logger:       Clearbooks.config.logger,
-            soap_header:  {  'tns:authenticate' => '', attributes!: {'tns:authenticate' => { apiKey: Clearbooks.config.api_key } } }
+    client wsdl: Clearbooks.config.wsdl,
+        log: Clearbooks.config.log,
+        logger: Clearbooks.config.logger,
+        log_level: Clearbooks.config.log_level,
+        soap_header: {'tns:authenticate' => '',
+                      attributes!: {'tns:authenticate' =>
+                                        {apiKey: Clearbooks.config.api_key}}}
 
-    operations :create_invoice, :list_invoices, :create_entity, :list_entities, :delete_entity,
-               :create_project, :list_projects, :list_account_codes, :create_journal, 
-               :delete_journal, :create_payment, :allocate_payment
+    operations :create_invoice,
+               :list_invoices,
+               :void_invoice,
 
+               :create_entity,
+               :list_entities,
+               :delete_entity,
+               :update_entity,
 
-    # @fn       def list_invoices {{{
-    # @brief    Get list of invoices from Clearbooks API
-    #
-    # @param    [Hash]    query     Hash of options to filter invoices. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/listinvoices/
-    #
-    # @return   [Array, Invoice]    An array or invoices.
-    #
-    # @example  Clearbooks.list_invoices
-    #
+               :create_project,
+               :list_projects,
+
+               :list_account_codes,
+
+               :create_journal,
+               :delete_journal,
+               :create_payment,
+               :allocate_payment
+
+    # @fn     def list_invoices {{{
+    # @brief  Get list of invoices from Clearbooks API.
+    # @param  [Hash] query Hash of options to filter invoices. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/listinvoices/
+    # @return [Array, Invoice] An array or invoices.
+    # @example
+    #   Clearbooks.list_invoices
     def list_invoices query = {}
-      defaults  = { ledger: :sales }
-      query     = defaults.merge(query)
-      response  = super message: {query: '', attributes!: {query: query}}
-      response  = response.to_hash
-      Invoice.build response[:list_invoices_response][:create_invoices_return][:invoice]
+      defaults = { ledger: :sales }
+      attributes = defaults.merge(query)
+      entity_id = attributes.delete :entity_id
+      invoice_id = attributes.delete :id
+      children = {}
+      children[:entityId] = {'xsd:integer' => entity_id} if entity_id
+      children[:id] = {'xsd:integer' => invoice_id} if invoice_id
+      response = super message: {query: children, attributes!: {query: attributes}}
+      response = response.to_hash
+      Invoice.build response[:list_invoices_response][:create_invoices_return].andand[:invoice]
     end # }}}
 
     # @fn       def create_invoice {{{
@@ -75,21 +94,38 @@ module Clearbooks
       }
     end # }}}
 
-    # @fn       def create_entity {{{
-    # @brief    Creates entity via Clearbooks API
-    #
-    # @param    [Entity]    entity      An entity to be created. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
-    #
-    # @return   [Hash]      [:entity_id] ID of the created entity.
-    #
+    # @fn     def void_invoice {{{
+    # @brief  Voids invoice via Clearbooks API.
+    # Operation taken from WSDL schema https://secure.clearbooks.co.uk/api/wsdl/
+    # @param  [String] ledger 'sales' or 'purchases'.
+    # @param  [Fixnum] invoice_id Invoice id.
+    # @return [Hash] [:@success, :@msg] Boolean result of the operation and a short message describing an error (if any).
+    # @example
+    #   Clearbooks.void_invoice 'purchases', 10
+    def void_invoice ledger, invoice_id
+      message = {
+          invoice: {
+              :@type => ledger,
+              :@id => invoice_id
+          }
+      }
+      response = super message: message
+      response = response.to_hash
+      response[:void_invoice_response][:void_success]
+    end
+
+    # @fn     def create_entity {{{
+    # @brief  Creates entity via Clearbooks API.
+    # @param  [Entity] entity An entity to be created. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
+    # @return [Hash] [:entity_id] ID of the created entity.
     # @example
-    #  Clearbooks.create_entity Clearbooks::Entity.new(company_name: 'DataLogic',
-    #         contact_name: 'Oleg Kukareka',
-    #             address1: 'Kiev',
-    #             country: 'UA',
-    #             postcode: '04073',
-    #             email: 'info@datalogic.co.uk',
-    #             website: 'https://datalogic.co.uk',
+    #  Clearbooks.create_entity Clearbooks::Entity.new(company_name: 'Example Inc.',
+    #         contact_name: 'John Doe',
+    #             address1: 'London',
+    #             country: 'UK',
+    #             postcode: '01100',
+    #             email: 'info@example.com',
+    #             website: 'http://example.com',
     #             phone1: '01234 567890',
     #             supplier: {
     #             default_account_code: '1001001',
@@ -103,7 +139,33 @@ module Clearbooks
       { entity_id: response[:create_entity_response][:create_entity_return].to_i }
     end # }}}
 
-    # @fn       def list_entities {{{
+    # @fn     def update_entity {{{
+    # @brief  Updates entity via Clearbooks API.
+    # Operation taken from WSDL schema https://secure.clearbooks.co.uk/api/wsdl/
+    # @param  [Entity] entity An entity to be updated. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
+    # @return [Hash] [:entity_id] ID of the updated entity.
+    # @example
+    #  Clearbooks.create_entity Clearbooks::Entity.new(id: 10,
+    #             company_name: 'Example Inc.',
+    #             contact_name: 'John Doe',
+    #             address1: 'London',
+    #             country: 'UK',
+    #             postcode: '01100',
+    #             email: 'info@example.com',
+    #             website: 'http://example.com',
+    #             phone1: '01234 567890',
+    #             supplier: {
+    #             default_account_code: '1001001',
+    #             default_credit_terms: 30,
+    #             default_vat_rate: 0
+    #         })
+    def update_entity entity
+      response = super message: {entityId: entity.id}.merge(entity.to_savon)
+      response = response.to_hash
+      { entity_id: response[:update_entity_response][:update_entity_return].to_i }
+    end # }}}
+
+    # @fn     def list_entities {{{
     # @brief  Get list of entities from Clearbooks API.
     # @param  [Hash] query Hash of options to filter entities. See the list of available options in official docs: https://www.clearbooks.co.uk/support/api/docs/soap/list-entities/
     # @return [Array, Entity] An array or entities.

data/lib/clearbooks/library/configuration.rb

@@ -2,6 +2,8 @@
 
 # System include
 require 'yaml'
+require 'andand'
+require 'logger'
 
 
 # @module     Clearbooks
@@ -11,8 +13,7 @@ module Clearbooks
   # @class    Configuration
   # @brief    Handles configurations of clearbooks gem such as api keys
   class Configuration
-
-    attr_accessor :api_key, :wsdl, :log, :logger
+    attr_accessor :api_key, :wsdl, :log, :logger, :log_level
 
     # @fn       def initialize
     # @brief    Constructor for Clearbooks::Configuration class objects
@@ -20,10 +21,11 @@ module Clearbooks
       defaults  = YAML.load_file(DEFAULT_CONFIG) rescue nil
       defaults  ||= YAML.load_file(File.expand_path("~/#{DEFAULT_CONFIG}")) rescue Hash.new
 
-      @api_key  = ENV['CLEARBOOKS_API_KEY'] || defaults['api_key']
-      @wsdl     = defaults['wsdl'] || 'https://secure.clearbooks.co.uk/api/wsdl/'
-      @logger   = Logger.new(STDOUT) if @log = defaults['log']
-
+      @api_key = ENV['CLEARBOOKS_API_KEY'] || defaults['api_key']
+      @wsdl = defaults['wsdl'] || 'https://secure.clearbooks.co.uk/api/wsdl/'
+      @log = defaults['log'] || false
+      @logger = Logger.new(STDOUT)
+      @log_level = defaults['log_level'].andand.to_sym || :info
       self
     end # }}}
 

data/lib/clearbooks/model/base.rb

@@ -20,10 +20,12 @@ module Clearbooks
       #
       # @note     Still returns an array when called with a hash representing a single item.
       def build data
-        unless data.is_a? Array
-          [ create(data) ]
+        if data.nil?
+          Array.new
+        elsif data.is_a? Array
+          data.map { |d| create(d) }
         else
-          return data.map { |d| create(d) }
+          [ create(data) ]
         end
       end  # }}}
 
@@ -56,7 +58,7 @@ module Clearbooks
       if date.nil? || date.is_a?(Date)
         date
       else
-        DateTime.strptime date, '%Y-%m-%d %H:%M:%S'
+        DateTime.strptime(date, '%Y-%m-%d %H:%M:%S').to_date rescue Date.strptime(date, '%Y-%m-%d')
       end
     end # }}}
 

data/lib/clearbooks/model/entity.rb

@@ -137,7 +137,7 @@ module Clearbooks
     # @param      [Hash]     data        Entity attributes. For the list of available options see https://www.clearbooks.co.uk/support/api/docs/soap/createentity/
     #
     def initialize data
-      @id               = data.savon(:id).to_i
+      @id               = Integer data.savon(:id) rescue nil
       @company_name     = data.savon :company_name
       @contact_name     = data.savon :contact_name
 
@@ -156,7 +156,7 @@ module Clearbooks
       @website          = data.savon :website
 
       @statement_url    = data.savon :statement_url
-      @external_id      = data.savon(:external_id).to_i
+      @external_id      = data.savon :external_id
 
       @supplier = entity_extra data.savon :supplier
       @supplier = @supplier.from_savon if @supplier
@@ -211,7 +211,7 @@ module Clearbooks
         {
             :@default_account_code	=> extra[:default_account_code],
             :@default_vat_rate      => extra[:default_vat_rate],
-            :@default_credit_terms  => extra[:default_credit_terms].to_i,
+            :@default_credit_terms  => (Integer extra[:default_credit_terms] rescue nil),
         }.compact
       end
     end # }}}

data/lib/clearbooks/model/invoice.rb

@@ -13,7 +13,10 @@ module Clearbooks
 
     attr_reader :invoice_id, :date_created, :date_due, :date_accrual, :credit_terms, :description, 
                 :entity_id, :reference, :project, :status, :invoice_prefix,
-                :invoice_number, :external_id, :statement_page, :date_modified, :items, :type, :bank_payment_id
+                :invoice_number, :external_id, :statement_page, :date_modified, :items, :type, :bank_payment_id,
+                :gross, :net, :vat, :paid, :balance, :external_id # FIXME add docs for new attributes
+
+    alias :id :invoice_id
 
     # @!attribute [r] invoice_id
     # @return [Fixnum] Invoice Id.
@@ -106,29 +109,36 @@ module Clearbooks
     #
     # @param    [Hash]     data      Invoice attributes. For the list of available options see https://www.clearbooks.co.uk/support/api/docs/soap/createinvoice/
     def initialize data
-      @invoice_id       = data.savon(:invoice_id).to_i
+      @invoice_id       = Integer data.savon(:invoice_id) rescue nil
 
-      @date_created     = parse_date data.savon(:date_created)
-      @date_due         = parse_date data.savon(:date_due)
+      @date_created     = parse_date data.savon :date_created
+      @date_due         = parse_date data.savon :date_due
 
-      @credit_terms     = data.savon(:credit_terms).to_i
+      @credit_terms     = Integer data.savon(:credit_terms) rescue nil
       @description      = data.savon :description
 
-      @entity_id        = data.savon(:entity_id).to_i
+      @entity_id        = Integer data.savon(:entity_id) rescue nil
       @reference        = data.savon :reference
-      @project          = data.savon(:project).to_i
+      @project          = Integer data.savon(:project) rescue nil
       @status           = data.savon :status
 
       @invoice_prefix   = data.savon :invoice_prefix
       @invoice_number   = data.savon :invoice_number
-      @external_id      = data.savon(:external_id).to_i
-      @statement_page   = data.savon :statement_page
+      @external_id      = data.savon :external_id
+      @statement_page   = CGI.unescapeHTML data.savon :statement_page rescue nil
+
+      @date_modified    = parse_date data.savon :date_modified
+      @date_accrual     = parse_date data.savon :date_accrual
 
-      @date_modified    = parse_date data.savon(:date_modified)
-      @date_accrual     = parse_date data.savon(:date_accrual)
+      @type             = data.savon :type
+      @bank_payment_id  = Integer data.savon(:bank_payment_id) rescue nil
 
-      @type             = data.savon(:type)
-      @bank_payment_id  = data.savon(:bank_payment_id).to_i
+      @gross            = BigDecimal data.savon(:gross) rescue nil
+      @net              = BigDecimal data.savon(:net) rescue nil
+      @vat              = BigDecimal data.savon(:vat) rescue nil
+      @paid             = BigDecimal data.savon(:paid) rescue nil
+      @balance          = BigDecimal data.savon(:balance) rescue nil
+      @external_id      = data.savon(:external_id)
 
       @items = Item.build( data[:items].is_a?(Array) ? data[:items] : data[:items][:item] )
     end # }}}
@@ -148,10 +158,11 @@ module Clearbooks
           :@creditTerms => @credit_terms,
           :@reference   => @reference,
           :@project     => @project,
+          :@external_id => @external_id,
 
           description:  @description,
           items:        { item: items.map(&:to_savon) }
-        }
+        }.compact
       }
     end # }}}
 

data/lib/clearbooks/model/item.rb

@@ -66,9 +66,9 @@ module Clearbooks
             :@quantity      => @quantity,
             :@type          => @type,
             :@vat           => @vat,
-            :@vat_rate      => @vat_rate,
+            :@vatRate       => @vat_rate,
             :description    => @description
-      }
+      }.compact
     end # }}}
 
   end # of class Item

data/spec/clearbooks/model/entity_spec.rb

@@ -19,13 +19,13 @@ module Clearbooks
 
     describe '::create_entity' do
       let(:entity) do
-        Entity.new(company_name: 'DataLogic',
-                   contact_name: 'Oleg Kukareka',
-                   address1: 'Kiev',
-                   country: 'UA',
-                   postcode: '04073',
-                   email: 'info@datalogic.co.uk',
-                   website: 'https://datalogic.co.uk',
+        Entity.new(company_name: 'Example Inc.',
+                   contact_name: 'John Doe',
+                   address1: 'London',
+                   country: 'UL',
+                   postcode: '01100',
+                   email: 'info@example.com',
+                   website: 'http://example.com',
                    phone1: '01234 567890',
                    supplier: {
                        default_account_code: '1001001',
@@ -48,6 +48,38 @@ module Clearbooks
       end
     end
 
+    describe '::update_entity' do
+      let(:entity) do
+        Entity.new(id: 10,
+                   company_name: 'Example Inc.',
+                   contact_name: 'John Doe',
+                   address1: 'London',
+                   country: 'UK',
+                   postcode: '01100',
+                   email: 'info@example.com',
+                   website: 'http://example.com',
+                   phone1: '01234 567890',
+                   supplier: {
+                       default_account_code: '1001001',
+                       default_credit_terms: 30,
+                       default_vat_rate: 0
+                   })
+      end
+
+      let(:xml) { File.read('spec/fixtures/response/update_entity.xml') }
+
+      let(:response) do
+        savon.expects(:update_entity).with(message: message).returns(xml)
+        Clearbooks.update_entity(entity)
+      end
+
+      it 'updates existing entity' do
+        expect(response).to be_a Hash
+        expect(response[:entity_id]).to be_a Fixnum
+        expect(response[:entity_id]).to be > 0
+      end
+    end
+
     describe '::list_entities' do
       let(:xml) { File.read('spec/fixtures/response/list_entities.xml') }
 
@@ -58,7 +90,7 @@ module Clearbooks
 
       it 'returns list of entnties' do
         expect(entities).to be_an Array
-        expect(entities.length).to eq 4
+        expect(entities.length).to eq 2
       end
 
       describe Entity do
@@ -69,22 +101,22 @@ module Clearbooks
         end
 
         it 'has proper attribute values' do
-          expect(entity.id).to eq 7
-          expect(entity.company_name).to eq 'DataLogic'
-          expect(entity.contact_name).to eq 'Oleg Kukareka'
+          expect(entity.id).to eq 6
+          expect(entity.company_name).to eq 'Example Inc.'
+          expect(entity.contact_name).to eq 'John Foo'
           expect(entity.address1).to eq 'Street 1'
-          expect(entity.town).to eq 'Kiev'
-          expect(entity.county).to eq 'Ukraine'
-          expect(entity.postcode).to eq '04073'
-          expect(entity.email).to eq 'info@datalogic.co.uk'
+          expect(entity.town).to eq 'London'
+          expect(entity.county).to eq 'United Kingdom'
+          expect(entity.postcode).to eq '01100'
+          expect(entity.email).to eq 'info@example.com'
           expect(entity.phone1).to eq '01234 567890'
           expect(entity.building).to eq 'Building2'
           expect(entity.address2).to eq 'Street2'
           expect(entity.phone2).to eq '1234 567890'
           expect(entity.fax).to eq '2345 67890'
-          expect(entity.website).to eq 'https://datalogic.co.uk'
-          expect(entity.external_id).to eq 3
-          expect(entity.statement_url).to eq 'https://secure.clearbooks.co.uk/s/58055:YGD2d9_WFz6GvKUv4V4anw'
+          expect(entity.website).to eq 'http://example.com'
+          expect(entity.external_id).to eq '3'
+          expect(entity.statement_url).to eq 'https://secure.clearbooks.co.uk/'
           expect(entity.supplier[:default_account_code]).to eq '30'
           expect(entity.supplier[:default_vat_rate]).to eq '10'
           expect(entity.supplier[:default_credit_terms]).to eq 30

data/spec/clearbooks/model/invoice_spec.rb

@@ -103,6 +103,20 @@ module Clearbooks
         expect(response[:invoice_number]).to eq '3'
       end
     end
+
+    describe '::void_invoice' do
+      let(:xml) { File.read('spec/fixtures/response/void_invoice.xml') }
+      let(:response) do
+        savon.expects(:void_invoice).with(message: message).returns(xml)
+        Clearbooks.void_invoice 'purchases', 10
+      end
+
+      it 'voids an invoice' do
+        expect(response).to be_a Hash
+        expect(response[:@success]).to eq 'true'
+        expect(response[:@msg]).to eq 'The invoice has been voided'
+      end
+    end
   end
 end
 

data/spec/fixtures/response/list_entities.xml

@@ -15,27 +15,11 @@
           <customer/>
           <bankAccount bankName="" name="" sortcode="" accountNumber=""/>
         </ns1:Entity>
-        <ns1:Entity id="2" company_name="Doski LLC" contact_name="Mr John Foo" address1="1270 LONDON ROAD NORBURY"
-                    town="London" county="" postcode="SW164DH" email="john.foo@datalogic.ua" phone1="380672382496"
-                    building="DOSHI &amp; CO 1ST FLOOR WINDSOR HOUSE" address2="" phone2="" fax="" website=""
-                    date_modified="2015-04-27 17:39:23" external_id="" company_number="06889723"
-                    statement_url="https://secure.clearbooks.co.uk/s/58055:IVm_rJOxQvRyPODa-U77HQ">
-          <supplier default_account_code="30" default_vat_rate="0" default_credit_terms="30"/>
-          <bankAccount bankName="" name="" sortcode="" accountNumber=""/>
-        </ns1:Entity>
-        <ns1:Entity id="6" company_name="DataLogic" contact_name=" Oleg Kukareka" address1="Kiev" town="" county=""
-                    postcode="04073" email="info@datalogic.co.uk" phone1="01234 567890" building="" address2=""
-                    phone2="" fax="" website="https://datalogic.co.uk" date_modified="2015-04-28 15:59:17"
-                    external_id="0" company_number=""
-                    statement_url="https://secure.clearbooks.co.uk/s/58055:oGADQmCXvwNPIsBANlv9Xg">
-          <supplier default_account_code="30" default_vat_rate="0" default_credit_terms="30"/>
-          <bankAccount bankName="" name="" sortcode="" accountNumber=""/>
-        </ns1:Entity>
-        <ns1:Entity id="7" company_name="DataLogic" contact_name="Oleg Kukareka" address1="Street 1" town="Kiev" county="Ukraine"
-                    postcode="04073" email="info@datalogic.co.uk" phone1="01234 567890" building="Building2" address2="Street2"
-                    phone2="1234 567890" fax="2345 67890" website="https://datalogic.co.uk" date_modified="2015-04-28 16:10:57"
+        <ns1:Entity id="6" company_name="Example Inc." contact_name="John Foo" address1="Street 1" town="London" county="United Kingdom"
+                    postcode="01100" email="info@example.com" phone1="01234 567890" building="Building2" address2="Street2"
+                    phone2="1234 567890" fax="2345 67890" website="http://example.com" date_modified="2015-04-28 15:59:17"
                     external_id="3" company_number=""
-                    statement_url="https://secure.clearbooks.co.uk/s/58055:YGD2d9_WFz6GvKUv4V4anw">
+                    statement_url="https://secure.clearbooks.co.uk/">
           <supplier default_account_code="30" default_vat_rate="10" default_credit_terms="30"/>
           <bankAccount bankName="" name="" sortcode="" accountNumber=""/>
         </ns1:Entity>

data/spec/fixtures/response/update_entity.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+                   xmlns:ns1="https://secure.clearbooks.co.uk/api/soap/">
+  <SOAP-ENV:Header>
+    <ns1:authenticate>true</ns1:authenticate>
+  </SOAP-ENV:Header>
+  <SOAP-ENV:Body>
+    <SOAP-ENV:updateEntityResponse>
+      <updateEntityReturn>6</updateEntityReturn>
+    </SOAP-ENV:updateEntityResponse>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/fixtures/response/void_invoice.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+                   xmlns:ns1="https://secure.clearbooks.co.uk/api/soap/">
+  <SOAP-ENV:Header>
+    <ns1:authenticate>true</ns1:authenticate>
+  </SOAP-ENV:Header>
+  <SOAP-ENV:Body>
+    <SOAP-ENV:voidInvoiceResponse>
+      <voidSuccess success="true" msg="The invoice has been voided"/>
+    </SOAP-ENV:voidInvoiceResponse>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/spec_helper.rb

@@ -21,6 +21,8 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.order = 'random'
 
+  Clearbooks.config.api_key ||= ''
+
 end # of RSpec.configure
 
 # vim:ts=2:tw=100:wm=100:syntax=ruby

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clearbooks
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.18.1
 platform: ruby
 authors:
 - Bjoern Rennhak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -146,6 +146,8 @@ files:
 - spec/fixtures/response/list_invoices.xml
 - spec/fixtures/response/list_projects.xml
 - spec/fixtures/response/no_api_key_fault.xml
+- spec/fixtures/response/update_entity.xml
+- spec/fixtures/response/void_invoice.xml
 - spec/fixtures/response/well_formed_request.xml
 - spec/fixtures/response/wrong_api_key_fault.xml
 - spec/spec_helper.rb
@@ -159,7 +161,7 @@ post_install_message: "
   |   | ____|  /   |  _ | __ ) / _  / _ | |/ / ___| \n    | |   | |   |  _|   / _
   \ | |_) |  _ | | | | | | | ' /___  \n    | |___| |___| |___ / ___ |  _ <| |_) |
   |_| | |_| | .  ___) |\n     ____|_____|_____/_/   __| _____/ ___/ ___/|_|_____/
-  \n                                                             \n\n    (c) 2015-05-01
+  \n                                                             \n\n    (c) 2015-05-18
   00:00:00 UTC, All rights reserved\n    Bjoern Rennhak, Greylon Ltd.\n\n    Don't
   forget to get Clearbooks API key from http://clearbooks.co.uk\n    and save it in
   ~/.clearbooks/config.yml:\n\n    $ echo \"api_key: {your_api_key}\" >> ~/.clearbooks/config.yml\n\n
@@ -191,6 +193,7 @@ test_files:
 - spec/fixtures/response/list_invoices.xml
 - spec/fixtures/response/create_payment.xml
 - spec/fixtures/response/list_entities.xml
+- spec/fixtures/response/update_entity.xml
 - spec/fixtures/response/no_api_key_fault.xml
 - spec/fixtures/response/create_entity.xml
 - spec/fixtures/response/create_project.xml
@@ -198,6 +201,7 @@ test_files:
 - spec/fixtures/response/delete_entity.xml
 - spec/fixtures/response/list_account_codes.xml
 - spec/fixtures/response/delete_journal.xml
+- spec/fixtures/response/void_invoice.xml
 - spec/fixtures/response/wrong_api_key_fault.xml
 - spec/fixtures/response/create_journal.xml
 - spec/fixtures/response/allocate_payment.xml