peperusha 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2464129e7e2ff1fbfb3502faf96418b0b1cb04f63d2f05ebeab85d17a467acf
+  data.tar.gz: 9133eb59666008ac409a295c766578e8143dd0af462ea58961cbe7c08c216902
+SHA512:
+  metadata.gz: 896a80adf95215065157bc4f5a0fdc9a7db5cf9b53eee5483752b0538e2c878ef28e4220c9e324274868e91fa7d829790c7b628de573f5f90cb4e084967c48cd
+  data.tar.gz: 503ac21f3d9723aaf9fde23f09bfdb94b721949319a8571a23449f30fed2f4063555f05aeac444585dca541e40a15c01f4e561da829cf06cab4190e917a843ab

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 1.0.0 / 2020-09-14
+
+* [ENHANCEMENT] Add logger for Mpesa requests and responses
+* [FEATURE] Add mpesa authentication mechanism
+* [BUGFIX] Fix faraday response json parsing
+* [BUGFIX] Add activesupport for missing delegates signature
+
+## 1.0.0 / 2020-09-13
+
+* Initial release!

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 kerandisylvance@gmail.com. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in peperusha.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    peperusha (0.1.0)
+      activesupport
+      faraday
+      interactor
+      json
+      logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    interactor (3.1.2)
+    json (2.3.1)
+    logger (1.4.2)
+    minitest (5.14.2)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  peperusha!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sylvance Mbaka
+
+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,175 @@
+# Peperusha
+
+Mpesa Client with better error handling and edge case protection.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'peperusha'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install peperusha
+
+## Usage
+### Intro
+`N/B`: All the result below will respond to these;
+```ruby
+result.success? # either true or false
+result.errors # an array of strings describing the errors, default is []
+result.body # {body: body} if success otherwise {} 
+```
+
+To use `peperusha` first get the client token:
+```ruby
+result = Peperusha::Authenticate.call(
+    consumer_key: consumer_key,
+    consumer_secret: consumer_secret
+)
+result.body # returns the response body
+result.body['access_token'] # the token to be used henceforth
+result.body['expires_in'] # the time, in seconds, the token takes to expire
+```
+
+### Register urls
+To ensure that customer to business calls work, you will have to register the callback urls:
+```ruby
+result = Peperusha::C2bRegisterUrls.call(
+    token: token,
+    business_number: business_number,
+    confirmation_url: confirmation_url,
+    validation_url: validation_url
+)
+result.body # returns the response body
+```
+
+### Payments
+We can find the test credentials for these here `https://developer.safaricom.co.ke/test_credentials`
+
+For customer to business send money via paybill do:
+```ruby
+result = Peperusha::CustomerPayViaPaybill.call(
+    token: token,
+    account_number: account_number,
+    amount: amount,
+    customer_number: customer_number,
+    business_paybill_number: business_paybill_number
+)
+result.body # returns the response body
+```
+
+For customer to business send money via till do:
+```ruby
+result = Peperusha::CustomerPayViaTill.call(
+    token: token,
+    amount: amount,
+    customer_number: customer_number,
+    business_till_number: business_till_number
+)
+result.body # returns the response body
+```
+
+For business to customer send money do:
+```ruby
+result = Peperusha::BusinessToCustomer.call(
+    amount: amount, # e.g 70
+    business_number: business_number, # e.g 123454
+    customer_number: customer_number, # e.g 254790123456
+    initiator_name: initiator_name, # e.g John_Doe
+    remarks: remarks,
+    result_url: result_url, # url where to send notification upon processing of the payment request. 
+    security_credential: security_credential, # e.g 32SzVdmCvjpmQfw3X2RK8UAv7xuhh304dXxFC5+3lslkk2TDJY/Lh6ESVwtqMxJzF7qA==
+    timeout_url: timeout_url, # url where to send notification incase the payment request is timed out while awaiting processing in the queue.
+    token: token # the access token
+)
+result.body # returns the response body
+```
+
+For business till to another business till number do:
+```ruby
+result = Peperusha::BusinessToTill.call(
+    amount: amount, # e.g 70
+    business_number1: business_number1, # e.g 123321
+    business_number2: business_number2, # e.g 123456 should be a till number receiving the funds
+    initiator_name: initiator_name, # e.g Business 1
+    remarks: remarks,
+    result_url: result_url, # url where to send notification upon processing of the payment request. 
+    security_credential: security_credential, # e.g 32SzVdmCvjpmQfw3X2RK8UAv7xuhh304dXxFC5+3lslkk2TDJY/Lh6ESVwtqMxJzF7qA==
+    timeout_url: timeout_url, # url where to send notification incase the payment request is timed out while awaiting processing in the queue.
+    token: token # the access token
+)
+result.body # returns the response body
+```
+
+For business paybill to another business paybill number do:
+```ruby
+result = Peperusha::BusinessToPaybill.call(
+    account_reference: account_reference, # e.g 123 the account value under the paybill
+    amount: amount, # e.g 70
+    business_number1: business_number1, # e.g 123321
+    business_number2: business_number2, # e.g 123456 should be a paybill number receiving the funds
+    initiator_name: initiator_name, # e.g Business 1
+    remarks: remarks,
+    result_url: result_url, # url where to send notification upon processing of the payment request. 
+    security_credential: security_credential, # e.g 32SzVdmCvjpmQfw3X2RK8UAv7xuhh304dXxFC5+3lslkk2TDJY/Lh6ESVwtqMxJzF7qA==
+    timeout_url: timeout_url, # url where to send notification incase the payment request is timed out while awaiting processing in the queue.
+    token: token # the access token
+)
+result.body # returns the response body
+```
+
+### Inquiry
+To check the status of a B2C and C2B APIs transactions:
+```ruby
+result = Peperusha::TransactionInquiry.call(
+    token: token,
+    initiator_name: initiator_name,
+    receiving_number: receiving_number,
+    remarks: remarks,
+    result_url: result_url,
+    security_credential: security_credential,
+    timeout_url: timeout_url,
+    transaction_id: transaction_id
+)
+```
+
+### Reversal
+To reverse a B2C APIs transactions:
+```ruby
+result = Peperusha::TransactionReversal.call(
+    token: token,
+    initiator_name: initiator_name,
+    receiving_number: receiving_number,
+    remarks: remarks,
+    result_url: result_url,
+    security_credential: security_credential,
+    timeout_url: timeout_url,
+    transaction_id: transaction_id,
+)
+```
+
+## 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 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/sylvance/peperusha. 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/sylvance/peperusha/blob/master/CODE_OF_CONDUCT.md). Other issues contact `peperusha.kakitu@gmail.com`.
+
+
+## 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 Peperusha project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sylvance/peperusha/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "peperusha"
+
+# 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/peperusha.rb

@@ -0,0 +1,7 @@
+require 'peperusha/version'
+require 'peperusha/authenticate'
+
+module Peperusha
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/peperusha/authenticate.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class Authenticate
+    include Interactor
+
+    delegate :consumer_key, :consumer_secret, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      response = Peperusha::Client.invoke_token_request(consumer_key, consumer_secret)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'consumer_key.missing' if consumer_key.nil?
+      errors << 'consumer_secret.missing' if consumer_secret.nil?
+      errors
+    end
+  end
+end

data/lib/peperusha/business_to_customer.rb

@@ -0,0 +1,60 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class BusinessToCustomer
+    include Interactor
+
+    delegate :amount, :business_number, :customer_number, :initiator_name, :remarks, :result_url, :security_credential, :timeout_url, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/b2c/v1/paymentrequest'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'token.missing' if token.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'business_number.missing' if business_number.nil?
+      errors << 'customer_number.missing' if customer_number.nil?
+      errors << 'security_credential.missing' if security_credential.nil?
+      errors
+    end
+
+    def attributes
+      result_url = nil if result_url.nil?
+      timeout_url = nil if timeout_url.nil?
+      {
+        'Amount': amount,
+        'CommandID': 'BusinessPayment',
+        'InitiatorName': initiator_name,
+        'Occasion': 'Generated by peperusha',
+        'PartyA': business_number,
+        'PartyB': customer_number,
+        'Remarks': remarks,
+        'ResultURL': result_url,
+        'SecurityCredential': security_credential,
+        'QueueTimeOutURL': timeout_url
+      }
+    end
+  end
+end

data/lib/peperusha/business_to_paybill.rb

@@ -0,0 +1,64 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class BusinessToPaybill
+    include Interactor
+
+    delegate :account_reference, :amount, :business_number1, :business_number2, :initiator_name, :remarks, :result_url, :security_credential, :timeout_url, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/b2b/v1/paymentrequest'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'token.missing' if token.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'business_number1.missing' if business_number1.nil?
+      errors << 'business_number2.missing' if business_number2.nil?
+      errors << 'account_reference.missing' if account_reference.nil?
+      errors << 'security_credential.missing' if security_credential.nil?
+      errors
+    end
+
+    def attributes
+      result_url = nil if result_url.nil?
+      timeout_url = nil if timeout_url.nil?
+      {
+        'AccountReference': account_reference,
+        'Amount': amount,
+        'CommandID': 'BusinessPayBill',
+        'Initiator': initiator_name,
+        'Occasion': 'Generated by peperusha',
+        'PartyA': business_number1,
+        'PartyB': business_number2,
+        'RecieverIdentifierType': '4',
+        'Remarks': remarks,
+        'ResultURL': result_url,
+        'SecurityCredential': security_credential,
+        'SenderIdentifierType': '4',
+        'QueueTimeOutURL': timeout_url
+      }
+    end
+  end
+end

data/lib/peperusha/business_to_till.rb

@@ -0,0 +1,62 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class BusinessToTill
+    include Interactor
+
+    delegate :amount, :business_number1, :business_number2, :initiator_name, :remarks, :result_url, :security_credential, :timeout_url, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/b2b/v1/paymentrequest'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'token.missing' if token.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'business_number1.missing' if business_number1.nil?
+      errors << 'business_number2.missing' if business_number2.nil?
+      errors << 'security_credential.missing' if security_credential.nil?
+      errors
+    end
+
+    def attributes
+      result_url = nil if result_url.nil?
+      timeout_url = nil if timeout_url.nil?
+      {
+        'Amount': amount,
+        'CommandID': 'BusinessBuyGoods',
+        'Initiator': initiator_name,
+        'Occasion': 'Generated by peperusha',
+        'PartyA': business_number1,
+        'PartyB': business_number2,
+        'RecieverIdentifierType': '2',
+        'Remarks': remarks,
+        'ResultURL': result_url,
+        'SecurityCredential': security_credential,
+        'SenderIdentifierType': '2',
+        'QueueTimeOutURL': timeout_url
+      }
+    end
+  end
+end

data/lib/peperusha/c2b_register_urls.rb

@@ -0,0 +1,49 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class C2bRegisterUrls
+    include Interactor
+
+    delegate :business_number, :confirmation_url, :token, :validation_url, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/c2b/v1/registerurl'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'confirmation_url.missing' if confirmation_url.nil?
+      errors << 'business_number.missing' if business_number.nil?
+      errors
+    end
+
+    def attributes
+      {
+        'ConfirmationURL': confirmation_url,
+        'ResponseType': 'Canceled',
+        'ShortCode': business_number,
+        'ValidationURL': validation_url
+      }
+    end
+  end
+end

data/lib/peperusha/client.rb

@@ -0,0 +1,54 @@
+require 'faraday'
+require 'json'
+
+require_relative('./logs.rb')
+
+module Peperusha
+  class Client
+    def self.invoke_token_request(consumer_key, consumer_secret)
+      conn = Faraday.new(url: 'https://sandbox.safaricom.co.ke') do |build|
+        build.request :url_encoded
+        build.use Peperusha::Logs
+        build.adapter  Faraday.default_adapter
+      end
+
+      conn.basic_auth(consumer_key, consumer_secret)
+
+      conn.get('oauth/v1/generate') do |req|
+        req.params['grant_type'] = 'client_credentials'
+      end
+    end
+
+    def self.invoke_post_request(token, domain_url, body)
+      base_url = 'https://sandbox.safaricom.co.ke'
+      headers = {
+        'Accept' => 'application/json',
+        'Authorization' => "Bearer #{token}",
+        'Content-Type' => 'application/json'
+      }
+
+      conn = Faraday.new(url: base_url, headers: headers) do |build|
+        build.request :url_encoded
+        build.use Peperusha::Logs
+        build.adapter  Faraday.default_adapter
+      end
+
+      conn.post(domain_url) do |req|
+        req.body = body.to_json
+      end
+    end
+
+    def self.build_errors_collection(response)
+      data = JSON.parse(response.body)
+      [
+        {
+          status_code: response.status,
+          error: {
+            code: data['errorCode'],
+            errorMessage: data['errorMessage']
+          }
+        }
+      ]
+    end
+  end
+end

data/lib/peperusha/customer_pay_via_paybill.rb

@@ -0,0 +1,52 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class CustomerPayViaPaybill
+    include Interactor
+
+    delegate :account_number, :amount, :business_paybill_number, :customer_number, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/c2b/v1/simulate'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'account_number.missing' if account_number.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'business_paybill_number.missing' if business_paybill_number.nil?
+      errors << 'customer_number.missing' if customer_number.nil?
+      errors
+    end
+
+    def attributes
+      {
+        'Amount': amount,
+        'BillRefNumber': account_number,
+        'CommandID': 'CustomerPayBillOnline',
+        'Msisdn': customer_number,
+        'ShortCode': business_paybill_number
+      }
+    end
+  end
+end

data/lib/peperusha/customer_pay_via_till.rb

@@ -0,0 +1,50 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class CustomerPayViaTill
+    include Interactor
+
+    delegate :amount, :business_till_number, :customer_number, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/c2b/v1/simulate'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'amount.missing' if amount.nil?
+      errors << 'business_till_number.missing' if business_till_number.nil?
+      errors << 'customer_number.missing' if customer_number.nil?
+      errors
+    end
+
+    def attributes
+      {
+        'Amount': amount,
+        'CommandID': 'CustomerBuyGoodsOnline:',
+        'Msisdn': customer_number,
+        'ShortCode': business_till_number
+      }
+    end
+  end
+end

data/lib/peperusha/logs.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+module Peperusha
+  class Logs
+        
+    def initialize(app)
+      @app = app
+      @logger = Logger.new(STDOUT)
+    end
+
+    def call(env)
+      on_request('request', env)
+      @app.call(env).on_complete do
+        on_response('response', env)
+      end
+    end
+
+    private
+
+    def on_request(phase, env)
+      @logger.info("#{phase} : #{env.method} - #{env.url}") if env.method and env.url
+    end
+
+    def on_response(phase, env)
+      @logger.info("#{phase} : #{env.body}") if env.body 
+    end    
+  end
+end

data/lib/peperusha/transaction_inquiry.rb

@@ -0,0 +1,61 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class TransactionInquiry
+    include Interactor
+
+    delegate :initiator_name, :receiving_number, :remarks, :result_url, :security_credential, :timeout_url, :transaction_id, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = 'mpesa/transactionstatus/v1/query'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'token.missing' if token.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'receiving_number.missing' if receiving_number.nil?
+      errors << 'transaction_id.missing' if transaction_id.nil?
+      errors << 'account_reference.missing' if account_reference.nil?
+      errors << 'security_credential.missing' if security_credential.nil?
+      errors
+    end
+
+    def attributes
+      result_url = nil if result_url.nil?
+      timeout_url = nil if timeout_url.nil?
+      {
+        'CommandID': 'TransactionStatusQuery',
+        'IdentifierType': '1',
+        'Initiator': initiator_name,
+        'Occasion': 'Generated by peperusha',
+        'PartyA': receiving_number,
+        'Remarks': remarks,
+        'ResultURL': result_url,
+        'SecurityCredential': security_credential,
+        'TransactionID': transaction_id,
+        'QueueTimeOutURL': timeout_url
+      }
+    end
+  end
+end

data/lib/peperusha/transaction_reversal.rb

@@ -0,0 +1,62 @@
+require 'active_support'
+require 'interactor'
+require 'json'
+
+require_relative('./client.rb')
+
+module Peperusha
+  class TransactionReversal
+    include Interactor
+
+    delegate :initiator_name, :remarks, :result_url, :security_credential, :timeout_url, :transaction_id, :token, to: :context
+
+    before do
+      missing_params_errors = check_if_params_missing
+      context.fail!(errors: missing_params_errors) if missing_params_errors.size > 0
+    end
+
+    def call
+      path = '/mpesa/reversal/v1/request'
+      response = Peperusha::Client.invoke_post_request(token, path, attributes)
+
+      if response.status == 200
+        data = JSON.parse(response.body)
+        context.body = data
+      else
+        client_errors = Peperusha::Client.build_errors_collection(response)
+        context.fail!(errors: client_errors)
+      end
+    end
+
+    private
+
+    def check_if_params_missing
+      errors = []
+      errors << 'token.missing' if token.nil?
+      errors << 'amount.missing' if amount.nil?
+      errors << 'receiving_number.missing' if receiving_number.nil?
+      errors << 'transaction_id.missing' if transaction_id.nil?
+      errors << 'account_reference.missing' if account_reference.nil?
+      errors << 'security_credential.missing' if security_credential.nil?
+      errors
+    end
+
+    def attributes
+      result_url = nil if result_url.nil?
+      timeout_url = nil if timeout_url.nil?
+      {
+        'CommandID': 'TransactionReversal',
+        'IdentifierType': '1',
+        'Initiator': initiator_name,
+        'Occasion': 'Generated by peperusha',
+        'PartyA': receiving_number,
+        'RecieverIdentifierType': '1',
+        'Remarks': remarks,
+        'ResultURL': result_url,
+        'SecurityCredential': security_credential,
+        'TransactionID': transaction_id,
+        'QueueTimeOutURL': timeout_url
+      }
+    end
+  end
+end

data/lib/peperusha/version.rb

@@ -0,0 +1,3 @@
+module Peperusha
+  VERSION = "0.1.1"
+end

data/peperusha.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/peperusha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "peperusha"
+  spec.version       = Peperusha::VERSION
+  spec.authors       = ["Sylvance Kerandi"]
+  spec.email         = ["peperusha.kakitu@gmail.com"]
+
+  spec.summary       = %q{Mpesa Client with better error handling and edge case protection.}
+  spec.description   = %q{Peperusha use the power of ruby interactors to bring in better error handling and edge case scenarios for easier debugging.}
+  spec.homepage      = "https://github.com/sylvance/peperusha"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sylvance/peperusha"
+  spec.metadata["changelog_uri"] = "https://github.com/sylvance/peperusha"
+
+  # dependencies
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday"
+  spec.add_dependency "interactor"
+  spec.add_dependency "json"
+  spec.add_dependency "logger"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: peperusha
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sylvance Kerandi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: faraday
+  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: interactor
+  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: 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: logger
+  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'
+description: Peperusha use the power of ruby interactors to bring in better error
+  handling and edge case scenarios for easier debugging.
+email:
+- peperusha.kakitu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/peperusha.rb
+- lib/peperusha/authenticate.rb
+- lib/peperusha/business_to_customer.rb
+- lib/peperusha/business_to_paybill.rb
+- lib/peperusha/business_to_till.rb
+- lib/peperusha/c2b_register_urls.rb
+- lib/peperusha/client.rb
+- lib/peperusha/customer_pay_via_paybill.rb
+- lib/peperusha/customer_pay_via_till.rb
+- lib/peperusha/logs.rb
+- lib/peperusha/transaction_inquiry.rb
+- lib/peperusha/transaction_reversal.rb
+- lib/peperusha/version.rb
+- peperusha.gemspec
+homepage: https://github.com/sylvance/peperusha
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sylvance/peperusha
+  source_code_uri: https://github.com/sylvance/peperusha
+  changelog_uri: https://github.com/sylvance/peperusha
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Mpesa Client with better error handling and edge case protection.
+test_files: []