momoapi-ruby 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f12ed418233f72f5340d44b9eacb05a0f9a93329806f081f3ac8a0cf6ffd312
-  data.tar.gz: 791db9e61c6d73c833ff28025cb83b9e9e5f51583569bfea6b4b6518247f6de4
+  metadata.gz: 59f987b2d792f29ab687833b30ff702544e30ed0db2eb39810240f4edf615ad0
+  data.tar.gz: b49d2a488248de144535c6289f516b2d3f347b4a69b41fa05700a73e99560f8c
 SHA512:
-  metadata.gz: 6c4e5b1e00631015144d31a157927732acc13c284ff4c177f31a1452d0afd55b4107ceaf426cd56f33c4b1abc09040d8a5bf9f245502bdfcd07399ea79f4d848
-  data.tar.gz: 3869ce98f646bdd3ffdbf0ee64f898ccf5422554f93cb2e92c5032758eb1fea1484094ac545b0ab3c6e32e4010d7e42d846e34313ac9a908984bc97df8c4af80
+  metadata.gz: 598c194f973eb9cbcc31689c04239b5118e4d6be2b0ad954661d1b86dc935113cccc50c04bbc828bcae07f387ffc1dab4117b095398568d547d90f43e887541f
+  data.tar.gz: 1d9877820849c3c387abdd7e24d72096a45668e2f2ccd59e6919ba4d1a110c1213754df91e07c59b9b105b1ec464d24b686ca7866cffdeb44607863fe9d7b2b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    momoapi-ruby (0.1.0)
+    momoapi-ruby (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -70,22 +70,12 @@ 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`.
+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. The 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. 
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_reference` 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.
@@ -110,22 +100,12 @@ 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.
+1. `transfer`: Used to transfer an amount from the owner’s account to a payee account. The 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. 
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_reference` 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.
@@ -150,22 +130,39 @@ 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.
+1. `transfer`: Used to transfer an amount from the owner’s account to a payee account. The 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. 
+2. `get_transaction_status`: Retrieve transaction information using the `transaction_reference` 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
+
+## 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")
+collection = Momoapi::Collection.new 
+
+collection.is_user_active('256772123456')
+
+collection.get_balance
+
+transaction = collection.request_to_pay(
+    phone_number="256772123456", amount=600, external_id="123456789", payee_note="dd", payer_message="dd", currency="EUR")
+
+transaction_ref = transaction[:transaction_reference]
+
+collection.get_transaction_status(transaction_ref)
+
 ```
-An extra argument, `callback_url`, can be passed to this method, denoting the URL to the server where the callback should be sent.
+
+### Points to note:
+All methods for Disbursements and Remittances follow the same format as the examples shown above for Collections 
+
+The 'transfer' method for Disbursements and Remittances follows the same format as 'request_to_pay' above.
+
+An extra argument, `callback_url`, can be passed to the 'request_to_pay' and 'transfer' methods, denoting the URL to the server where the callback should be sent.
 
 
 ## Contributing

data/lib/momoapi-ruby/cli.rb

@@ -21,9 +21,10 @@ module Momoapi
       create_sandbox_user
     end
 
+    # Create an API user in the sandbox target environment
     def create_sandbox_user
       body = { "providerCallbackHost": @host }
-      @url = 'https://sandbox.momodeveloper.mtn.com/v1_0/apiuser'
+      @url = 'https://ericssonbasicapi2.azure-api.net/v1_0/apiuser'
       response = Faraday.post(@url) do |req|
         req.headers['Content-Type'] = 'application/json'
         req.headers['X-Reference-Id'] = @uuid
@@ -32,21 +33,22 @@ module Momoapi
       end
 
       unless response.status == 201
-        raise Error::APIError.new(response.body, response.status)
+        raise Momoapi::Error.new(response.body, response.status)
       end
 
       generate_api_key
     end
 
+    # Generate an API key in the sandbox target environment
     def generate_api_key
-      @url = 'https://sandbox.momodeveloper.mtn.com/v1_0/apiuser/' +
+      @url = 'https://ericssonbasicapi2.azure-api.net/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)
+        raise Momoapi::Error.new(response.body, response.status)
       end
 
       key = JSON.parse(response.body)

data/lib/momoapi-ruby/client.rb

@@ -11,17 +11,21 @@ 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)
+    def send_request(method, path, headers, body = {})
+      begin
+        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)
+        case method
+        when 'get'
+          response = conn.get(path)
+        when 'post'
+          response = conn.post(path, body.to_json)
+        end
+      rescue ArgumentError
+        raise "Missing configuration key(s) for #{@product.capitalize}s"
       end
       interpret_response(response)
     end
@@ -35,11 +39,11 @@ module Momoapi
       unless resp.status >= 200 && resp.status < 300
         handle_error(response[:body], response[:code])
       end
-      response
+      body
     end
 
     def handle_error(response_body, response_code)
-      raise Error::APIError.new(response_body, response_code)
+      raise Momoapi::Error.new(response_body, response_code)
     end
 
     # Create an  access token which can then be used to
@@ -48,12 +52,12 @@ module Momoapi
       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)
+      @product = path.split('/')[0]
+      get_credentials(@product)
+      conn.basic_auth(@username, @password)
       response = conn.post(path)
       begin
         JSON.parse(response.body)
@@ -62,6 +66,20 @@ module Momoapi
       end
     end
 
+    def get_credentials(product)
+      case product
+      when 'collection'
+        @username = Momoapi.config.collection_user_id
+        @password = Momoapi.config.collection_api_secret
+      when 'disbursement'
+        @username = Momoapi.config.disbursement_user_id
+        @password = Momoapi.config.disbursement_api_secret
+      when 'remittance'
+        @username = Momoapi.config.remittance_user_id
+        @password = Momoapi.config.remittance_api_secret
+      end
+    end
+
     def prepare_get_request(path, subscription_key)
       headers = {
         "X-Target-Environment": Momoapi.config.environment || 'sandbox',

data/lib/momoapi-ruby/collection.rb

@@ -6,6 +6,7 @@ require 'securerandom'
 
 require 'momoapi-ruby/config'
 require 'momoapi-ruby/client'
+require 'momoapi-ruby/validate'
 
 module Momoapi
   class Collection < Client
@@ -33,7 +34,8 @@ module Momoapi
     # by using `get_transation_status`
     def request_to_pay(phone_number, amount, external_id,
                        payee_note = '', payer_message = '',
-                       currency = 'EUR', **options)
+                       currency = 'EUR', callback_url = '')
+      Momoapi::Validate.new.validate(phone_number, amount, currency)
       uuid = SecureRandom.uuid
       headers = {
         "X-Target-Environment": Momoapi.config.environment || 'sandbox',
@@ -41,9 +43,7 @@ module Momoapi
         "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
+      headers['X-Callback-Url'] = callback_url unless callback_url.empty?
       body = {
         "payer": {
           "partyIdType": 'MSISDN',

data/lib/momoapi-ruby/config.rb

@@ -5,7 +5,8 @@
 
 module Momoapi
   class Config
-    attr_accessor :environment, :base_url,
+    attr_writer   :base_url
+    attr_accessor :environment,
                   :callback_host, :collection_primary_key,
                   :collection_user_id, :collection_api_secret,
                   :disbursement_primary_key, :disbursement_user_id,
@@ -26,5 +27,9 @@ module Momoapi
       @remittance_user_id = nil
       @remittance_api_secret = nil
     end
+
+    def base_url
+      @base_url || 'https://ericssonbasicapi2.azure-api.net'
+    end
   end
 end

data/lib/momoapi-ruby/disbursement.rb

@@ -28,7 +28,8 @@ module Momoapi
     # by using `get_transation_status`
     def transfer(phone_number, amount, external_id,
                  payee_note = '', payer_message = '',
-                 currency = 'EUR', **options)
+                 currency = 'EUR', callback_url = '')
+      Momoapi::Validate.new.validate(phone_number, amount, currency)
       uuid = SecureRandom.uuid
       headers = {
         "X-Target-Environment": Momoapi.config.environment || 'sandbox',
@@ -36,11 +37,9 @@ module Momoapi
         "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
+      headers['X-Callback-Url'] = callback_url unless callback_url.empty?
       body = {
-        "payer": {
+        "payee": {
           "partyIdType": 'MSISDN',
           "partyId": phone_number
         },

data/lib/momoapi-ruby/errors.rb

@@ -2,11 +2,17 @@
 
 # Error handling for unsuccessful responses from the MTN Momo API
 
-module Error
-  class APIError < StandardError
+module Momoapi
+  class Error < StandardError
     def initialize(message, code)
       @code = code
-      super("Error - code #{code}, message: #{message}")
+      super("Error code #{code} #{message}")
+    end
+  end
+
+  class ValidationError < StandardError
+    def initialize(msg = message)
+      super(msg)
     end
   end
 end

data/lib/momoapi-ruby/remittance.rb

@@ -28,19 +28,18 @@ module Momoapi
     # by using `get_transation_status`
     def transfer(phone_number, amount, external_id,
                  payee_note = '', payer_message = '',
-                 currency = 'EUR', **options)
+                 currency = 'EUR', callback_url = '')
+      Momoapi::Validate.new.validate(phone_number, amount, currency)
       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
+        "Ocp-Apim-Subscription-Key": Momoapi.config.remittance_primary_key
       }
-      if options[:callback_url]
-        headers['X-Callback-Url'] = options[:callback_url]
-      end
+      headers['X-Callback-Url'] = callback_url unless callback_url.empty?
       body = {
-        "payer": {
+        "payee": {
           "partyIdType": 'MSISDN',
           "partyId": phone_number
         },

data/lib/momoapi-ruby/validate.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Validations for parameters passed into client methods
+
+require 'momoapi-ruby/errors'
+
+module Momoapi
+  class Validate
+    def validate(phone_number, amount, currency)
+      validate_string?(phone_number, 'Phone number')
+      validate_numeric?(amount, 'Amount')
+      validate_string?(currency, 'Currency')
+    end
+
+    def validate_numeric?(num, field)
+      return true if num.is_a? Numeric
+
+      raise Momoapi::ValidationError, "#{field} should be a number"
+    end
+
+    def validate_string?(str, field)
+      return true if str.is_a? String
+
+      raise Momoapi::ValidationError, "#{field} should be a string"
+    end
+  end
+end

data/lib/momoapi-ruby/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: momoapi-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Lydia Sanyu Naggayi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,6 +152,7 @@ files:
 - lib/momoapi-ruby/disbursement.rb
 - lib/momoapi-ruby/errors.rb
 - lib/momoapi-ruby/remittance.rb
+- lib/momoapi-ruby/validate.rb
 - lib/momoapi-ruby/version.rb
 - momoapi-ruby.gemspec
 homepage: