stanbic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42c701e53003988ca6ea2d2b47c750a6251c354c1efc253f70efb7f77ea17e91
+  data.tar.gz: 69bde2a14bb9bcb17bf33dcbf90fdc89ec34dd94429e42d3e46874f846e53221
+SHA512:
+  metadata.gz: 9bcf63bc1a3477e686388701e8640db293455e15229f925b5bc291ce1423005beea22af20fdafedb8f073893a8af83262047d0f656bc282381bee348d9765a9d
+  data.tar.gz: 732ee56d9f7c9e06b2c298d46a577802441326b0a19f756019c5b8e308144281132e5876bf6b73bea70e79607dab47011e86f322403ee45ee249ee0c2dd2e399

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stanbic.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    stanbic (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.2)
+      json
+      oauth2 (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    hashie (5.0.0)
+    json (2.6.2)
+    jwt (2.5.0)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    multi_xml (0.6.0)
+    multipart-post (2.2.3)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    unicode-display_width (2.3.0)
+    version_gem (1.1.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  stanbic!
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ochieng Otieno
+
+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,81 @@
+# Stanbic
+
+Stanbic Payment APIs ruby sdk
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add stanbic
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install stanbic
+
+## Usage
+
+### Initialize Stanbic Client
+
+```ruby
+require "stanbic"
+@client = Stanbic::Client.new(api_key: ENV['STANBIC_API_KEY'], api_secret: ENV['STANBIC_API_SECRET'])
+```
+
+Make API calls using the @client object
+
+### Payments to Stanbic Accounts
+
+```ruby
+send_to_stanbic = @client.stanbic_payments(to_account, amount)
+```
+
+- `to_account`: stanbic recipient account number`REQUIRED`
+- `amount`: amount to transact `REQUIRED`
+
+### Send Money to Mobile Money APIs
+
+```ruby
+mobile_transfer = @client.mobile_payments(sender, receipient, amount, provider)
+```
+
+- `sender`: sender mobile number`REQUIRED`
+- `receipient`: receipient mobile number `REQUIRED`
+- `amount`: amount to transact `REQUIRED`
+- `provider`: mobile provider `REQUIRED`
+
+- providers :
+  - MPESA
+  - T-KASH
+  - AIRTEL MONEY
+
+### STK Push - M-Pesa Checkout
+
+```ruby
+  mpesa_checkout = @client.mpesa_checkout(mobile_number, amount, bill_account_ref)
+```
+
+- `mobile_number`: customer being charged mobile number`REQUIRED`
+- `amount`: amount being deducted from M-Pesa `REQUIRED`
+- `amount`: Stanbic account recieveing the funds `REQUIRED`
+
+### Inter-Bank Transfers API via Pesalink
+
+> **Note**
+> To be implemented
+
+```ruby
+inter_bank_transfer = @client.inter_bank_transfer
+```
+
+- `to_account`: stanbic recipient account number`REQUIRED`
+- `amount`: amount to transact `REQUIRED`
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/ochiengotieno304/stanbic>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/stanbic/api_exceptions.rb

@@ -0,0 +1,12 @@
+module Stanbic
+  module ApiExceptions
+    APIExceptionError = Class.new(StandardError)
+    BadRequestError = Class.new(APIExceptionError)
+    UnauthorizedError = Class.new(APIExceptionError)
+    ForbiddenError = Class.new(APIExceptionError)
+    ApiRequestsQuotaReachedError = Class.new(APIExceptionError)
+    NotFoundError = Class.new(APIExceptionError)
+    UnprocessableEntityError = Class.new(APIExceptionError)
+    ApiError = Class.new(APIExceptionError)
+  end
+end

data/lib/stanbic/client.rb

@@ -0,0 +1,201 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Stanbic
+  class Client
+    HTTP_OK_CODE = 200
+    BASE_URL = "https://api.connect.stanbicbank.co.ke/api/sandbox/".freeze
+    attr_reader :adapter, :api_key, :api_secret, :currency_code
+
+    def initialize(api_key:, api_secret:, currency_code: "KES", adapter: Faraday.default_adapter)
+      @api_key = api_key
+      @api_secret = api_secret
+      @adapter = adapter
+      @currency_code = currency_code
+    end
+
+    def stanbic_payments(account_to, amount)
+      dbs_reference_id = Random.rand(1_000_000_000_000)
+      end_to_end_id = Random.rand(1_000_000_000)
+      post_body = {
+        "originatorAccount": {
+          "identification": {
+            "mobileNumber": ""
+          }
+        },
+
+        "requestedExecutionDate": Time.now.strftime("%Y-%m-%d"),
+
+        "dbsReferenceId": dbs_reference_id.to_s,
+
+        "txnNarrative": "TRANSACTION NARRATIVE",
+
+        "callBackUrl": "http://clientdomain.com/omnichannel/esbCallback",
+
+        "transferTransactionInformation": {
+          "instructedAmount": {
+            "amount": amount.to_s,
+            "currencyCode": currency_code
+          },
+
+          "counterparty": {
+            "name": "J. Sparrow",
+            "postalAddress": {
+              "addressLine1": "Some street",
+              "addressLine2": "99",
+              "postCode": "1100 ZZ",
+              "town": "Amsterdam",
+              "country": "NL"
+            }
+          },
+
+          "counterpartyAccount": {
+            "identification": {
+              "identification": account_to.to_s
+            }
+          },
+
+          "remittanceInformation": {
+            "type": "UNSTRUCTURED",
+            "content": "SALARY"
+          },
+
+          "endToEndIdentification": end_to_end_id.to_s
+        }
+      }
+
+      request(http_method: :post, endpoint: "stanbic-payments", params: post_body)
+    end
+
+    def mobile_transfer(sender, receipient, amount, provider)
+      # PROVIDERS = {
+      #   MPESA,
+      #   T-KASH,
+      #   AIRTET MONEY
+      # }
+      dbs_reference_id = Random.rand(1_000_000_000_000)
+      end_to_end_id = Random.rand(1_000_000_000)
+      post_body = {
+        "originatorAccount": {
+          "identification": {
+            "mobileNumber": sender.to_s
+          }
+        },
+        "requestedExecutionDate": Time.now.strftime("%Y-%m-%d"),
+        "dbsReferenceId": dbs_reference_id.to_s,
+        "txnNarrative": "TRANSACTION NARRATIVE",
+        "callBackUrl": "http://client_domain.com/omnichannel/esbCallback",
+        "transferTransactionInformation": {
+          "instructedAmount": {
+            "amount": amount.to_s,
+            "currencyCode": currency_code
+          },
+          "mobileMoneyMno": {
+            "name": provider.to_s
+          },
+          "counterparty": {
+            "name": "J. Sparrow",
+            "mobileNumber": receipient.to_s,
+            "postalAddress": {
+              "addressLine1": "Some street",
+              "addressLine2": "99",
+              "postCode": "1100 ZZ",
+              "town": "Amsterdam",
+              "country": "NL"
+            }
+          },
+          "remittanceInformation": {
+            "type": "UNSTRUCTURED",
+            "content": "SALARY"
+          },
+          "endToEndIdentification": end_to_end_id.to_s
+        }
+      }
+      request(http_method: :post, endpoint: "mobile-payments", params: post_body)
+    end
+
+    def inter_bank_transfer
+      request(http_method: :post, endpoint: "pesalink-payments", params: options)
+    end
+
+    def mpesa_checkout(mobile_number, amount, bill_account_ref)
+      dbs_reference_id = ([*("A".."Z"), *("0".."9")] - %w[0 1 I O]).sample(13).join
+      post_body = {
+        "dbsReferenceId": dbs_reference_id.to_s,
+        "billAccountRef": bill_account_ref.to_s,
+        "amount": amount.to_s,
+        "mobileNumber": mobile_number.to_s
+      }
+      request(http_method: :post, endpoint: "mpesa-checkout", params: post_body)
+    end
+
+    def inspect
+      "#<Stanbic::Client>"
+    end
+
+    private
+
+    def get_token(client_id, client_secret)
+      data = {
+        scope: "payments",
+        grant_type: "client_credentials",
+        client_id: client_id,
+        client_secret: client_secret
+      }
+
+      url = "https://api.connect.stanbicbank.co.ke/api/sandbox/auth/oauth2/token"
+      response = Faraday.post(url) do |req|
+        req.headers["Content-Type"] = "application/x-www-form-urlencoded"
+        req.body = URI.encode_www_form(data)
+      end
+
+      parsed_response = JSON.parse(response.body)
+
+      OpenStruct.new(parsed_response).access_token
+    end
+
+    def connection
+      token = get_token(api_key, api_secret)
+
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.headers["Authorization"] = "Bearer #{token}"
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter
+      end
+    end
+
+    def request(http_method:, endpoint:, params: {})
+      response = connection.public_send(http_method, endpoint, params)
+      parsed_response = OpenStruct.new(response.body)
+      # response.body
+
+      # return parsed_response.httpCode if parsed_response.httpCode == response_successful?
+
+      # raise error_class, "Code: #{response.status}, response: #{response.body}"
+    end
+
+    # def error_class
+    #   case response.status
+    #   when HTTP_BAD_REQUEST_CODE
+    #     BadRequestError
+    #   when HTTP_UNAUTHORIZED_CODE
+    #     UnauthorisedError
+    #   when HTTP_FORBIDDEN_CODE
+    #     ForbiddenError
+    #   when HTTP_NOT_FOUND_CODE
+    #     NotFoundError
+    #   when HTTP_UNPROCESSABLE_ENTITY_CODE
+    #     UnprocessableEntityError
+    #   else
+    #     APIError
+    #   end
+    # end
+
+    def response_successful?
+      HTTP_OK_CODE
+    end
+  end
+end

data/lib/stanbic/error.rb

@@ -0,0 +1,3 @@
+module Stanbic
+  class Error < StandardError; end
+end

data/lib/stanbic/http_status_codes.rb

@@ -0,0 +1,10 @@
+module Stanbic
+  module HttpStatusCodes
+    HTTP_OK_CODE = 200
+    HTTP_BAD_REQUEST_CODE = 400
+    HTTP_UNAUTHORIZED_CODE = 401
+    HTTP_FORBIDDEN_CODE = 403
+    HTTP_NOT_FOUND_CODE = 404
+    HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+  end
+end

data/lib/stanbic/version.rb

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

data/lib/stanbic.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "stanbic/version"
+
+module Stanbic
+  autoload :Client, "stanbic/client"
+  autoload :Error, "stanbic/error"
+  autoload :HttpsStatusCodes, "stanbic/http_status_codes"
+  autoload :ApiExceptions, "stanbic/api_exceptions"
+end

data/sig/stanbic.rbs

@@ -0,0 +1,4 @@
+module Stanbic
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: stanbic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ochieng Otieno
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: oauth2
+  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'
+description: Ruby SDK for Stanbic Kilele APIs
+email:
+- ochiengotieno71@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stanbic.rb
+- lib/stanbic/api_exceptions.rb
+- lib/stanbic/client.rb
+- lib/stanbic/error.rb
+- lib/stanbic/http_status_codes.rb
+- lib/stanbic/version.rb
+- sig/stanbic.rbs
+homepage: https://github.com/ochiengotieno304/stanbic-api-ruby-wrapper
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ochiengotieno304/stanbic-api-ruby-wrapper
+  source_code_uri: https://github.com/ochiengotieno304/stanbic-api-ruby-wrapper
+  changelog_uri: https://github.com/ochiengotieno304/stanbic-api-ruby-wrapper/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Stanbic Kilele APIs
+test_files: []