k2-connect-ruby 0.0.1

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w(--color --format documentation nested)
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'k2-connect-ruby'
+
+# 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/k2-connect-ruby.gemspec

@@ -0,0 +1,51 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'k2-connect-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'k2-connect-ruby'
+  spec.version       = K2ConnectRuby::VERSION
+  spec.authors       = ['DavidKar1uk1']
+  spec.email         = ['David.mwangi@kopokopo.com']
+
+  spec.summary       = 'Ruby SDK for connection to the Kopo Kopo API.'
+  spec.description   = 'Ruby SDK for connection to the Kopo Kopo API, with webhook handling and JSON request parsing with the Ruby on Rails framework.'
+  spec.homepage      = 'https://github.com/kopokopo/k2-connect-ruby.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/kopokopo/k2-connect-ruby.git'
+    spec.metadata['changelog_uri'] = 'https://github.com/kopokopo/k2-connect-ruby.git/CHANGELOG.MD'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) 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 'activesupport', '~> 6.1.3.1'
+  spec.add_dependency 'activemodel', '~> 6.1.3.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency "guard", '~> 2.16.2'
+  spec.add_development_dependency "guard-rspec", '~> 4.7.3'
+  spec.add_dependency 'rest-client', '~> 2.1.0'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency "rspec-nc", '~> 0.3.0'
+  spec.add_development_dependency 'vcr', '~> 6.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.12.2'
+  spec.add_dependency 'yajl-ruby', '~> 1.4.1'
+end

data/lib/k2-connect-ruby.rb

@@ -0,0 +1,34 @@
+# Base
+require 'k2-connect-ruby/k2_errors'
+require 'k2-connect-ruby/version'
+require 'active_model'
+require 'active_support/json'
+# For the blank? check
+require 'active_support/dependencies/autoload'
+require 'active_support/core_ext'
+
+# Utilities
+require 'k2-connect-ruby/utilities'
+
+# Services
+require 'k2-connect-ruby/k2_services/payload_process'
+
+# Entity
+require 'k2-connect-ruby/k2_financial_entity/k2_entity'
+require 'k2-connect-ruby/k2_financial_entity/entity'
+
+# ActiveSupport
+require 'active_support/core_ext/hash/indifferent_access'
+
+# YAJL
+require 'yajl'
+
+# YAML
+require 'yaml'
+
+# Rest Client
+require 'rest-client'
+
+# JSON
+require 'json'
+

data/lib/k2-connect-ruby/k2_errors.rb

@@ -0,0 +1,77 @@
+# Standard K2Error
+class K2Errors < StandardError
+  attr_reader :status, :message
+  def initialize(msg = @message)
+    super(msg)
+  end
+end
+
+# For errors concerning the Status code returned from Kopo Kopo
+class K2ConnectionError < K2Errors
+  def initialize(error)
+    @error = error
+  end
+
+  def message
+    case @error
+    when 400.to_s
+      STDERR.puts "Bad Request.\n\tYour request is Invalid"
+    when 401.to_s
+      STDERR.puts "Unauthorized.\n Your API key is wrong"
+    when 403.to_s
+      STDERR.puts "Forbidden.\n The resource requested cannot be accessed"
+    when 404.to_s
+      STDERR.puts "Not Found.\n\tThe specified resource could not be found"
+    when 405.to_s
+      STDERR.puts "Method Not Allowed.\n You tried to access a resource with an invalid method"
+    when 406.to_s
+      STDERR.puts "Not Acceptable.\n You requested a format that isn't valid json"
+    when 410.to_s
+      STDERR.puts "Gone.\n The resource requested has been moved"
+    when 429.to_s
+      STDERR.puts "Too Many Requests.\n Request threshold has been exceeded"
+    when 500.to_s
+      STDERR.puts "Internal Server Error.\n We had a problem with our server. Try again later"
+    when 503.to_s
+      STDERR.puts "Service Unavailable.\n We're temporarily offline for maintenance. Please try again later"
+    else
+      STDERR.puts 'Undefined Kopo Kopo Server Response.'
+    end
+  end
+end
+
+# Errors concerning the Validation module
+class K2ValidateErrors < K2Errors
+  attr_reader :the_keys
+
+  def initialize(the_keys)
+    super
+    @the_keys = the_keys
+    @status = :bad_request
+  end
+
+  def loop_keys
+    STDERR.puts @message
+    @the_keys.each(&method(:puts))
+  end
+
+  def message
+    loop_keys
+  end
+end
+
+# Hash / Params has Empty Values within it
+class K2EmptyParams < K2ValidateErrors
+  def initialize(the_keys)
+    @message = "Invalid Hash Object!\n The Following Parameter(s) are Empty: "
+    super
+  end
+end
+
+# Error for Incorrect Hash Key Symbols (K2Entity validate => input)
+class K2IncorrectParams < K2ValidateErrors
+  def initialize(the_keys)
+    @message = "Incorrect Hash/Parameters Object!\n The Following Parameter(s) are Incorrect: "
+    super
+  end
+end

data/lib/k2-connect-ruby/k2_financial_entity/entities/k2_pay.rb

@@ -0,0 +1,100 @@
+# For PAY/ Send Money to others
+# TODO: Add K2Config configuration for the callback URL
+class K2Pay < K2Entity
+  attr_reader :recipients_location_url, :payments_location_url
+
+  # Adding PAY Recipients with either mobile_wallets or bank_accounts as destination of your payments.
+  def add_recipient(params)
+    params = params.with_indifferent_access
+    @exception_array += %w[type]
+    # In the case of mobile pay recipient
+    if params[:type].eql?('mobile_wallet')
+      params = validate_input(params, @exception_array += %w[first_name last_name phone_number email network])
+      k2_request_pay_recipient = {
+        first_name: params[:first_name],
+        last_name: params[:last_name],
+        phone_number: validate_phone(params[:phone_number]),
+        email: validate_email(params[:email]),
+        network: params[:network]
+      }
+      # In the case of bank pay recipient
+    elsif params[:type].eql?('bank_account')
+      params = validate_input(params, @exception_array += %w[account_name account_number bank_branch_ref settlement_method])
+      k2_request_pay_recipient = {
+          account_name: params[:account_name],
+          account_number: params[:account_number],
+          bank_branch_ref: params[:bank_branch_ref],
+          settlement_method: params[:settlement_method]
+      }
+      # In the case of till pay recipient
+    elsif params[:type].eql?('till')
+      params = validate_input(params, @exception_array += %w[till_name till_number])
+      k2_request_pay_recipient = {
+        till_name: params[:till_name],
+        till_number: params[:till_number]
+      }
+      # In the case of bank pay recipient
+    elsif params[:type].eql?('kopo_kopo_merchant')
+      params = validate_input(params, @exception_array += %w[alias_name till_number])
+      k2_request_pay_recipient = {
+        alias_name: params[:alias_name],
+        till_number: params[:till_number]
+      }
+    else
+      raise ArgumentError, 'Undefined Payment Method.'
+    end
+    recipients_body = {
+      type: params[:type],
+      #type: params['pay_type'],
+      pay_recipient: k2_request_pay_recipient
+    }
+    pay_recipient_hash = make_hash(K2Config.path_url('pay_recipient'), 'post', @access_token, 'PAY', recipients_body)
+    @threads << Thread.new do
+      sleep 0.25
+      @recipients_location_url = K2Connect.make_request(pay_recipient_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Create an outgoing Payment to a third party.
+  def create_payment(params)
+    # Validation
+    params = validate_input(params, @exception_array += %w[destination_reference destination_type currency value callback_url metadata])
+    # The Request Body Parameters
+    k2_request_pay_amount = {
+      currency: params[:currency],
+      value: params[:value]
+    }
+    k2_request_pay_metadata = params[:metadata]
+    k2_request_links = {
+        callback_url: params[:callback_url]
+    }
+    create_payment_body = {
+      destination_reference: params[:destination_reference],
+      destination_type: params[:destination_type],
+      amount: k2_request_pay_amount,
+      meta_data: k2_request_pay_metadata,
+      _links: k2_request_links
+    }
+    create_payment_hash = make_hash(K2Config.path_url('payments'), 'post', @access_token, 'PAY', create_payment_body)
+    @threads << Thread.new do
+      sleep 0.25
+      @payments_location_url = K2Connect.make_request(create_payment_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Query/Check the status of a previously initiated PAY Payment request
+  def query_status(method_type)
+    if method_type.eql?('recipients')
+      super('PAY', @recipients_location_url)
+    elsif method_type.eql?('payments')
+      super('PAY', @payments_location_url)
+    end
+  end
+
+  # Query Location URL
+  def query_resource(url)
+    super('PAY', url)
+  end
+end

data/lib/k2-connect-ruby/k2_financial_entity/entities/k2_settlement.rb

@@ -0,0 +1,49 @@
+# For Creating pre-approved and owned settlement accounts
+class K2Settlement < K2Entity
+  # Create a Verified Settlement Account via API (Mobile Wallet and Bank Account)
+  def add_settlement_account(params)
+    params=params.with_indifferent_access
+    the_path_url = ''
+    settlement_body = {}
+    @exception_array += %w[type]
+    # The Request Body Parameters
+    if params[:type].eql?('merchant_wallet')
+      params = validate_input(params, @exception_array += %w[first_name last_name phone_number network])
+      settlement_body = {
+        first_name: params[:first_name],
+        last_name: params[:last_name],
+        phone_number: validate_phone(params[:phone_number]),
+        network: params[:network]
+      }
+      the_path_url = K2Config.path_url('settlement_mobile_wallet')
+    elsif params[:type].eql?('merchant_bank_account')
+      params = validate_input(params, @exception_array += %w[account_name bank_ref bank_branch_ref account_number currency value, settlement_method])
+      settlement_body = {
+          account_name: params[:account_name],
+          bank_branch_ref: params[:bank_branch_ref],
+          account_number: params[:account_number],
+          settlement_method: params[:settlement_method]
+      }
+      the_path_url = K2Config.path_url('settlement_bank_account')
+    else
+      raise ArgumentError, 'Unknown Settlement Account'
+    end
+
+    settlement_hash = make_hash(the_path_url, 'post', @access_token, 'Transfer', settlement_body)
+    @threads << Thread.new do
+      sleep 0.25
+      @location_url = K2Connect.make_request(settlement_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Check the status of a prior initiated Transfer. Make sure to add the id to the url
+  def query_status
+    super('Settlement', path_url=@location_url)
+  end
+
+  # Query Location URL
+  def query_resource(url)
+    super('Settlement', url)
+  end
+end

data/lib/k2-connect-ruby/k2_financial_entity/entities/k2_stk.rb

@@ -0,0 +1,48 @@
+# For STK Push/Receive MPESA Payments from merchant's customers
+class K2Stk < K2Entity
+  # Receive payments from M-PESA users.
+  def receive_mpesa_payments(params)
+    # Validation
+    params = validate_input(params, @exception_array += %w[payment_channel till_number first_name last_name phone_number email currency value metadata callback_url])
+    # The Request Body Parameters
+    k2_request_subscriber = {
+      first_name: params[:first_name],
+      middle_name: params[:middle_name],
+      last_name: params[:last_name],
+      phone_number: validate_phone(params[:phone_number]),
+      email: validate_email(params[:email])
+    }
+    k2_request_amount = {
+      currency: 'KES',
+      value: params[:value]
+    }
+    k2_request_metadata = params[:metadata]
+    k2_request_links = {
+        callback_url: params[:callback_url]
+    }
+    receive_body = {
+      payment_channel: params[:payment_channel],
+      till_number: validate_till_number_prefix(params[:till_number]),
+      subscriber: k2_request_subscriber,
+      amount: k2_request_amount,
+      meta_data: k2_request_metadata,
+      _links: k2_request_links
+    }
+    receive_hash = make_hash(K2Config.path_url('incoming_payments'), 'post', @access_token, 'STK', receive_body)
+    @threads << Thread.new do
+      sleep 0.25
+      @location_url = K2Connect.make_request(receive_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Query/Check STK Payment Request Status
+  def query_status
+    super('STK', path_url=@location_url)
+  end
+
+  # Query Location URL
+  def query_resource(url)
+    super('STK', url)
+  end
+end

data/lib/k2-connect-ruby/k2_financial_entity/entities/k2_transfer.rb

@@ -0,0 +1,45 @@
+# For Transferring funds to pre-approved and owned settlement accounts
+class K2Transfer < K2Entity
+  # Create a either a 'blind' transfer, for when destination is specified, and a 'targeted' transfer which has a specified destination.
+  def transfer_funds(params)
+    # Validation
+    unless params["destination_reference"].blank? && params["destination_type"].blank?
+      params = validate_input(params, @exception_array += %w[destination_reference destination_type currency value callback_url metadata])
+    end
+    params = params.with_indifferent_access
+    # The Request Body Parameters
+    k2_request_transfer = {
+        destination_reference: params[:destination_reference],
+        destination_type: params[:destination_type],
+        amount: {
+            currency: params[:currency],
+            value: params[:value]
+        }
+    }
+    metadata = params[:metadata]
+    transfer_body = k2_request_transfer.merge(
+        {
+            _links:
+                {
+                    callback_url: params[:callback_url]
+                },
+            metadata: metadata
+        })
+    transfer_hash = make_hash(K2Config.path_url('transfers'), 'post', @access_token, 'Transfer', transfer_body)
+    @threads << Thread.new do
+      sleep 0.25
+      @location_url = K2Connect.make_request(transfer_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Check the status of a prior initiated Transfer. Make sure to add the id to the url
+  def query_status
+    super('Transfer', path_url=@location_url)
+  end
+
+  # Query Location URL
+  def query_resource(url)
+    super('Transfer', url)
+  end
+end