hws-connectors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bec6f19f3cc3493448142dff0b5943455739586d828bc5ddbf59cf06169af26
+  data.tar.gz: 55b3283003d97292a98fe62ac60982f6b9992012a86d457f8b291cd19cd9c085
+SHA512:
+  metadata.gz: 03572de21caf450e084421d525f4dee719e3b123d48292e7840b96879948b086461e1b220ee55fd500d667596a53fc45944bf4eb474cf69d614cc55e929c844f
+  data.tar.gz: 37ac5ddb408afac8f21d5d4355ffd630f0832f9404b1163ba6b8d8f0481e01435e282ce9491c5d9b0166b4a10736d47ebf9d45184d4b727f5376e31b02d5483e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [RELEASES]
+
+## [0.1.0] - 2021-12-16
+
+- Initial release
+- Added Hypto Connectors (Payouts, Virtual Accounts)
+- Configured webhook for Hypto Connectors

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tholkappiyan@hypto.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hws-stores.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tholkappiyan
+
+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,123 @@
+<h1 align="center">
+  Hws Connectors
+</h1>
+
+<p align="center">
+  <a href="LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/hwslabs/hws-connectors-ruby"></a>
+  <a href="https://github.com/hwslabs/hws-connectors-ruby/pulls"><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square"></a>
+</p>
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hws-connectors'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install hws-connectors
+```
+
+### Configuration
+
+```ruby
+Hws::Connectors.configure do |config|
+  config.logger = Rails.logger
+  config.options = { skip_logging: %w(get) },
+    config.webhooks = {
+      'payouts' => {
+        'callback' => -> (entity, response) { puts "#{entity.inspect} - #{response.inspect}" },
+      },
+      'virtual_accounts' => {
+        'notify' => -> (entity, response) { puts "#{entity.inspect} - #{response.inspect}" }
+      }
+    }
+end
+```
+
+### Payout
+
+```ruby
+# Initialise payout client (eg: Hypto)
+CLIENT_INFO = { 'api_token' => "<HYPTO_API_TOKEN>", 'env' => 'development | production' }
+$hypto_payout_client = Hws::Connectors::Hypto::Payout.new(CLIENT_INFO)
+
+# Send to bank account
+beneficiary = Hws::Connectors::Dto::AccountDetail.new(name: 'Logesh', account_number: '12345678', account_ifsc: 'HDFC0005322', note: 'Connector testing')
+request = Hws::Connectors::Dto::PayoutRequest.new(beneficiary: beneficiary, payment_type: 'IMPS', amount: 1)
+resp = $hypto_payout_client.send_to_bank_account(request: request)
+
+# Send to Upi Id
+beneficiary = Hws::Connectors::Dto::AccountDetail.new(name: 'Logesh', upi_id: 'ddlogesh@okhdfcbank', note: 'Connector testing')
+request = Hws::Connectors::Dto::PayoutRequest.new(beneficiary: beneficiary, payment_type: 'UPI', amount: 1)
+resp = $hypto_payout_client.send_to_upi_id(request: request)
+
+# Fetch payout status
+resp = $hypto_payout_client.status(reference_number: 'reference_number')
+```
+
+### VirtualAccount
+
+```ruby
+# Initialise virtual account client (eg: Hypto)
+$hypto_va_client = Hws::Connectors::Hypto::VirtualAccount.new(CLIENT_INFO)
+
+# Create a virtual account
+request = Hws::Connectors::Dto::VirtualAccountRequest.new(reference_number: 'REF123')
+resp = $hypto_va_client.create(request: request)
+
+# Update an existing virtual account
+request = Hws::Connectors::Dto::VirtualAccountRequest.new(reference_number: 'REF139856', meta: { id: 139856 })
+resp = $hypto_va_client.update(request: request)
+
+# Activate a virtual account
+resp = $hypto_va_client.activate(reference_number: 139856)
+
+# Deactivate a virtual account
+resp = $hypto_va_client.deactivate(reference_number: 139856)
+
+# Fetch a virtual account
+resp = $hypto_va_client.fetch(reference_number: 139856)
+```
+
+#### Payout (From Virtual Account)
+
+```ruby
+# Send to bank account
+beneficiary = Hws::Connectors::Dto::AccountDetail.new(name: 'Logesh', account_number: '12345678', account_ifsc: 'HDFC0005322', note: 'Connector testing')
+request = Hws::Connectors::Dto::PayoutRequest.new(beneficiary: beneficiary, payment_type: 'IMPS', amount: 1, meta: { va_id: 139856 })
+resp = $hypto_va_client.send_to_bank_account(request: request)
+
+# Send to Upi Id
+beneficiary = Hws::Connectors::Dto::AccountDetail.new(name: 'Logesh', upi_id: 'ddlogesh@okhdfcbank', note: 'Connector testing')
+request = Hws::Connectors::Dto::PayoutRequest.new(beneficiary: beneficiary, payment_type: 'UPI', amount: 1, meta: { va_id: 139856 })
+resp = $hypto_va_client.send_to_upi_id(request: request)
+
+# Fetch payout status
+resp = $hypto_va_client.status(reference_number: 'reference_number', va_id: 139856)
+```
+
+### Webhooks
+
+```
+Payout Status 
+POST : {{host}}/hws/connectors/payouts/hypto/callback
+
+Credit Virtual Account
+POST : {{host}}/hws/connectors/virtual_accounts/hypto/notify
+```
+
+### Contributing
+
+Fork our project and send us your pull request: may be a minor bug, extension or major improvements.
+
+**Every contribution is welcome!**

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/controllers/hws/connectors/payouts_controller.rb

@@ -0,0 +1,18 @@
+class Hws::Connectors::PayoutsController < Hws::Connectors::WebhooksController
+  HYPTO_META_RESPONSES = %w(id txn_time created_at txn_type charges_gst settled_amount connected_banking udf1 udf2 udf3 initiated_account_ifsc
+va_closing_balance hypto_va_id va_wallet_amount va_settler_id)
+
+  def callback
+    Hws::Connectors.logger.debug "===== Hws::Connectors::PayoutsController.callback - Payload: #{params.inspect} ====="
+    beneficiary = Hws::Connectors::Dto::AccountDetail
+                    .new(name: params['beneficiary_name'], account_number: params['account_number'],
+                         account_ifsc: params['account_ifsc'], note: params['note'])
+    response = Hws::Connectors::Dto::PayoutResponse
+                 .new(reference_number: params['reference_number'], beneficiary: beneficiary, account_holder: params['account_holder'],
+                      amount: params['amount'].to_f, payment_type: params['payment_type'], status: params['status'],
+                      bank_ref_num: params['bank_ref_num'], txn_time: Time.strptime(params['txn_time'], '%Y-%m-%d %H:%M:%S'),
+                      meta: params.as_json.slice(*HYPTO_META_RESPONSES))
+
+    render_response(response)
+  end
+end

data/app/controllers/hws/connectors/virtual_accounts_controller.rb

@@ -0,0 +1,15 @@
+class Hws::Connectors::VirtualAccountsController < Hws::Connectors::WebhooksController
+  HYPTO_META_RESPONSES = %w(id va_closing_balance va_settler_id charges_gst settled_amount txn_time created_at hypto_va_id va_wallet_amount va_lien_amount)
+
+  def notify
+    Hws::Connectors.logger.debug "===== Hws::Connectors::VirtualAccountsController.notify - Payload: #{params.inspect} ====="
+    beneficiary = Hws::Connectors::Dto::AccountDetail.new(account_number: params['bene_account_no'], account_ifsc: params['bene_account_ifsc'])
+    remitter = Hws::Connectors::Dto::AccountDetail.new(account_number: params['rmtr_account_no'], account_ifsc: params['rmtr_account_ifsc'],
+                                                       note: params['rmtr_to_bene_note'], name: params['rmtr_full_name'])
+
+    response = Hws::Connectors::Dto::CreditVirtualAccountResponse
+                 .new(credit_time: Time.strptime(params['credited_at'], '%Y-%m-%d %H:%M:%S'), beneficiary: beneficiary, remitter: remitter, amount: params['amount'].to_f,
+                      payment_type: params['payment_type'], bank_ref_num: params['bank_ref_num'], meta: params.as_json.slice(*HYPTO_META_RESPONSES))
+    render_response(response)
+  end
+end

data/app/controllers/hws/connectors/webhooks_controller.rb

@@ -0,0 +1,11 @@
+class Hws::Connectors::WebhooksController < ApplicationController
+  protect_from_forgery
+
+  protected
+
+  def render_response(response)
+    entity = Hws::Connectors::Dto::Entity.new(name: params['entity'])
+    Hws::Connectors.webhooks.to_h[params['controller'].split('/').last].to_h[params['action']].try(:call, entity, response)
+    render status: 200, json: { success: true, message: 'success' }
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hws/connectors"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+  namespace :hws do
+    namespace :connectors do
+      resource :payouts, only: :none do
+        collection { post ':entity/callback', action: :callback }
+      end
+      resource :virtual_accounts, only: :none do
+        collection { post ':entity/notify', action: :notify }
+      end
+    end
+  end
+end

data/hws-connectors.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hws-connectors'
+
+Gem::Specification.new do |spec|
+  spec.name = 'hws-connectors'
+  spec.version = Hws::Connectors::VERSION
+  spec.authors = ['Hypto Engineering Team']
+  spec.email = ['engineering@hypto.in']
+
+  spec.summary = 'HWS Connector'
+  spec.description = 'Primitive for connecting to the financial services'
+  spec.homepage = 'https://github.com/hwslabs/hws-connectors-ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hwslabs/hws-connectors-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/hwslabs/hws-connectors-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '~> 5.0'
+  spec.add_dependency 'rest-client', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.2.33'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+end

data/lib/hws-connectors/base.rb

@@ -0,0 +1,12 @@
+class Hws::Connectors::Base
+  ALLOWED_ACTION_CLASSES = [String, Symbol].freeze
+
+  def self.execute_action action, *args
+    return nil unless ALLOWED_ACTION_CLASSES.include?(action.class)
+
+    action = action.to_sym
+    return nil unless self.methods.include?(action)
+
+    self.send(action, *args)
+  end
+end

data/lib/hws-connectors/dto/base.rb

@@ -0,0 +1,6 @@
+module Hws::Connectors::Dto
+end
+
+require 'hws-connectors/dto/common/base'
+require 'hws-connectors/dto/payout/base'
+require 'hws-connectors/dto/virtual_account/base'

data/lib/hws-connectors/dto/common/account_detail.rb

@@ -0,0 +1,13 @@
+class Hws::Connectors::Dto::AccountDetail
+  attr_accessor :name, :account_number, :account_ifsc, :upi_id, :note, :created_at, :updated_at
+
+  def initialize(name: nil, account_number: nil, account_ifsc: nil, upi_id: nil, note: nil, created_at: nil, updated_at: nil)
+    @name = name
+    @account_number = account_number
+    @account_ifsc = account_ifsc
+    @upi_id = upi_id
+    @note = note
+    @created_at = created_at
+    @updated_at = updated_at
+  end
+end

data/lib/hws-connectors/dto/common/base.rb

@@ -0,0 +1,4 @@
+require 'hws-connectors/dto/common/entity'
+require 'hws-connectors/dto/common/request'
+require 'hws-connectors/dto/common/response'
+require 'hws-connectors/dto/common/account_detail'

data/lib/hws-connectors/dto/common/entity.rb

@@ -0,0 +1,7 @@
+class Hws::Connectors::Dto::Entity
+  attr_accessor :name
+
+  def initialize(name: nil)
+    @name = name
+  end
+end

data/lib/hws-connectors/dto/common/request.rb

@@ -0,0 +1,8 @@
+class Hws::Connectors::Request < Hws::Connectors
+  attr_accessor :reference_number, :meta
+
+  def initialize(reference_number: nil, meta: {})
+    @reference_number = reference_number
+    @meta = meta.to_h.transform_keys { |key| key.to_sym }
+  end
+end

data/lib/hws-connectors/dto/common/response.rb

@@ -0,0 +1,8 @@
+class Hws::Connectors::Response < Hws::Connectors
+  attr_accessor :message, :meta
+
+  def initialize(message: nil, meta: {})
+    @message = message
+    @meta = meta.to_h.transform_keys { |key| key.to_sym }
+  end
+end

data/lib/hws-connectors/dto/payout/base.rb

@@ -0,0 +1,2 @@
+require 'hws-connectors/dto/payout/payout_request'
+require 'hws-connectors/dto/payout/payout_response'

data/lib/hws-connectors/dto/payout/payout_request.rb

@@ -0,0 +1,10 @@
+class Hws::Connectors::Dto::PayoutRequest < Hws::Connectors::Request
+  attr_accessor :beneficiary, :amount, :payment_type
+
+  def initialize(beneficiary:, amount:, payment_type:, reference_number: nil, meta: {})
+    @beneficiary = beneficiary
+    @amount = amount
+    @payment_type = payment_type
+    super(reference_number: reference_number, meta: meta)
+  end
+end

data/lib/hws-connectors/dto/payout/payout_response.rb

@@ -0,0 +1,17 @@
+class Hws::Connectors::Dto::PayoutResponse < Hws::Connectors::Response
+  attr_accessor :reference_number, :account_holder, :amount, :payment_type, :beneficiary
+  attr_accessor :txn_time, :status, :bank_ref_num
+
+  def initialize(reference_number:, beneficiary:, account_holder: nil, amount:, payment_type:, txn_time:, status:, bank_ref_num: nil,
+                 message: nil, meta: {})
+    @reference_number = reference_number
+    @beneficiary = beneficiary
+    @account_holder = account_holder
+    @amount = amount
+    @payment_type = payment_type
+    @txn_time = txn_time
+    @status = status
+    @bank_ref_num = bank_ref_num
+    super(message: message, meta: meta)
+  end
+end

data/lib/hws-connectors/dto/virtual_account/base.rb

@@ -0,0 +1,3 @@
+require 'hws-connectors/dto/virtual_account/virtual_account_request'
+require 'hws-connectors/dto/virtual_account/virtual_account_response'
+require 'hws-connectors/dto/virtual_account/credit_virtual_account_response'

data/lib/hws-connectors/dto/virtual_account/credit_virtual_account_response.rb

@@ -0,0 +1,13 @@
+class Hws::Connectors::Dto::CreditVirtualAccountResponse < Hws::Connectors::Response
+  attr_accessor :credit_time, :beneficiary, :remitter, :amount, :payment_type, :bank_ref_num
+
+  def initialize(credit_time:, beneficiary:, remitter:, amount:, payment_type:, bank_ref_num:, meta: {})
+    @credit_time = credit_time
+    @beneficiary = beneficiary
+    @remitter = remitter
+    @amount = amount
+    @payment_type = payment_type
+    @bank_ref_num = bank_ref_num
+    super(meta: meta)
+  end
+end

data/lib/hws-connectors/dto/virtual_account/virtual_account_request.rb

@@ -0,0 +1,8 @@
+class Hws::Connectors::Dto::VirtualAccountRequest < Hws::Connectors::Request
+  attr_accessor :remitters
+
+  def initialize(remitters: [], reference_number:, meta: {})
+    @remitters = remitters
+    super(reference_number: reference_number, meta: meta)
+  end
+end

data/lib/hws-connectors/dto/virtual_account/virtual_account_response.rb

@@ -0,0 +1,12 @@
+class Hws::Connectors::Dto::VirtualAccountResponse < Hws::Connectors::Response
+  attr_accessor :reference_number, :beneficiary, :remitters, :status, :balance
+
+  def initialize(reference_number:, beneficiary:, remitters: [], status: nil, balance: nil, message: nil, meta: {})
+    @reference_number = reference_number
+    @beneficiary = beneficiary
+    @remitters = remitters
+    @status = status
+    @balance = balance
+    super(message: message, meta: meta)
+  end
+end

data/lib/hws-connectors/engine.rb

@@ -0,0 +1,4 @@
+require 'rails/engine'
+
+class Hws::Connectors::Engine < Rails::Engine
+end

data/lib/hws-connectors/exception.rb

@@ -0,0 +1,33 @@
+module Hws::Connectors::Exception
+  class Error < StandardError
+    attr_accessor :reason
+
+    def initialize(err = nil)
+      case err.class.name
+      when 'Hash'
+        @reason = err['reason']
+        super(err['message'])
+      else
+        super(err)
+      end
+    end
+  end
+
+  class UnAuthorized < Error
+    def initialize(msg = 'Invalid credentials')
+      super(msg)
+    end
+  end
+
+  class LowBalance < Error
+    def initialize(msg = 'Your account balance is low')
+      super(msg)
+    end
+  end
+
+  class RatelimitExceeded < Error
+    def initialize(msg = 'You have exceeded the number of attempts')
+      super(msg)
+    end
+  end
+end

data/lib/hws-connectors/helper.rb

@@ -0,0 +1,23 @@
+module Hws::Connectors::Helper
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def option(param, block = nil)
+      [self, self.class].each do |_class|
+        _class.class_eval do
+          attr_accessor(param)
+          next if block.nil?
+
+          define_method(param) do
+            instance_variable_set("@#{param}", block.call) if instance_variable_get("@#{param}").nil?
+            instance_variable_get("@#{param}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hws-connectors/hypto/base.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+require 'rest-client'
+
+class Hws::Connectors::Hypto < Hws::Connectors
+  NAME = 'hypto'.freeze
+  END_POINTS = ::YAML.load_file(File.join(__dir__, 'endpoints.yml')).freeze
+
+  def initialize(options = {})
+    @api_token = options['api_token']
+    @base_url = "https://partners.hypto#{'.co' if options['env'].try(:to_sym) != :production}.in"
+  end
+
+  protected
+
+  def initiate_request(method, payload = {})
+    begin
+      _class = self.class.name
+      Hws::Connectors.logger.debug "===== #{_class}.#{method} - args: #{payload} ====="
+
+      end_point = END_POINTS[_class][method.to_s].clone
+      end_point['path'] = end_point['path'] % payload if end_point['path'].include?('%')
+
+      resp = RestClient::Request.execute(url: "#{@base_url}#{end_point['path']}", method: end_point['method'], payload: payload.to_json, headers: headers).body
+      Hws::Connectors.logger.debug "===== #{_class}.#{method} - Response: #{resp} =====" if Hws::Connectors.logging?(end_point['method'])
+      return JSON.parse(resp)
+    rescue => e
+      error = e.try(:response).try(:body)
+      Hws::Connectors.logger.error "===== #{_class}.#{method} - Error: #{error} ====="
+      error = JSON.parse(error) if error.present?
+
+      case e.class.name
+      when 'RestClient::Unauthorized'
+        raise Hws::Connectors::Exception::UnAuthorized.new(error)
+      when 'RestClient::TooManyRequests'
+        raise Hws::Connectors::Exception::RatelimitExceeded.new(error)
+      when 'RestClient::BadRequest', 'RestClient::NotFound'
+        case error['reason']
+        when 'Action Denied. Your account balance is negative'
+          raise Hws::Connectors::Exception::LowBalance.new(error)
+        else
+          raise Hws::Connectors::Exception::Error.new(error)
+        end
+      else
+        raise Hws::Connectors::Exception::Error.new(e.message)
+      end
+    end
+  end
+
+  private
+
+  def headers
+    { 'Authorization' => @api_token, 'Content-Type' => 'application/json' }
+  end
+end
+
+require_relative 'virtual_account/base'
+require_relative 'payout/base'

data/lib/hws-connectors/hypto/endpoints.yml

@@ -0,0 +1,36 @@
+Hws::Connectors::Hypto::VirtualAccount:
+  create:
+    method: post
+    path: /api/virtual_accounts
+  fetch:
+    method: get
+    path: /api/virtual_accounts/%{id}
+  update:
+    method: post
+    path: /api/virtual_accounts/%{id}/modify
+  activate:
+    method: post
+    path: /api/virtual_accounts/%{id}/activate
+  deactivate:
+    method: post
+    path: /api/virtual_accounts/%{id}/deactivate
+  send_to_bank_account:
+    method: post
+    path: /api/virtual_accounts/%{id}/transfer
+  send_to_upi_id:
+    method: post
+    path: /api/virtual_accounts/%{id}/transfer
+  status:
+    method: get
+    path: /api/virtual_accounts/%{id}/transfer/%{reference_number}
+
+Hws::Connectors::Hypto::Payout:
+  send_to_bank_account:
+    method: post
+    path: /api/transfers/initiate
+  send_to_upi_id:
+    method: post
+    path: /api/transfers/initiate
+  status:
+    method: get
+    path: /api/transfers/status/%{reference_number}

data/lib/hws-connectors/hypto/payout/base.rb

@@ -0,0 +1,48 @@
+class Hws::Connectors::Hypto::Payout < Hws::Connectors::Hypto
+  META_RESPONSES = %w(id txn_time created_at txn_type charges_gst settled_amount closing_balance connected_banking transfer_udf1 transfer_udf2 transfer_udf3 transfer_initiated_account_ifsc)
+
+  # @!group Actions
+
+  # @param [Types::PayoutRequest] request
+  # @return [Types::PayoutResponse]
+  def send_to_bank_account(request:)
+    beneficiary = request.beneficiary
+    payload = { reference_number: request.reference_number, number: beneficiary.account_number, ifsc: beneficiary.account_ifsc, amount: request.amount,
+                payment_type: request.payment_type, note: beneficiary.note, beneficiary_name: beneficiary.name, udf1: request.meta[:udf1],
+                udf2: request.meta[:udf2], udf3: request.meta[:udf3] }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::PayoutRequest] request
+  # @return [Types::PayoutResponse]
+  def send_to_upi_id(request:)
+    beneficiary = request.beneficiary
+    payload = { reference_number: request.reference_number, upi_id: beneficiary.upi_id, amount: request.amount, payment_type: 'UPI',
+                note: beneficiary.note, beneficiary_name: beneficiary.name, udf1: request.meta[:udf1],
+                udf2: request.meta[:udf2], udf3: request.meta[:udf3] }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::String] reference_number
+  # @return [Types::PayoutResponse]
+  def status(reference_number:)
+    payload = { reference_number: reference_number }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  private
+
+  def to_response(resp_data, message)
+    beneficiary = Hws::Connectors::Dto::AccountDetail
+                    .new(name: resp_data['transfer_beneficiary_name'], account_number: resp_data['transfer_account_number'],
+                         account_ifsc: resp_data['transfer_account_ifsc'], note: resp_data['transfer_note'])
+    Hws::Connectors::Dto::PayoutResponse
+      .new(reference_number: resp_data['reference_number'], beneficiary: beneficiary, account_holder: resp_data['transfer_account_holder'],
+           amount: resp_data['settled_amount'], payment_type: resp_data['payment_type'], status: resp_data['status'], message: message,
+           bank_ref_num: resp_data['bank_ref_num'], txn_time: Time.strptime(resp_data['txn_time'], '%Y-%m-%d %H:%M:%S'),
+           meta: resp_data.slice(*META_RESPONSES))
+  end
+end

data/lib/hws-connectors/hypto/virtual_account/base.rb

@@ -0,0 +1,69 @@
+class Hws::Connectors::Hypto::VirtualAccount < Hws::Connectors::Hypto
+  META_RESPONSES = %w(id account_number udf1 udf2 udf3 settle_to parent_id parent_type level hierarchy created_at updated_at link_upi upi_details)
+
+  # @!group Actions
+
+  # @param [Types::VirtualAccountRequest] request
+  # @return [Types::VirtualAccountResponse]
+  def create(request:)
+    payload = { reference_number: request.reference_number, udf1: request.meta[:udf1], udf2: request.meta[:udf2], udf3: request.meta[:udf3],
+                parent_id: request.meta[:parent_id], link_upi: request.meta[:link_upi], upi_name: request.meta[:upi_name],
+                whitelisted_remitters: request.remitters.map { |remitter| { number: remitter.beneficiary.account_number, ifsc: remitter.beneficiary.account_ifsc } } }
+    payload[:settle_to] = request.meta[:settle_to] if request.meta[:settle_to].present?
+    payload[:parent_type] = request.meta[:parent_type] if request.meta[:parent_type].present?
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data']['virtual_account'], resp['message'])
+  end
+
+  # @param [Types::String] reference_number
+  # @return [Types::VirtualAccountResponse]
+  def fetch(reference_number:)
+    payload = { id: reference_number }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::VirtualAccountRequest] request
+  # @return [Types::VirtualAccountResponse]
+  def update(request:)
+    payload = { id: request.meta[:id], reference_number: request.reference_number, udf1: request.meta[:udf1], udf2: request.meta[:udf2], udf3: request.meta[:udf3],
+                whitelisted_remitters: request.remitters.map { |remitter| { number: remitter.beneficiary.account_number, ifsc: remitter.beneficiary.account_ifsc } } }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data']['virtual_account'], resp['message'])
+  end
+
+  # @param [Types::String] reference_number
+  # @return [Types::VirtualAccountResponse]
+  def activate(reference_number:)
+    payload = { id: reference_number }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::String] reference_number
+  # @return [Types::VirtualAccountResponse]
+  def deactivate(reference_number:)
+    payload = { id: reference_number }
+    resp = initiate_request(__method__, payload)
+    to_response(resp['data'], resp['message'])
+  end
+
+  require_relative 'transaction'
+  include Transaction
+
+  private
+
+  def to_response(resp_data, message)
+    resp_account_data = resp_data['details'][0]
+    beneficiary = Hws::Connectors::Dto::AccountDetail.new(account_number: resp_account_data['account_number'], account_ifsc: resp_account_data['account_ifsc'])
+
+    remitters = []
+    resp_data['whitelisted_remitters'].each do |wl_rmtr|
+      remitters << Hws::Connectors::Dto::AccountDetail.new(account_number: wl_rmtr['number'], account_ifsc: wl_rmtr['ifsc'], created_at: wl_rmtr['created_at'], updated_at: wl_rmtr['updated_at'])
+    end
+
+    Hws::Connectors::Dto::VirtualAccountResponse
+      .new(reference_number: resp_data['reference_number'], beneficiary: beneficiary, remitters: remitters, status: resp_data['status'],
+           balance: resp_data['account_balance'], message: message, meta: resp_data.slice(*META_RESPONSES))
+  end
+end

data/lib/hws-connectors/hypto/virtual_account/transaction.rb

@@ -0,0 +1,46 @@
+module Hws::Connectors::Hypto::VirtualAccount::Transaction
+  TXN_META_RESPONSES = %w(id txn_time created_at txn_type charges_gst settled_amount closing_balance connected_banking transfer_udf1 transfer_udf2 transfer_udf3 transfer_initiated_account_ifsc hypto_va_id va_closing_balance va_wallet_amount)
+
+  # @param [Types::PayoutRequest] request
+  # @return [Types::PayoutResponse]
+  def send_to_bank_account(request:)
+    beneficiary = request.beneficiary
+    payload = { reference_number: request.reference_number, number: beneficiary.account_number, ifsc: beneficiary.account_ifsc, amount: request.amount,
+                payment_type: request.payment_type, note: beneficiary.note, beneficiary_name: beneficiary.name, udf1: request.meta[:udf1],
+                udf2: request.meta[:udf2], udf3: request.meta[:udf3], id: request.meta[:va_id] }
+    resp = initiate_request(__method__, payload)
+    to_txn_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::PayoutRequest] request
+  # @return [Types::PayoutResponse]
+  def send_to_upi_id(request:)
+    beneficiary = request.beneficiary
+    payload = { reference_number: request.reference_number, upi_id: beneficiary.upi_id, amount: request.amount, payment_type: 'UPI',
+                note: beneficiary.note, beneficiary_name: beneficiary.name, udf1: request.meta[:udf1],
+                udf2: request.meta[:udf2], udf3: request.meta[:udf3], id: request.meta[:va_id] }
+    resp = initiate_request(__method__, payload)
+    to_txn_response(resp['data'], resp['message'])
+  end
+
+  # @param [Types::String] reference_number
+  # @return [Types::PayoutResponse]
+  def status(reference_number:, va_id: nil)
+    payload = { reference_number: reference_number, id: va_id }
+    resp = initiate_request(__method__, payload)
+    to_txn_response(resp['data'], resp['message'])
+  end
+
+  private
+
+  def to_txn_response(resp_data, message)
+    beneficiary = Hws::Connectors::Dto::AccountDetail
+                    .new(name: resp_data['transfer_beneficiary_name'], account_number: resp_data['transfer_account_number'],
+                         account_ifsc: resp_data['transfer_account_ifsc'], note: resp_data['transfer_note'])
+    Hws::Connectors::Dto::PayoutResponse
+      .new(reference_number: resp_data['reference_number'], beneficiary: beneficiary, account_holder: resp_data['transfer_account_holder'],
+           amount: resp_data['settled_amount'], payment_type: resp_data['payment_type'], status: resp_data['status'], message: message,
+           bank_ref_num: resp_data['bank_ref_num'], txn_time: Time.strptime(resp_data['txn_time'], '%Y-%m-%d %H:%M:%S'),
+           meta: resp_data.slice(*TXN_META_RESPONSES))
+  end
+end

data/lib/hws-connectors/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+
+class Hws::Connectors::Railtie < ::Rails::Railtie
+  initializer 'Configure Rails Logger' do
+    Hws::Connectors.configure do |config|
+      config.logger = ::Rails.logger
+      config.options = { skip_logging: %w(get) }
+    end
+  end
+end

data/lib/hws-connectors.rb

@@ -0,0 +1,30 @@
+module Hws
+  class Connectors
+    VERSION = '0.1.0'.freeze
+
+    require 'hws-connectors/exception'
+    include Hws::Connectors::Exception
+    require 'hws-connectors/helper'
+    include Hws::Connectors::Helper
+
+    option :logger
+    option :options
+    option :webhooks
+
+    class << self
+      def configure
+        yield self
+        self
+      end
+
+      def logging?(method)
+        !options[:skip_logging].to_a.include?(method.to_s)
+      end
+    end
+  end
+end
+
+require 'hws-connectors/railtie'
+require 'hws-connectors/engine'
+require 'hws-connectors/dto/base'
+require 'hws-connectors/hypto/base'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: hws-connectors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hypto Engineering Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.33
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: Primitive for connecting to the financial services
+email:
+- engineering@hypto.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/hws/connectors/payouts_controller.rb
+- app/controllers/hws/connectors/virtual_accounts_controller.rb
+- app/controllers/hws/connectors/webhooks_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- hws-connectors.gemspec
+- lib/hws-connectors.rb
+- lib/hws-connectors/base.rb
+- lib/hws-connectors/dto/base.rb
+- lib/hws-connectors/dto/common/account_detail.rb
+- lib/hws-connectors/dto/common/base.rb
+- lib/hws-connectors/dto/common/entity.rb
+- lib/hws-connectors/dto/common/request.rb
+- lib/hws-connectors/dto/common/response.rb
+- lib/hws-connectors/dto/payout/base.rb
+- lib/hws-connectors/dto/payout/payout_request.rb
+- lib/hws-connectors/dto/payout/payout_response.rb
+- lib/hws-connectors/dto/virtual_account/base.rb
+- lib/hws-connectors/dto/virtual_account/credit_virtual_account_response.rb
+- lib/hws-connectors/dto/virtual_account/virtual_account_request.rb
+- lib/hws-connectors/dto/virtual_account/virtual_account_response.rb
+- lib/hws-connectors/engine.rb
+- lib/hws-connectors/exception.rb
+- lib/hws-connectors/helper.rb
+- lib/hws-connectors/hypto/base.rb
+- lib/hws-connectors/hypto/endpoints.yml
+- lib/hws-connectors/hypto/payout/base.rb
+- lib/hws-connectors/hypto/virtual_account/base.rb
+- lib/hws-connectors/hypto/virtual_account/transaction.rb
+- lib/hws-connectors/railtie.rb
+homepage: https://github.com/hwslabs/hws-connectors-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hwslabs/hws-connectors-ruby
+  source_code_uri: https://github.com/hwslabs/hws-connectors-ruby
+  changelog_uri: https://github.com/hwslabs/hws-connectors-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+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: HWS Connector
+test_files: []