core_pro.rb 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47e1af473fc3afb70990f259b46c112f2afd2a76b0eaee62ff6e23d6a3cc48ed
-  data.tar.gz: cd00c1b26e77b9e65f5bb2622820622920c803c24ef11154212739df2e88d96e
+  metadata.gz: 130b62b258a66f45f4d37795a3d33bce4d57bbc1c0ebcf1238afe2a0e4e2bf90
+  data.tar.gz: e5bb0ab3b6da965530a0b5cbe1e8505cc2d1e16ddb3adae4564f6ada38d5201a
 SHA512:
-  metadata.gz: c839debe81fa0792059ff1a5ef41443f5d720cd4d31bec182cf700ec85f4c6a20931277d28942bb95578991aaea157a6141e50088e2d1edc71dfd3fdbb42c3dc
-  data.tar.gz: 73e433fae0e4488ec487396df6de906807c2e5327d27bc727a61256d670efd609b9d663ba0f3bffa6adbf5d2bb8eb383085842f6ac8884689ae283c449750e06
+  metadata.gz: b4a3880e631dc4a72d38f58a7f21892e5eba603e0c8c1447e0e8205deac302de3f33a5b473cf0565f14fdd988c614c18a8f30126e8429047834469bcd8d1fe7d
+  data.tar.gz: 2e029a79d634de155fb9353d650adab6ca1c245517cb7b6149b65092414feaced0c143c7e412d61db16ce4546c461bc4d00c445cd4a845c5e788d99246ae083d

data/README.md

@@ -1,6 +1,6 @@
-# CorePro API SDK
+# Helix by Q2 (ex CorePro) API SDK
 
-Ruby SDK for working with [CorePro](https://docs.corepro.io)
+Ruby SDK for working with [Helix Q2](https://docs.helix.q2.com)
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-A subset of the CorePro resources are provided with this SDK:
+A subset of the Helix/CorePro resources are provided with this SDK:
 
  * `CorePro::Program`
  * `CorePro::Customer`
@@ -34,6 +34,7 @@ These resources have implemented the following methods to allow API operations:
  * `#find`
  * `#create`
  * `#onboard(kyc_vendor)` (only for `CorePro::Customer`)
+ * `#by_tag` (only for `CorePro::Transaction`)
 
 Here's an example on how to create a customer, an account,
 and initiate a transfer:
@@ -66,10 +67,16 @@ transfer = CorePro::Transfer.create(
 )
 
 transactions = CorePro::Transaction.all(
-  customerId,
-  accountId,
-  '2021-12-21',
-  '2021-12-22'
+  [
+    customerId,
+    accountId,
+    '2021-12-21',
+    '2021-12-22'
+  ],
+  {
+    pageNumber: 0,
+    pageSize: 200
+  }
 )
 ```
 
@@ -77,9 +84,9 @@ transactions = CorePro::Transaction.all(
 
 The API keys will be loaded from your environment variables:
 
- * `COREPRO_KEY`
- * `COREPRO_SECRET`
- * `COREPRO_ENDPOINT` defaults to `https://api.corepro.io`
+ * `HELIX_KEY`
+ * `HELIX_SECRET`
+ * `HELIX_ENDPOINT` defaults to `https://api.helix.q2.com`
 
 ## Development
 

data/lib/core_pro/version.rb

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

data/lib/core_pro.rb

@@ -8,9 +8,16 @@ module CorePro
   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'])
+    endpoint(
+      ENV['COREPRO_ENDPOINT'] ||
+        ENV['HELIX_ENDPOINT'] ||
+        'https://api.helix.q2.com'
+    )
+    basic_auth(
+      user: ENV['COREPRO_KEY'] || ENV['HELIX_KEY'],
+      pass: ENV['COREPRO_SECRET'] || ENV['HELIX_SECRET']
+    )
 
     # Resource collection finder, uses the default limit
     #
@@ -43,8 +50,8 @@ module CorePro
     # @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))
+    def self.update(params = {})
+      objectify(request(:post, uri(:update), json: params))
     end
 
     # Resource constructor wrapper
@@ -52,11 +59,11 @@ module CorePro
     # @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)
+      if payload.is_a?(Hash) && payload['data'].is_a?(Array)
         return payload['data'].map { |data| new(data) }
       end
 
-      return new(payload['data']) if payload['data'].is_a?(Hash)
+      return new(payload['data']) if payload&.fetch('data', nil).is_a?(Hash)
 
       payload
     end
@@ -84,7 +91,7 @@ module CorePro
     #
     # @return [String]
     def self.extract_error(response, parsed_response)
-      parsed_response['errors'] || super(response, parsed_response)
+      parsed_response&.fetch('errors', nil) || super(response, parsed_response)
     end
 
     # Validate error response
@@ -96,7 +103,8 @@ module CorePro
     #
     # @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?
+      errors = parsed_response&.fetch('errors', nil) || []
+      !(200..299).cover?(response.code) || errors.any?
     end
   end
 
@@ -145,5 +153,14 @@ module CorePro
   # Transaction endpoint resource
   class Transaction < Resource
     path '/transaction'
+
+    # By-tag finder method
+    #
+    # @param id_or_ids [String] resource indentifiers
+    # @param params [Hash] URI parameters to pass to the endpoint.
+    # @return [Object] instance
+    def self.by_tag(*id_or_ids)
+      objectify(request(:get, uri(:getByTag, *id_or_ids)))
+    end
   end
 end

data/spec/core_pro_spec.rb

@@ -75,6 +75,53 @@ RSpec.describe CorePro::Resource do
     end
   end
 
+  describe '#update for customer', vcr: 'core_pro' do
+    it do
+      customer = CorePro::Customer.update(
+        customerId: 12_345,
+        firstName: 'James',
+        lastName: 'Bond',
+        isSubjectToBackupWithholding: false,
+        isOptedInToBankCommunication: false,
+        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'
+        ]
+      )
+
+      expect(customer.firstName).to eq('James')
+      expect(customer.lastName).to eq('Bond')
+      expect(customer.customerId).to eq(12_345)
+    end
+  end
+
+  describe '#update with errors for customer', vcr: 'core_pro_errors' do
+    it do
+      expect do
+        CorePro::Customer.update(
+          customerId: 12_345,
+          firstName: 'James'
+        )
+      end.to raise_error(
+        HTTP::RestClient::ResponseError,
+        /used during the ID Verification process is not allowed/
+      )
+    end
+  end
+
   describe '#create with errors', vcr: 'core_pro_errors' do
     let(:new_customer) do
       CorePro::Customer.create(
@@ -131,4 +178,11 @@ RSpec.describe CorePro::Resource do
       expect(new_account).to be_a(CorePro::Account)
     end
   end
+
+  describe '#error_response?', vcr: 'core_pro_errors' do
+    it do
+      expect { CorePro::Account.all }
+        .to raise_error(HTTP::RestClient::ResponseError, '502 Bad Gateway')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: core_pro.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Stas SUȘCOV
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-rest_client
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: CorePro Ruby SDK