paymentsds-mpesa 0.1.0.pre.alpha.32 → 0.1.0.pre.alpha.37

data/paymentsds-mpesa-0.1.0.pre.alpha.31/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/paymentsds-mpesa-0.1.0.pre.alpha.31/data/Rakefile

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

data/paymentsds-mpesa-0.1.0.pre.alpha.31/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/paymentsds-mpesa-0.1.0.pre.alpha.31/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/paymentsds-mpesa-0.1.0.pre.alpha.31/data/lib/paymentsds/mpesa.rb

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

data/paymentsds-mpesa-0.1.0.pre.alpha.31/data/lib/paymentsds/mpesa/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Paymentsds
+  module MPesa
+    class Client
+      def initialize
+        @service = Service.new
+        yield(@service.config) if block_given?
+        @service.apply
+      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/paymentsds-mpesa-0.1.0.pre.alpha.31/data/lib/paymentsds/mpesa/configuration.rb

@@ -0,0 +1,59 @@
+# 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
+        @user_agent = 'Paymentsds Ruby'
+        @origin = "*"
+        @verify_ssl = false
+        @timeout = 10
+        
+        yield(self) if block_given?
+      end
+
+      def apply
+        @environment = if @environment == :production
+          Paymentsds::MPesa::Environment.new('https', 'api.vm.co.mz').freeze
+        else
+          Paymentsds::MPesa::Environment.new('https', 'api.sandbox.vm.co.mz').freeze
+        end
+      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/paymentsds-mpesa-0.1.0.pre.alpha.31/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