subledger 0.7.7

data/spec/subledger_report_spec.rb

@@ -0,0 +1,295 @@
+require 'spec_helper'
+
+Test 'Subledger' do
+
+  let(:factory) { Subledger::Factory.create }
+  let(:amount ) { '1' }
+
+  Instance do
+    subject { factory.client }
+
+    Test 'Report' do
+
+      # POST /v2/orgs/:org_id/books/:book_id/reports
+      RespondsTo 'report.create' do
+        ByReturning 'an instance of Subledger::Domain::ActiveReport' do
+          subject.report.create( factory.report_args ).
+                     must_be_instance_of Subledger::Domain::ActiveReport
+        end
+      end
+
+      # GET /v2/orgs/:org_id/books/:book_id/reports/:id
+      [ :archived, :active ].each do |state|
+        RespondsTo 'report.read' do
+          let(:report) { factory.create_report state }
+
+          ByReturning "an instance of #{state} report" do
+            subject.report.read( :id => report.id ).
+                       must_be_instance_of report.class
+          end
+        end
+      end
+
+      # PATCH /v2/orgs/:org_id/books/:book_id/reports/:id
+      [ :archived, :active ].each do |state|
+        RespondsTo 'reports.update' do
+          let(:report   ) { factory.create_report state }
+          let(:args       ) { report.attributes }
+          let(:description) { 'updated description' }
+          let(:update_args) { args.merge :description => description,
+                                         :version     => 2 }
+
+          ByReturning "an instance of #{state} report" do
+            patched = subject.reports.update update_args
+
+            patched.must_be_instance_of report.class
+            patched.description.must_equal description
+          end
+        end
+      end
+
+      # GET /v2/orgs/:org_id/books/:book_id/reports ? before   = :description & limit = :limit & state = :state
+      #                               ending
+      #                               starting
+      #                               after
+      [ :active, :archived ].each do |state|
+        Subledger.scenarios_order.each do |scenario|
+          action       = scenario.keys.first
+          expectations = scenario[action]
+
+          RespondsTo "reports.collect :action => #{action}, :state => #{state}" do
+            let(:reports) { factory.create_report_collection state }
+            let(:item      ) { reports[2] }
+            let(:limit     ) { 2 }
+            let(:collection) { subject.reports.collect args }
+            let(:klass     ) { item.class }
+
+            let(:args) { { :action      => action,
+                           :description => item.description,
+                           :state       => state,
+                           :limit       => limit } }
+
+            When 'not given a block' do
+              ByReturning "a list of #{state} reports" do
+                collection.length.must_equal limit
+              end
+            end
+
+            When 'given a block' do
+              ByYielding "a list of #{state} reports" do
+                count = 0
+
+                collection.each do |report|
+                  expectation = expectations[count]
+
+                  report.description.must_equal expectation
+
+                  report.must_be_instance_of klass
+
+                  count += 1
+                end
+
+                count.must_equal limit
+              end
+            end
+          end
+        end
+      end
+
+      # GET /reports ? preceding = :book_id & limit = :limit & state = :state
+      #                following = :book_id & limit = :limit & state = :state
+      [ :active, :archived ].each do |state|
+        Subledger.scenarios_id.each do |scenario|
+          action       = scenario.keys.first
+          expectations = scenario[action]
+
+          RespondsTo "reports.collect :action => #{action}" do
+            let(:reports) { factory.create_report_collection state }
+            let(:item      ) { reports[2] }
+            let(:limit     ) { 2 }
+            let(:collection) { subject.reports.collect args }
+            let(:klass     ) { item.class }
+
+            let(:args) { { :action => action,
+                           :id     => item.id,
+                           :state  => state,
+                           :limit  => limit } }
+
+            When 'not given a block' do
+              ByReturning "a list of #{state} reports" do
+                collection.length.must_equal limit
+              end
+            end
+
+            When 'given a block' do
+              ByYielding "a list of #{state} reports" do
+                count = 0
+
+                collection.each do |report|
+                  expectation = expectations[count]
+
+                  report.description.must_equal expectation
+
+                  report.must_be_instance_of klass
+
+                  count += 1
+                end
+
+                count.must_equal limit
+              end
+            end
+          end
+        end
+      end
+
+      # GET /v1/orgs/:org_id/books/:book_id/reports ? before   = :description & limit = :limit & state = :state
+      #                                               ending
+      #                                               starting
+      #                                               after
+      # Test collects with large number of items
+      [ :active ].each do |state|
+        Subledger.scenarios_order.each do |scenario|
+          action       = scenario.keys.first
+          expectations = scenario[action]
+
+          RespondsTo "reports.collect :action => #{action}, :state => #{state}" do
+            let(:reports   ) { factory.create_large_report_collection state }
+
+            let(:item      ) { reports[100] }
+            let(:limit     ) { 100 }
+            let(:collection) { subject.reports.collect args }
+            let(:klass     ) { item.class }
+
+            let(:args) { { :action      => action,
+                           :description => item.description,
+                           :state       => state,
+                           :limit       => limit } }
+
+            When 'not given a block' do
+              ByReturning "a list of #{state} reports" do
+                collection.length.must_equal limit
+              end
+            end
+
+            When 'given a block' do
+              ByYielding "a list of #{state} reports" do
+                count = 0
+
+                collection.each do |report|
+                  report.must_be_instance_of klass
+
+                  count += 1
+                end
+
+                count.must_equal limit
+              end
+            end
+          end
+        end
+      end
+
+      # GET /v1/orgs/:org_id/books/:book_id/reports ? preceding = :id & limit = :limit & state = :state
+      #                                               following = :id
+      # Test collects with large number of items
+      [ :active ].each do |state|
+        Subledger.scenarios_id.each do |scenario|
+          action       = scenario.keys.first
+          expectations = scenario[action]
+
+          RespondsTo "reports.collect :action => #{action}, :state => #{state}" do
+            let(:reports   ) { factory.create_large_report_collection state }
+
+            let(:item      ) { reports[100] }
+            let(:limit     ) { 100 }
+            let(:collection) { subject.reports.collect args }
+            let(:klass     ) { item.class }
+
+            let(:args) { { :action => action,
+                           :id     => item.id,
+                           :state  => state,
+                           :limit  => limit } }
+
+            When 'not given a block' do
+              ByReturning "a list of #{state} reports" do
+                collection.length.must_equal limit
+              end
+            end
+
+            When 'given a block' do
+              ByYielding "a list of #{state} reports" do
+                count = 0
+
+                collection.each do |report|
+                  report.must_be_instance_of klass
+
+                  count += 1
+                end
+
+                count.must_equal limit
+              end
+            end
+          end
+        end
+      end
+
+      # POST /v1/orgs/:org_id/books/:book_id/reports/:id/archive
+      RespondsTo 'report_instance.archive' do
+        ByReturning 'an instance of Subledger::Domain::ArchivedReport' do
+          factory.create_report(:active).archive.
+                     must_be_instance_of Subledger::Domain::ArchivedReport
+        end
+      end
+
+      # POST /v2/orgs/:org_id/books/:book_id/archived_reports/:id/activate
+      RespondsTo 'archived_report_instance.activate' do
+        ByReturning 'an instance of Subledger::Domain::ActiveReport' do
+          factory.create_report(:archived).activate.
+                     must_be_instance_of Subledger::Domain::ActiveReport
+        end
+      end
+
+      # GET /v2/orgs/:org_id/books/:book_id/reports/:id/categories
+      if Subledger::STORE == :api
+        RespondsTo 'report_instance.categories' do
+          ByRaising 'a Store::ReportError' do
+            lambda do
+              factory.create_report(:active).categories
+            end.must_raise Subledger::Store::ReportError
+          end
+        end
+      else
+        RespondsTo 'report_instance.categories' do
+          ByReturning 'a collection of Subledger::Domain::ActiveCategories' do
+            factory.create_report(:active).categories.
+                       must_be_instance_of Array
+          end
+        end
+      end
+
+      # POST /v2/orgs/:org_id/books/:book_id/reports/:id/render
+      RespondsTo 'report_instance.render :at => Time' do
+        let(:at) { Time.now.utc }
+
+        ByReturning 'an instance of Subledger::Domain::BuildingReportRendering' do
+          factory.create_report(:active).render(:at => at).
+                     must_be_instance_of Subledger::Domain::BuildingReportRendering
+        end
+      end
+
+      # GET /v2/orgs/:org_id/books/:book_id/report_renderings/:id
+      RespondsTo 'to_json' do
+        let(:report          ) { factory.loaded_report }
+        let(:at              ) { Time.now }
+        let(:report_rendering) { report.render :at => at }
+        let(:rr_json         ) { report_rendering.to_json }
+        let(:rr_hash         ) { MultiJson.load rr_json }
+
+        before { report.render :at => at }
+
+        ByReturning 'a REST report' do
+          rr_hash.must_be_instance_of Hash
+        end
+      end
+    end
+  end
+end

data/spec/subledger_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+Test 'Subledger' do
+
+  let(:amount ) { '1' }
+
+  let(:args) { { } }
+
+  Module do
+    subject { Subledger }
+
+    RespondsTo 'new' do
+      When ':store is not received' do
+        ByReturning 'an instance of Subledger::Interface::Client' do
+          subject.new( args ).must_be_instance_of Subledger::Interface::Client
+        end
+      end
+
+      When ':store is received' do
+        And ':store is a symbol' do
+          ByReturning 'an instance of Subledger::Interface::Client' do
+            args.merge! :store => Subledger::STORE
+
+            subject.new( args ).must_be_instance_of Subledger::Interface::Client
+          end
+        end
+
+        And ':store is unknown' do
+          ByRaising 'a Error' do
+            args.merge! :store => 'unknown'
+
+            lambda { subject.new( args ) }.must_raise Subledger::Error
+          end
+        end
+      end
+    end
+
+    RespondsTo 'parse_time' do
+      ByReturning 'a UTC Time' do
+        [
+          ( Subledger::EARLIEST_TIME ).iso8601(3),
+          ( Subledger::LATEST_TIME   ).iso8601(3),
+        ].each do |time_string|
+          subject.parse_time(
+                    :test,
+                    time_string ).utc?.must_equal true
+        end
+
+        [
+          nil,
+          '',
+          'bob',
+          ( Subledger::EARLIEST_TIME - 1 ).iso8601(3),
+          ( Subledger::LATEST_TIME + 1   ).iso8601(3),
+        ].each do |time_string|
+          lambda { subject.parse_time(
+                             :test,
+                             time_string ) }.must_raise Subledger::DateError
+        end
+      end
+    end
+  end
+
+  Instance do
+    subject { Subledger.new args }
+
+    RespondsTo 'debit' do
+      When 'an amount is received' do
+        ByReturning 'a kind of Debit' do
+          subject.debit( amount ).must_be_kind_of Subledger::Domain::Debit
+        end
+      end
+
+      When 'an amount is not received' do
+        ByReturning 'an ancestor of Debit' do
+          subject.debit.ancestors.must_include Subledger::Domain::Debit
+        end
+      end
+    end
+
+    RespondsTo 'credit' do
+      When 'an amount is received' do
+        ByReturning 'a kind of Debit' do
+          subject.credit( amount ).must_be_kind_of Subledger::Domain::Credit
+        end
+      end
+
+      When 'an amount is not received' do
+        ByReturning 'an ancestor of Debit' do
+          subject.credit.ancestors.must_include Subledger::Domain::Credit
+        end
+      end
+    end
+
+    RespondsTo 'zero' do
+      ByReturning 'a kind of Zero' do
+        subject.zero( 0 ).must_be_instance_of Subledger::Domain::Zero
+      end
+    end
+  end
+end

data/subledger.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/subledger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = [ 'Loren Hale', 'Tom Mornini' ]
+  gem.email         = 'admin@subledger.com'
+  gem.description   = 'Subledger client gem'
+  gem.summary       = 'Ruby client gem for accessing the Subledger API'
+  gem.homepage      = 'http://subledger.com'
+
+  gem.license       = 'BSD 3-Clause'
+
+  gem.files = [ ]
+
+  gem.files <<         [ '.gitignore',
+                         'LICENSE.txt',
+                         'subledger.gemspec',
+                         'Rakefile',
+                         'README.md' ]
+
+
+  gem.bindir        = 'bin'
+  gem.executables   = 'subledger'
+
+  gem.files <<         [ 'lib/subledger.rb' ]
+
+  gem.files << Dir.glob( 'lib/subledger/*.rb' )
+
+  gem.files << Dir.glob( 'lib/subledger/domain/**/*.rb' )
+
+  gem.files << Dir.glob( 'lib/subledger/interface/**/*.rb' )
+
+  gem.files <<           'lib/subledger/store/api.rb'
+  gem.files << Dir.glob( 'lib/subledger/store/api/**/*.rb' )
+
+  gem.files << Dir.glob( 'spec/*.rb' )
+
+  gem.files << Dir.glob( 'spec/domain/**/*.rb' )
+  gem.files << Dir.glob( 'spec/interface/**/*.rb' )
+  gem.files << Dir.glob( 'spec/store/**/*.rb' )
+
+  gem.test_files    = gem.files.grep /spec[.]rb/
+
+  gem.name          = 'subledger'
+  gem.version       = Subledger::VERSION
+
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_runtime_dependency 'multi_json', '~> 1.9.0'
+  gem.add_runtime_dependency 'grape-entity', '~> 0.4.0'
+  gem.add_runtime_dependency 'bcrypt', '~> 3.1.0'
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: subledger
+version: !ruby/object:Gem::Version
+  version: 0.7.7
+  prerelease: 
+platform: ruby
+authors:
+- Loren Hale
+- Tom Mornini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Subledger client gem
+email: admin@subledger.com
+executables:
+- subledger
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.txt
+- subledger.gemspec
+- Rakefile
+- README.md
+- bin/subledger
+- lib/subledger.rb
+- lib/subledger/actor.rb
+- lib/subledger/collection_name.rb
+- lib/subledger/domain.rb
+- lib/subledger/exception_handler.rb
+- lib/subledger/interface.rb
+- lib/subledger/path.rb
+- lib/subledger/rest.rb
+- lib/subledger/server.rb
+- lib/subledger/store.rb
+- lib/subledger/supervisor.rb
+- lib/subledger/uuid.rb
+- lib/subledger/version.rb
+- lib/subledger/domain/account.rb
+- lib/subledger/domain/balance.rb
+- lib/subledger/domain/book.rb
+- lib/subledger/domain/category.rb
+- lib/subledger/domain/control.rb
+- lib/subledger/domain/formatters.rb
+- lib/subledger/domain/identity.rb
+- lib/subledger/domain/journal_entry.rb
+- lib/subledger/domain/key.rb
+- lib/subledger/domain/line.rb
+- lib/subledger/domain/org.rb
+- lib/subledger/domain/report.rb
+- lib/subledger/domain/report_rendering.rb
+- lib/subledger/domain/roles/activatable.rb
+- lib/subledger/domain/roles/archivable.rb
+- lib/subledger/domain/roles/attributable.rb
+- lib/subledger/domain/roles/collectable.rb
+- lib/subledger/domain/roles/creatable.rb
+- lib/subledger/domain/roles/describable.rb
+- lib/subledger/domain/roles/describable_report_rendering.rb
+- lib/subledger/domain/roles/identifiable.rb
+- lib/subledger/domain/roles/postable.rb
+- lib/subledger/domain/roles/progressable.rb
+- lib/subledger/domain/roles/readable.rb
+- lib/subledger/domain/roles/restable.rb
+- lib/subledger/domain/roles/storable.rb
+- lib/subledger/domain/roles/timeable.rb
+- lib/subledger/domain/roles/updatable.rb
+- lib/subledger/domain/roles/versionable.rb
+- lib/subledger/domain/roles.rb
+- lib/subledger/domain/value/credit.rb
+- lib/subledger/domain/value/debit.rb
+- lib/subledger/domain/value/zero.rb
+- lib/subledger/domain/value.rb
+- lib/subledger/interface/client.rb
+- lib/subledger/interface/dispatcher.rb
+- lib/subledger/store/api.rb
+- lib/subledger/store/api/errors.rb
+- lib/subledger/store/api/roles/activate.rb
+- lib/subledger/store/api/roles/archive.rb
+- lib/subledger/store/api/roles/balance.rb
+- lib/subledger/store/api/roles/categories.rb
+- lib/subledger/store/api/roles/collect.rb
+- lib/subledger/store/api/roles/create.rb
+- lib/subledger/store/api/roles/create_and_post.rb
+- lib/subledger/store/api/roles/create_identity.rb
+- lib/subledger/store/api/roles/create_line.rb
+- lib/subledger/store/api/roles/first_and_last_line.rb
+- lib/subledger/store/api/roles/post.rb
+- lib/subledger/store/api/roles/progress.rb
+- lib/subledger/store/api/roles/read.rb
+- lib/subledger/store/api/roles/reports.rb
+- lib/subledger/store/api/roles/update.rb
+- lib/subledger/store/api/store.rb
+- spec/spec_helper.rb
+- spec/subledger_account_spec.rb
+- spec/subledger_book_spec.rb
+- spec/subledger_category_spec.rb
+- spec/subledger_control_spec.rb
+- spec/subledger_identity_spec.rb
+- spec/subledger_journal_entry_spec.rb
+- spec/subledger_key_spec.rb
+- spec/subledger_org_spec.rb
+- spec/subledger_report_spec.rb
+- spec/subledger_spec.rb
+homepage: http://subledger.com
+licenses:
+- BSD 3-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Ruby client gem for accessing the Subledger API
+test_files:
+- spec/subledger_account_spec.rb
+- spec/subledger_book_spec.rb
+- spec/subledger_category_spec.rb
+- spec/subledger_control_spec.rb
+- spec/subledger_identity_spec.rb
+- spec/subledger_journal_entry_spec.rb
+- spec/subledger_key_spec.rb
+- spec/subledger_org_spec.rb
+- spec/subledger_report_spec.rb
+- spec/subledger_spec.rb