hyperwallet-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f31081cedba40c93a380dfd7585086cbc3107d831c4f6c73e9ebb34a3d2074b2
+  data.tar.gz: 0e5bcfa99c18483e0fa7fe5516eaad124512e987cbbafd089a82902552c0a44f
+SHA512:
+  metadata.gz: 41dbb1320af2b60195d024329599f3670f902e5219b1f8dda4d6e7316607a0a5bd20ce6f40483ef0b8594d9696a8dc2f103d693185bff7a5a63509d48178563d
+  data.tar.gz: b0701e2343c45c1defa69c4dc4f87c4dae257dc1af0b5ca46ec7b071bec90d2fbec714a891fb4daceac3857460557912b15dd01443f426e765fffc83131dfcd5

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.env
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Taylor Brooks
+
+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,44 @@
+# Hyperwallet Ruby Client
+A Ruby wrapper for the Hyperwallet API
+
+To get a general overview of API: https://docs.hyperwallet.com/content/hyperwallet-payout-documentation
+
+### Installation
+Add this line to your application's Gemfile:
+````ruby
+  # in your Gemfile
+  gem 'hyperwallet-api', '~> 1.0'
+
+  # then...
+  bundle install
+````
+
+### Usage
+````ruby
+  client = Hyperwallet::Client.new(
+    url: ...,
+    username: ...,
+    password: ...,
+  )
+
+  response = client.list_users
+
+  puts response
+````
+
+### History
+
+View the [changelog](https://github.com/taylorbrooks/hyperwallet/blob/master/CHANGELOG.md)
+This gem follows [Semantic Versioning](http://semver.org/)
+
+### Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/taylorbrooks/hyperwallet/issues)
+- Fix bugs and [submit pull requests](https://github.com/taylorbrooks/hyperwallet/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+### Copyright
+Copyright (c) 2022 Taylor Brooks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :environment do
+  require 'dotenv'
+  Dotenv.load
+
+  $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+  require 'hyperwallet'
+end

data/bin/rspec

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path(
+  '../../Gemfile',
+  Pathname.new(__FILE__).realpath
+)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/hyperwallet.gemspec

@@ -0,0 +1,33 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'hyperwallet/version'
+require 'base64'
+
+Gem::Specification.new do |s|
+  s.name          = 'hyperwallet-api'
+  s.version       = Hyperwallet::VERSION
+  s.authors       = ['Taylor Brooks']
+  s.email         = ['dGJyb29rc0BnbWFpbC5jb20='].map { |e| Base64.decode64(e) }
+  s.homepage      = 'https://github.com/taylorbrooks/hyperwallet'
+  s.summary       = 'A Ruby wrapper for the Hyperwallet API'
+  s.description   = 'A Ruby wrapper for the Hyperwallet API'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test)/})
+
+  s.required_ruby_version = '>= 2.7'
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency     'faraday', '~> 2.0'
+  s.add_runtime_dependency     'json'
+
+  s.add_development_dependency 'bundler', '~> 2.3'
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'sinatra', '~> 2.0'
+  s.add_development_dependency 'webmock', '~> 3.1'
+end

data/lib/hyperwallet/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+
+Dir[File.expand_path('../resources/*.rb', __FILE__)].each { |f| require f }
+require File.expand_path('../response/base.rb', __FILE__)
+Dir[File.expand_path('../response/*.rb', __FILE__)].each { |f| require f }
+
+module Hyperwallet
+  class Client
+    include Hyperwallet::Client::BankAccount
+    include Hyperwallet::Client::Payment
+    include Hyperwallet::Client::User
+    include Hyperwallet::Client::WebhookNotification
+
+    attr_reader :url, :username, :password, :logger, :connection, :adapter
+
+    def initialize(url:, username:, password:, logger: true, adapter: Faraday.default_adapter)
+      @url      = "#{url}/rest/v4/"
+      @username = username
+      @password = password
+      @logger   = logger
+      @adapter  = adapter
+    end
+
+    def delete(path, options = {})
+      connection.delete(path, options).body
+    end
+
+    def get(path, options = {})
+      connection.get(path, options).body
+    end
+
+    def patch(path, options = {})
+      connection.patch(path, options).body
+    end
+
+    def post(path, options = {})
+      connection.post(path, options).body
+    end
+
+    def put(path, options = {})
+      connection.put(path, options).body
+    end
+
+    private
+
+    def connection
+      headers = {
+        accept: 'application/json',
+        'User-Agent' => "hyperwallet-gem/v#{Hyperwallet::VERSION}"
+      }
+
+      client_opts = {
+        url: url,
+        headers: headers
+      }
+
+      Faraday.new(client_opts) do |conn|
+        conn.request   :authorization, :basic, username, password
+        conn.request   :json
+        conn.response  :json
+        conn.response  :logger if logger
+        conn.response  :hyperwallet_errors
+        conn.adapter   adapter
+      end
+    end
+  end
+end

data/lib/hyperwallet/error.rb

@@ -0,0 +1,48 @@
+module Hyperwallet
+  class Error < StandardError; end
+  class BadGateway < Error; end
+  class BadRequest < Error; end
+  class Forbidden < Error; end
+  class GatewayTimeout < Error; end
+  class InternalServerError < Error; end
+  class NotFound < Error; end
+  class ServiceUnavailable < Error; end
+  class Unauthorized < Error; end
+end
+
+module Hyperwallet
+  class ErrorHandler < Faraday::Middleware
+    ERROR_STATUSES = 400..600
+
+    def on_complete(env)
+      case env[:status]
+      when 400
+        raise Hyperwallet::BadRequest, error_message(env)
+      when 401
+        raise Hyperwallet::Unauthorized, error_message(env)
+      when 403
+        raise Hyperwallet::Forbidden, error_message(env)
+      when 404
+        raise Hyperwallet::NotFound, error_message(env)
+      when 500
+        raise Hyperwallet::InternalServerError, error_message(env)
+      when 502
+        raise Hyperwallet::BadGateway, error_message(env)
+      when 503
+        raise Hyperwallet::ServiceUnavailable, error_message(env)
+      when 504
+        raise Hyperwallet::GatewayTimeout, error_message(env)
+      when ERROR_STATUSES
+        raise Hyperwallet::Error, error_message(env)
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:status]}: #{env[:url]} #{env[:body]}"
+    end
+  end
+end
+
+Faraday::Response.register_middleware(hyperwallet_errors: Hyperwallet::ErrorHandler)

data/lib/hyperwallet/resources/bank_account.rb

@@ -0,0 +1,52 @@
+module Hyperwallet
+  class Client
+    module BankAccount
+      PATH = 'bank-accounts'.freeze
+
+      def list_bank_accounts(user_token, options = {})
+        get(bank_account_path(user_token), options)
+      end
+
+      def find_bank_account(user_token, id)
+        get(bank_account_path(user_token, id))
+      end
+
+      def create_bank_account(
+        user_token,
+        routing_number:,
+        account_number:,
+        business_name:,
+        address:,
+        city:,
+        state:,
+        postal_code:
+      )
+
+        options = {
+          profileType: 'BUSINESS',
+          transferMethodCountry: 'US',
+          transferMethodCurrency: 'USD',
+          type: 'BANK_ACCOUNT',
+          branchId: routing_number,
+          bankAccountId: account_number,
+          bankAccountPurpose: 'CHECKING',
+          businessName: business_name,
+          addressLine1: address,
+          city: city,
+          stateProvince: state,
+          postalCode: postal_code,
+          country: 'US'
+        }
+
+        post(bank_account_path(user_token), options)
+      end
+
+      private
+
+      def bank_account_path(user_token, id = nil)
+        root_path = "users/#{user_token}/#{PATH}"
+        id ? "#{root_path}/#{id}" : root_path
+      end
+    end
+  end
+end

data/lib/hyperwallet/resources/payment.rb

@@ -0,0 +1,42 @@
+module Hyperwallet
+  class Client
+    module Payment
+      PATH = 'payments'.freeze
+
+      def list_payments(options = {})
+        get(payment_path, options)
+      end
+
+      def find_payment(id)
+        get(payment_path(id))
+      end
+
+      def create_payment(
+        amount:,
+        client_payment_id:,
+        destination_token:,
+        program_token:,
+        currency: 'USD',
+        purpose: 'OTHER'
+      )
+
+        options = {
+          amount: amount,
+          clientPaymentId: client_payment_id,
+          currency: currency,
+          destinationToken: destination_token,
+          programToken: program_token,
+          purpose: purpose
+        }
+
+        post(payment_path, options)
+      end
+
+      private
+
+      def payment_path(id = nil)
+        id ? "#{PATH}/#{id}" : PATH
+      end
+    end
+  end
+end

data/lib/hyperwallet/resources/user.rb

@@ -0,0 +1,53 @@
+module Hyperwallet
+  class Client
+    module User
+      PATH = 'users'.freeze
+
+      def list_users(options = {})
+        get(user_path, options)
+      end
+
+      def find_user(id)
+        get(user_path(id))
+      end
+
+      def create_user(
+        program_token:,
+        client_user_id:,
+        email:,
+        profile_type: 'BUSINESS',
+        business_type: 'NOT_FOR_PROFIT_ORGANIZATION',
+        business_name:,
+        address:,
+        city:,
+        state:,
+        postal_code:,
+        country: 'US'
+      )
+
+        options = {
+          programToken: program_token,
+          clientUserId: client_user_id,
+          profileType: profile_type,
+          email: email,
+          profileType: profile_type,
+          businessType: business_type,
+          businessName: business_name,
+          addressLine1: address,
+          city: city,
+          stateProvince: state,
+          postalCode: postal_code,
+          country: country
+        }
+
+        post(user_path, options)
+      end
+
+      private
+
+      def user_path(id = nil)
+        id ? "#{PATH}/#{id}" : PATH
+      end
+    end
+  end
+end

data/lib/hyperwallet/resources/webhook_notification.rb

@@ -0,0 +1,17 @@
+module Hyperwallet
+  class Client
+    module WebhookNotification
+      PATH = 'webhook-notifications'.freeze
+
+      def list_webhook_notifications(options = {})
+        get(webhook_notifications_path, options)
+      end
+
+      private
+
+      def webhook_notifications_path(id = nil)
+        id ? "#{PATH}/#{id}" : PATH
+      end
+    end
+  end
+end

data/lib/hyperwallet/response/base.rb

@@ -0,0 +1,31 @@
+module Hyperwallet
+  module Response
+    class Base
+      attr_reader :data
+
+      def self.format(data)
+        new(data).format
+      end
+
+      def initialize(data)
+        @data = data
+      end
+
+      def format
+        if data.is_a?(Array)
+          data.map { |item| format_single(item) }
+        else
+          format_single(data)
+        end
+      end
+
+      def to_h(dict, data)
+        return {} if data.nil?
+
+        dict.each_with_object({}) do |(l, r), object|
+          object[l] = data[r]
+        end
+      end
+    end
+  end
+end

data/lib/hyperwallet/version.rb

@@ -0,0 +1,3 @@
+module Hyperwallet
+  VERSION = '0.0.2'.freeze
+end

data/lib/hyperwallet.rb

@@ -0,0 +1,6 @@
+require_relative 'hyperwallet/client'
+require_relative 'hyperwallet/error'
+require_relative 'hyperwallet/version'
+
+module Hyperwallet
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: hyperwallet-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Taylor Brooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: pry
+  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: '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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A Ruby wrapper for the Hyperwallet API
+email:
+- tbrooks@gmail.com
+executables:
+- rspec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/rspec
+- hyperwallet.gemspec
+- lib/hyperwallet.rb
+- lib/hyperwallet/client.rb
+- lib/hyperwallet/error.rb
+- lib/hyperwallet/resources/bank_account.rb
+- lib/hyperwallet/resources/payment.rb
+- lib/hyperwallet/resources/user.rb
+- lib/hyperwallet/resources/webhook_notification.rb
+- lib/hyperwallet/response/base.rb
+- lib/hyperwallet/version.rb
+homepage: https://github.com/taylorbrooks/hyperwallet
+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.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Hyperwallet API
+test_files: []