column_api 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73530bf2a0b110c13bd34d55231cc3e0d91ff44046221a7b74ea8ec2b380ef82
-  data.tar.gz: f41a16e9e40eff65511e43e85238708fe6c54027a8f006cdfe0d8fac8ad02533
+  metadata.gz: a503efefcfe39d720cbb939f82acfe1d564c6335746d516d75d96e7e79e35a6f
+  data.tar.gz: 012c38bed66d9f244b61be505991595c1543d3958bac7b71ed99b1074a5a84ea
 SHA512:
-  metadata.gz: e3af56a1cf2c39c8f2e073fcefb302f9aec329c6f578c63e628c10aac54b88d5ac9493b57d77a270f24895bd8578eecdac02b65848a125399c79a4b056b925ba
-  data.tar.gz: 319b6972c7d192ad2900d8f7baf805fcdfd9fd90d0ed3a77afb0724b00f4341661abd67be927a4f8757f0ec4dd9a160dcc389dd88340992280b31977becdfa39
+  metadata.gz: 9a905c02a3672a528bb39297ad1ca12d3e1969d610f2af95236c47a71fbfe1632600bcd4bfd54501d12916feb0cbd354c85e5f44d5e02a36dbb732505321064e
+  data.tar.gz: 106db37b864694cc854e0e43ab3fc7816f0b42a3c718e70e7511b701627559529a0da2d711e38bf9fba3b929ec11ee650b29246838daf7c61bd5ece99e476374

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
-## [0.1.0] - 2023-12-29
+## [0.0.4] - 2024-01-02
+
+- Add ACH Tranfer endpoints
+
+## [0.0.3] - 2024-01-02
+
+- Add Bank Account endpoints
+
+## [0.0.2] - 2023-12-31
+
+- Add Entity endpoints
+
+## [0.0.1] - 2023-12-29
 
 - Initial release
+- Add Faraday client

data/Gemfile

@@ -12,3 +12,6 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 
 gem "webmock", "~> 3.19", ">= 3.19.1"
+
+gem "simplecov", "~> 0.22", require: false, group: :test
+gem "simplecov_json_formatter"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    column_api (0.0.2)
+    column_api (0.0.4)
       faraday (~> 2.8.1)
       faraday-parse_dates (~> 0.1.1)
 
@@ -15,6 +15,7 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
+    docile (1.4.0)
     faraday (2.8.1)
       base64
       faraday-net_http (>= 2.0, < 3.1)
@@ -63,6 +64,12 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     unicode-display_width (2.5.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)
@@ -78,6 +85,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  simplecov (~> 0.22)
+  simplecov_json_formatter
   webmock (~> 3.19, >= 3.19.1)
 
 BUNDLED WITH

data/README.md

@@ -1,15 +1,15 @@
+[![Gem Version](https://badge.fury.io/rb/column_api.svg)](https://badge.fury.io/rb/column_api) [![Maintainability](https://api.codeclimate.com/v1/badges/43aa9279fa11d33f6fa3/maintainability)](https://codeclimate.com/github/matiasleidemer/column_api/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/43aa9279fa11d33f6fa3/test_coverage)](https://codeclimate.com/github/matiasleidemer/column_api/test_coverage)
+
 # ColumnApi
 
 _This gem is under development and the API is unstable._
 
-[![Gem Version](https://badge.fury.io/rb/column_api.svg)](https://badge.fury.io/rb/column_api)
-
 Ruby bindings for [Column's API](https://column.com/docs/api).
 
 ## Installation
 
 ```ruby
-gem 'column_api', '~> 0.0.2'
+gem 'column_api', '~> 0.0.4'
 ```
 
 ## Usage
@@ -17,8 +17,13 @@ gem 'column_api', '~> 0.0.2'
 ```ruby
 client = ColumnApi::Client.new(api_key: ENV["COLUMN_API_KEY"])
 
-client.entities.retrieve(entity_id: "enti_2aELWf6D")
-# => #<ColumnApi::PersonEntity documents=[], id="enti_2aELWf6D", is_root=true, type="PERSON" (...)>
+person = client.entities.retrieve(entity_id: "enti_2aELWf6D")
+person.id # => enti_2Q1ctiJm1NypVqCt8UBC8e4xTfH
+person.person_details.email # => oliver@column.com
+
+bank_accounts = client.bank_accounts.list({ limit: 2 })
+bank_accounts.data # => [#<ColumnApi::BankAccount>, #<ColumnApi::BankAccount>]
+bank_accounts.has_more # => true
 ```
 
 Alternatively, you can query the endpoints directly:
@@ -41,13 +46,38 @@ https://column.com/docs/api/#entity/object
 
 ```ruby
 client.entities.list({})
-client.entities.retrieve(entity_id: "ID")
+client.entities.retrieve(entity_id:)
 client.entities.create_person({})
 client.entities.create_business({})
 client.entities.update_person(entity_id:, params: {})
 client.entities.update_business(entity_id:, params: {})
-client.entities.delete(entity_id: "ID")
-client.entities.submit_document(entity_id: "ID", params: {})
+client.entities.delete(entity_id:)
+client.entities.submit_document(entity_id:, params: {})
+```
+
+### Bank Accounts
+
+https://column.com/docs/api/#bank-account/object
+
+```ruby
+client.bank_accounts.list({})
+client.bank_accounts.retrieve(bank_account_id:)
+client.bank_accounts.create({})
+client.bank_accounts.update(bank_account_id:, params: {})
+client.bank_accounts.delete(bank_account_id:)
+client.bank_accounts.history(bank_account_id:, from_date: Date, to_date: Date)
+```
+
+### ACH Transfers
+
+https://column.com/docs/api/#ach-transfer/object
+
+```ruby
+client.ach_transfers.list({})
+client.ach_transfers.retrieve(ach_transfer_id:)
+client.ach_transfers.create({})
+client.ach_transfers.cancel(ach_transfer_id:)
+client.ach_transfers.reverse(ach_transfer_id:, reason:, description: "")
 ```
 
 ## Development

data/lib/column_api/client.rb

@@ -10,10 +10,18 @@ module ColumnApi
       @adapter = adapter
     end
 
+    def ach_transfers
+      AchTransferResource.new(self)
+    end
+
     def entities
       EntityResource.new(self)
     end
 
+    def bank_accounts
+      BankAccountResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :basic, "", api_key

data/lib/column_api/object.rb

@@ -10,7 +10,13 @@ module ColumnApi
     end
 
     def to_ostruct(obj)
-      JSON.parse obj.to_json, object_class: OpenStruct
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
     end
   end
 end

data/lib/column_api/objects/ach_transfer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class AchTransfer < Object
+  end
+end

data/lib/column_api/objects/bank_account.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class BankAccount < Object
+  end
+end

data/lib/column_api/resource.rb

@@ -14,7 +14,7 @@ module ColumnApi
       handle_response client.connection.get(url, params, headers)
     end
 
-    def post_request(url, body:, headers: {})
+    def post_request(url, body: {}, headers: {})
       handle_response client.connection.post(url, body, headers)
     end
 

data/lib/column_api/resources/ach_transfer_resource.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class AchTransferResource < Resource
+    def list(params = {})
+      response = get_request("transfers/ach", params: params).body
+      Collection.from_response(response, key: "transfers", type: AchTransfer)
+    end
+
+    def retrieve(ach_transfer_id:)
+      AchTransfer.new get_request("transfers/ach/#{ach_transfer_id}").body
+    end
+
+    def create(params)
+      AchTransfer.new post_request("transfers/ach", body: params).body
+    end
+
+    def cancel(ach_transfer_id:)
+      AchTransfer.new post_request("transfers/ach/#{ach_transfer_id}/cancel").body
+    end
+
+    def reverse(ach_transfer_id:, reason:, description: "")
+      AchTransfer.new(
+        post_request("transfers/ach/#{ach_transfer_id}/reverse",
+                     body: { reason: reason, description: description }).body
+      )
+    end
+  end
+end

data/lib/column_api/resources/bank_account_resource.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class BankAccountResource < Resource
+    def list(params = {})
+      response = get_request("bank-accounts", params: params).body
+      Collection.from_response(response, key: "bank_accounts", type: BankAccount)
+    end
+
+    def retrieve(bank_account_id:)
+      BankAccount.new get_request("bank-accounts/#{bank_account_id}").body
+    end
+
+    def create(params)
+      BankAccount.new post_request("bank-accounts", body: params).body
+    end
+
+    def update(bank_account_id:, params:)
+      BankAccount.new patch_request("bank-accounts/#{bank_account_id}", body: params).body
+    end
+
+    def delete(bank_account_id:)
+      delete_request("bank-accounts/#{bank_account_id}")
+      true
+    end
+
+    def history(bank_account_id:, from_date:, to_date:)
+      params = { from_date: from_date.strftime("%Y-%m-%d"), to_date: to_date.strftime("%Y-%m-%d") }
+
+      BankAccount.new get_request("bank-accounts/#{bank_account_id}/history", params: params).body
+    end
+  end
+end

data/lib/column_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColumnApi
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/column_api.rb

@@ -15,9 +15,13 @@ module ColumnApi
   autoload :Resource, "column_api/resource"
 
   # Objects
+  autoload :AchTransfer, "column_api/objects/ach_transfer"
+  autoload :BankAccount, "column_api/objects/bank_account"
   autoload :BusinessEntity, "column_api/objects/business_entity"
   autoload :PersonEntity, "column_api/objects/person_entity"
 
   # Resources
+  autoload :AchTransferResource, "column_api/resources/ach_transfer_resource"
+  autoload :BankAccountResource, "column_api/resources/bank_account_resource"
   autoload :EntityResource, "column_api/resources/entity_resource"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: column_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Matias Leidemer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-31 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,9 +59,13 @@ files:
 - lib/column_api/collection.rb
 - lib/column_api/errors.rb
 - lib/column_api/object.rb
+- lib/column_api/objects/ach_transfer.rb
+- lib/column_api/objects/bank_account.rb
 - lib/column_api/objects/business_entity.rb
 - lib/column_api/objects/person_entity.rb
 - lib/column_api/resource.rb
+- lib/column_api/resources/ach_transfer_resource.rb
+- lib/column_api/resources/bank_account_resource.rb
 - lib/column_api/resources/entity_resource.rb
 - lib/column_api/version.rb
 - sig/column_api.rbs
@@ -85,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Ruby bindings for Column API