codat 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c200bf7bf3b3702f186640149441c8cdb016b2078e374f8386da4f36d6d14a5a
-  data.tar.gz: 0b2409f51c5a5d6c49b3f477d8d9613a759071f207fcc0359f10b75a976b62af
+  metadata.gz: 0a1b2456d6687df09540e3f231fb900684a379771bece070ac5ca515070fc4b0
+  data.tar.gz: 15b72b23934fcfbfd404affa282ee004316778b69c79f3e349719a5dcd9fbb8b
 SHA512:
-  metadata.gz: 2bb60e32a71c375260ad46d6da81505068b9a18dbdeb256674c204d56fcacd7797779109cf7c115a3fb1ce3e46d6c671df9358cf491cb9a8c15c0aa40902b71c
-  data.tar.gz: f8a0417775eefeefc554f593542f88d296e61f9dd614a015a45b1b72f3981218c6b461530f0960da6509c35d4558a4c9dc3b13d7be0d8d4b36d4ead46bc644f7
+  metadata.gz: d5e4e98c94b48af0f8dbda9af71a093f3ff93e69e1b1aeabdc2bb890c9208868b87aae423ca39079f1a990f7ecfa6222b047e54e1b9578ed404ba5e002d15fc9
+  data.tar.gz: 8d70d18e2bd0de1063b0b93fe82be49d0cf4f82369fb3271e37b23c0090b2713ac52016c0ef9c78bdafa2361dfc737721802ee914ce7e7e453120cc7884a49cf

data/.gitignore

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

data/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 before_script:
   - ruby -v
   - which ruby
-  - gem install bundler --no-ri --no-rdoc
+  - gem install bundler
   - bundle install --jobs $(nproc) "${FLAGS[@]}"
 
 rspec:

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/README.md

@@ -1,5 +1,7 @@
 # Codat
 
+[![Gem Version](https://badge.fury.io/rb/codat.svg)](https://badge.fury.io/rb/codat)
+
 A simple wrapper for the [Codat](https://www.codat.io/) API. Please refer to Codat's documentation
 to complement any information you need:
 

data/bin/console

@@ -12,8 +12,8 @@ Codat.configure do |config|
 end
 
 # To avoid having to namespace everything when inside the console.
-Object.send(:include, Codat)
-Object.send(:include, Codat::Models)
+Object.include(Codat)
+Object.include(Codat::Models)
 
 require 'pry'
 Pry.start

data/codat.gemspec

@@ -25,13 +25,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5'
+
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'faraday_middleware', '~> 0.12'
   spec.add_dependency 'faraday_middleware-multi_json', '~> 0.0.6'
   spec.add_dependency 'multi_json', '~> 1.13'
   spec.add_dependency 'rainbow', '~> 3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'dotenv', '~> 2.5'
   spec.add_development_dependency 'pry-byebug', '~> 3.6'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -40,5 +42,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec', '~> 1.27'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 4.0.0'
-  spec.add_development_dependency 'webmock', '~> 3.4.2'
+  spec.add_development_dependency 'webmock', '~> 3.7.2'
 end

data/lib/codat.rb

@@ -7,9 +7,10 @@ require 'codat/client'
 require 'codat/models/bank_account'
 require 'codat/models/company'
 require 'codat/models/report'
-require 'codat/models/bank_statement'
+require 'codat/models/bank_statement_list'
 require 'codat/models/balance_sheet'
 require 'codat/models/profit_and_loss'
+require 'codat/models/integration'
 
 module Codat
   module_function

data/lib/codat/base_model.rb

@@ -39,6 +39,12 @@ module Codat
 
         formatted
       end
+
+      # As per Codat API doc
+      # https://docs.codat.io/reference/errors
+      def successful_response?(result)
+        result.status < 400
+      end
     end
 
     # Sets all the instance variables by reading the JSON from Codat and converting the keys from

data/lib/codat/models/bank_account.rb

@@ -16,7 +16,7 @@ module Codat
 
         result = get(url)
 
-        return [] if result.status == 404
+        return [] unless successful_response?(result)
 
         result.body.map { |account| new(json: account) }
       end

data/lib/codat/models/bank_statement.rb

@@ -6,24 +6,8 @@ module Codat
   module Models
     # Bank statements for a given company.
     class BankStatement < BaseModel
-      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:, account_id:, page: 1)
-        url = format_url(ENDPOINT, company_id: company_id.to_s.strip)
-
-        result = get(url, accountId: account_id.to_s.strip, page: page.to_s.strip)
-
-        return [] if result.status == 404
-
-        records = result.body.dig(:results)
-
-        return [] unless records
-
-        records.map { |bank_statement| new(json: bank_statement) }
-      end
     end
   end
 end

data/lib/codat/models/bank_statement_list.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+require 'codat/models/bank_statement'
+require 'codat/models/metadata'
+
+module Codat
+  module Models
+    # Bank statements for a given company. This endpoint will return an array of records and also
+    # metadata (page size, page number and total results).
+    class BankStatementList < BaseModel
+      ENDPOINT = '/companies/:company_id/data/bankStatements'
+
+      attr_reader :records, :metadata
+
+      def self.for(company_id:, account_id:, page: 1)
+        url = format_url(ENDPOINT, company_id: company_id.to_s.strip)
+
+        result = get(url, accountId: account_id.to_s.strip, page: page.to_s.strip)
+
+        return nil unless successful_response?(result)
+
+        new(json: result.body)
+      end
+
+      def initialize(json:)
+        super
+
+        records = json.delete(:results) || []
+
+        @records = records.map { |bank_statement| BankStatement.new(json: bank_statement) }
+
+        @metadata = Metadata.new(json: json)
+      end
+    end
+  end
+end

data/lib/codat/models/company.rb

@@ -18,9 +18,7 @@ module Codat
       def self.all(params = {})
         result = get(ENDPOINTS[:collection], params)
 
-        return [] if result.status == 404
-
-        return result.body if result.status == 400
+        return [] unless successful_response?(result)
 
         result.body[:results].map { |company| new(json: company) }
       end
@@ -30,7 +28,7 @@ module Codat
 
         result = get(url)
 
-        return nil if result.status == 404
+        return nil unless successful_response?(result)
 
         new(json: result.body)
       end
@@ -38,7 +36,7 @@ module Codat
       def self.create(params = {})
         result = post(ENDPOINTS[:collection], params)
 
-        return { error: 'An error occured.' } if result.status == 404 || result.status == 400
+        return { error: 'An error occured.' } unless successful_response?(result)
 
         new(json: result.body)
       end

data/lib/codat/models/financial_sheet.rb

@@ -36,7 +36,7 @@ module Codat
 
         result = get(url, build_query(params))
 
-        return nil if result.status == 404 || result.status == 400
+        return nil unless successful_response?(result)
 
         new(json: result.body)
       end

data/lib/codat/models/integration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+
+module Codat
+  module Models
+    class Integration < BaseModel
+      ENDPOINT = '/integrations'
+
+      attributes :key, :logo_url, :name, :enabled, :source_id, :integration_id, :source_type
+
+      def self.all(params = {})
+        result = get(ENDPOINT, params)
+
+        return [] unless successful_response?(result)
+
+        result.body.fetch(:results, []).map { |integration| new(json: integration) }
+      end
+    end
+  end
+end

data/lib/codat/models/metadata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'codat/base_model'
+
+module Codat
+  module Models
+    class Metadata < BaseModel
+      attributes :page_number, :page_size, :total_results
+    end
+  end
+end

data/lib/codat/models/report.rb

@@ -16,7 +16,7 @@ module Codat
 
         result = get(url)
 
-        return [] if result.status == 404
+        return [] unless successful_response?(result)
 
         result.body[:data].map { |report| new(json: report) }
       end

data/lib/codat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Ricardo Otero
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,16 +84,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.7.2
 description: Codat API wrapper in Ruby
 email:
 - oterosantos@gmail.com
@@ -231,7 +231,7 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -250,8 +250,11 @@ files:
 - lib/codat/models/balance_sheet_report.rb
 - lib/codat/models/bank_account.rb
 - lib/codat/models/bank_statement.rb
+- lib/codat/models/bank_statement_list.rb
 - lib/codat/models/company.rb
 - lib/codat/models/financial_sheet.rb
+- lib/codat/models/integration.rb
+- lib/codat/models/metadata.rb
 - lib/codat/models/profit_and_loss.rb
 - lib/codat/models/profit_and_loss_report.rb
 - lib/codat/models/report.rb
@@ -261,7 +264,7 @@ homepage: https://gitlab.com/finpoint/codat
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,16 +272,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: Codat API wrapper in Ruby
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1