clearbooks 0.16.3

data/spec/clearbooks/model/entity_spec.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+
+# System include
+require 'savon'
+
+# Custom include
+require 'spec_helper'
+
+
+module Clearbooks
+
+  describe Clearbooks do
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    let(:message) { :any }
+
+    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',
+                   phone1: '01234 567890',
+                   supplier: {
+                       default_account_code: '1001001',
+                       default_credit_terms: 30,
+                       default_vat_rate: 0
+                   })
+      end
+
+      let(:xml) { File.read('spec/fixtures/response/create_entity.xml') }
+
+      let(:response) do
+        savon.expects(:create_entity).with(message: message).returns(xml)
+        Clearbooks.create_entity(entity)
+      end
+
+      it 'creates a new 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') }
+
+      let(:entities) do
+        savon.expects(:list_entities).with(message: message).returns(xml)
+        Clearbooks.list_entities
+      end
+
+      it 'returns list of entnties' do
+        expect(entities).to be_an Array
+        expect(entities.length).to eq 4
+      end
+
+      describe Entity do
+        let(:entity) {entities.last}
+
+        it 'is an Entity' do
+          expect(entity).to be_an Entity
+        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.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.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.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
+          expect(entity.customer).to be_nil
+        end
+      end
+    end
+
+    describe '::delete_entity' do
+      let(:xml) { File.read('spec/fixtures/response/delete_entity.xml') }
+
+      it 'deletes an entity with given id' do
+        savon.expects(:delete_entity).with(message: message).returns(xml)
+        expect(Clearbooks.delete_entity(1)).to eq true
+      end
+    end
+
+  end
+
+end

data/spec/clearbooks/model/invoice_spec.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+
+# System include
+require 'savon'
+
+# Custom include
+require 'spec_helper'
+
+
+module Clearbooks
+
+  describe Clearbooks do
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    let(:message) { :any }
+
+    describe '::list_invoices' do
+      let(:response) { File.read('spec/fixtures/response/list_invoices.xml') }
+      let(:invoices) do
+        savon.expects(:list_invoices).with(message: message).returns(response)
+        Clearbooks.list_invoices
+      end
+
+      it 'returns invoice list' do
+        expect(invoices).to be_an Array
+        expect(invoices.count).to eq 3
+      end
+
+      describe Invoice do
+        let(:invoice) { invoices.last }
+
+        it 'is an Invoice' do
+          expect(invoice).to be_an Invoice
+        end
+
+        it 'has proper attribute values' do
+          expect(invoice.entity_id).to eq 1
+          expect(invoice.invoice_id).to eq 3
+          expect(invoice.invoice_prefix).to eq 'INV'
+          expect(invoice.invoice_number).to eq '3'
+          expect(invoice.reference).to eq 'ref1'
+          expect(invoice.date_created).to eq Date.parse '2015-04-27 00:00:00'
+          expect(invoice.date_due).to eq Date.parse '2015-05-27 00:00:00'
+          expect(invoice.date_accrual).to eq Date.parse '2015-04-27 00:00:00'
+          expect(invoice.credit_terms).to eq 30
+          expect(invoice.project).to eq 7
+          expect(invoice.status).to eq 'approved'
+          expect(invoice.statement_page).to eq 'https://secure.clearbooks.co.uk/accounting/sales/invoice_html/?source=statement'
+          expect(invoice.type).to eq 'S'
+        end
+
+        it 'has items' do
+          expect(invoice.items).to be_an Array
+          expect(invoice.items.count).to eq 3
+        end
+
+        describe Item do
+          let (:item) { invoice.items.last }
+
+          it 'is an Item' do
+            expect(item).to be_an Item
+          end
+
+          it 'has proper description' do
+            expect(item.description).to eq '232323'
+          end
+
+          it 'has proper attribute values' do
+            expect(item.unit_price).to eq 5
+            expect(item.vat).to eq '2'
+            expect(item.quantity).to eq 1
+            expect(item.type).to eq '1001001'
+            expect(item.vat_rate).to eq '0.00:Out'
+          end
+        end
+      end
+    end
+
+    describe '::create_invoice' do
+      let(:items) { [Item.new(description: 'abcd', unit_price: 9.99,
+                              quantity: 5, type: '1001001', vat: 0, vat_rate: '0.00:Out'),
+                     Item.new(description: 'abcd', unit_price: 19.99,
+                              quantity: 7, type: '1001001', vat: 0, vat_rate: '0.00:Out')] }
+      let(:invoice) { Invoice.new(date_created: Date.today,
+                                  credit_terms: 30,
+                                  entity_id: 1,
+                                  type: 'purchases',
+                                  items: items)}
+      let(:xml) { File.read('spec/fixtures/response/create_invoice.xml') }
+      let(:response) do
+        savon.expects(:create_invoice).with(message: message).returns(xml)
+        Clearbooks.create_invoice(invoice)
+      end
+
+      it 'creates a new invoice' do
+        expect(response).to be_a Hash
+        expect(response[:due]).to eq 50
+        expect(response[:invoice_id]).to eq 3
+        expect(response[:invoice_prefix]).to eq 'PUR'
+        expect(response[:invoice_number]).to eq '3'
+      end
+    end
+  end
+end
+
+

data/spec/clearbooks/model/journal_spec.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+
+# System include
+require 'savon'
+
+# Custom include
+require 'spec_helper'
+
+
+module Clearbooks
+
+  describe Clearbooks do
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    let(:message) { :any }
+
+    let(:description) { 'Journal1' }
+    let(:accounting_date) { '2015-05-01 00:00:00' }
+    let(:entity) { 100 }
+    let(:project) { 200 }
+    let(:accounts) { ['4001001', '4001002'] }
+    let(:amounts) { [19.99, 29.99] }
+    let(:ledgers) do
+      [accounts, amounts].transpose.map do |data|
+        Ledger.new(account: data[0], amount: data[1].to_s)
+      end
+    end
+
+    let(:journal) { Journal.new(description: description,
+                                accounting_date: accounting_date,
+                                entity: entity, project: project,
+                                ledgers: ledgers) }
+
+    describe Journal do
+      describe :initialize do
+        it 'initializes new journal' do
+          expect(journal.description).to eq description
+          expect(journal.accounting_date).to eq Date.parse accounting_date
+          expect(journal.entity).to eq entity
+          expect(journal.project).to eq project
+          expect(journal.ledgers.length).to eq ledgers.length
+          journal.ledgers.each_with_index do |ledger, i|
+            expect(ledger.account).to eq accounts[i]
+            expect(ledger.amount).to eq amounts[i]
+          end
+        end
+      end
+    end
+
+    describe '::create_journal' do
+      let(:xml) { File.read('spec/fixtures/response/create_journal.xml') }
+
+      let(:response) do
+        savon.expects(:create_journal).with(message: message).returns(xml)
+        Clearbooks.create_journal(journal)
+      end
+
+      it 'creates new journal' do
+        expect(response).to be_a Hash
+        expect(response[:journal_id]).to be_a Fixnum
+        expect(response[:journal_id]).to be > 0
+      end
+    end
+
+    describe '::delete_journal' do
+      let(:xml) { File.read('spec/fixtures/response/delete_journal.xml') }
+
+      it 'deletes a journal with given id' do
+        savon.expects(:delete_journal).with(message: message).returns(xml)
+        expect(Clearbooks.delete_journal(8)).to eq true
+      end
+    end
+  end
+end

data/spec/clearbooks/model/payment_spec.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+
+# System include
+require 'savon'
+
+# Custom include
+require 'spec_helper'
+
+
+module Clearbooks
+
+  describe Clearbooks do
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    let(:message) { :any }
+
+    let(:accounting_date) { '2015-05-01 00:00:00' }
+    let(:type) { 'sales' }
+    let(:description) { 'Description1'}
+    let(:amount) { 59.99 }
+    let(:entity_id) { 1 }
+    let(:payment_method) { 1 }
+    let(:bank_account) { '7502001' }
+    let(:invoices) do
+      [ {id: 1, amount: '9.99'}, {id:9, amount: '19.99'} ]
+    end
+
+    let(:payment) { Payment.new(accounting_date: accounting_date,
+                                type: type,
+                                description: description,
+                                amount: amount.to_s,
+                                entity_id: entity_id,
+                                payment_method: payment_method,
+                                bank_account: bank_account,
+                                invoices: invoices) }
+
+    describe Payment do
+
+      describe :initialize do
+        it 'initializes a new payment' do
+          expect(payment.accounting_date).to eq Date.parse(accounting_date)
+          expect(payment.type).to eq type
+          expect(payment.description).to eq description
+          expect(payment.amount).to eq amount
+          expect(payment.entity_id).to eq entity_id
+          expect(payment.payment_method).to eq payment_method
+          expect(payment.bank_account).to eq bank_account
+          expect(payment.invoices.length).to eq invoices.length
+
+          payment.invoices.each_with_index do |inv, i|
+            expect(inv[:id]).to eq invoices[i][:id]
+            expect(inv[:amount]).to eq invoices[i][:amount]
+          end
+        end
+      end
+    end
+
+    describe '.create_payment' do
+      let(:xml) { File.read('spec/fixtures/response/create_payment.xml') }
+
+      let(:response) do
+        savon.expects(:create_payment).with(message: message).returns(xml)
+        Clearbooks.create_payment(payment)
+      end
+
+      it 'creates new payment' do
+        expect(response).to be_a Hash
+        expect(response[:payment_id]).to be_a Fixnum
+        expect(response[:payment_id]).to be > 0
+      end
+    end
+
+    describe '.allocate_payment' do
+      let(:xml) { File.read('spec/fixtures/response/allocate_payment.xml') }
+
+      let(:params) do
+        {
+            payment_id:   1,
+            entity_id:    1,
+            type:         'sales',
+            invoices:     [
+                {id: 1, amount: 9.99},
+                {id: 2, amount: 19.99}
+            ]
+        }
+      end
+
+      let(:response) do
+        savon.expects(:allocate_payment).with(message: message).returns(xml)
+        Clearbooks.allocate_payment(params)
+      end
+
+      it 'allocates a payment against an invoice or set of invoices' do
+        expect(response).to be_a Hash
+        expect(response[:success]).to be true
+        expect(response[:msg]).to eq 'The payment has been allocated'
+      end
+    end
+  end
+end

data/spec/clearbooks/model/project_spec.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+
+# System include
+require 'savon'
+
+# Custom include
+require 'spec_helper'
+
+
+module Clearbooks
+
+  describe Clearbooks do
+
+    before(:all) { savon.mock! }
+    after(:all) { savon.unmock! }
+
+    let(:message) { :any }
+
+    describe '::create_project' do
+      let(:project) do
+        Project.new(description: 'Project 1 description',
+                   project_name: 'Project 1 name',
+                   status: 'open')
+      end
+
+      let(:xml) { File.read('spec/fixtures/response/create_project.xml') }
+
+      let(:response) do
+        savon.expects(:create_project).with(message: message).returns(xml)
+        Clearbooks.create_project(project)
+      end
+
+      it 'creates a new project' do
+        expect(response).to be_a Hash
+        expect(response[:project_id]).to be_a Fixnum
+        expect(response[:project_id]).to be > 0
+      end
+    end
+
+    describe '::list_projects' do
+      let(:xml) { File.read('spec/fixtures/response/list_projects.xml') }
+
+      let(:projects) do
+        savon.expects(:list_projects).with(message: message).returns(xml)
+        Clearbooks.list_projects
+      end
+
+      it 'returns list of projects' do
+        expect(projects).to be_an Array
+        expect(projects.length).to eq 3
+      end
+
+      describe Project do
+        let(:project) {projects.last}
+
+        it 'is a Project' do
+          expect(project).to be_a Project
+        end
+
+        it 'has proper attribute values' do
+          expect(project.project_name).to eq 'Project 3 name'
+          expect(project.status).to eq 'open'
+          expect(project.description).to eq 'description3'
+          expect(project.id).to eq 3
+        end
+      end
+    end
+
+  end
+
+end