paymentsds-mpesa 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eec94343c54d33bb54e2492a22a89d538231c674ba4f4ea3aac71e133cf3cb4b
+  data.tar.gz: 33813434c53a1270dd0699ed3c824f8c90cba92b962140a1ad6244b8af04dc35
+SHA512:
+  metadata.gz: 778a5b13075fcc4aeb92a3883000cf5dc1a9281d5b1a1cc66770cc27ad3b2c3813a8bc860087dd155b09c7e1987e7118c409ab8cfa6bd8db1ddc448bfa2d4598
+  data.tar.gz: 24a25d403a4228c16065c09b1d18c6ded65ea02ee070d1ad79d277bb0de0d3d5206e0be88c51b6490727ff3a33462ff2f9740c932981c432b4a3e4519eec2a96

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/build.shh
+/Gemfile.lock
+# 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.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Edson Michaque, Nélio Macombo
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,261 @@
+# M-Pesa SDK for Ruby
+
+M-Pesa SDK for Ruby is an unofficial library aiming to help businesses integrating every [M-Pesa](https://developer.mpesa.vm.co.mz) operations to their Ruby applications.
+
+## Contents
+
+- [Features](#features)
+- [Usage](#usage)
+   - [Quickstart](#usage/scenario-1)
+   - [Receive Money from a Mobile Account](#usage/scenario-1)
+   - [Send Money to a Mobile Account](#usage/scenario-2)
+   - [Send Money to a Business Account](#usage/scenario-3)
+   - [Revert a Transaction](#usage/scenario-4)
+   - [Query the Status of a Transaction](#usage/scenario-5)
+   - [Examples](#usage/scenario-6)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+   - [Using RubyGems](#installation/scenario-1)
+   - [Using Bundler](#installation/scenario-2)
+   - [Installation Scenario 3](#installation/scenario-3)
+   - [Installation Scenario 4](#installation/scenario-4)
+- [Configuration](#configuration)
+   - [Configuration Scenario 1](#configuration/scenario-1)
+   - [Configuration Scenario 2](#configuration/scenario-2)
+   - [Configuration Scenario 3](#configuration/scenario-3)
+   - [Configuration Scenario 4](#configuration/scenario-4)
+- [Related Projects](#related-projects)
+   - [Dependencies](#related-projects/dependencies)
+   - [Friends](#related-projects/friends)
+   - [Alternatives](#related-projects/alternatives)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+- [Authors](#authors)
+- [Credits](#credits)
+- [License](#license)
+
+## Features <a name="features"></a>
+
+- Receive money from a mobile account to a business account
+- Send money from a business account to a mobile account
+- Send money from a business account to a another business account
+- Revert a transaction
+- Query the status of a transaction
+
+## Usage <a name="usage"></a>
+
+### Quickstart <a name="#usage/scenario-1"></a>
+
+### Receive Money from a Mobile Account <a name="#usage/scenario-2"></a>
+
+```ruby
+require 'paymentsds/mpesa'
+
+client = Paymentsds::MPesa::Client.new do |config|
+   config.api_key = '<REPLACE>'               # API Key
+   config.public_key = '<REPLACE>'            # Public Key
+   config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
+end
+
+begin
+   payment_data = {
+      from: '841234567',       # input_CustomerMSISDN
+      reference: '11114',      # input_ThirdPartyReference
+      transaction: 'T12344CC', # input_TransactionReference
+      amount: '10'             # input_Amount
+   }
+
+   result = client.receive(payment_data)
+
+   if result.success?
+      puts result.data
+   end
+rescue
+   puts 'Operation failed'
+end
+```
+### Send Money to a Mobile Account <a name="#usage/scenario-3"></a>
+
+```ruby
+require 'paymentsds/mpesa'
+
+client = Paymentsds::MPesa::Client.new do |config|
+   config.api_key = '<REPLACE>'               # API Key
+   config.public_key = '<REPLACE>'            # Public Key
+   config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
+end
+
+begin
+   payment_data = {
+      to: '841234567',       # input_CustomerMSISDN
+      reference: '11114',      # input_ThirdPartyReference
+      transaction: 'T12344CC', # input_TransactionReference
+      amount: '10'             # input_Amount
+   }
+
+   result = client.send(payment_data)
+
+   if result.success?
+      puts result.data
+   end
+rescue
+   puts 'Operation failed'
+end
+```
+
+### Send Money to a Business Account <a name="#usage/scenario-4"></a>
+
+```ruby
+require 'paymentsds/mpesa'
+
+client = Paymentsds::MPesa::Client.new do |config|
+   config.api_key = '<REPLACE>'               # API Key
+   config.public_key = '<REPLACE>'            # Public Key
+   config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
+end
+
+begin
+   payment_data = {
+      to: '979797',            # input_ReceiverPartyCode
+      reference: '11114',      # input_ThirdPartyReference
+      transaction: 'T12344CC', # input_TransactionReference
+      amount: '10'             # input_Amount
+   }
+
+   result = client.send(payment_data)
+
+   if result.success?
+      puts result.data
+   end
+rescue
+   puts 'Operation failed'
+end
+```
+
+### Revert a Transaction <a name="#usage/scenario-5"></a>
+
+```ruby
+require 'paymentsds/mpesa'
+
+client = Paymentsds::MPesa::Client.new do |config|
+   config.api_key = '<REPLACE>'               # API Key
+   config.public_key = '<REPLACE>'            # Public Key
+   config.service_provider_code = '<REPLACE>' # input_ServiceProviderCode
+   config.initiator_identifier = '<REPLACE>'  # input_InitiatorIdentifier,
+   config.security_identifier = '<REPLACE>'   # input_SecurityCredential
+end
+
+begin
+   reversion_data = {
+      reference: '11114',      # input_ThirdPartyReference
+      transaction: 'T12344CC', # input_TransactionReference
+      amount: '10'             # input_ReversalAmounts
+   }
+
+   result = client.reversion(payment_data)
+
+   if result.success?
+      # Handle success scenario
+   end
+rescue
+   # Handle failure scenario
+end
+```
+
+### Query the Status of a Transaction <a name="#usage/scenario-6"></a>
+
+### Examples <a name="usage/scenario-7"></a>
+
+## Prerequisites <a name="prerequisites"></a>
+
+- [Ruby 2.5+](https://www.ruby-lang.org)
+- [RubyGems](https://rubygems.org)
+- [Bundler](https://bundler.io)
+
+## Installation <a name="installation"></a>
+
+### Using RubyGems <a name="installation/scenario-1"></a>
+
+```bash
+gem install paymentsds-mpesa
+```
+
+### Using Bundler <a name="installation/scenario-2"></a>
+
+```ruby
+#Gemfile
+gem 'paymentsds-mpesa'
+```
+
+### Installation Scenario 3 <a name="installation/scenario-3"></a>
+
+## Configuration <a name="configuration"></a>
+
+### Configuration Scenario 1 <a name="configuration/scenario-1"></a>
+
+### Configuration Scenario 2 <a name="configuration/scenario-2"></a>
+
+### Configuration Scenario 3 <a name="configuration/scenario-3"></a>
+
+## Related Projects <a name="related-projects"></a>
+
+### Dependencies <a name="related-projects/dependencies"></a>
+
+#### Production Dependencies
+
+- [Faraday](https://github.com/lostisland/faraday)
+- [OpenSSL](https://github.com/ruby/openssl)
+
+
+#### Development Dependencies
+
+- [RSpec](https://github.com/rspec/rspec)
+- [Rake](https://github.com/ruby/rake)
+- [RuboCop](https://github.com/rubocop-hq/rubocop)
+- [Overcommit](https://github.com/sds/overcommit)
+
+### Friends <a name="related-projects/friends"></a>
+
+- [M-Pesa SDK for Javascript](https://github.com/paymentsds/mpesa-js-sdk)
+- [M-Pesa SDK for PHP](https://github.com/paymentsds/mpesa-php-sdk)
+- [M-Pesa SDK for Ruby](https://github.com/paymentsds/mpesa-ruby-sdk)
+- [M-Pesa SDK for Python](https://github.com/paymentsds/mpesa-python-sdk)
+
+### Alternatives <a name="related-projects/alternatives"></a>
+
+- [Alternative 1](https://github.com/<username>/<project>)
+- [Alternative 2](https://github.com/<username>/<project>)
+- [Alternative 3](https://github.com/<username>/<project>)
+- [Alternative 4](https://github.com/<username>/<project>)
+
+
+### Inspiration
+
+- [rosariopfernandes/mpesa-node-api](https://github.com/abdulmueid/mpesa-php-api)
+- [karson/mpesa-php-sdk](https://github.com/karson/mpesa-php-sdk)
+- [codeonweekends/mpesa-php-sdk](https://github.com/codeonweekends/mpesa-php-sdk)
+- [abdulmueid/mpesa-php-api](https://github.com/abdulmueid/mpesa-php-api)
+- [realdm/mpesasdk](https://github.com/realdm/mpesasdk)
+
+
+## Contributing <a name="contributing"></a>
+
+## Changelog <a name="changelog"></a>
+
+## Authors <a name="authors"></a>
+
+- [Edson Michaque](https://github.com/edsonmichaque)
+- [Nélio Macombo](https://github.com/neliomacombo)
+
+## Credits <a name="credits"></a>
+
+## License <a name="license"></a>
+
+Copyright 2020 Anísio Mandlate, Edson Michaque, Elton Laice and Nélio Macombo
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+

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 'paysuite/mpesa'
+
+# 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/paymentsds/mpesa.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'mpesa/version'
+require_relative 'mpesa/operation'
+require_relative 'mpesa/constants'
+require_relative 'mpesa/configuration'
+require_relative 'mpesa/service'
+require_relative 'mpesa/client'
+
+module Paymentsds
+  module MPesa
+    class Error < StandardError; end
+  end
+end

data/lib/paymentsds/mpesa/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    class Client
+      def initialize
+        @service = Service.new
+        yield(@service.config) if block_given?
+      end
+
+      def send(intent)
+        @service.handle_send(intent)
+      end
+
+      def receive(intent)
+        @service.handle_receive(intent)
+      end
+
+      def query(intent)
+        @service.handle_query(intent)
+      end
+
+      def revert(intent)
+        @service.handle_revert(intent)
+      end
+    end
+  end
+end

data/lib/paymentsds/mpesa/configuration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'openssl'
+
+module Paymentsds
+  module MPesa
+    class Configuration
+      attr_accessor :access_token
+      attr_accessor :api_key
+      attr_accessor :public_key
+      attr_accessor :user_agent
+      attr_accessor :verify_ssl
+      attr_accessor :timeout
+      attr_accessor :debugging
+      attr_accessor :environment
+      attr_accessor :initiator_identifier
+      attr_accessor :security_credential
+      attr_accessor :service_provider_code
+      attr_accessor :origin
+      attr_reader :auth
+
+      def initialize
+        yield(self) if block_given?
+      end
+
+      def generate_access_token
+        has_keys = instance_variable_defined?('@api_key') && instance_variable_defined?('@public_key')
+        has_access_token = instance_variable_defined?('@access_token')
+
+        @auth = encrypt(@api_key, @public_key) if has_keys
+        @auth = @access_token if has_access_token
+      end
+
+      private
+
+      def encrypt(api_key, public_key)
+        plain_public_key = Base64.decode64 public_key
+        key = OpenSSL::PKey::RSA.new plain_public_key
+        encrypted_api_key = key.public_encrypt api_key
+
+        Base64.strict_encode64 encrypted_api_key
+      end
+    end
+  end
+end

data/lib/paymentsds/mpesa/constants.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    PATTERNS = {
+      PHONE_NUMBER: /^((00|\+)?(258))?8[45][0-9]{7}$/,
+      MONEY_AMOUNT: /^[1-9][0-9]*(\.[0-9]+)?$/,
+      WORD: /^\w+$/,
+      SERVICE_PROVIDER: /^[0-9]{5,6}$/
+    }.freeze
+
+    OPERATIONS = {
+      C2B_PAYMENT: {
+        method: :post,
+        port: '18352',
+        path: '/ipg/v1x/c2bPayment/singleStage/',
+        mapping: {
+          to: 'input_ServiceProviderCode',
+          from: 'input_CustomerMSISDN',
+          amount: 'input_Amount',
+          reference: 'input_ThirdPartyReference',
+          transaction: 'input_TransactionReference'
+        },
+        validation: {
+          to: PATTERNS[:SERVICE_PROVIDER],
+          from: PATTERNS[:PHONE_NUMBER],
+          amount: PATTERNS[:MONEY_AMOUNT],
+          reference: PATTERNS[:WORD],
+          transaction: PATTERNS[:WORD]
+        },
+        required: [
+          :to,
+          :from,
+          :amount,
+          :reference,
+          :transaction
+        ],
+        optional: [
+          :to
+        ]
+      },
+
+      B2C_PAYMENT: {
+        method: :post,
+        port: '18345',
+        path: '/ipg/v1x/b2cPayment/',
+        mapping: {
+          to: 'input_ServiceProviderCode',
+          from: 'input_CustomerMSISDN',
+          amount: 'input_Amount',
+          reference: 'input_ThirdPartyReference',
+          transaction: 'input_TransactionReference'
+        },
+        validation: {
+          to: PATTERNS[:SERVICE_PROVIDER],
+          from: PATTERNS[:PHONE_NUMBER],
+          amount: PATTERNS[:MONEY_AMOUNT],
+          reference: PATTERNS[:WORD],
+          transaction: PATTERNS[:WORD]
+        },
+        required: [
+          :to,
+          :from,
+          :amount,
+          :reference,
+          :transaction
+        ],
+        optional: [
+          :to
+        ]
+      },
+
+      B2B_PAYMENT: {
+        method: :post,
+        port: '18349',
+        path: '/ipg/v1x/b2bPayment/',
+        mapping: {
+          to: 'input_ServiceProviderCode',
+          from: 'input_CustomerMSISDN',
+          amount: 'input_Amount',
+          reference: 'input_ThirdPartyReference',
+          transaction: 'input_TransactionReference'
+        },
+        validation: {
+          to: PATTERNS[:SERVICE_PROVIDER],
+          from: PATTERNS[:PHONE_NUMBER],
+          amount: PATTERNS[:MONEY_AMOUNT],
+          reference: PATTERNS[:WORD],
+          transaction: PATTERNS[:WORD]
+        },
+        required: [
+          :to,
+          :from,
+          :amount,
+          :reference,
+          :transaction
+        ],
+        optional: [
+          :to
+        ]
+      },
+
+      REVERSAL: {
+        method: :put,
+        port: '18354',
+        path: '/ipg/v1x/reversal/',
+        mapping: {
+          to: 'input_ServiceProviderCode',
+          from: 'input_CustomerMSISDN',
+          amount: 'input_Amount',
+          reference: 'input_ThirdPartyReference',
+          transaction: 'input_TransactionReference'
+        },
+        validation: {
+          to: PATTERNS[:SERVICE_PROVIDER],
+          from: PATTERNS[:PHONE_NUMBER],
+          amount: PATTERNS[:MONEY_AMOUNT],
+          reference: PATTERNS[:WORD],
+          transaction: PATTERNS[:WORD]
+        },
+        required: [
+          :to,
+          :from,
+          :amount,
+          :reference,
+          :transaction
+        ],
+        optional: [
+          :to
+        ]
+      },
+
+      QUERY_TRANSACTION_STATUS: {
+        method: :get,
+        port: '18353',
+        path: '/ipg/v1x/queryTransactionStatus/',
+        mapping: {
+          to: 'input_ServiceProviderCode',
+          from: 'input_CustomerMSISDN',
+          amount: 'input_Amount',
+          reference: 'input_ThirdPartyReference',
+          transaction: 'input_TransactionReference'
+        },
+        validation: {
+          to: PATTERNS[:SERVICE_PROVIDER],
+          from: PATTERNS[:PHONE_NUMBER],
+          amount: PATTERNS[:MONEY_AMOUNT],
+          reference: PATTERNS[:WORD],
+          transaction: PATTERNS[:WORD]
+        },
+        required: [
+          :to,
+          :from,
+          :amount,
+          :reference,
+          :transaction
+        ],
+        optional: [
+          :to
+        ]
+      }
+    }.freeze
+  end
+end

data/lib/paymentsds/mpesa/error_type.rb

@@ -0,0 +1,8 @@
+module Paymentsds
+    module MPesa
+        class ErrorType
+            MISSING_PROPERTIES = :MISSING_PROPERTIES
+            VALIDATION_ERROR = :VALIDATION_ERROR
+        end
+    end
+end

data/lib/paymentsds/mpesa/operation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    class Operation
+      attr_accessor :name
+      attr_accessor :method
+      attr_accessor :port
+      attr_accessor :path
+      attr_accessor :mapping
+      attr_accessor :requires
+      attr_accessor :validation
+      attr_accessor :optional
+
+      def initialize
+        yield(self) if block_given?
+      end
+
+      def valid?
+        method_valid = ['get', 'post'].include? @method
+        port_valid = @port.to_s.match? /^[0-9]{1,5}$/
+        requires_is_array = @requires.is_a? Array
+
+        method_valid && port_valid && requires_is_array
+      end
+    end
+  end
+end

data/lib/paymentsds/mpesa/patterns.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    PATTERNS = {
+      PHONE_NUMBER: /^((00|\+)?(258))?8[45][0-9]{7}$/,
+      MONEY_AMOUNT: /^[1-9][0-9]*(\.[0-9]+)?$/,
+      WORD: /^\w+$/,
+      SERVICE_PROVIDEER: /^[0-9]{5,6}$/
+    }.freeze
+  end
+end

data/lib/paymentsds/mpesa/result.rb

@@ -0,0 +1,18 @@
+module Paymentsds
+    module MPesa
+        class Result
+            attr_reader :error
+            attr_reader :data
+
+            def initialize(success, error, data)
+                @success = success
+                @error = error
+                @data = data
+            end
+
+            def success?
+                @success
+            end
+        end
+    end
+end

data/lib/paymentsds/mpesa/service.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    class Service
+      attr_accessor :config
+
+      def initialize
+        @config = Paymentsds::MPesa::Configuration.new
+      end
+
+      def handle_send(intent)
+        operation = detect_operation(intent)
+        handle_request(operation, intent)
+      end
+
+      def handle_receive(intent)
+        handle_request(:C2B_PAYMENT, intent)
+      end
+
+      def handle_revert(intent)
+        handle_request(:REVERSAL, intent)
+      end
+
+      def handle_query(_intent)
+        handle_request(:QUERY_TRANSACTION_STATUS, ntent)
+      end
+
+      private
+
+      def handle_request(opcode, intent)
+        data = fill_optional_properties(opcode, intent)
+
+        missing_properties = detect_missing_properties(opcode, data)
+        unless missing_properties.empty?
+          return Result.new(false, ErrorType::MISSING_PROPERTIES, missing_properties)
+        end
+
+        errors = detect_errors(opcode, data)
+        unless errors.empty?
+          return Result.new(false, ErrorType::VALIDATION_ERROR, errors)
+        end
+
+        perform_request(opcode, intent)
+      end
+
+      def detect_operation(intent)
+        if intent.key? :to
+          case intent[:to]
+          when /^((00|\+)?258)?8[45][0-9]{7}$/
+            :B2C_PAYMENT
+          when /^[0-9]{5,6}$/
+            :B2B_PAYMENT
+          end
+
+          # Should raise an exception
+        end
+
+        # Should raise an exception
+      end
+
+      def detect_missing_properties(opcode, intent)
+        operation = Paymentsds::MPesa::OPERATIONS[opcode]
+
+        operation[:required] - intent.keys
+      end
+
+      def detect_errors(opcode, intent)
+        operation = Paymentsds::MPesa::OPERATIONS[opcode]
+
+        errors = []
+
+        intent.each do |k, _v|
+          errors.push(k) unless (intent[k]).match operation.validation[k]
+        end
+
+        errors
+      end
+
+      def fill_optional_properties(opcode, intent)
+        case opcode
+        when :C2B_PAYMENT
+          intent[:to] = @config.service_provider_code if intent.key?(:to) && !@config.service_provider_code.nil?
+        when :B2B_PAYMENT
+          intent[:to] = @config.service_provider_code if intent.key?(:to) && !@config.service_provider_code.nil?
+        when :B2C_PAYMENT
+          intent[:from] = @config.service_provider_code if intent.key?(:from) && !@config.service_provider_code.nil?
+        when :REVERSAL
+          intent[:to] = @config.service_provider_code if intent.key?(:to) && !@config.service_provider_code.nil?
+
+          if intent.key?(:initiator_identifier) && !@config.initiator_identifier.nil?
+            intent[:initiator_identifier] = @config.initiator_identifier
+          end
+
+          if intent.key?(:security_credential) && !@config.security_credential.nil?
+            intent[:security_credential] = @config.security_credential
+          end
+        when :QUERY_TRANSACTION_STATUS
+          intent[:to] = @config.service_provider_code if intent.key?(:to) && !@config.service_provider_code.nil?
+        end
+
+        intent
+      end
+
+      def build_request_body(opcode, intent)
+        operation = Paymentsds::MPesa::OPERATIONS[opcode]
+
+        body = {}
+        operation[:mapping].each do |k, v|
+          body[v] = intent[k]
+        end
+
+        body
+      end
+
+      def build_request_headers
+        generate_access_token
+
+        headers = {
+          'Authorization': "Bearer #{@config.auth}",
+          'Origin': @config.origin,
+          'Content-Type': 'application/json',
+          'User-Agent': @config.user_agent
+        }
+
+        headers
+      end
+
+      def perform_request(opcode, intent)
+        generate_access_token
+        
+        request_data = {
+          base_url: "#{@config.environment.scheme}://#{@config.environment.domain}:#{operation[:port]}",
+          url: operation[:path],
+          method: operation[:method],
+          path: operation[:path],
+          headers: build_request_headers,
+          timeout: @config.timeout * 1000,
+          body: build_request_body(opcode, intent)
+        }
+
+        http_client = Faraday::Connection.new do |client|
+          client.url = "#{request_data[:base_url]}/#{request_data[:path]}"
+          client.headers = request_data[:headers]
+          client.options.timeout = request_data.timeout
+        end
+
+        case operation[:method]
+        
+        when :get
+          response = http_client.get do |req|
+            req.params = request_data.body
+          end
+
+        when :post
+          response = http_client.post do |req|
+            req.body = request_data.body
+          end
+
+        when :put
+          response = http_client.put do |req|
+            req.body = request_data.body
+          end
+        end
+
+        bulid_response(response)
+      end
+
+      def build_response(result)
+        if result.status >= 200 && result.status < 300
+          response = Response.new(result.success?, nil, result.data)
+        end
+        
+      end
+
+      def generate_access_token
+        @config.generate_access_token
+      end
+    end
+  end
+end

data/lib/paymentsds/mpesa/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    VERSION = '0.1.0.pre.alpha.1'
+  end
+end

data/paymentsds-mpesa.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/paymentsds/mpesa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'paymentsds-mpesa'
+  spec.version       = Paymentsds::MPesa::VERSION
+  spec.authors       = ['Edson Michaque']
+  spec.email         = ['edson@michaque.com']
+
+  spec.summary       = 'A Ruby library aiming to helps developers integrating their products with M-Pesa Platform'
+  spec.description   = %q{M-Pesa SDK for Ruby is an unofficial library aiming to help businesses integrating every M-Pesa operations to their Ruby applications.}
+  spec.homepage      = "https://github.com/paymentsds/mpesa-ruby-sdk"
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.license       = 'Apache-2.0'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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 'faraday', '~> 1.0.1', '>= 1.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0', '>= 3.9.0'
+  spec.add_development_dependency 'overcommit', '~> 0.55.0', '>= 0.55.0'
+  spec.add_development_dependency 'rubocop', '~> 0.88.0', '>= 0.88.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: paymentsds-mpesa
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.1
+platform: ruby
+authors:
+- Edson Michaque
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.88.0
+description: M-Pesa SDK for Ruby is an unofficial library aiming to help businesses
+  integrating every M-Pesa operations to their Ruby applications.
+email:
+- edson@michaque.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paymentsds/mpesa.rb
+- lib/paymentsds/mpesa/client.rb
+- lib/paymentsds/mpesa/configuration.rb
+- lib/paymentsds/mpesa/constants.rb
+- lib/paymentsds/mpesa/error_type.rb
+- lib/paymentsds/mpesa/operation.rb
+- lib/paymentsds/mpesa/patterns.rb
+- lib/paymentsds/mpesa/result.rb
+- lib/paymentsds/mpesa/service.rb
+- lib/paymentsds/mpesa/version.rb
+- paymentsds-mpesa.gemspec
+homepage: https://github.com/paymentsds/mpesa-ruby-sdk
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/paymentsds/mpesa-ruby-sdk
+  source_code_uri: https://github.com/paymentsds/mpesa-ruby-sdk
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby library aiming to helps developers integrating their products with
+  M-Pesa Platform
+test_files: []