unit_ruby_sdk 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c537218faa351239ef177faffa0c2b9de8d40eebf52eb3608b55e76dc89746a
-  data.tar.gz: aee02b9bca0da9370d687d5e374e1210198f7224e4834e585d32998fb3a74582
+  metadata.gz: 14fc2502ef67bd580d1fb1d8ed06af33d22d99161bce1fa79ea98ac7acc9dad6
+  data.tar.gz: c0df3342ca09be9cb8f3ded2ff6717f188620716b0a8118b7850a19143b0ab4e
 SHA512:
-  metadata.gz: 30b0e0991cb6d0e291c0d6af7b4a8448ee293e06d06b1e7f2dac9b39b189807879eff0f048f788c41fc49045cd593dd319ee74e7c42fc7ec884c1495a3f45f8c
-  data.tar.gz: 0fbae70cf0069a97e19ab5bbf5284fe802f9355879e30f15484e63b13b67a56f5e141dfde7c2ed0f4b17298b4b618498e8f594239897c0e7ea3bc0b530981dbb
+  metadata.gz: 1270a0a50b9e23a8608716098ea341708a18233d290e124416aed5be9a564a28e4c4d7b4f1c59a8224e74ae54746dc51c3908bdf1bb790df79dc810ba173602f
+  data.tar.gz: 5f4fac2c94ec93621ca4541ebc9c80a1bc0f2c0590f8503a1133d7b4fe437b783c0488ea42665f771d212c7959ac91837229f7917eec148ea7246e272a78a066

data/.rubocop.yml

@@ -30,5 +30,8 @@ Layout/LineLength:
 Style/ClassVars:
   Enabled: false
 
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false

data/Gemfile

@@ -4,13 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in unit-ruby-sdk.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rubocop", "~> 1.21"
-
-gem "httparty", "~0.20.0"
-
-gem "ruby-debug-ide"
-
-gem "factory_bot_rails", "~> 6.2.0"

data/README.md

@@ -1 +1,97 @@
-# unit-ruby-sdk
+# unit_ruby_sdk
+
+This gem provides a ruby wrapper for [Unit's API](https://docs.unit.co/#introduction).
+
+## Documentation
+
+See [Unit's Docs](https://docs.unit.co)
+
+## Installation
+
+```bash
+gem install unit_ruby_sdk
+```
+
+## Usage
+
+### Creating a Business Application
+
+```ruby
+require 'unit_ruby_sdk'
+
+Unit.config(api_url: ENV['API_URL'], token: ENV['TOKEN'])
+
+full_name = Unit::Types::FullName.new('John', 'Doe')
+date_of_birth = '1980-08-10'
+address = Unit::Types::Address.new('123 Main St', 'San Francisco', 'CA', '94205', 'US')
+phone = Unit::Types::Phone.new('380', '555123222')
+email = 'jone.doe@unit-finance.com'
+ssn = '123456789'
+beneficial_owner = Unit::Types::BeneficialOwner.new(full_name, date_of_birth, address, phone, email, ssn)
+
+response = Unit::Application.create_business_application(
+  name: "Acme Inc.",
+  address: address,
+  phone: phone,
+  state_of_incorporation: "CA",
+  ein: '123456789',
+  industry: "Retail",
+  contact: Unit::Types::BusinessContact.new(full_name, email, phone),
+  officer: Unit::Types::Officer.new(full_name, date_of_birth, address, phone, email, ssn),
+  beneficial_owners: [beneficial_owner, beneficial_owner],
+  entity_type: 'LLC'
+)
+
+application = response.data
+
+puts application.id
+```
+
+### Fetching a Customer
+
+```ruby
+require 'unit_ruby_sdk'
+
+Unit.config(api_url: ENV['API_URL'], token: ENV['TOKEN'])
+
+customer = Unit::Customer.list_customers.first
+puts customer.id
+```
+
+### 
+### Creating a Payment
+    
+```ruby
+require 'unit_ruby_sdk'
+
+response = Unit::Payment.create_book_payment(
+  amount: 10000,
+  description: 'Payment for order #123',
+  relationships: { account: Unit::Types::Relationship.new("depositAccount", "12345").to_hash,
+                   counterpartyAccount: Unit::Types::Relationship.new("depositAccount", "36221").to_hash }
+)
+payment = response.data
+puts payment.id
+```
+
+### Get a transaction by id
+
+```ruby
+response = Unit::Transaction.get_transaction(transaction_id: '12345', account_id: '72345')
+transaction = response.data
+puts transaction.id
+```
+
+### Logging Errors
+
+```ruby
+require 'unit_ruby_sdk'
+
+Unit.config(api_url: ENV['API_URL'], token: "missing token")
+
+# response is a Unit::UnitError
+response = Unit::Application.get_application('123')
+
+# Prints "Bearer token is missing"
+response.errors.each{|error| puts error.title}
+```

data/lib/unit/api_resources/account_resource.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating request for accounts to Unit API and parsing responses
+# @see https://docs.unit.co/#accounts
+module Unit
+  module Resource
+    class AccountResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new account by calling Unit's API
+        # @param request [CreateDepositAccountRequest] request
+        # @return [UnitResponse, UnitError]
+        def create_account(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/accounts", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Close an account by calling Unit's API
+        # @param request [CloseDepositAccountRequest] request
+        # @return [UnitResponse, UnitError]
+        def close_account(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/accounts/#{request.account_id}/close", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Reopen an account by calling Unit's API
+        # @param account_id [String]
+        # @param reason [String]
+        # @return [UnitResponse, UnitError]
+        def reopen_account(account_id)
+          response = HttpHelper.post("#{api_url}/accounts/#{account_id}/reopen", headers: headers)
+          response_handler(response)
+        end
+
+        # Freeze an account by calling Unit's API
+        # @param request [FreezeAccountRequest]
+        # @return [UnitResponse, UnitError]
+        def freeze_account(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/accounts/#{request.account_id}/freeze", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Unfreeze an account by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def unfreeze_account(account_id)
+          response = HttpHelper.post("#{api_url}/accounts/#{account_id}/unfreeze", headers: headers)
+          response_handler(response)
+        end
+
+        # Get account by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_account(account_id)
+          response = HttpHelper.get("#{api_url}/accounts/#{account_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # List accounts by calling Unit's API
+        # @param params [ListAccountParams] - optional
+        # @return [UnitResponse, UnitError]
+        def list_accounts(params = nil)
+          response = HttpHelper.get("#{api_url}/accounts", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Update account by calling Unit's API
+        # @param request [PatchDepositAccountRequest]
+        def update_account(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/accounts/#{request.account_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Limit account by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def limits(account_id)
+          response = HttpHelper.get("#{api_url}/accounts/#{account_id}/limits", headers: headers)
+          response_handler(response)
+        end
+
+        # Get deposit products by calling Unit's API
+        # @param account_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_deposit_products(account_id)
+          response = HttpHelper.get("#{api_url}/accounts/#{account_id}/deposit-products", headers: headers)
+          response_handler(response)
+        end
+
+        # Get account balance history by calling Unit's API
+        # @param params [BalanceHistoryRequest]
+        # @return [UnitResponse, UnitError]
+        def get_account_balance_history(params)
+          response = HttpHelper.get("#{api_url}/account-end-of-day", params: params.to_hash.to_json, headers: headers)
+          response_handler(response)
+        end
+
+        # Add account owners by calling Unit's API
+        # @param request [AccountOwnersRequest]
+        # @return [UnitResponse, UnitError]
+        def add_owners(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/accounts/#{request.account_id}/relationships/customers", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Remove account owners by calling Unit's API
+        # @param request [AccountOwnersRequest]
+        # @return [UnitResponse, UnitError]
+        def remove_owners(request)
+          payload = request.to_json_api
+          response = HttpHelper.delete("#{api_url}/accounts/#{request.account_id}/relationships/customers", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/api_token_resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+
+# class for creating new API tokens' requests
+# @see https://docs.unit.co/org-api-tokens
+# @see https://docs.unit.co/customer-api-tokens
+module Unit
+  module Resource
+    class ApiTokenResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new Org API api_token by calling Unit's API
+        # @param request [CreateApiTokenRequest]
+        # @return [UnitResponse, UnitError]
+        def create_org_api_token(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/users/#{request.user_id}/api-tokens", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get Org API tokens by calling Unit's API
+        # @param user_id [String]
+        # @return [UnitResponse, UnitError]
+        def list_org_tokens(user_id)
+          response = HttpHelper.get("#{api_url}/users/#{user_id}/api-tokens", headers: headers)
+          response_handler(response)
+        end
+
+        # Revoke Org API api_token by calling Unit's API
+        # @param user_id [String]
+        # @param token_id [String]
+        # @return [UnitResponse, UnitError]
+        def revoke_org_token(user_id, token_id)
+          response = HttpHelper.delete("#{api_url}/users/#{user_id}/api-tokens/#{token_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # Create customer token by calling Unit's API
+        # @param [CreateCustomerTokenRequest, CreateCustomerTokenUsingJwtRequest] request
+        # @return [UnitResponse, UnitError]
+        def create_customer_token(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/customers/#{request.customer_id}/token", headers: headers, body: payload)
+          response_handler(response)
+        end
+
+        # Create customer token verification by calling Unit's API
+        # @param [CreateCustomerTokenVerification] request
+        # @return [UnitResponse, UnitError]
+        def create_token_verification(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/customers/#{request.customer_id}/token/verification", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/application_resource.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "httparty"
 require_relative "./base_resource"
+require_relative "../utils/http_helper"
 require "json"
 # class for creating requests for applications to Unit API and parsing responses
-# See: https://docs.unit.co/applications
+# @see https://docs.unit.co/applications
 module Unit
   module Resource
     class ApplicationResource < Unit::Resource::BaseResource
@@ -14,23 +14,23 @@ module Unit
         # @return [UnitResponse, UnitError]
         def create_application(request)
           payload = request.to_json_api
-          response = HTTParty.post("#{api_url}/applications", body: payload, headers: headers)
+          response = HttpHelper.post("#{api_url}/applications", body: payload, headers: headers)
           response_handler(response)
         end
 
         # Get an application by calling Unit's API
-        # @param [Integer] application_id
+        # @param [String] application_id
         # @return [UnitResponse, UnitError]
         def get_application(application_id)
-          response = HTTParty.get("#{api_url}/applications/#{application_id}", headers: headers)
+          response = HttpHelper.get("#{api_url}/applications/#{application_id}", headers: headers)
           response_handler(response)
         end
 
-        # Get an applications by calling Unit's API
+        # List applications by calling Unit's API
         # @param [ListApplicationParams] params
         # @return [UnitResponse, UnitError]
         def list_applications(params = nil)
-          response = HTTParty.get("#{api_url}/applications", body: params&.to_hash&.to_json, headers: headers)
+          response = HttpHelper.get("#{api_url}/applications", params: params&.to_hash, headers: headers)
           response_handler(response)
         end
 
@@ -50,7 +50,7 @@ module Unit
           headers["Content-Type"] = "image/jpeg" if request.file_type == "jpeg"
           headers["Content-Type"] = "image/png" if request.file_type == "png"
 
-          response = HTTParty.put(url, body: request.file, headers: headers)
+          response = HttpHelper.put(url, body: request.file, headers: headers)
 
           response_handler(response)
         end
@@ -60,7 +60,7 @@ module Unit
         # @return [UnitResponse, UnitError]
         def update(request)
           payload = request.to_json_api
-          response = HTTParty.patch("#{api_url}/applications/#{request.application_id}", body: payload, headers: headers)
+          response = HttpHelper.patch("#{api_url}/applications/#{request.application_id}", body: payload, headers: headers)
           response_handler(response)
         end
       end

data/lib/unit/api_resources/base_resource.rb

@@ -1,22 +1,14 @@
 # frozen_string_literal: true
 
-require "httparty"
-
 module Unit
   module Resource
     class BaseResource
       class << self
         # Check the response code and return a UnitResponse or UnitError
-        # @param [HTTParty::Response] response
+        # @param [HTTP::Response] response
         def response_handler(response)
-          included = response["included"].nil? ? nil : response["included"]
-          meta = response["meta"].nil? ? nil : response["meta"]
-          case response.code
-          when 200...300
-            Unit::UnitResponse.new(response["data"], included, meta)
-          else
-            Unit::UnitError.from_json_api(response)
-          end
+          handler = response.code.to_i.between?(200, 299) ? Unit::UnitResponse : Unit::UnitError
+          handler.from_json_api(response)
         end
 
         protected

data/lib/unit/api_resources/customer_resource.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require "httparty"
-
 require_relative "../api_resources/base_resource"
 require_relative "../models/unit_response"
 require_relative "../errors/unit_error"
+require_relative "../utils/http_helper"
 
 # class for creating requests for customers to Unit API and parsing responses
-# See: https://docs.unit.co/customers/
+# @see https://docs.unit.co/customers/
 module Unit
   module Resource
     class CustomerResource < Unit::Resource::BaseResource
@@ -17,7 +16,7 @@ module Unit
         # @return [UnitResponse, UnitError]
         def update(request)
           payload = request.to_json_api
-          response = HTTParty.patch("#{api_url}/customers/#{request.customer_id}", body: payload, headers: headers)
+          response = HttpHelper.patch("#{api_url}/customers/#{request.customer_id}", body: payload, headers: headers)
           response_handler(response)
         end
 
@@ -25,7 +24,7 @@ module Unit
         # @param [String] customer_id
         # @return [UnitResponse, UnitError]
         def get(customer_id)
-          response = HTTParty.get("#{api_url}/customers/#{customer_id}", headers: headers)
+          response = HttpHelper.get("#{api_url}/customers/#{customer_id}", headers: headers)
           response_handler(response)
         end
 
@@ -33,7 +32,7 @@ module Unit
         # @param [ListCustomerParams] params
         # @return [UnitResponse, UnitError]
         def list(params = nil)
-          response = HTTParty.get("#{api_url}/customers", body: params&.to_hash&.to_json, headers: headers)
+          response = HttpHelper.get("#{api_url}/customers", params: params&.to_hash, headers: headers)
           response_handler(response)
         end
 
@@ -42,7 +41,7 @@ module Unit
         # @return [UnitResponse, UnitError]
         def archive(request)
           payload = request.to_json_api
-          response = HTTParty.post("#{api_url}/customers/#{request.customer_id}/archive", body: payload, headers: headers)
+          response = HttpHelper.post("#{api_url}/customers/#{request.customer_id}/archive", body: payload, headers: headers)
           response_handler(response)
         end
 
@@ -51,9 +50,11 @@ module Unit
         # @return [UnitResponse, UnitError]
         def add_authorized_users(request)
           payload = request.to_json_api
-          response = HTTParty.post("#{api_url}/customers/#{request.customer_id}/authorized-users",
-                                   body: payload,
-                                   headers: headers)
+          response = HttpHelper.post(
+            "#{api_url}/customers/#{request.customer_id}/authorized-users",
+            body: payload,
+            headers: headers
+          )
           response_handler(response)
         end
 
@@ -62,7 +63,7 @@ module Unit
         # @return [UnitResponse, UnitError]
         def remove_authorized_users(request)
           payload = request.to_json_api
-          response = HTTParty.delete("#{api_url}/customers/#{request.customer_id}/authorized-users", body: payload, headers: headers)
+          response = HttpHelper.delete("#{api_url}/customers/#{request.customer_id}/authorized-users", body: payload, headers: headers)
           response_handler(response)
         end
       end

data/lib/unit/api_resources/payment_resource.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+
+# class for creating requests for book payments to Unit API and parsing responses
+# @see https://docs.unit.co/book-payments#book-payments
+module Unit
+  module Resource
+    class PaymentResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new book payment by calling Unit's API
+        # @param request [CreatePaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def create_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/payments", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Update a book payment by calling Unit's API
+        # @param request [PatchBookPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def update_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/payments/#{request.payment_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/transaction_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating requests for transactions to Unit API and parsing responses
+# @see https://docs.unit.co/transactions
+module Unit
+  module Resource
+    class TransactionResource < Unit::Resource::BaseResource
+      class << self
+        # Get a transaction by id by calling Unit's API
+        # @param params [GetTransactionParams]
+        # @return [UnitResponse, UnitError]
+        def get_transaction(params)
+          response = HttpHelper.get("#{api_url}/accounts/#{params.account_id}/transactions/#{params.transaction_id}", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get transactions by calling Unit's API
+        # @param params [ListTransactionParams]
+        # @return [UnitResponse, UnitError]
+        def list_transactions(params = nil)
+          response = HttpHelper.get("#{api_url}/transactions", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Update a transaction by calling Unit's API
+        # @param request [PatchTagsRequest]
+        # @return [UnitResponse, UnitError]
+        def update_tags(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/accounts/#{request.account_id}/transactions/#{request.transaction_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/errors/unit_error.rb

@@ -5,25 +5,19 @@ require_relative "unit_error_payload"
 # Represents an Error returned from Unit's API
 module Unit
   class UnitError
+    attr_reader :errors
+
     # Create a new UnitError
     # @param [Array<UnitErrorPayload>] errors
     def initialize(errors)
       @errors = errors
     end
 
-    class << self
-      # Creates a new UnitError from given response.
-      # @param [Hash] response The response returned from Unit's API
-      # @return [UnitError] a new UnitError populated with values taken from the response
-      def from_json_api(response)
-        errors = response["errors"]
-
-        errors&.map do |error|
-          UnitErrorPayload.new(error["title"], error["status"],
-                               error["detail"], error["details"], error["source"], error["code"])
-        end
-        UnitError.new(errors)
-      end
+    # Creates a new UnitError from given response.
+    # @param [HTTP::Response] response The response returned from Unit's API
+    # @return [UnitError] a new UnitError populated with values taken from the response
+    def self.from_json_api(response)
+      new((response.body["errors"] || []).map { |error| UnitErrorPayload.from_json_api(error) })
     end
   end
 end

data/lib/unit/errors/unit_error_payload.rb

@@ -11,8 +11,7 @@ module Unit
     # @param source [Hash] The source of the error
     # @param code [String] A Unit-specific code, uniquely identifying the error type
     # Check out documentation link for more details: https://docs.unit.co/about-jsonapi/#intro-errors
-    def initialize(title, status, detail, details = nil,
-                   source = nil, code = nil)
+    def initialize(title, status, detail, details = nil, source = nil, code = nil)
       @title = title
       @status = status
       @detail = detail
@@ -20,5 +19,19 @@ module Unit
       @source = source
       @code = code
     end
+
+    # Creates a new UnitErrorPayload from given response error.
+    # @param [Hash] error One of the errors returned in a response from Unit's API
+    # @return [UnitErrorPayload] a new UnitErrorPayload populated with values taken from the response error
+    def self.from_json_api(error)
+      new(
+        error["title"],
+        error["status"],
+        error["detail"],
+        error["details"],
+        error["source"],
+        error["code"]
+      )
+    end
   end
 end