hws-instruments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26f1c3f62a2642c4c100d197b1955f19f3bec484e3a713247623b33d7228ebbf
+  data.tar.gz: 558d4f2432f3b038661353885a1d4a7e7f36bd47d3766cd65a807ebb5f9a8d00
+SHA512:
+  metadata.gz: 0f28b2a2a05a2c621b6c94be673581ac86c706e2bbc6c7fafa964a28dfdcfdd7ee31552da1f517c26656d3e825c4a8a1f69510f2a17f6257ac3ba609689a0356
+  data.tar.gz: 99d596a7e62827e639f68f618341f819b6679d700e58a9f062ce309beea4bba4c78c13db4966972e69c3aaae49c07275ae66e8a85fe8bdc96b02f66821695f25

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/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hws-instrument.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'

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,43 @@
+# Hws::Instruments
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hws/instruments`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hws-instruments'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hws-instruments
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hws-instruments. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hws::Instruments project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hws-instruments/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hws/instruments"
+
+# 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/lib/generators/hws/instruments/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Adds necessary ActiveRecord migrations to the rails application
+
+Example:
+    rails generate hws:instruments:install
+
+    This will create:
+        db/migrate/<migration_number>_create_hws_instruments_tables.rb

data/lib/generators/hws/instruments/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Hws::Instruments
+  class InstallGenerator < Rails::Generators::Base # :nodoc:
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('templates', __dir__)
+
+    def self.next_migration_number(path)
+      ActiveRecord::Generators::Base.next_migration_number(path)
+    end
+
+    desc 'copying migrations to db/migrate'
+    def copy_migrations
+      migration_template 'migration.rb.erb', 'db/migrate/create_hws_instruments_tables.rb'
+    end
+  end
+end

data/lib/generators/hws/instruments/templates/migration.rb.erb

@@ -0,0 +1,33 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def self.up
+    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
+
+    create_table :instrument_configs, id: :uuid do |t| # payout
+      t.string   :connector_id # Hws::Connectors::Hypto::{VirtualAccounts, Payouts, UPI}, Hws::Connectors::YesBank::{...}, ...
+      t.string   :executor_id # Hws::Instruments::Executors::Hypto::VirtualAccounts
+      t.jsonb    :connector_credentials, default: {}
+      t.jsonb    :connector_actions, default: {} # {'action:send_to_bank': Hws::Connector::Payout::SendToBankRequest, ..}
+      t.timestamps
+    end
+
+    create_table :instruments, id: :uuid do |t|
+      t.belongs_to :instrument_config, type: :uuid, foreign_key: true
+      t.string     :external_identifier # VAN for virtual acc, UPI ID for UPI, nil for payouts
+      t.jsonb      :value, default: {}
+      t.jsonb      :connector_actions, default: {} # {'action:send_to_bank': {acc_no: '', ifsc, ref_no, amount, payent_mode, note}, ..}
+      t.jsonb      :allowed_actions, default: [] # array of actions which are enabled for the instrument
+      t.timestamps
+    end
+
+    # TODO - Decide if connector_id can be made the primary key of this table
+    add_index :instrument_configs, :connector_id, unique: true
+
+    add_index :instruments, :value, using: :gin
+    add_index :instruments, %I[external_identifier instrument_config_id], name: 'e_i_index'
+  end
+
+  def self.down
+    drop_table :instruments
+    drop_table :instrument_configs
+  end
+end

data/lib/hws-instruments/exceptions/exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hws::Instruments::Exceptions
+  class UnknownActionError < StandardError; end
+
+  class UnknownEntityError < StandardError; end
+end

data/lib/hws-instruments/executors/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hws::Instruments::Executors::Base
+  def execute(action, instrument, options)
+    actions = instrument.instrument_config.connector_actions.with_indifferent_access
+    unless actions.present? && actions.key?(action)
+      raise(
+        Hws::Instruments::Exceptions::UnknownActionError,
+        "Unknown action: #{action} for connector #{instrument.instrument_config.connector_id} | Allowed are: [#{actions}]"
+      )
+    end
+    raise "Action disabled: #{action}" if instrument.allowed_actions.include?(action)
+
+    Rails.logger.info "Instruments::Executors - Executing: action:#{action}, instrument: #{instrument}, options: #{options}"
+
+    if self.methods.include?(action) || self.private_methods.include?(action)
+      self.send(action.to_sym, instrument, options)
+    else
+      instrument.instrument_config.connector.send(action, options)
+    end
+  end
+end

data/lib/hws-instruments/executors/hypto/payouts.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+=begin
+  Instrument Config:
+  - connector_id: Hws::Connectors::Hypto::VirtualAccount
+  - executor_id: Hws::Instruments::Executors::Hypto::VirtualAccount
+  - connector_actions:
+      {'action:send_to_bank': Hws::Connector::Payout::SendToBankRequest, ..}
+
+  Instrument:
+  - value:
+=end
+
+# Hws::Connectors::Dto::PayoutRequest
+
+class Hws::Instruments::Executors::Hypto::Payouts # :nodoc:
+  require 'hws-instruments/executors/base'
+  extend Hws::Instruments::Executors::Base
+
+  class << self
+    private
+
+    def send_to_bank_account(instrument, options)
+      options['beneficiary'] = Hws::Connectors::Dto::AccountDetail.new(options.delete('beneficiary').symbolize_keys)
+      req = Hws::Connectors::Dto::PayoutRequest.new(options.symbolize_keys)
+      instrument.instrument_config.connector.send_to_bank_account(request: req)
+    end
+
+    def send_to_upi_id(instrument, options)
+      options['beneficiary'] = Hws::Connectors::Dto::AccountDetail.new(options.delete('beneficiary').symbolize_keys)
+      req = Hws::Connectors::Dto::PayoutRequest.new(options.symbolize_keys)
+      instrument.instrument_config.connector.send_to_upi_id(request: req)
+    end
+
+    def status(instrument, options)
+      instrument.instrument_config.connector.status(reference_number: options[:reference_number])
+    end
+  end
+end

data/lib/hws-instruments/executors/hypto/virtual_account.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Executor for Hypto Virtual account module
+class Hws::Instruments::Executors::Hypto::VirtualAccount
+  require 'hws-instruments/executors/base'
+  extend Hws::Instruments::Executors::Base
+
+  class << self
+    private
+
+    def create(instrument, _)
+      resp = instrument.instrument_config.connector.create(
+        request: Hws::Connectors::Dto::VirtualAccountRequest.new(reference_number: instrument.id)
+      )
+      instrument.update!(
+        external_identifier: resp.beneficiary.account_number,
+        value: { id: resp.meta[:id], va_num: resp.beneficiary.account_number, account_ifsc: resp.beneficiary.account_ifsc }
+      )
+      instrument
+    end
+
+    def fetch(instrument, _); end
+
+    def update(instrument); end
+
+    def activate(instrument, _)
+      resp = instrument.instrument_config.connector.activate(reference_number: instrument.value['id'])
+      instrument.update!(value: instrument.value.merge({ status: 'ACTIVE' })) if resp.status == 'ACTIVE'
+    end
+
+    def deactivate(instrument, _)
+      resp = instrument.instrument_config.connector.deactivate(reference_number: instrument.value['id'])
+      instrument.update!(value: instrument.value.merge({ status: 'INACTIVE' })) if resp.status == 'INACTIVE'
+    end
+  end
+end

data/lib/hws-instruments/models/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Hws::Instruments::Models
+  class Base < ActiveRecord::Base # :nodoc:
+    self.abstract_class = true
+
+    before_create :set_uuid
+
+    def set_uuid
+      self.id = ::LSUUID.generate if self.id.blank?
+    end
+  end
+end

data/lib/hws-instruments/models/instrument.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Hws::Instruments::Models::Instrument < ActiveRecord::Base # :nodoc:
+  belongs_to :instrument_config
+
+  def execute(action:, options: {})
+    Rails.logger.debug("Instrument.execute(action: #{action}, options: #{options})")
+    self.instrument_config.executor.execute(action, self, options)
+  end
+end

data/lib/hws-instruments/models/instrument_config.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'hws-instruments/models/base'
+
+class Hws::Instruments::Models::InstrumentConfig < Hws::Instruments::Models::Base # :nodoc:
+  has_many :instruments
+
+  MANDATORY_FIELDS = %I[connector_id executor_id connector_credentials connector_actions].freeze
+
+  def self.create_config(params)
+    raise 'Missing mandatory param' unless params.keys.all? { |x| MANDATORY_FIELDS.include?(x) }
+
+    begin
+      unless Object.const_defined?(params[:connector_id])
+        raise Hws::Instruments::Exceptions::UnknownEntityError, "Connector not found: #{params[:connector_id]}"
+      end
+    rescue NameError => _e
+      raise Hws::Instruments::Exceptions::UnknownEntityError, "Connector not found: #{params[:connector_id]}"
+    end
+
+    begin
+      unless Object.const_defined?(params[:executor_id])
+        raise Hws::Instruments::Exceptions::UnknownEntityError, "Executor not found: #{params[:executor_id]}"
+      end
+    rescue NameError => _e
+      raise Hws::Instruments::Exceptions::UnknownEntityError, "Executor not found: #{params[:executor_id]}"
+    end
+
+    self.create(params)
+  end
+
+  def create_instrument(_external_identifier = nil)
+    instrument = self.instruments.create
+    instrument.execute(action: :create)
+  end
+
+  def connector
+    unless Object.const_defined?(self.connector_id)
+      raise "Invalid connector configuration. conn_id: #{self.connector_id}"
+    end
+
+    self.connector_id.constantize.new(self.connector_credentials)
+  end
+
+  def executor
+    raise "Invalid instrument executor with id: #{self.executor_id}" unless Object.const_defined?(self.executor_id)
+
+    self.executor_id.constantize
+  end
+end

data/lib/hws-instruments/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'hws-instruments'
+
+# Expose rake tasks to users of the gem
+class Hws::Instruments::Railtie < Rails::Railtie
+  railtie_name :'hws-instruments'
+
+  rake_tasks do
+    path = File.expand_path(__dir__)
+    Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+  end
+end

data/lib/hws-instruments/tasks/hypto.rake

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+namespace :'hws-instruments' do # rubocop:disable Metrics/BlockLength
+  namespace :hypto do # rubocop:disable Metrics/BlockLength
+    desc 'Initializes a Hypto payouts instrument config in DB'
+    task :payouts, [:api_token] => :environment do |_t, args|
+      Hws::Instruments.create_instrument_config(
+        connector_id: 'Hws::Connectors::Hypto::Payout',
+        executor_id: 'Hws::Instruments::Executors::Hypto::Payouts',
+        connector_credentials: args.to_h,
+        connector_actions: {
+          create: '', # Local action without connector call
+          status: 'String',
+          send_to_upi_id: 'Hws::Connectors::Dto::PayoutRequest',
+          send_to_bank_account: 'Hws::Connectors::Dto::PayoutRequest'
+        }
+      )
+    end
+
+    desc 'Initializes a Hypto virtual accounts instrument config in DB'
+    task :virtual_account, [:api_token] => :environment do |_t, args|
+      Hws::Instruments.create_instrument_config(
+        connector_id: 'Hws::Connectors::Hypto::VirtualAccount',
+        executor_id: 'Hws::Instruments::Executors::Hypto::VirtualAccount',
+        connector_credentials: args.to_h,
+        connector_actions: {
+          list: 'Hws::Connectors::Dto::ListVirtualAccountRequest',
+          fetch: 'Hws::Connectors::Dto::FetchVirtualAccountRequest',
+          create: 'Hws::Connectors::Dto::CreateVirtualAccountRequest',
+          search: 'Hws::Connectors::Dto::SearchVirtualAccountRequest',
+          status: 'Hws::Connectors::Dto::StatusRequest',
+          update: 'Hws::Connectors::Dto::UpdateVirtualAccountRequest',
+          activate: 'Hws::Connectors::Dto::ActivateVirtualAccountRequest',
+          statement: 'Hws::Connectors::Dto::StatementRequest',
+          deactivate: 'Hws::Connectors::Dto::DeactivateVirtualAccountRequest',
+          send_to_upi_id: 'Hws::Connectors::Dto::SendToUpiIdRequest',
+          send_to_bank_account: 'Hws::Connectors::Dto::SendToBankAccountRequest'
+        }
+      )
+    end
+  end
+end

data/lib/hws-instruments.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'hws-connectors'
+
+module Hws
+  module Instruments # :nodoc:
+    module Models # :nodoc:
+      require 'lsuuid'
+      require 'hws-instruments/models/instrument_config'
+      require 'hws-instruments/models/instrument'
+    end
+
+    module Executors
+      module Hypto # :nodoc:
+        require 'hws-instruments/executors/hypto/virtual_account'
+        require 'hws-instruments/executors/hypto/payouts'
+      end
+    end
+
+    module Exceptions
+      require 'hws-instruments/exceptions/exceptions'
+    end
+
+    def self.create_instrument_config(*args)
+      Models::InstrumentConfig.create_config(*args)
+    end
+  end
+end
+
+require 'hws-instruments/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: hws-instruments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hypto Engineering Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hws-connectors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: lsuuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Instruments library
+email:
+- engineering@hypto.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/hws/instruments/USAGE
+- lib/generators/hws/instruments/install_generator.rb
+- lib/generators/hws/instruments/templates/migration.rb.erb
+- lib/hws-instruments.rb
+- lib/hws-instruments/exceptions/exceptions.rb
+- lib/hws-instruments/executors/base.rb
+- lib/hws-instruments/executors/hypto/payouts.rb
+- lib/hws-instruments/executors/hypto/virtual_account.rb
+- lib/hws-instruments/models/base.rb
+- lib/hws-instruments/models/instrument.rb
+- lib/hws-instruments/models/instrument_config.rb
+- lib/hws-instruments/railtie.rb
+- lib/hws-instruments/tasks/hypto.rake
+homepage: https://github.com/hwslabs/hws-instruments-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hwslabs/hws-instruments-ruby
+  source_code_uri: https://github.com/hwslabs/hws-insruments-ruby
+  changelog_uri: https://github.com/hwslabs/hws-insruments-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Instruments library
+test_files: []