codat 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c200bf7bf3b3702f186640149441c8cdb016b2078e374f8386da4f36d6d14a5a
-  data.tar.gz: 0b2409f51c5a5d6c49b3f477d8d9613a759071f207fcc0359f10b75a976b62af
+  metadata.gz: 815e3180acc27e45f704e7cd9ba4893d55774b47d6b0417020568538ba780490
+  data.tar.gz: fcb66e4ccb57663cb4a1581d53271d2faecbba03602101e1758c981327101f63
 SHA512:
-  metadata.gz: 2bb60e32a71c375260ad46d6da81505068b9a18dbdeb256674c204d56fcacd7797779109cf7c115a3fb1ce3e46d6c671df9358cf491cb9a8c15c0aa40902b71c
-  data.tar.gz: f8a0417775eefeefc554f593542f88d296e61f9dd614a015a45b1b72f3981218c6b461530f0960da6509c35d4558a4c9dc3b13d7be0d8d4b36d4ead46bc644f7
+  metadata.gz: 84e5b6c95805735f2f9429dd28f7edb3b74037796528a481ac991fadbf62148544007624b39228ada5c1747ed3adf7d933042baa76690898e8bb40134f67be91
+  data.tar.gz: be197f35c8353eeb0136159c25517ff9af4609ca9f8b055dee54d08ad96251d7b952956edfec29452f4d0fa6abc798a2cd906d5ce75d7daf9c0bff09bde6ca80

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/lib/codat.rb

@@ -7,7 +7,7 @@ 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'
 

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 if result.status == 404
+
+        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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ricardo Otero
@@ -250,8 +250,10 @@ 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/metadata.rb
 - lib/codat/models/profit_and_loss.rb
 - lib/codat/models/profit_and_loss_report.rb
 - lib/codat/models/report.rb