Document methods

Author: NLSanyu

.rubocop.yml

@@ -13,4 +13,6 @@ Lint/DuplicateMethods:
 Naming/AccessorMethodName:
   Enabled: false
 Naming/PredicateName:
+  Enabled: false
+Style/AsciiComments:
   Enabled: false

lib/momoapi-ruby/cli.rb

@@ -1,5 +1,9 @@
 # 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'

lib/momoapi-ruby/client.rb

@@ -1,5 +1,9 @@
 # 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'
@@ -38,6 +42,8 @@ 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
@@ -65,14 +71,17 @@ def prepare_get_request(path, 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

lib/momoapi-ruby/collection.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Implementation of the MTN API collections client
+
 require 'securerandom'
 
 require 'momoapi-ruby/config'
@@ -22,6 +24,13 @@ def get_transaction_status(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)

lib/momoapi-ruby/config.rb

@@ -1,5 +1,8 @@
 # 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,

lib/momoapi-ruby/disbursement.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Implementation of the MTN API disbursements client
+
 require 'momoapi-ruby/config'
 require 'momoapi-ruby/client'
 
@@ -20,6 +22,10 @@ def get_transaction_status(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)

lib/momoapi-ruby/errors.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Error handling for unsuccessful responses from the MTN Momo API
+
 module Error
   class APIError < StandardError
     def initialize(message, code)

lib/momoapi-ruby/remittance.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Implementation of the MTN API remittances client
+
 require 'momoapi-ruby/config'
 require 'momoapi-ruby/client'
 
@@ -20,6 +22,10 @@ def get_transaction_status(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)