codat 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92ae19ae782d5a282bfe31ac82a20578fe5f69c7ddf3db320580e4d23af4a511
-  data.tar.gz: c76eb6c58326f6bc12b8c6b2bdb622541e5dd93ac07c3e369af0d59b01004488
+  metadata.gz: c200bf7bf3b3702f186640149441c8cdb016b2078e374f8386da4f36d6d14a5a
+  data.tar.gz: 0b2409f51c5a5d6c49b3f477d8d9613a759071f207fcc0359f10b75a976b62af
 SHA512:
-  metadata.gz: c4f2c95fb7cdd9c33f059ea0892af826e3c9b24aeec3f01a300fbf3633d4f7a1a4dad3d6b73680035ab0fd6b669e2d4aede3cb3e66ee8de5fe6153ad7ba4f68c
-  data.tar.gz: 6548792832997f953b496bc7e108ea67f6efe334e45e06f81389ef8d6d9f29e1555bf387467b5fb72a40d0cf77c49089b920c6ca8b32c250140c213a6a0ae11d
+  metadata.gz: 2bb60e32a71c375260ad46d6da81505068b9a18dbdeb256674c204d56fcacd7797779109cf7c115a3fb1ce3e46d6c671df9358cf491cb9a8c15c0aa40902b71c
+  data.tar.gz: f8a0417775eefeefc554f593542f88d296e61f9dd614a015a45b1b72f3981218c6b461530f0960da6509c35d4558a4c9dc3b13d7be0d8d4b36d4ead46bc644f7

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -1,5 +1,12 @@
 # Codat
 
+A simple wrapper for the [Codat](https://www.codat.io/) API. Please refer to Codat's documentation
+to complement any information you need:
+
+* [Codat API reference](https://docs.codat.io/)
+* [Codat API explorer](https://api-uat.codat.io/swagger/ui/index) (to use this you need to have
+  access to the UAT portal).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,50 +30,50 @@ Or install it yourself as:
 To get a list of bank accounts:
 
 ```ruby
-list = BankAccount.all(company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac')
+BankAccount.all(company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac')
 # => []
 ```
 
-### Financial financials
+### Financial reports
 
-To get a financial reports - profit & loss:
+To get a financial report - profit & loss:
 
 ```ruby
-list = Financial.profit_and_loss(
-    company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac',
-    period_length: '2',
-    periods_to_compare: '2'
+ProfitAndLoss.find(
+  company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac',
+  period_length: 12,
+  periods_to_compare: 2
 )
 # => []
 ```
 
-To get a financial reports - balance sheet:
+To get a financial report - balance sheet:
 
 ```ruby
-list = BankAccount.balance_sheet(
-    company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac',
-    period_length: period_length,
-    periods_to_compare: periods_to_compare
+BalanceSheet.find(
+  company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac',
+  period_length: 12,
+  periods_to_compare: 2
 )
 ```
 
-### Company companies
+### Companies
 
 To get a list of companies (paginated):
 
 ```ruby
-list = Company.all(page: '1')
+Company.all(page: 1)
 # => []
 ```
 
 To create a company:
 
 ```ruby
-response = Company.create(name: 'company name')
+Company.create(name: 'company name')
 # => {}
 ```
 
-### Report reports
+### Report
 
 To get a list of reports for aged debtor:
 
@@ -75,7 +82,7 @@ list = Report.all(company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac')
 # => []
 ```
 
-### BankStatement bankStatements
+### BankStatement
 
 To get a list of bank statements:
 
@@ -86,9 +93,14 @@ list = BankStatement.all(company_id: 'a49b891d-a593-43aa-bb82-0d8b108eb3ac')
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/codat.rb

@@ -5,10 +5,11 @@ require 'codat/configuration'
 require 'codat/client'
 
 require 'codat/models/bank_account'
-require 'codat/models/financial'
 require 'codat/models/company'
 require 'codat/models/report'
 require 'codat/models/bank_statement'
+require 'codat/models/balance_sheet'
+require 'codat/models/profit_and_loss'
 
 module Codat
   module_function

data/lib/codat/errors.rb

@@ -7,9 +7,6 @@ module Codat
   class GenericError < StandardError
   end
 
-  class CompanyNotProvidedError < StandardError
-  end
-
   class InvalidRequestError < StandardError
   end
 end

data/lib/codat/models/balance_sheet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+require 'codat/models/balance_sheet_report'
+require 'codat/models/financial_sheet'
+
+module Codat
+  module Models
+    class BalanceSheet < FinancialSheet
+      endpoint '/companies/:company_id/data/financials/balanceSheet'
+
+      # attributes :currency, :most_recent_available_month, :earliest_available_month
+
+      report_class BalanceSheetReport
+    end
+  end
+end

data/lib/codat/models/balance_sheet_report.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'codat/base_model'
+require 'codat/models/report_item'
+
+module Codat
+  module Models
+    class BalanceSheetReport < BaseModel
+      attributes :date, :net_assets
+
+      attr_accessor :assets, :liabilities, :equity
+
+      def initialize(json: {})
+        super
+
+        @assets = ReportItem.new(json: json.fetch(:assets, {}))
+        @liabilities = ReportItem.new(json: json.fetch(:liabilities, {}))
+        @equity = ReportItem.new(json: json.fetch(:equity, {}))
+      end
+
+      def date
+        Date.parse(@date)
+      end
+    end
+  end
+end

data/lib/codat/models/bank_statement.rb

@@ -6,21 +6,23 @@ module Codat
   module Models
     # Bank statements for a given company.
     class BankStatement < BaseModel
-      ENDPOINT = '/companies/:company_id/data/bankStatements/accounts'
+      ENDPOINT = '/companies/:company_id/data/bankStatements'
 
       attributes :id, :date, :description, :reconciled, :amount, :balance, :transaction_type
       attributes :modified_date, :source_modifiedDate
 
-      def self.all(company_id:)
-        url = format_url(
-          ENDPOINT, company_id: company_id.to_s.strip
-        )
+      def self.all(company_id:, account_id:, page: 1)
+        url = format_url(ENDPOINT, company_id: company_id.to_s.strip)
 
-        result = get(url)
+        result = get(url, accountId: account_id.to_s.strip, page: page.to_s.strip)
 
         return [] if result.status == 404
 
-        result.body.map { |bank_statement| new(json: bank_statement) }
+        records = result.body.dig(:results)
+
+        return [] unless records
+
+        records.map { |bank_statement| new(json: bank_statement) }
       end
     end
   end

data/lib/codat/models/company.rb

@@ -6,13 +6,17 @@ module Codat
   module Models
     # Companies for a given company.
     class Company < BaseModel
-      ENDPOINT = '/companies'
+      ENDPOINTS = {
+        collection: '/companies',
+        single: '/companies/:company_id'
+      }.freeze
 
       attributes :id, :name, :platform, :redirect, :status, :last_sync, :data_connections
       attributes :integration_id, :source_id, :platform_name, :link_url
 
+      # Returns the list of companies in the Codat account.
       def self.all(params = {})
-        result = get(ENDPOINT, params)
+        result = get(ENDPOINTS[:collection], params)
 
         return [] if result.status == 404
 
@@ -21,10 +25,18 @@ module Codat
         result.body[:results].map { |company| new(json: company) }
       end
 
-      def self.create(params = {})
-        url = format_url(ENDPOINT, {})
+      def self.find(company_id)
+        url = format_url(ENDPOINTS[:single], company_id: company_id)
+
+        result = get(url)
 
-        result = post(url, params)
+        return nil if result.status == 404
+
+        new(json: result.body)
+      end
+
+      def self.create(params = {})
+        result = post(ENDPOINTS[:collection], params)
 
         return { error: 'An error occured.' } if result.status == 404 || result.status == 400
 

data/lib/codat/models/financial_sheet.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Codat
+  module Models
+    class FinancialSheet < BaseModel
+      # Default period length (months)
+      DEFAULT_PERIOD_LENGTH = 12
+
+      # Default number of periods to compare
+      DEFAULT_PERIODS_TO_COMPARE = 2
+
+      attr_reader :reports
+
+      def self.inherited(other)
+        other.attributes :currency, :most_recent_available_month, :earliest_available_month
+      end
+
+      # Finds the latest financial sheet for a company. This can be a balance sheet or a profit and
+      # loss document.
+      #
+      # Params are listed below:
+      #  * company_id - the company ID from Codat
+      #  * period_length - the number of months to get
+      #  * periods_to_compare - how many periods (of period_length size) you want
+      #  * start_month (optional) - starting in which month (date)
+      #
+      # An ArgumentError is raised unless you provide a :company_id key in the params.
+      def self.find(params = {})
+        company_id = params.dig(:company_id)
+
+        raise ArgumentError, 'please provide company_id' unless company_id
+
+        url = format_url(@endpoint, company_id: company_id.to_s.strip)
+
+        result = get(url, build_query(params))
+
+        return nil if result.status == 404 || result.status == 400
+
+        new(json: result.body)
+      end
+
+      def self.build_query(params)
+        options = params.dup
+
+        query = {
+          periodLength: options.fetch(:period_length, DEFAULT_PERIOD_LENGTH),
+          periodsToCompare: options.fetch(:periods_to_compare, DEFAULT_PERIODS_TO_COMPARE)
+        }
+
+        options = options.map { |key, value| [Camelizer.transform(key), value] }.to_h
+
+        query.merge(options)
+      end
+
+      def self.report_class(report_class = nil)
+        return @report_class unless report_class
+
+        @report_class = report_class
+      end
+
+      def self.endpoint(endpoint = nil)
+        return @endpoint unless endpoint
+
+        @endpoint = endpoint
+      end
+
+      def initialize(json: {})
+        super
+
+        @most_recent_available_month = Date.parse(json.dig(:mostRecentAvailableMonth))
+        @earliest_available_month = Date.parse(json.dig(:earliestAvailableMonth))
+
+        reports_json = json.fetch(:reports, {})
+        @reports = reports_json.map { |report| self.class.report_class.new(json: report) }
+      end
+    end
+  end
+end

data/lib/codat/models/profit_and_loss.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+require 'codat/models/profit_and_loss_report'
+require 'codat/models/financial_sheet'
+
+module Codat
+  module Models
+    class ProfitAndLoss < FinancialSheet
+      endpoint '/companies/:company_id/data/financials/profitAndLoss'
+
+      attributes :report_basis
+
+      report_class ProfitAndLossReport
+    end
+  end
+end

data/lib/codat/models/profit_and_loss_report.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'codat/base_model'
+require 'codat/models/report_item'
+
+module Codat
+  module Models
+    class ProfitAndLossReport < BaseModel
+      attributes :from_date, :to_date, :gross_profit, :net_other_income, :net_profit
+      attributes :net_operating_profit
+
+      attr_accessor :income, :cost_of_sales, :expenses, :other_expenses, :other_income
+
+      def initialize(json: {})
+        super
+
+        @from_date = Date.parse(json.fetch(:fromDate))
+        @to_date = Date.parse(json.fetch(:toDate))
+
+        @income = ReportItem.new(json: json.fetch(:income, {}))
+        @cost_of_sales = ReportItem.new(json: json.fetch(:costOfSales, {}))
+        @expenses = ReportItem.new(json: json.fetch(:expenses, {}))
+        @other_expenses = ReportItem.new(json: json.fetch(:otherExpenses, {}))
+        @other_income = ReportItem.new(json: json.fetch(:otherIncome, {}))
+      end
+    end
+  end
+end

data/lib/codat/models/report_item.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+
+module Codat
+  module Models
+    # A report item can be present in BalanceSheetReport or ProfitAndLossReport.
+    class ReportItem < BaseModel
+      attributes :account_id, :name, :value
+
+      attr_accessor :items
+
+      def initialize(json: {})
+        super
+
+        # The items can have an array of items inside. It's weird, but this happens a lot.
+        items_json = json.fetch(:items, [])
+        @items = items_json.map { |item| ReportItem.new(json: item) }
+      end
+    end
+  end
+end

data/lib/codat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Codat
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-29 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -233,7 +233,6 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -247,11 +246,16 @@ files:
 - lib/codat/configuration.rb
 - lib/codat/errors.rb
 - lib/codat/faraday_codat_auth.rb
+- lib/codat/models/balance_sheet.rb
+- lib/codat/models/balance_sheet_report.rb
 - lib/codat/models/bank_account.rb
 - lib/codat/models/bank_statement.rb
 - lib/codat/models/company.rb
-- lib/codat/models/financial.rb
+- lib/codat/models/financial_sheet.rb
+- lib/codat/models/profit_and_loss.rb
+- lib/codat/models/profit_and_loss_report.rb
 - lib/codat/models/report.rb
+- lib/codat/models/report_item.rb
 - lib/codat/version.rb
 homepage: https://gitlab.com/finpoint/codat
 licenses:

data/Gemfile.lock

@@ -1,104 +0,0 @@
-PATH
-  remote: .
-  specs:
-    codat (0.1.1)
-      faraday (~> 0.15)
-      faraday_middleware (~> 0.12)
-      faraday_middleware-multi_json (~> 0.0.6)
-      multi_json (~> 1.13)
-      rainbow (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    byebug (10.0.2)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    dotenv (2.5.0)
-    faraday (0.15.3)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
-      faraday (>= 0.7.4, < 1.0)
-    faraday_middleware-multi_json (0.0.6)
-      faraday_middleware
-      multi_json
-    hashdiff (0.3.7)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    method_source (0.9.0)
-    multi_json (1.13.1)
-    multipart-post (2.0.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    public_suffix (3.0.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.59.2)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.29.1)
-      rubocop (>= 0.58.0)
-    ruby-progressbar (1.10.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
-    vcr (4.0.0)
-    webmock (3.4.2)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  codat!
-  dotenv (~> 2.5)
-  pry-byebug (~> 3.6)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.58)
-  rubocop-rspec (~> 1.27)
-  simplecov (~> 0.16)
-  vcr (~> 4.0.0)
-  webmock (~> 3.4.2)
-
-BUNDLED WITH
-   1.16.1

data/lib/codat/models/financial.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'codat/base_model'
-
-module Codat
-  module Models
-    # Financials for a given company.
-    class Financial < BaseModel
-      ENDPOINT = {
-        profit_and_loss: '/companies/:company_id/data/financials/profitAndLoss',
-        balance_sheet: '/companies/:company_id/data/financials/balanceSheet'
-      }.freeze
-
-      attributes :from_date, :to_date, :income, :account_id, :name, :value, :items
-      attributes :cost_of_sales, :gross_profit, :expenses, :net_operating_profit, :other_expenses
-      attributes :other_income, :net_other_income, :net_profit
-
-      def self.profit_and_loss(params = {})
-        company_id = params.delete(:company_id)
-
-        raise CompanyNotProvidedError if company_id.nil? || company_id.empty?
-
-        url = format_url(
-          ENDPOINT[:profit_and_loss],
-          company_id: company_id.to_s.strip
-        )
-
-        params = params.map { |key, value| [Camelizer.transform(key), value] }.to_h
-
-        result = get(url, params)
-
-        return [] if result.status == 404 || result.status == 400
-
-        result.body[:reports].map { |report| new(json: report) }
-      end
-
-      def self.balance_sheet(params = {})
-        company_id = params.delete(:company_id)
-
-        raise CompanyNotProvidedError if company_id.nil? || company_id.empty?
-
-        url = format_url(
-          ENDPOINT[:balance_sheet],
-          company_id: company_id.to_s.strip
-        )
-
-        params.delete(:company_id)
-        params = params.map { |key, value| [Camelizer.transform(key), value] }.to_h
-
-        result = get(url, params)
-
-        return [] if result.status == 404 || result.status == 400
-
-        result.body[:reports].map { |report| new(json: report) }
-      end
-    end
-  end
-end