increase 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9243d27fe1bd52cec9e7de6d0f9437258c21fd6d3ca2b87d3aecaa72cb94b5f
-  data.tar.gz: a3074a286a31dcb1803edf08a06b1a8fe22df790c09adeeb8ab9546dc993d5c6
+  metadata.gz: 43bc6e7b10ff9beb7aad80057ffd20e38540f60b6d2324e119326218794e14b3
+  data.tar.gz: 8bb3bb23e78e81801fb0fa3ab29019c2b663a9dd2cd0462d3946698c347fff5a
 SHA512:
-  metadata.gz: 68e401c32b3ccc3a4dcc782b9d46cc2cce6fd7cee70a04581f78fbdb9be8a278bde79feaa1b58b9ebe54e00bf80e0361564eebc4370e538f96029106664041b0
-  data.tar.gz: ef900afd66bea27938146e787a7e14679d230d1a05ccee069699277101d4af659a15de0eb091719a1040f9c50f754f7782a1435a83f6611c81104611f06495f8
+  metadata.gz: af671bbe00de695ebee4d75c90e0207f87f79c20b2ad431919d6016987859821397c15ab596268ace2958cbee054832349262764413cc53ddda844a4bc7a4178
+  data.tar.gz: 1187e2cefba42d32e0c18c13bfbac49be565def33cbc832ef4a897d88aaf87d087a781a3d3750979fb697026fce327c16b74131058e3e76e2426502126de5968

data/Gemfile

@@ -4,9 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in increase.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "standard", "~> 1.3"

data/lib/faraday/raise_increase_api_error.rb

@@ -0,0 +1,11 @@
+require "faraday"
+
+module FaradayMiddleware
+  class RaiseIncreaseApiError < Faraday::Middleware
+    def on_complete(env)
+      return if env[:status] < 400
+
+      raise Increase::ApiError.from_response(env)
+    end
+  end
+end

data/lib/increase/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "increase/configuration"
+
+require "faraday"
+require "faraday/follow_redirects"
+
+# Custom Faraday Middleware to handle raising errors
+require "faraday/raise_increase_api_error"
+
+module Increase
+  class Client
+    extend Forwardable
+
+    attr_accessor :configuration
+    def_delegators :configuration, :configure
+
+    def_delegators :configuration, :base_url, :base_url=
+    def_delegators :configuration, :api_key, :api_key=
+    def_delegators :configuration, :raise_api_errors, :raise_api_errors=
+
+    def initialize(config = nil)
+      @configuration = config.is_a?(Configuration) ? config : Configuration.new(config)
+    end
+
+    def connection
+      Faraday.new(
+        url: @configuration.base_url,
+        headers: {
+          Authorization: "Bearer #{@configuration.api_key}"
+        }
+      ) do |f|
+        f.request :json
+
+        if @configuration.raise_api_errors
+          # This custom middleware for raising Increase API errors must be
+          # located before the JSON response middleware.
+          f.use FaradayMiddleware::RaiseIncreaseApiError
+        end
+
+        f.response :json
+        f.response :follow_redirects
+        f.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/increase/configuration.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Increase
+  class Configuration
+    attr_reader :base_url
+    attr_accessor :api_key
+    attr_accessor :raise_api_errors
+    # TODO: support Faraday config
+
+    def initialize(config = nil)
+      if config.nil?
+        reset
+      else
+        configure(config)
+      end
+    end
+
+    def reset
+      @base_url = ENV["INCREASE_BASE_URL"] || Increase::PRODUCTION_URL
+      @api_key = nil || ENV["INCREASE_API_KEY"]
+      @raise_api_errors = true
+    end
+
+    def configure(config = nil)
+      if config.is_a?(Hash)
+        config.each do |key, value|
+          unless respond_to?("#{key}=")
+            raise Error, "Invalid configuration key: #{key}"
+          end
+          public_send("#{key}=", value)
+        end
+      end
+
+      if block_given?
+        yield self
+      end
+
+      self
+    end
+
+    def base_url=(url)
+      url = PRODUCTION_URL if url == :production
+      url = SANDBOX_URL if [:sandbox, :development].include?(url)
+
+      # Validate url
+      unless url&.match?(URI::DEFAULT_PARSER.make_regexp(%w[http https]))
+        raise ArgumentError, "Invalid url: #{url}"
+      end
+
+      @base_url = url
+    end
+  end
+end

data/lib/increase/errors.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Increase
+  class Error < StandardError; end
+
+  class ApiError < Error
+    attr_reader :response
+
+    attr_reader :detail
+    attr_reader :status
+    attr_reader :title
+    attr_reader :type
+
+    def initialize(message, response: nil, detail: nil, status: nil, title: nil, type: nil)
+      @response = response
+
+      @detail = detail || response.body["detail"]
+      @status = status || response.body["status"]
+      @title = title || response.body["title"]
+      @type = type || response.body["type"]
+
+      super(message)
+    end
+
+    class << self
+      def from_response(response)
+        type = response.body["type"]
+        klass = ERROR_TYPES[type]
+
+        # Fallback in case of really bad 5xx error
+        klass ||= InternalServerError if (500..599).cover?(response.status)
+
+        # Handle case of an unknown error
+        klass ||= ApiError
+
+        code = [response.body["status"] || response.status, type].compact.join(": ") || "Error"
+        message = [response.body["title"], response.body["detail"]].compact.join(" ") || "Increase API Error"
+
+        klass.new("[#{code}] #{message}", response: response)
+      end
+    end
+  end
+
+  class ApiMethodNotFoundError < ApiError; end
+
+  class EnvironmentMismatchError < ApiError; end
+
+  class IdempotencyConflictError < ApiError; end
+
+  class IdempotencyUnprocessableError < ApiError; end
+
+  class InsufficientPermissionsError < ApiError; end
+
+  class InternalServerError < ApiError; end
+
+  class InvalidApiKeyError < ApiError; end
+
+  class InvalidOperationError < ApiError; end
+
+  class InvalidParametersError < ApiError; end
+
+  class MalformedRequestError < ApiError; end
+
+  class ObjectNotFoundError < ApiError; end
+
+  class PrivateFeatureError < ApiError; end
+
+  class RateLimitedError < ApiError; end
+
+  ERROR_TYPES = {
+    "api_method_not_found_error" => ApiMethodNotFoundError,
+    "environment_mismatch_error" => EnvironmentMismatchError,
+    "idempotency_conflict_error" => IdempotencyConflictError,
+    "idempotency_unprocessable_error" => IdempotencyUnprocessableError,
+    "insufficient_permissions_error" => InsufficientPermissionsError,
+    "internal_server_error" => InternalServerError,
+    "invalid_api_key_error" => InvalidApiKeyError,
+    "invalid_operation_error" => InvalidOperationError,
+    "invalid_parameters_error" => InvalidParametersError,
+    "malformed_request_error" => MalformedRequestError,
+    "object_not_found_error" => ObjectNotFoundError,
+    "private_feature_error" => PrivateFeatureError,
+    "rate_limited_error" => RateLimitedError
+  }
+end

data/lib/increase/resource.rb

@@ -0,0 +1,130 @@
+require "increase/response_hash"
+
+module Increase
+  class Resource
+    def initialize(client: nil)
+      if instance_of?(Resource)
+        raise NotImplementedError, "Resource is an abstract class. You should perform actions on its subclasses (Accounts, Transactions, Card, etc.)"
+      end
+      @client = client || Increase.default_client
+    end
+
+    def self.with_config(config)
+      if config.is_a?(Client)
+        new(client: config)
+      else
+        new(client: Client.new(config))
+      end
+    end
+
+    def self.resource_url
+      "/#{resource_name.downcase.tr(" ", "_")}"
+    end
+
+    def self.resource_name
+      if self == Resource
+        raise NotImplementedError, "Resource is an abstract class. You should perform actions on its subclasses (Accounts, Transactions, Card, etc.)"
+      end
+
+      name.split("::").last.gsub(/[A-Z]/, ' \0').strip
+    end
+
+    def self.endpoint(method, as: nil, with: nil)
+      if as == :action
+        raise Error, "`with` must be a valid HTTP method" unless %i[get post put patch delete].include?(with)
+        return endpoint_action(method, with)
+      end
+      raise Error, "as must be :action" if as
+
+      define_singleton_method(method) do |*args, &block|
+        new.send(method, *args, &block)
+      end
+
+      public method
+    end
+
+    private_class_method :endpoint
+
+    def self.endpoint_action(method, http_method)
+      define_singleton_method(method) do |*args, &block|
+        new.send(:action, method, http_method, *args, &block)
+      end
+
+      define_method(method) do |*args, &block|
+        new.send(:action, method, http_method, *args, &block)
+      end
+    end
+
+    private_class_method :endpoint_action
+
+    private
+
+    def create(params = nil, headers = nil)
+      request(:post, self.class.resource_url, params, headers)
+    end
+
+    def list(params = nil, headers = nil, &block)
+      results = []
+      count = 0
+      limit = params&.[](:limit) || params&.[]("limit")
+      if limit == :all || limit&.>(100)
+        params&.delete(:limit)
+        params&.delete("limit")
+      end
+
+      loop do
+        res = request(:get, self.class.resource_url, params, headers)
+        data = res["data"]
+        count += data.size
+        if ![nil, :all].include?(limit) && count >= limit
+          data = data[0..(limit - (count - data.size) - 1)]
+        end
+
+        if block
+          block.call(data)
+        else
+          results += data
+        end
+
+        if limit.nil? || (limit != :all && count >= limit) || res["next_cursor"].nil?
+          if block
+            break
+          else
+            return results
+          end
+        end
+
+        params = (params || {}).merge({cursor: res["next_cursor"]})
+      end
+    end
+
+    def update(id, params = nil, headers = nil)
+      raise Error, "id must be a string" unless id.is_a?(String)
+      path = "#{self.class.resource_url}/#{id}"
+      request(:patch, path, params, headers)
+    end
+
+    def retrieve(id, params = nil, headers = nil)
+      raise Error, "id must be a string" unless id.is_a?(String)
+      path = "#{self.class.resource_url}/#{id}"
+      request(:get, path, params, headers)
+    end
+
+    # Such as for "/accounts/{account_id}/close"
+    # "close" is the action.
+    def action(action, http_method, id, params = nil, headers = nil)
+      raise Error, "id must be a string" unless id.is_a?(String)
+      path = "#{self.class.resource_url}/#{id}/#{action}"
+      request(http_method, path, params, headers)
+    end
+
+    def request(method, path, params = nil, headers = nil)
+      if method == :post
+        headers = {"Content-Type" => "application/json"}.merge!(headers || {})
+      end
+
+      response = @client.connection.send(method, path, params, headers)
+      ResponseHash.new(response.body, response: response)
+    end
+  end
+end

data/lib/increase/resources/account_numbers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class AccountNumbers < Resource
+    endpoint :create
+    endpoint :list
+    endpoint :update
+    endpoint :retrieve
+  end
+end

data/lib/increase/resources/account_transfers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class AccountTransfers < Resource
+    endpoint :create
+    endpoint :list
+    endpoint :retrieve
+    endpoint :approve, as: :action, with: :post
+    endpoint :cancel, as: :action, with: :post
+  end
+end

data/lib/increase/resources/accounts.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Accounts < Resource
+    endpoint :create
+    endpoint :list
+    endpoint :update
+    endpoint :retrieve
+    endpoint :close, as: :action, with: :post
+  end
+end

data/lib/increase/resources/ach_transfers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class AchTransfers < Resource
+    endpoint :create
+    endpoint :list
+    endpoint :retrieve
+    endpoint :approve, as: :action, with: :post
+    endpoint :cancel, as: :action, with: :post
+  end
+end

data/lib/increase/resources/cards.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Cards < Resource
+    endpoint :create
+    endpoint :list
+    endpoint :details, as: :action, with: :get
+    endpoint :update
+    endpoint :retrieve
+  end
+end

data/lib/increase/resources/events.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Events < Resource
+    endpoint :list
+    endpoint :retrieve
+  end
+end

data/lib/increase/resources/pending_transactions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class PendingTransactions < Resource
+    endpoint :list
+    endpoint :retrieve
+  end
+end

data/lib/increase/resources/transactions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "increase/resource"
+
+module Increase
+  class Transactions < Resource
+    endpoint :list
+    endpoint :retrieve
+  end
+end

data/lib/increase/resources.rb

@@ -0,0 +1,4 @@
+# Require all files in the lib/increase/resources directory
+Dir[File.expand_path("resources/*.rb", __dir__)].sort.each do |file|
+  require file
+end

data/lib/increase/response_hash.rb

@@ -0,0 +1,15 @@
+module Increase
+  class ResponseHash < Hash
+    attr_reader :response
+
+    def initialize(hash, response: nil)
+      @response = response
+      merge!(hash)
+    end
+
+    # https://increase.com/documentation/api#idempotency
+    def idempotent_replayed
+      response.headers["Idempotent-Replayed"]
+    end
+  end
+end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/increase/webhooks.rb

@@ -0,0 +1,16 @@
+require "openssl"
+require "securecompare"
+
+module Increase
+  class Webhooks
+    def self.verify?(payload:, signature_header:, secret:, scheme: "v1")
+      sig_values = signature_header.split(",").map { |pair| pair.split("=") }
+      sig_values = sig_values.to_h
+
+      signed_payload = sig_values["t"] + "." + payload.to_s
+
+      expected_sig = OpenSSL::HMAC.hexdigest("SHA256", secret, signed_payload)
+      SecureCompare.compare(expected_sig, sig_values["v1"])
+    end
+  end
+end

data/lib/increase.rb

@@ -1,8 +1,26 @@
 # frozen_string_literal: true
 
-require_relative "increase/version"
+require "increase/version"
+require "increase/client"
+require "increase/configuration"
+require "increase/errors"
+require "increase/resources"
+require "increase/webhooks"
 
 module Increase
-  class Error < StandardError; end
-  # Your code goes here...
+  PRODUCTION_URL = "https://api.increase.com"
+  SANDBOX_URL = "https://sandbox.increase.com"
+
+  @default_client = Client.new
+
+  class << self
+    extend Forwardable
+
+    attr_accessor :default_client
+    def_delegators :default_client, :configure
+
+    def_delegators :default_client, :base_url, :base_url=
+    def_delegators :default_client, :api_key, :api_key=
+    def_delegators :default_client, :raise_api_errors, :raise_api_errors=
+  end
 end

metadata

@@ -1,15 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gary Tou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
-dependencies: []
+date: 2023-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: securecompare
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: Ruby API client for Increase, a platform for Bare-Metal Banking APIs
 email:
 - gary@garytou.com
@@ -23,8 +135,24 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/faraday/raise_increase_api_error.rb
 - lib/increase.rb
+- lib/increase/client.rb
+- lib/increase/configuration.rb
+- lib/increase/errors.rb
+- lib/increase/resource.rb
+- lib/increase/resources.rb
+- lib/increase/resources/account_numbers.rb
+- lib/increase/resources/account_transfers.rb
+- lib/increase/resources/accounts.rb
+- lib/increase/resources/ach_transfers.rb
+- lib/increase/resources/cards.rb
+- lib/increase/resources/events.rb
+- lib/increase/resources/pending_transactions.rb
+- lib/increase/resources/transactions.rb
+- lib/increase/response_hash.rb
 - lib/increase/version.rb
+- lib/increase/webhooks.rb
 - sig/increase.rbs
 homepage: https://github.com/garyhtou/increase-ruby
 licenses: