core_pro.rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47e1af473fc3afb70990f259b46c112f2afd2a76b0eaee62ff6e23d6a3cc48ed
+  data.tar.gz: cd00c1b26e77b9e65f5bb2622820622920c803c24ef11154212739df2e88d96e
+SHA512:
+  metadata.gz: c839debe81fa0792059ff1a5ef41443f5d720cd4d31bec182cf700ec85f4c6a20931277d28942bb95578991aaea157a6141e50088e2d1edc71dfd3fdbb42c3dc
+  data.tar.gz: 73e433fae0e4488ec487396df6de906807c2e5327d27bc727a61256d670efd609b9d663ba0f3bffa6adbf5d2bb8eb383085842f6ac8884689ae283c449750e06

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Stas Suscov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# CorePro API SDK
+
+Ruby SDK for working with [CorePro](https://docs.corepro.io)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'core_pro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install core_pro
+
+## Usage
+
+A subset of the CorePro resources are provided with this SDK:
+
+ * `CorePro::Program`
+ * `CorePro::Customer`
+ * `CorePro::Account`
+ * `CorePro::ExternalAccount`
+ * `CorePro::Transfer`
+ * `CorePro::Transaction`
+
+These resources have implemented the following methods to allow API operations:
+ * `#all`
+ * `#find`
+ * `#create`
+ * `#onboard(kyc_vendor)` (only for `CorePro::Customer`)
+
+Here's an example on how to create a customer, an account,
+and initiate a transfer:
+```ruby
+require 'core_pro'
+
+customer = CorePro::Customer.create(
+  firstName: 'James',
+  lastName: 'Bond',
+  isSubjectToBackupWithholding: false,
+  isOptedInToBankCommunication: false,
+  isDocumentsAccepted: true
+).reload
+
+customer.onboard(:socure)
+
+old_account = CorePro::Account.find(customer.customerId, <OLD_ACCOUNT_ID>)
+
+account = CorePro::Account.create(
+  customerId: customer.customerId,
+  name: 'Test',
+  productId: <PRODUCT_ID>
+)
+
+transfer = CorePro::Transfer.create(
+  amount: 1.0,
+  customerId: customer.customerId,
+  fromId: old_account.accountId,
+  toId: account.accountId
+)
+
+transactions = CorePro::Transaction.all(
+  customerId,
+  accountId,
+  '2021-12-21',
+  '2021-12-22'
+)
+```
+
+### Configuration
+
+The API keys will be loaded from your environment variables:
+
+ * `COREPRO_KEY`
+ * `COREPRO_SECRET`
+ * `COREPRO_ENDPOINT` defaults to `https://api.corepro.io`
+
+## Development
+
+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
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/HeyBetter/core_pro. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/lib/core_pro/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CorePro
+  VERSION = '0.0.1'
+end

data/lib/core_pro.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'http/rest_client'
+
+# CorePro HTTP API Client
+module CorePro
+  # Base endpoint resources class
+  class Resource < OpenStruct
+    extend HTTP::RestClient::DSL
+
+    endpoint(ENV['COREPRO_ENDPOINT'] || 'https://api.corepro.io')
+    content_type 'application/json'
+    basic_auth(user: ENV['COREPRO_KEY'], pass: ENV['COREPRO_SECRET'])
+
+    # Resource collection finder, uses the default limit
+    #
+    # @param filters [Array] URI filters to pass to the endpoint.
+    # @param params [Hash] URI parameters to pass to the endpoint.
+    # @return [Array] of [Object] instances
+    def self.all(filters = [], params = {})
+      objectify(request(:get, uri(:list, *filters), params: params))
+    end
+
+    # Resource finder
+    #
+    # @param id [String] resource indentifier
+    # @param params [Hash] URI parameters to pass to the endpoint.
+    # @return [Object] instance
+    def self.find(*id_or_ids)
+      objectify(request(:get, uri(:get, *id_or_ids)))
+    end
+
+    # Resource creation helper
+    #
+    # @param params [Hash] request parameters to pass to the endpoint as JSON.
+    # @return [Object] instance
+    def self.create(params = {})
+      objectify(request(:post, uri(:create), json: params))
+    end
+
+    # Resource update helper
+    #
+    # @param id [String] resource indentifier
+    # @param params [Hash] request parameters to pass to the endpoint as JSON.
+    # @return [Object] instance
+    def self.update(id, params = {})
+      objectify(request(:patch, uri(:update, id), json: params))
+    end
+
+    # Resource constructor wrapper
+    #
+    # @param payload [Hash] response payload to build a resource.
+    # @return [Object] instance or a list of instances.
+    def self.objectify(payload)
+      if payload['data'].is_a?(Array)
+        return payload['data'].map { |data| new(data) }
+      end
+
+      return new(payload['data']) if payload['data'].is_a?(Hash)
+
+      payload
+    end
+
+    # Returns the ID name based on the resource type
+    #
+    # @return [String]
+    def resource_id
+      resource_name = self.class.name.to_s.split('::').last
+      resource_name[0] = resource_name[0].downcase
+      "#{resource_name}Id"
+    end
+
+    # Helper to reload a resource
+    #
+    # @return [CorePro::Resource]
+    def reload
+      self.class.find(send(resource_id))
+    end
+
+    # Extracts the error message from the response
+    #
+    # @param response [HTTP::Response] the server response
+    # @param parsed_response [Object] the parsed server response
+    #
+    # @return [String]
+    def self.extract_error(response, parsed_response)
+      parsed_response['errors'] || super(response, parsed_response)
+    end
+
+    # Validate error response
+    #
+    # Looks at the response code by default.
+    #
+    # @param response [HTTP::Response] the server response
+    # @param parsed_response [Object] the parsed server response
+    #
+    # @return [TrueClass] if status code is not a successful standard value
+    def self.error_response?(response, parsed_response)
+      !(200..299).cover?(response.code) && parsed_response['errors'].any?
+    end
+  end
+
+  # Customer endpoint resource
+  class Program < Resource
+    path '/program'
+  end
+
+  # Customer endpoint resource
+  class Customer < Resource
+    path '/customer'
+
+    # Performs a customer KYC/onboarding
+    #
+    # See: https://docs.corepro.io/reference#4-run-kyc-on-the-customer
+    #
+    # @return [Customer] instance
+    def onboard(kyc_vendor)
+      onboard_uri = self.class.uri(:onboard, kyc_vendor, :all)
+
+      self.class.objectify(
+        self.class.request(
+          :post,
+          onboard_uri,
+          json: { customerId: customerId }
+        )
+      )
+    end
+  end
+
+  # Accounts endpoint resource
+  class Account < Resource
+    path '/account'
+  end
+
+  # External account endpoint resource
+  class ExternalAccount < Resource
+    path '/externalAccount'
+  end
+
+  # Transfer endpoint resource
+  class Transfer < Resource
+    path '/transfer'
+  end
+
+  # Transaction endpoint resource
+  class Transaction < Resource
+    path '/transaction'
+  end
+end

data/spec/core_pro_spec.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe CorePro::Resource do
+  describe '#all', vcr: 'core_pro' do
+    let(:customers) do
+      CorePro::Customer.all({})
+    end
+
+    it do
+      expect(customers).not_to be_empty
+      expect(customers.size).to eq(2)
+
+      customer = customers.first
+
+      expect(customer.firstName).to eq('James')
+      expect(customer.customerId).to eq(12_345)
+
+      expect(customer).to be_a(CorePro::Customer)
+    end
+  end
+
+  describe '#onboard', vcr: 'core_pro' do
+    let(:customer) do
+      CorePro::Customer.find(12_345)
+    end
+
+    it do
+      expect(customer).not_to be_nil
+
+      updated_customer = customer.onboard(:socure)
+
+      expect(updated_customer.customerId).to eq(12_345)
+      expect(updated_customer.kyc['status']).to eq('Verified')
+      expect(updated_customer.ofac['status']).to eq('Verified')
+    end
+  end
+
+  describe '#create for a new customer', vcr: 'core_pro' do
+    let(:new_customer) do
+      CorePro::Customer.create(
+        firstName: 'James',
+        lastName: 'Bond',
+        isSubjectToBackupWithholding: false,
+        isOptedInToBankCommunication: false,
+        isDocumentsAccepted: true,
+        birthDate: '1987-07-27',
+        taxId: '498931947',
+        emailAddress: 'stas@startuplandia.io',
+        phones: [
+          {
+            number: '+16502530000',
+            phoneType: 'Mobile'
+          }
+        ],
+        addresses: [
+          addressLine1: '4017 Buffalo Ave',
+          addressType: 'Residence',
+          city: 'Buffalo',
+          country: 'US',
+          postalCode: '94043',
+          state: 'NY'
+        ]
+      ).reload
+    end
+
+    it do
+      expect(new_customer).not_to be_nil
+      expect(new_customer.firstName).to eq('James')
+      expect(new_customer.lastName).to eq('Bond')
+      expect(new_customer.customerId).not_to be_nil
+
+      expect(new_customer).to be_a(CorePro::Customer)
+    end
+  end
+
+  describe '#create with errors', vcr: 'core_pro_errors' do
+    let(:new_customer) do
+      CorePro::Customer.create(
+        lastName: 'Bond',
+        isSubjectToBackupWithholding: false,
+        isOptedInToBankCommunication: false,
+        isDocumentsAccepted: true
+      ).reload
+    end
+
+    it do
+      expect { new_customer }.to raise_error(
+        HTTP::RestClient::ResponseError,
+        /First Name is a required field/
+      )
+    end
+  end
+
+  describe '#all for accounts', vcr: 'core_pro' do
+    let(:accounts) do
+      CorePro::Account.all([12_345], {})
+    end
+
+    it do
+      expect(accounts).not_to be_empty
+      expect(accounts.size).to eq(1)
+
+      account = accounts.first
+
+      expect(account.name).to eq('Test')
+      expect(account.customerId).to eq(12_345)
+      expect(account.externalAccountId).to eq(9_876)
+
+      expect(account).to be_a(CorePro::Account)
+    end
+  end
+
+  describe '#create for a new account', vcr: 'core_pro' do
+    let(:new_account) do
+      CorePro::Account.create(
+        name: 'Test',
+        customerId: 12_345,
+        productId: 98_765
+      )
+    end
+
+    it do
+      expect(new_account).not_to be_nil
+
+      expect(new_account.name).to eq('Test')
+      expect(new_account.customerId).to eq(12_345)
+      expect(new_account.accountId).not_to be_nil
+
+      expect(new_account).to be_a(CorePro::Account)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simplecov'
+require 'vcr'
+
+SimpleCov.start do
+  add_group 'Lib', 'lib'
+  add_group 'Tests', 'spec'
+end
+SimpleCov.minimum_coverage 90
+
+VCR.configure do |config|
+  config.configure_rspec_metadata!
+  config.cassette_library_dir = 'vcr_cassettes'
+  config.hook_into :webmock
+  config.default_cassette_options = {
+    record: :new_episodes
+  }
+
+  %w[COREPRO_ENDPOINT COREPRO_KEY COREPRO_SECRET].each do |pkey|
+    ENV[pkey] ||= 'secret'
+    config.filter_sensitive_data("<#{pkey}>") { ENV[pkey] }
+  end
+
+  config.filter_sensitive_data('<AUTH_TOKEN>') do |interaction|
+    auth_headers = interaction.request.headers['Authorization'] || []
+    auth_headers.first.to_s.split.last
+  end
+end
+
+require 'core_pro'
+
+RSpec.configure do |config|
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+  config.filter_run_when_matching :focus
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: core_pro.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stas SUȘCOV
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby SDK for working with CorePro web services.
+email:
+- stas@nerd.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/core_pro.rb
+- lib/core_pro/version.rb
+- spec/core_pro_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/HeyBetter/core_pro
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: CorePro Ruby SDK
+test_files: []