momoapi-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84233d3a948cd641d3664e290b10789c97728009ed2e50de4c8a663581dcb625
+  data.tar.gz: '0764955b5e484a2cc4e727c4365101dbc19d021d10582a6e4ab7bc734495f974'
+SHA512:
+  metadata.gz: 2c0edeccf9353280687071eb002fb0e45716102214575185f8effd38c9777267df1bb3d4bff3ff3f781f68eded6b1e1fc551f535e330cacd564b16246edf359f
+  data.tar.gz: d37405e1e743ba3bf3beb9c8bccf901a6ac3ff61db093ac5db16622696f015fac7b50cd53456113191d3a96da3c5cb05347d2d91351b791c36fb8fca11cd363a

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: bYVvifY6POXhFwOja3SZIX1nUxtWrUxKj

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/.rubocop.yml

@@ -0,0 +1,18 @@
+Documentation:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Metrics/MethodLength: 
+  Max: 25
+Metrics/BlockLength:
+  Max: 35
+Metrics/ParameterLists:
+  Max: 8
+Lint/DuplicateMethods:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/PredicateName:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2
+git:
+  depth: 25
+  quiet: true

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 lydiansanyu@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in momoapi-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    momoapi-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.0)
+    json (2.3.0)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      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.2)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.24.1)
+      sync
+    vcr (5.1.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8.15)
+  faraday
+  momoapi-ruby!
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 5.1)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 LydiaSanyu
+
+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,181 @@
+# MTN MoMo API Ruby Gem
+
+[![Build Status](https://travis-ci.com/sparkplug/momoapi-ruby.svg?branch=master)](https://travis-ci.com/sparkplug/momoapi-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/sparkplug/momoapi-ruby/badge.svg?branch=master)](https://coveralls.io/github/sparkplug/momoapi-ruby?branch=master)
+[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/momo-api-developers/)
+
+## Usage
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'momoapi-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install momoapi-ruby
+
+
+## Creating a sandbox environment API user
+Type this command into your terminal:
+
+```
+momoapi-ruby --host Your-Provider-Callback-Host --key Your-Ocp-Apim-Subscription-Key
+```
+
+A User ID and API Key will be generated:
+
+```
+User ID: Generated user ID
+API key: Generated API key
+```
+
+## Using live credentials
+Add the following configurations in an initializer file (for example, `config/initializers/momoapi-ruby.rb` in a Rails app):
+
+```
+Momoapi.configure do |config|
+  config.base_url = 'Your MoMo account base URL'
+  config.callback_host = 'Your Provider Callback Host'
+end
+```
+
+## Collections
+The collections client can be created with the following paramaters. Note that the `COLLECTION_USER_ID` and `COLLECTION_API_SECRET` for production are provided on the MTN OVA dashboard.
+
+Add the following to your configuration block:
+```
+  config.collection_primary_key = 'Your Collection Subscription Key'
+  config.collection_user_id = 'Your Collection User ID'
+  config.collection_api_secret = 'Your Collection API Key'
+```
+
+* `collection_primary_key`: Primary Key for the `Collection` product on the developer portal.
+* `collection_user_id`: For sandbox, use the one generated with the `momoapi-ruby` command.
+* `collection_api_secret`: For sandbox, use the one generated with the `momoapi-ruby` command.
+
+You can create a collection client with the following:
+
+```ruby
+require 'momoapi-ruby'
+
+collection = Momoapi::Collection.new
+```
+
+### Methods
+1. `request_to_pay`: This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction is executed once the payer has authorized the payment. The transaction will be in status PENDING until it is authorized or declined by the payer or it is timed out by the system. Status of the transaction can be validated by using `get_transaction_status`.
+
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_id` returned by `request_to_pay`. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error. 
+
+3. `get_balance`: Get the balance of the account.
+
+### Sample Code
+
+```ruby
+require 'momoapi-ruby'
+
+collection = Momoapi::Collection.new
+collection.request_to_pay(
+    mobile="256772123456", amount="600", external_id="123456789", payee_note="dd", payer_message="dd", currency="EUR")
+```
+An extra argument, `callback_url`, can be passed to this method, denoting the URL to the server where the callback should be sent.
+
+## Disbursements
+The disbursements client can be created with the following paramaters. The `DISBURSEMENT_USER_ID` and `DISBURSEMENT_API_SECRET` for production are provided on the MTN OVA dashboard.
+
+Add the following to your configuration block:
+```
+  config.disbursement_primary_key = 'Your Disbursement Subscription Key'
+  config.disbursement_user_id = 'Your Disbursement User ID'
+  config.disbursement_api_secret = 'Your Disbursement API Key'
+```
+
+* `disbursement_primary_key`: Primary Key for the `Disbursement` product on the developer portal.
+* `disbursement_user_id`: For sandbox, use the one generated with the `momoapi-ruby` command.
+* `disbursement_api_secret`: For sandbox, use the one generated with the `momoapi-ruby` command.
+
+You can create a disbursement client with the following:
+
+```ruby
+require 'momoapi-ruby'
+
+disbursement = Momoapi::Disbursement.new
+```
+
+### Methods
+1. `transfer`: Used to transfer an amount from the owner’s account to a payee account. Status of the transaction can be validated by using the `get_transaction_status` method.
+
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_id` returned by `transfer`. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error. 
+
+3. `get_balance`: Get the balance of the account.
+
+### Sample Code
+
+```ruby
+require 'momoapi-ruby'
+
+disbursement = Momoapi::Disbursement.new
+disbursement.transfer(
+    mobile="256772123456", amount="600", external_id="123456789", payee_note="dd", payer_message="dd", currency="EUR")
+```
+An extra argument, `callback_url`, can be passed to this method, denoting the URL to the server where the callback should be sent.
+
+## Remittances
+The remittances client can be created with the following paramaters. The `REMITTANCES_USER_ID` and `REMITTANCES_API_SECRET` for production are provided on the MTN OVA dashboard.
+
+Add the following to your configuration block:
+```
+  config.remittance_primary_key = 'Your Remittance Subscription Key'
+  config.remittance_user_id = 'Your Remittance User ID'
+  config.remittance_api_secret = 'Your Remittance API Key'
+```
+
+* `remittance_primary_key`: Primary Key for the `Remittance` product on the developer portal.
+* `remittance_user_id`: For sandbox, use the one generated with the `momoapi-ruby` command.
+* `remittance_api_secret`: For sandbox, use the one generated with the `momoapi-ruby` command.
+
+You can create a remittance client with the following:
+
+```ruby
+require 'momoapi-ruby'
+
+remittance = Momoapi::Remittance.new
+```
+
+### Methods
+1. `transfer`: Used to transfer an amount from the owner’s account to a payee account. Status of the transaction can be validated by using the `get_transaction_status` method.
+
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_id` returned by `transfer`. You can invoke it at intervals until the transaction fails or succeeds. If the transaction has failed, it will throw an appropriate error. 
+
+3. `get_balance`: Get the balance of the account.
+
+### Sample Code
+
+```ruby
+require 'momoapi-ruby'
+
+remittance = Momoapi::Remittance.new
+remittance.transfer(
+    mobile="256772123456", amount="600", external_id="123456789", payee_note="dd", payer_message="dd", currency="EUR")
+```
+An extra argument, `callback_url`, can be passed to this method, denoting the URL to the server where the callback should be sent.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sparkplug/momoapi-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Momoapi::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sparkplug/momoapi-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'momoapi-ruby'
+
+# 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/momoapi-ruby

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'momoapi-ruby'
+require 'optparse'
+require_relative '../lib/momoapi-ruby/cli'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: momoapi --host host --key key'
+
+  opts.on('-h', '--host=HOST', String,
+          'Provider callback host') do |v|
+    options[:host] = v
+  end
+
+  opts.on('-k', '--key=KEY', String,
+          'Subscription key') do |v|
+    options[:key] = v
+  end
+end.parse!
+
+Momoapi::CLI.new(options)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/momoapi-ruby/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# This is an executable file allowing a user to use the command line interface
+# to pass in a callback host url and a subscription key
+# and get back a generated user id and API key
+
+require 'faraday'
+require 'json'
+require 'securerandom'
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/errors'
+require 'momoapi-ruby'
+
+module Momoapi
+  class CLI
+    def initialize(option)
+      @uuid = SecureRandom.uuid
+      @host = option[:host]
+      @key = option[:key]
+      create_sandbox_user
+    end
+
+    def create_sandbox_user
+      body = { "providerCallbackHost": @host }
+      @url = 'https://sandbox.momodeveloper.mtn.com/v1_0/apiuser'
+      response = Faraday.post(@url) do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-Reference-Id'] = @uuid
+        req.headers['Ocp-Apim-Subscription-Key'] = @key
+        req.body = body.to_json
+      end
+
+      unless response.status == 201
+        raise Error::APIError.new(response.body, response.status)
+      end
+
+      generate_api_key
+    end
+
+    def generate_api_key
+      @url = 'https://sandbox.momodeveloper.mtn.com/v1_0/apiuser/' +
+             @uuid + '/apikey'
+      response = Faraday.post(@url) do |req|
+        req.headers['Ocp-Apim-Subscription-Key'] = @key
+      end
+
+      unless response.status == 201
+        raise Error::APIError.new(response.body, response.status)
+      end
+
+      key = JSON.parse(response.body)
+      puts "\n User ID: #{@uuid} \n API key: #{key['apiKey']} \n\n"
+    end
+  end
+end

data/lib/momoapi-ruby/client.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Base implementation of the MTN API client
+
+# Includes methods common to collections, disbursements and remittances
+
+require 'faraday'
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/errors'
+
+module Momoapi
+  class Client
+    def send_request(method, path, headers, *_body)
+      auth_token = get_auth_token['access_token']
+      conn = Faraday.new(url: Momoapi.config.base_url)
+      conn.headers = headers
+      conn.authorization(:Bearer, auth_token)
+
+      case method
+      when 'get'
+        response = conn.get(path)
+      when 'post'
+        response = conn.post(path)
+      end
+      interpret_response(response)
+    end
+
+    def interpret_response(resp)
+      body = resp.body.empty? ? '' : JSON.parse(resp.body)
+      response = {
+        body: body,
+        code: resp.status
+      }
+      unless resp.status >= 200 && resp.status < 300
+        handle_error(response[:body], response[:code])
+      end
+      response
+    end
+
+    def handle_error(response_body, response_code)
+      raise Error::APIError.new(response_body, response_code)
+    end
+
+    # Create an  access token which can then be used to
+    # authorize and authenticate towards the other end-points of the API
+    def get_auth_token(path, subscription_key)
+      headers = {
+        "Ocp-Apim-Subscription-Key": subscription_key
+      }
+      username = Momoapi.config.collection_user_id
+      password = Momoapi.config.collection_api_secret
+      url = Momoapi.config.base_url
+      conn = Faraday.new(url: url)
+      conn.headers = headers
+      conn.basic_auth(username, password)
+      response = conn.post(path)
+      begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        response.body.to_s
+      end
+    end
+
+    def prepare_get_request(path, subscription_key)
+      headers = {
+        "X-Target-Environment": Momoapi.config.environment || 'sandbox',
+        "Content-Type": 'application/json',
+        "Ocp-Apim-Subscription-Key": subscription_key
+      }
+      send_request('get', path, headers)
+    end
+
+    # get the balance on an account
+    def get_balance(path, subscription_key)
+      prepare_get_request(path, subscription_key)
+    end
+
+    # retrieve transaction information, for transfer and payments
+    def get_transaction_status(path, subscription_key)
+      prepare_get_request(path, subscription_key)
+    end
+
+    # check if an account holder is registered and active in the system
+    def is_user_active(path, subscription_key)
+      prepare_get_request(path, subscription_key)
+    end
+  end
+end

data/lib/momoapi-ruby/collection.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Implementation of the MTN API collections client
+
+require 'securerandom'
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/client'
+
+module Momoapi
+  class Collection < Client
+    def get_auth_token
+      path = 'collection/token/'
+      super(path, Momoapi.config.collection_primary_key)
+    end
+
+    def get_balance
+      path = '/collection/v1_0/account/balance'
+      super(path, Momoapi.config.collection_primary_key)
+    end
+
+    def get_transaction_status(transaction_id)
+      path = "/collection/v1_0/requesttopay/#{transaction_id}"
+      super(path, Momoapi.config.collection_primary_key)
+    end
+
+    # This method is used to request a payment from a consumer (Payer).
+    # The payer will be asked to authorize the payment. The transaction will
+    # be executed once the payer has authorized the payment.
+    # The requesttopay will be in status PENDING until the transaction
+    # is authorized or declined by the payer or it is timed out by the system.
+    # The status of the transaction can be validated
+    # by using `get_transation_status`
+    def request_to_pay(phone_number, amount, external_id,
+                       payee_note = '', payer_message = '',
+                       currency = 'EUR', **options)
+      uuid = SecureRandom.uuid
+      headers = {
+        "X-Target-Environment": Momoapi.config.environment || 'sandbox',
+        "Content-Type": 'application/json',
+        "X-Reference-Id": uuid,
+        "Ocp-Apim-Subscription-Key": Momoapi.config.collection_primary_key
+      }
+      if options[:callback_url]
+        headers['X-Callback-Url'] = options[:callback_url]
+      end
+      body = {
+        "payer": {
+          "partyIdType": 'MSISDN',
+          "partyId": phone_number
+        },
+        "payeeNote": payee_note,
+        "payerMessage": payer_message,
+        "externalId": external_id,
+        "currency": currency,
+        "amount": amount.to_s
+      }
+      path = '/collection/v1_0/requesttopay'
+      send_request('post', path, headers, body)
+      { transaction_reference: uuid }
+    end
+
+    def is_user_active(phone_number)
+      path = "/collection/v1_0/accountholder/msisdn/#{phone_number}/active"
+      super(path, Momoapi.config.collection_primary_key)
+    end
+  end
+end

data/lib/momoapi-ruby/config.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Configurations are set up in this file
+# for a user's MTN MoMo API user credentials
+
+module Momoapi
+  class Config
+    attr_accessor :environment, :base_url,
+                  :callback_host, :collection_primary_key,
+                  :collection_user_id, :collection_api_secret,
+                  :disbursement_primary_key, :disbursement_user_id,
+                  :disbursement_api_secret, :remittance_primary_key,
+                  :remittance_user_id, :remittance_api_secret
+
+    def initialize
+      @environment = nil
+      @base_url = nil
+      @callback_host = nil
+      @collection_primary_key = nil
+      @collection_user_id = nil
+      @collection_api_secret = nil
+      @disbursement_primary_key = nil
+      @disbursement_user_id = nil
+      @disbursement_api_secret = nil
+      @remittance_primary_key = nil
+      @remittance_user_id = nil
+      @remittance_api_secret = nil
+    end
+  end
+end

data/lib/momoapi-ruby/disbursement.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Implementation of the MTN API disbursements client
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/client'
+
+module Momoapi
+  class Disbursement < Client
+    def get_auth_token
+      path = 'disbursement/token/'
+      super(path, Momoapi.config.disbursement_primary_key)
+    end
+
+    def get_balance
+      path = '/disbursement/v1_0/account/balance'
+      super(path, Momoapi.config.disbursement_primary_key)
+    end
+
+    def get_transaction_status(transaction_id)
+      path = "/disbursement/v1_0/transfer/#{transaction_id}"
+      super(path, Momoapi.config.disbursement_primary_key)
+    end
+
+    # The transfer operation is used to transfer an amount from the owner’s
+    # account to a payee account.
+    # The status of the transaction can be validated
+    # by using `get_transation_status`
+    def transfer(phone_number, amount, external_id,
+                 payee_note = '', payer_message = '',
+                 currency = 'EUR', **options)
+      uuid = SecureRandom.uuid
+      headers = {
+        "X-Target-Environment": Momoapi.config.environment || 'sandbox',
+        "Content-Type": 'application/json',
+        "X-Reference-Id": uuid,
+        "Ocp-Apim-Subscription-Key": Momoapi.config.disbursement_primary_key
+      }
+      if options[:callback_url]
+        headers['X-Callback-Url'] = options[:callback_url]
+      end
+      body = {
+        "payer": {
+          "partyIdType": 'MSISDN',
+          "partyId": phone_number
+        },
+        "payeeNote": payee_note,
+        "payerMessage": payer_message,
+        "externalId": external_id,
+        "currency": currency,
+        "amount": amount.to_s
+      }
+      path = '/disbursement/v1_0/transfer'
+      send_request('post', path, headers, body)
+      { transaction_reference: uuid }
+    end
+
+    def is_user_active(phone_number)
+      path = "/disbursement/v1_0/accountholder/msisdn/#{phone_number}/active"
+      super(path, Momoapi.config.disbursement_primary_key)
+    end
+  end
+end

data/lib/momoapi-ruby/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Error handling for unsuccessful responses from the MTN Momo API
+
+module Error
+  class APIError < StandardError
+    def initialize(message, code)
+      @code = code
+      super("Error - code #{code}, message: #{message}")
+    end
+  end
+end

data/lib/momoapi-ruby/remittance.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Implementation of the MTN API remittances client
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/client'
+
+module Momoapi
+  class Remittance < Client
+    def get_auth_token
+      path = 'remittance/token/'
+      super(path, Momoapi.config.remittance_primary_key)
+    end
+
+    def get_balance
+      path = '/remittance/v1_0/account/balance'
+      super(path, Momoapi.config.remittance_primary_key)
+    end
+
+    def get_transaction_status(transaction_id)
+      path = "/remittance/v1_0/transfer/#{transaction_id}"
+      super(path, Momoapi.config.remittance_primary_key)
+    end
+
+    # The transfer operation is used to transfer an amount from the owner’s
+    # account to a payee account.
+    # The status of the transaction can be validated
+    # by using `get_transation_status`
+    def transfer(phone_number, amount, external_id,
+                 payee_note = '', payer_message = '',
+                 currency = 'EUR', **options)
+      uuid = SecureRandom.uuid
+      headers = {
+        "X-Target-Environment": Momoapi.config.environment || 'sandbox',
+        "Content-Type": 'application/json',
+        "X-Reference-Id": uuid,
+        "Ocp-Apim-Subscription-Key": Momoapi.config.disbursement_primary_key
+      }
+      if options[:callback_url]
+        headers['X-Callback-Url'] = options[:callback_url]
+      end
+      body = {
+        "payer": {
+          "partyIdType": 'MSISDN',
+          "partyId": phone_number
+        },
+        "payeeNote": payee_note,
+        "payerMessage": payer_message,
+        "externalId": external_id,
+        "currency": currency,
+        "amount": amount.to_s
+      }
+      path = '/remittance/v1_0/transfer'
+      send_request('post', path, headers, body)
+      { transaction_reference: uuid }
+    end
+
+    def is_user_active(phone_number)
+      path = "/remittance/v1_0/accountholder/msisdn/#{phone_number}/active"
+      super(path, Momoapi.config.remittance_primary_key)
+    end
+  end
+end

data/lib/momoapi-ruby/version.rb

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

data/lib/momoapi-ruby.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'momoapi-ruby/config'
+require 'momoapi-ruby/version'
+require 'momoapi-ruby/cli'
+require 'momoapi-ruby/collection'
+require 'momoapi-ruby/disbursement'
+require 'momoapi-ruby/remittance'
+
+module Momoapi
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.reset
+    @config = Config.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/momoapi-ruby.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'momoapi-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'momoapi-ruby'
+  spec.version       = Momoapi::VERSION
+  spec.authors       = ['Lydia Sanyu Naggayi']
+  spec.email         = ['lydiansanyu@gmail.com']
+  spec.summary       = 'MTN MoMo gem'
+  spec.description   = 'MTN MoMo API Client for Ruby'
+  spec.license       = 'MIT'
+
+  # 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        = 'bin'
+  spec.executables   = 'momoapi-ruby'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.15'
+  spec.add_development_dependency 'faraday'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 5.1'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: momoapi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lydia Sanyu Naggayi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.15
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: MTN MoMo API Client for Ruby
+email:
+- lydiansanyu@gmail.com
+executables:
+- momoapi-ruby
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/momoapi-ruby
+- bin/setup
+- lib/momoapi-ruby.rb
+- lib/momoapi-ruby/cli.rb
+- lib/momoapi-ruby/client.rb
+- lib/momoapi-ruby/collection.rb
+- lib/momoapi-ruby/config.rb
+- lib/momoapi-ruby/disbursement.rb
+- lib/momoapi-ruby/errors.rb
+- lib/momoapi-ruby/remittance.rb
+- lib/momoapi-ruby/version.rb
+- momoapi-ruby.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: MTN MoMo gem
+test_files: []