ruby-daraja 0.1.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54d32eb80ef95e66f06eb67cafd137afb492c5075838214b4b84a623132234b2
+  data.tar.gz: 6c91f7aa3e0574c532a93edbec21c65c6873c42fbf5377e5c7d3f4fc150a1252
+SHA512:
+  metadata.gz: ccb350036f1e564249f1a95892c08837c5bb6fe55fe1f55f78b53c725c0dab06dca18a93fd5465a33ce3c36f6ed0ea751feebebf58356e37382c1bab5932c8b2
+  data.tar.gz: 488ed6272db7dcb62fc1e4a9486d3cbbcb261d3fabe326e535d73210c8f53d642d6c1d1beff022c7f5d3ed157761ae31b070429ffd44d1ba820bd6dbe1c147ba

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,90 @@
+# require other spec gems
+require: rubocop-rspec
+
+# AllCops configuration
+AllCops:
+  NewCops: enable
+  # Exclude the vendor directory and any generated files
+  Exclude:
+    - 'vendor/**/*'
+    - '**/*.rdoc'
+    - '**/*.md'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Guardfile'
+    - '**/config.ru'
+
+# Style configuration
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'lib/daraja_api_wrapper/version.rb'
+
+# Lint configuration
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+Lint/BlockAlignment:
+  Enabled: true
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Lint/RedundantCopDisableDirective:
+  Enabled: true
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+# Metrics configuration
+Metrics/BlockLength:
+  Enabled: true
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 10
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+Metrics/MethodLength:
+  Enabled: true
+  Max: 20
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 10
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 10
+
+# Naming configuration
+Naming/AccessorMethodName:
+  Enabled: true
+Naming/MethodName:
+  Enabled: true
+Naming/PredicateName:
+  Enabled: true
+
+
+# RSpec configuration
+RSpec/ExampleLength:
+  Enabled: true
+  Max: 10
+RSpec/BeforeAfterAll:
+  Enabled: true
+RSpec/DescribeClass:
+  Enabled: true
+RSpec/ExpectActual:
+  Enabled: true
+RSpec/ImplicitExpect:
+  Enabled: true
+RSpec/LetBeforeExamples:
+  Enabled: true
+RSpec/MultipleExpectations:
+  Enabled: true
+  Max: 3
+RSpec/NestedGroups:
+  Enabled: true
+RSpec/RepeatedDescription:
+  Enabled: true
+RSpec/SingleArgumentMessageChain:
+  Enabled: true
+RSpec/SubjectStub:
+  Enabled: true
+RSpec/VerifiedDoubles:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-18
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at okumu.otsembo@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-daraja.gemspec
+gemspec
+
+gem "faraday"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+
+gem 'rubocop-rspec', require: false
+gem "rubocop", "~> 1.21", require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 otsembo
+
+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,166 @@
+# Ruby::Daraja
+
+`Ruby::Daraja` is a Ruby wrapper for the [Safaricom Daraja API](https://developer.safaricom.co.ke). It provides a simple interface to the API endpoints and allows for smooth setup in `Ruby on Rails` applications or any other Ruby application.
+
+## Installation
+
+**IMPORTANT**: This gem is not yet released to [rubygems.org](https://rubygems.org). The instructions below are for when the gem is released.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ruby-daraja
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ruby-daraja
+
+# Usage
+With `ruby-daraja` you can easily make requests to the Safaricom Daraja API. The DSL is simple and easy to use. The DSL is divided into two parts:
+
+1. [Configuration](#configuration)
+2. [Requests](#requests)
+   1. [Register C2B URLs](#register-c2b-urls)
+   2. [MPESA PayBill](#mpesa-paybill)
+   3. [MPESA Buy Goods And Services](#mpesa-buy-goods-and-services)
+## Configuration
+In order to get started with the DSL, you need to configure the gem with your credentials. 
+
+There are two ways to get started with `ruby-daraja`:
+1. [Development](#development)
+2. [Production](#production)
+
+
+### Development
+This is a quick-start mode for the gem. It is meant to get you up and running quickly. It is not recommended for `production` applications. To get started with the gem in `development` mode, follow the steps below:
+
+1. Setup environment variables needed for your application. The environment variables needed are:
+    ```shell
+   # mandatory variables
+   CONSUMER_KEY='daraja consumer key here'
+   CONSUMER_SECRET='daraja consumer secret here'
+   
+   # optional variables
+   VALIDATION_URL='C2B Validation URL'
+   CONFIRMATION_URL='C2B Confirmation URL'
+   IS_SANDBOX='boolean indicating whether you are in sandbox or production'
+   SHORT_CODE='daraja (paybill /till number) short code here'
+   B2C_RESULT_URL='B2C Result URL'
+   INITIATOR_NAME='B2C initiator name'
+   INITIATOR_PASSWORD='B2C initiator password'
+   SSL_CERTIFICATE='path to SSL certificate'
+   BALANCE_RESULT_URL='Balance Result URL' 
+   ```
+2. You will need a ```Daraja::AppConfig``` instance. This instance is used to configure the application. It is created as follows:
+    ```ruby
+    require 'ruby-daraja'
+   
+    app_config = Daraja::Default.new._app_config
+    ```
+
+### Production
+`TODO: Add instructions for production mode`
+
+## Requests
+
+### Register C2B URLs
+
+1. Register C2B URLs - This needs to be done only once for each set of URLs.
+   ```ruby
+   require 'ruby-daraja'
+   
+   app_config = `Daraja::AppConfig instance here`
+   responses =  app_config.register_urls # array of JSON responses from Safaricom Daraja API
+   ```
+
+### MPESA PayBill
+
+1. Create a new `Daraja::PayBill` instance.
+   ```ruby
+   require 'ruby-daraja'
+   
+   app_config = `Daraja::AppConfig instance here`
+   paybill_client = Daraja::PayBill.new(config: app_config, pass_key: 'pass key here')
+   ```
+2. Initiate Payment Request (STK Push) for `MPESA PayBill`.
+   ```ruby
+    response = paybill_client.initiate_stk_push(
+      amount: 1,
+      phone_number: '2547xxxxxxxx',
+      account_reference: 'account reference',
+      transaction_description: 'transaction description'
+    ) # JSON response from Safaricom Daraja API
+   ```
+   
+3. Initiate B2C Request for `MPESA PayBill`
+   ```ruby
+   response = paybill_client.initiate_b2c(
+     amount: 1,
+     phone_number: '2547xxxxxxxx',
+     type: 0, # 0 for business, 1 for salary, 2 for promotion
+     remarks: 'remarks',
+     occasion: 'occasion'
+   ) # JSON response from Safaricom Daraja API
+   ```
+
+4. Check balance for `MPESA PayBill`
+   ```ruby
+   response = paybill_client.initiate_balance_request(
+        remarks: 'remarks'
+   ) # JSON response from Safaricom Daraja API
+   ```
+
+### MPESA Buy Goods And Services
+
+1. Create a new `Daraja::BuyGoods` instance.
+   ```ruby
+   require 'ruby-daraja'
+   
+   app_config = `Daraja::AppConfig instance here`
+   till_client = Daraja::BuyGoods.new(config: app_config, pass_key: 'pass key here')
+   ```
+
+2. Initiate Payment Request (STK Push) for `MPESA Buy Goods And Services`.
+   ```ruby
+    response = till_client.initiate_stk_push(
+      amount: 1,
+      phone_number: '2547xxxxxxxx',
+      account_reference: 'account reference',
+      transaction_description: 'transaction description'
+    ) # JSON response from Safaricom Daraja API
+   ```
+
+3. Initiate B2C Request for `MPESA Buy Goods And Services`
+   ```ruby
+   response = till_client.initiate_b2c(
+     amount: 1,
+     phone_number: '2547xxxxxxxx',
+     type: 0, # 0 for business, 1 for salary, 2 for promotion
+     remarks: 'remarks',
+     occasion: 'occasion'
+   ) # JSON response from Safaricom Daraja API
+   ```
+   
+4. Check balance for `MPESA Buy Goods And Services`
+   ```ruby
+   response = till_client.initiate_balance_request(
+        remarks: 'remarks'
+   ) # JSON response from Safaricom Daraja API
+   ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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/otsembo/ruby-daraja. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby-daraja/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Ruby::Daraja project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-daraja/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ruby/app_utils.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+# Application Utilities
+module AppUtils
+  # base configuration class
+  class BaseConfig
+    attr_accessor :connection
+    attr_writer :is_sandbox
+
+    def initialize(is_sandbox: false)
+      @is_sandbox = is_sandbox
+      @connection = Faraday.new(url: toggle_base_url, headers: { 'Content-Type' => 'application/json' }) do |f|
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
+      end
+    end
+
+    # toggle between sandbox and production daraja API urls
+    # @return [String] url
+    def toggle_base_url
+      if @is_sandbox
+        'https://sandbox.safaricom.co.ke/'
+      else
+        'https://api.safaricom.co.ke/'
+      end
+    end
+  end
+
+  # Default utility class
+  # @return [Default] default
+  class Default
+    # create Faraday connection object
+    # @return [Faraday::Connection] conn
+    def _connection
+      Faraday.new(url: _toggle_base_url, headers: { 'Content-Type' => 'application/json' }) do |f|
+        f.request :url_encoded
+        f.adapter Faraday.default_adapter
+      end
+    end
+
+    # toggle between sandbox and production daraja API urls
+    # @return [String] url
+    def _toggle_base_url
+      if _is_sandbox
+        'https://sandbox.safaricom.co.ke/'
+      else
+        'https://api.safaricom.co.ke/'
+      end
+    end
+
+    # APP OBJECTS
+    # create a new instance of DarajaAuthProvider class in sandbox mode
+    def _auth_provider
+      DarajaAuthProvider.create(
+        key: _consumer_key,
+        secret: _consumer_secret,
+        is_sandbox: _is_sandbox
+      )
+    end
+
+    # create a new instance of AppConfig class in sandbox mode
+    # @return [AppConfig] app_config
+    def _app_config
+      Pay::AppConfig.setup(
+        provider: _auth_provider,
+        short_code: _short_code,
+        validation_url: _validation_url,
+        confirmation_url: _confirmation_url,
+        b2c_result_url: _b2c_result_url,
+        initiator_name: _initiator_name,
+        initiator_password: _initiator_password,
+        ssl_certificate: _ssl_certificate,
+        balance_result_url: _balance_result_url
+      )
+    end
+
+    ## FETCH ENVIRONMENT VARIABLES
+    # fetch consumer key from environment variables
+    # @return [String] consumer_key
+    # @raise [RuntimeError] if consumer key is not set
+    def _consumer_key
+      ENV.fetch('CONSUMER_KEY') do
+        raise 'Consumer Key not set'
+      end
+    end
+
+    # fetch consumer secret from environment variables
+    # @return [String] consumer_secret
+    # @raise [RuntimeError] if consumer secret is not set
+    def _consumer_secret
+      ENV.fetch('CONSUMER_SECRET') do
+        raise 'Consumer Secret not set'
+      end
+    end
+
+    # fetch Validation URL from environment variables
+    # @return [String] validation_url
+    # @raise [RuntimeError] if validation url is not set
+    def _validation_url
+      ENV.fetch('VALIDATION_URL') do
+        raise 'Validation URL not set'
+      end
+    end
+
+    # fetch Confirmation URL from environment variables
+    # @return [String] confirmation_url
+    # @raise [RuntimeError] if confirmation url is not set
+    def _confirmation_url
+      ENV.fetch('CONFIRMATION_URL') do
+        raise 'Confirmation URL not set'
+      end
+    end
+
+    # fetch B2C Result URL from environment variables
+    # @return [String] b2c_result_url
+    # @return [nil] if b2c result url is not set
+    def _b2c_result_url
+      ENV.fetch('B2C_RESULT_URL', nil)
+    end
+
+    # fetch Balance Result URL from environment variables
+    # @return [String] balance_result_url
+    # @return [nil] if balance result url is not set
+    def _balance_result_url
+      ENV.fetch('BALANCE_RESULT_URL', nil)
+    end
+
+    # fetch sandbox mode from environment variables
+    # @return [Boolean] is_sandbox
+    # default: true
+    def _is_sandbox
+      ENV.fetch('IS_SANDBOX', true)
+    end
+
+    # fetch short code from environment variables
+    # @return [String] short_code
+    # @raise [RuntimeError] if short code is not set
+    def _short_code
+      ENV.fetch('SHORT_CODE') do
+        raise 'Short Code not set'
+      end
+    end
+
+    # fetch Initiator Name from environment variables
+    # @return [String] initiator_name
+    # @raise [RuntimeError] if initiator name is not set
+    def _initiator_name
+      ENV.fetch('INITIATOR_NAME') do
+        raise 'Initiator Name not set'
+      end
+    end
+
+    # fetch Initiator Password from environment variables
+    # @return [String] initiator_password
+    # @return [nil] if initiator password is not set
+    def _initiator_password
+      ENV.fetch('INITIATOR_PASSWORD', nil)
+    end
+
+    # fetch SSL Certificate from environment variables
+    # @return [String] ssl_certificate
+    # @return [nil] if ssl certificate is not set
+    def _ssl_certificate
+      ENV.fetch('SSL_CERTIFICATE', nil)
+    end
+  end
+end

data/lib/ruby/daraja/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Daraja
+    VERSION = '0.1.0-alpha'
+  end
+end

data/lib/ruby/daraja.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'daraja/version'
+require_relative 'daraja_auth_provider'
+require_relative 'pay'
+
+# Main App module that has the Daraja Wrapper.
+module Daraja
+  include AppUtils
+  include Pay
+  class Error < StandardError; end
+
+  # import all externally defined classes
+  class AuthProvider < DarajaAuthProvider; end
+end

data/lib/ruby/daraja_auth_provider.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'faraday'
+require_relative 'app_utils'
+# Create Access Token for Daraja Requests
+class DarajaAuthProvider < AppUtils::BaseConfig
+  attr_accessor :url, :token, :consumer_key, :consumer_secret
+  attr_reader :request_token, :is_sandbox
+
+  def initialize(consumer_key: nil, consumer_secret: nil, is_sandbox: false)
+    super(is_sandbox: is_sandbox)
+    @consumer_key = consumer_key
+    @consumer_secret = consumer_secret
+    @request_token = create_auth_token
+    @token = fetch_token
+  end
+
+  # create a new instance of DarajaAuthProvider class in sandbox mode (default)
+  # @return [DarajaAuthProvider] auth_provider
+  def self.create(key: nil, secret: nil, is_sandbox: true)
+    DarajaAuthProvider.new(consumer_key: key, consumer_secret: secret, is_sandbox: is_sandbox)
+  end
+
+  private
+
+  # create an authorization token from consumer key and secret
+  # @return [String] token
+  def create_auth_token
+    key = @consumer_key
+    secret = @consumer_secret
+    Base64.strict_encode64("#{key}:#{secret}")
+  end
+
+  # fetch authorization token from daraja API
+  # @return [String] token
+  def fetch_token
+    response = @connection.get('/oauth/v1/generate?grant_type=client_credentials') do |req|
+      req.headers['Authorization'] = "Basic #{@request_token}"
+    end
+    begin
+      @token = JSON.parse(response.body)['access_token']
+    rescue JSON::ParserError => _e
+      return nil
+    end
+    @token.to_str
+  end
+end

data/lib/ruby/pay.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require_relative 'payment'
+
+# Main module for processing requests
+module Pay
+  # AppConfig class
+  class AppConfig < AppUtils::BaseConfig
+    attr_accessor :short_code,
+                  :confirmation_url,
+                  :validation_url,
+                  :b2c_result_url,
+                  :initiator_name,
+                  :initiator_password,
+                  :ssl_certificate,
+                  :balance_result_url
+    attr_reader :provider
+
+    def initialize(
+      provider: DarajaAuthProvider.create,
+      short_code: nil,
+      confirmation_url: nil,
+      validation_url: nil,
+      b2c_result_url: nil,
+      initiator_name: nil,
+      initiator_password: nil,
+      ssl_certificate: nil,
+      balance_result_url: nil
+    )
+      super(is_sandbox: provider.is_sandbox)
+      @short_code = short_code
+      @confirmation_url = confirmation_url
+      @validation_url = validation_url
+      @provider = provider
+      @b2c_result_url = b2c_result_url
+      @initiator_name = initiator_name
+      @initiator_password = initiator_password
+      @ssl_certificate = ssl_certificate
+      @balance_result_url = balance_result_url
+    end
+
+    # receive all inputs for payment setup
+    def self.setup(
+      provider: DarajaAuthProvider.create,
+      short_code: nil,
+      confirmation_url: nil,
+      validation_url: nil,
+      b2c_result_url: nil,
+      initiator_name: nil,
+      initiator_password: nil,
+      ssl_certificate: nil,
+      balance_result_url: nil
+    )
+      AppConfig.new(provider: provider,
+                    short_code: short_code,
+                    confirmation_url: confirmation_url,
+                    validation_url: validation_url,
+                    b2c_result_url: b2c_result_url,
+                    initiator_name: initiator_name,
+                    initiator_password: initiator_password,
+                    ssl_certificate: ssl_certificate,
+                    balance_result_url: balance_result_url)
+    end
+
+    # register all request types (fail / success) urls
+    # @return [Array] response
+    def register_urls
+      %w[Completed Cancelled].map { |status| setup_status(status) }
+    end
+
+    private
+
+    # register url
+    # @param [String] status
+    # @return [Hash] response
+    def setup_status(status)
+      response = @connection.post('/mpesa/c2b/v1/registerurl') do |req|
+        req.headers['Authorization'] = "Basic #{@provider.token}"
+        req.body = {
+          ShortCode: @short_code,
+          ResponseType: status,
+          ConfirmationURL: @confirmation_url,
+          ValidationURL: @validation_url
+        }.to_json
+      end
+      JSON.parse(response.body)
+    end
+  end
+
+  # MPESA Pay Bill Online (C2B / B2C)
+  class PayBill < Payment
+    def initialize(config: AppConfig.new, pass_key: nil)
+      super(config: config, pass_key: pass_key, push_type: 0)
+    end
+  end
+
+  # MPESA Buy Goods Online (C2B / B2C)
+  class BuyGoods < Payment
+    def initialize(config: AppConfig.new, pass_key: nil)
+      super(config: config, pass_key: pass_key, push_type: 1)
+    end
+  end
+end

data/lib/ruby/payment.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# initialize Payment class
+class Payment
+  attr_reader :config, :payment_credentials, :push_type
+  attr_accessor :pass_key
+
+  C2B = %w[CustomerPayBillOnline CustomerBuyGoodsOnline].freeze
+  B2C = %w[BusinessPayment SalaryPayment PromotionPayment].freeze
+  def initialize(config: AppConfig.new, pass_key: nil, push_type: 0)
+    @config = config
+    @pass_key = pass_key
+    @push_type = push_type
+    @payment_credentials = encode_password
+  end
+
+  # send STK Push request
+  # @param [String] phone_number
+  # @param [String] amount
+  # @param [String] reference
+  # @param [String] description
+  # @return [Hash] response
+  def initiate_stk_push(phone_number:, amount:, reference:, description:)
+    response = @connection.post('/mpesa/stkpush/v1/processrequest') do |req|
+      req.headers['Authorization'] = "Basic #{@config.provider.token}"
+      req.body = {
+        BusinessShortCode: @config.short_code,
+        Password: @payment_credentials.password,
+        Timestamp: @payment_credentials.timestamp,
+        TransactionType: C2B[@push_type],
+        Amount: amount,
+        PartyA: phone_number,
+        PartyB: @config.short_code,
+        PhoneNumber: phone_number,
+        CallBackURL: @config.confirmation_url,
+        AccountReference: reference,
+        TransactionDesc: description
+      }.to_json
+    end
+    JSON.parse(response.body)
+  end
+
+  # send B2C request
+  # @param [String] phone_number
+  # @param [String] amount
+  # @param [String] remarks
+  # @param [int] type
+  # @param [String|nil] occasion
+  # @return [Hash<String, String|nil>] response
+  def initiate_b2c(phone_number:, amount:, remarks:, type: 0, occasion: nil)
+    response = @connection.post('/mpesa/b2c/v1/paymentrequest') do |req|
+      req.headers['Authorization'] = "Basic #{@config.provider.token}"
+      req.body = {
+        InitiatorName: @config.initiator_name,
+        SecurityCredential: security_credential,
+        CommandID: B2C[type],
+        Amount: amount,
+        PartyA: @config.short_code,
+        PartyB: phone_number,
+        Remarks: remarks,
+        QueueTimeOutURL: @config.b2c_result_url,
+        ResultURL: @config.b2c_result_url,
+        Occasion: occasion
+      }.to_json
+    end
+    JSON.parse(response)
+  end
+
+  # initiate balance request
+  # @param [String?] remarks
+  # @return [Hash<String, String|nil>] response
+  def initiate_balance_request(remarks: nil)
+    response = @connection.post('/mpesa/accountbalance/v1/query') do |req|
+      req.headers['Authorization'] = "Basic #{@config.provider.token}"
+      req.body = {
+        Initiator: @config.initiator_name,
+        SecurityCredential: security_credential,
+        CommandID: 'AccountBalance',
+        PartyA: @config.short_code,
+        IdentifierType: 4,
+        Remarks: remarks,
+        QueueTimeOutURL: @config.balance_result_url,
+        ResultURL: @config.balance_result_url
+      }.to_json
+    end
+    JSON.parse(response)
+  end
+
+  private
+
+  def encode_password
+    timestamp = Time.now.strftime('%Y%m%d%H%M%S').to_s.to_i
+    {
+      timestamp: timestamp,
+      password: Base64.strict_encode64("#{@config.short_code}#{@pass_key}#{timestamp}")
+    }
+  end
+
+  def security_credential
+    Base64.strict_encode64(OpenSSL::HMAC.hexdigest('sha256', @config.initiator_password, @config.ssl_certificate))
+  end
+end

data/sig/app_utils/base_config.rbs

@@ -0,0 +1,3 @@
+module AppUtils
+
+end

data/sig/app_utils.rbs

@@ -0,0 +1,26 @@
+module AppUtils
+  class BaseConfig
+    attr_accessor connection: untyped
+    attr_writer is_sandbox: bool
+
+    def toggle_base_url: -> string
+  end
+
+  class Default
+    def _balance_result_url: -> string
+    def _toggle_base_url : () -> void
+    def _connection: -> untyped
+    def _short_code: -> string
+    def _ssl_certificate: -> string
+    def _auth_provider: -> DarajaAuthProvider
+    def _app_config: -> BaseConfig
+    def _consumer_key: -> string
+    def _consumer_secret: -> string
+    def _validation_url: -> string
+    def _confirmation_url: -> string
+    def _b2c_result_url: -> string
+    def _initiator_name: -> string
+    def _initiator_password: -> string
+    def _is_sandbox: -> bool
+  end
+end

data/sig/daraja_auth_provider.rbs

@@ -0,0 +1,16 @@
+class DarajaAuthProvider
+  attr_accessor connection: untyped
+  attr_reader is_sandbox: bool
+  attr_accessor url: string | nil
+  attr_accessor token: string
+  attr_writer is_sandbox: bool
+  attr_accessor consumer_key: string | nil
+  attr_accessor consumer_secret: string | nil
+  attr_reader request_token: string | nil
+
+  def fetch_token : () -> string
+  def create_auth_token : () -> string?
+  def toggle_base_url : () -> void
+  def self.create : (key: string?, secret: string?, is_sandbox: bool?) -> DarajaAuthProvider
+
+end

data/sig/pay/app_config.rbs

@@ -0,0 +1,22 @@
+module Pay
+  class AppConfig
+    attr_reader provider: DarajaAuthProvider
+    attr_accessor short_code: int|nil
+    attr_accessor confirmation_url: string|nil
+    attr_accessor ssl_certificate: string|nil
+    attr_accessor validation_url: string|nil
+    attr_accessor b2c_result_url: string|nil
+    attr_accessor balance_result_url: string|nil
+    attr_accessor initiator_name: string|nil
+    attr_accessor initiator_password: string|nil
+
+    def self.setup : () -> Pay::AppConfig
+    def register_urls: () -> Array[url_registration_response]
+    def setup_status: () -> url_registration_response
+    type  url_registration_response = {
+        ConversationId: string,
+        OriginatorCoversationID: string,
+        ResponseDescription: string,
+      }
+  end
+end

data/sig/payment.rbs

@@ -0,0 +1,20 @@
+class Payment
+  include AppUtils
+
+  C2B: Array[string]
+  B2C: Array[string]
+
+  attr_reader config: AppUtils::BaseConfig
+  attr_accessor pass_key: string|nil
+  attr_reader payment_credentials: { timestamp: string, password: string }
+  attr_reader push_type: int
+
+  def initiate_balance_request: -> Hash[String, String|int]
+  def initiate_stk_push: -> Hash[String, String|int]
+  def initiate_b2c: -> Hash[String, String|int]
+
+  private
+
+  def encode_password: -> { timestamp: string, password: string }
+  def security_credential: -> string
+end

data/sig/ruby/daraja.rbs

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ruby-daraja
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha
+platform: ruby
+authors:
+- otsembo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-23 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  The gem abstracts away the low-level details of the API, providing a simple and intuitive
+  interface for sending payment requests, checking payment status, and managing payment callbacks
+email:
+- okumu.otsembo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby/app_utils.rb
+- lib/ruby/daraja.rb
+- lib/ruby/daraja/version.rb
+- lib/ruby/daraja_auth_provider.rb
+- lib/ruby/pay.rb
+- lib/ruby/payment.rb
+- sig/app_utils.rbs
+- sig/app_utils/base_config.rbs
+- sig/daraja_auth_provider.rbs
+- sig/pay/app_config.rbs
+- sig/payment.rbs
+- sig/ruby/daraja.rbs
+homepage: https://github.com/otsembo/ruby-daraja
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/otsembo/ruby-daraja
+  source_code_uri: https://github.com/otsembo/ruby-daraja
+  changelog_uri: https://github.com/otsembo/ruby-daraja/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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: A simple gem that allows implements smooth
+test_files: []