rave_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d0de78eb5d5fc35c6ea80ceca8b1537b9ed12e88a70a948fdc39a81892f9d0
-  data.tar.gz: 4fa81aa9c64f6cedba27045a6722b7badd908c993fbce452920eb43bed17128d
+  metadata.gz: e0bcdac759e9365153ee35f5508ef69b1e483da33379a780ab3e3a57a28c2950
+  data.tar.gz: 32251e36bb561cfa4dc177dafe2b1db68b6743980ac6c9128736d4116fbe5d88
 SHA512:
-  metadata.gz: 23c10ff6b2e46282cfae2b1536a4440ab6a685c6605d6585d1bb1095cb8cd31a692e4cb6e30d6e5314b4fa0346438190aac90f5d70e2ff39d01462f407ec8ec7
-  data.tar.gz: aabec004b41770acfd5d3b3a472cf6a2a7d133a784e44f12b8f6d6fdb117889cd2060b6d089b9a85764313dfb649fecaba3e789a86db8ced90ce566b6b21183b
+  metadata.gz: 5ade21a39b8321638abba7899fad1b6115adb1b813c385ac416bb4904c54712c76ae33c64b35877ed3bd1d350d13e76437794056141ff0ad2583c05fc1b14c10
+  data.tar.gz: 4b73d8c3120d25ffd81c3d9890aa364dea6580d99d5d7a75df04e2a7856fe4a80f281a5c1fc8c536f944c575d86457261b3b482a5fb22969d661a9e23d968f49

data/.gitignore

@@ -19,5 +19,6 @@ preauth_test.rb
 sub_account_test.rb
 subscriptionTest.rb
 uganda_mobile_money_test.rb
+zambia_mobile_money_test.rb
 payment_plan_test.rb
 env.rb

data/README.md

@@ -67,6 +67,7 @@ rave = RaveRuby.new("YOUR_RAVE_LIVE_PUBLIC_KEY", "YOUR_RAVE_LIVE_SECRET_KEY", tr
 - [Subscription.new(rave)](#subscriptionnewrave)
 - [Transfer.new(rave)](#transfernewrave)
 - [UgandaMobileMoney.new(rave)](#ugandamobilemoneynewrave)
+- [ZambiaMobileMoney.new(rave)](#zambiamobilemoneynewrave)
 - [Ussd.new(rave)](#ussdnewrave)
 - [ListBanks.new(rave)](#listbanksnewrave)
 
@@ -1298,18 +1299,20 @@ It returns this response in ruby hash. A sample response:
 
 ```ruby
 {
-    "error"=>false, "status"=>"success", "message"=>"SUBSCRIPTIONS-FETCHED", "data"=>{"page_info"=>{"total"=>0, "current_page"=>0, "total_pages"=>0}, "plansubscriptions"=>[]}, "plansubscriptions"=>[]
+    "error"=>false, "status"=>"success", "message"=>"SUBSCRIPTIONS-FETCHED", "data"=>{"page_info"=>{"total"=>6, "current_page"=>1, "total_pages"=>1}, "plansubscriptions"=>[{"id"=>1785, "amount"=>100, "customer"=>{"id"=>83207, "customer_email"=>"horozex@ace-mail.net"}, "plan"=>1296, "status"=>"cancelled",
+    "date_created"=>"2019-02-06T21:03:21.000Z"}, {"id"=>1726, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-29T08:58:38.000Z"}, {"id"=>1724, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-28T17:16:46.000Z"}, {"id"=>1720,
+    "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-26T17:15:36.000Z"}, {"id"=>1719, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-26T15:13:07.000Z"}, {"id"=>1533, "amount"=>100, "customer"=>{"id"=>73332, "customer_email"=>"jolaosoyusuf16@gmail.com"}, "plan"=>1296, "status"=>"active", "date_created"=>"2018-12-29T11:47:45.000Z"}]}, "plansubscriptions"=>[{"id"=>1785, "amount"=>100, "customer"=>{"id"=>83207, "customer_email"=>"horozex@ace-mail.net"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-02-06T21:03:21.000Z"}, {"id"=>1726, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-29T08:58:38.000Z"}, {"id"=>1724, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-28T17:16:46.000Z"}, {"id"=>1720, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-26T17:15:36.000Z"}, {"id"=>1719, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"cancelled", "date_created"=>"2019-01-26T15:13:07.000Z"}, {"id"=>1533, "amount"=>100, "customer"=>{"id"=>73332, "customer_email"=>"jolaosoyusuf16@gmail.com"}, "plan"=>1296, "status"=>"active", "date_created"=>"2018-12-29T11:47:45.000Z"}]
 }
 ```
 
-### `.fetch_subscription("subscription_id", "subscription_email")`
+### `.fetch_subscription(transaction_id)`
 
-This function is called to fetch a single subscription taking the subscription id and subscription email as its arguments.
+This function is called to fetch a single subscription by taking the transaction id from a successful charge or verify response as its arguments.
 
 #### Sample fetch_subscription call:
 
 ```ruby
-response = subscription.fetch_subscription("1", "test@test.com")
+response = subscription.fetch_subscription("426082")
 ```
 #### which returns:
 
@@ -1317,42 +1320,72 @@ It returns this response in ruby hash. A sample response:
 
 ```ruby
 {
-    "error"=>false, "status"=>"success", "message"=>"SUBSCRIPTIONS-FETCHED", "data"=>{"page_info"=>{"total"=>0, "current_page"=>0, "total_pages"=>0}, "plansubscriptions"=>[]}
+    "error"=>false, "status"=>"success", "message"=>"SUBSCRIPTIONS-FETCHED", "data"=>{"page_info"=>{"total"=>1, "current_page"=>1, "total_pages"=>1}, "plansubscriptions"=>[{"id"=>1794, "amount"=>100, "customer"=>{"id"=>51655, "customer_email"=>"user@gmail.com"}, "plan"=>1296, "status"=>"active", "date_created"=>"2019-02-07T16:04:34.000Z"}]}
 }
 ```
 
-### `.activate_subscription("subscription_id")`
+### `.activate_subscription(transaction_id)`
 
-This function is called to activate a subscription taking the subscription id as its argument.
+This function is called to activate a subscription by taking the transaction id from a successful charge or verify response as its arguments.
 
 #### Sample activate_subscription call:
 
 ```ruby
-response = subscription.activate_subscription(1533)
+response = subscription.activate_subscription(426082)
 ```
 #### which returns:
 
 It returns this response in ruby hash. A sample response:
 
 ```ruby
-
+{
+  "error"=>false,
+  "status"=> "success",
+  "message"=> "SUBSCRIPTION-ACTIVATED",
+  "data"=> {
+    "id"=> 1794,
+    "amount"=> 100,
+    "customer"=> {
+      "id"=> 51655,
+      "customer_email"=> "user@gmail.com"
+    },
+    "plan"=> 1296,
+    "status"=> "active",
+    "date_created"=> "2019-02-07T16:04:34.000Z"
+  }
+}
 ```
 
-### `.cancel_subscription("subscription_id")`
+### `.cancel_subscription(transaction_id)`
 
-This function is called to cancel a subscription taking the subscription id as its argument.
+This function is called to cancel a subscription by taking the transaction id from a successful charge or verify response as its arguments.
 
 #### Sample cancel_subscription call:
 
 ```ruby
-response = subscription.cancel_subscription(1533)
+response = subscription.cancel_subscription(426082)
 ```
 #### which returns:
 
 It returns this response in ruby hash. A sample response:
 
 ```ruby
-
+{
+  "error"=>false,
+  "status" => "success",
+  "message"=> "SUBSCRIPTION-CANCELLED",
+  "data"=> {
+    "id"=> 1794,
+    "amount"=> 100,
+    "customer"=> {
+      "id"=> 51655,
+      "customer_email"=> "user@gmail.com"
+    },
+    "plan"=> 1296,
+    "status"=> "cancelled",
+    "date_created"=> "2019-02-07T16:04:34.000Z"
+  }
+}
 ```
 
 ### Full Subscription Flow
@@ -1366,7 +1399,7 @@ rave = RaveRuby.new("FLWPUBK-xxxxxxxxxxxxxxxxxxxxx-X", "FLWSECK-xxxxxxxxxxxxxxxx
 subscription = Subscription.new(rave)
 response = subscription.list_all_subscription
 print response
-response = subscription.fetch_subscription("1", "test@test.com")
+response = subscription.fetch_subscription("1")
 print response
 response = subscription.activate_subscription(1533)
 print response
@@ -1712,6 +1745,109 @@ print response
 
 ```
 
+## `ZambiaMobileMoney.new(rave)`
+
+To perform zambia mobile money transactions, instantiate the zambia mobile money object and pass rave object as its argument.
+
+Its functions includes:
+
+- `.initiate_charge`
+- `.verify_charge`
+
+### `.initiate_charge(payload)`
+
+This function is called to initiate zambia mobile money transaction. The payload should be a ruby hash with uganda mobile money details. Its parameters should include the following:
+
+- `amount`,
+
+- `email`,
+
+- `phonenumber`,
+
+- `network`,
+
+You can also add your custom transaction reference `(txRef)`, if not, one would be automatically generated for you in which we used the ruby `securerandom` module for generating this in the `Util` module.
+
+#### Sample zambia mobile money charge call:
+
+```ruby
+response = charge_zambia_mobile_money.initiate_charge(payload)
+```
+#### which returns:
+
+It returns this response in ruby hash. A sample response:
+
+```ruby
+
+{
+    "error"=>false, "status"=>"success-pending-validation", "validation_required"=>true, "txRef"=>"MC-bed3093128cd133623ad3cc7cbfc22b2", "flwRef"=>"flwm3s4m0c1549542975743", "amount"=>30, "currency"=>"ZMW", "validateInstruction"=>nil, "authModelUsed"=>"MOBILEMONEY", "paymentType"=>"mobilemoneyzm"
+}
+
+```
+
+### `.verify_charge(txRef)`
+
+You can call the `verify_charge` function to check if your transaction was completed successfully. To do this, you have to pass the transaction reference generated at the point of making your charge call. This is the txRef in the response parameter returned in any of the `initiate_charge` call.
+
+#### Sample verify_charge call:
+
+```ruby
+response = charge_zambia_mobile_money.verify_charge(response["txRef"])
+```
+
+#### which returns:
+
+It returns this response in ruby hash with the `txRef`, `flwRef` and `transaction_complete` which indicates the transaction is successfully completed.
+
+Full sample response returned if a transaction is successfully verified:
+
+```ruby
+{
+    "error"=>false, "transaction_complete"=>false, "data"=>{"txid"=>425673, "txref"=>"MC-bed3093128cd133623ad3cc7cbfc22b2", "flwref"=>"flwm3s4m0c1549542975743", "devicefingerprint"=>"N/A", "cycle"=>"one-time", "amount"=>30, "currency"=>"ZMW", "chargedamount"=>30, "appfee"=>0.42, "merchantfee"=>0, "merchantbearsfee"=>1, "chargecode"=>"02", "chargemessage"=>"Pending Payment Validation", "authmodel"=>"MOBILEMONEY", "ip"=>"::ffff:10.63.225.86", "narration"=>"Simply Recharge", "status"=>"success-pending-validation", "vbvcode"=>"N/A", "vbvmessage"=>"N/A", "authurl"=>"NO-URL", "acctcode"=>nil, "acctmessage"=>nil, "paymenttype"=>"mobilemoneyzm", "paymentid"=>"N/A", "fraudstatus"=>"ok", "chargetype"=>"normal", "createdday"=>4, "createddayname"=>"THURSDAY", "createdweek"=>6, "createdmonth"=>1, "createdmonthname"=>"FEBRUARY", "createdquarter"=>1, "createdyear"=>2019, "createdyearisleap"=>false, "createddayispublicholiday"=>0, "createdhour"=>12, "createdminute"=>36, "createdpmam"=>"pm", "created"=>"2019-02-07T12:36:15.000Z", "customerid"=>83416, "custphone"=>"054709929300", "custnetworkprovider"=>"UNKNOWN PROVIDER",
+    "custname"=>"John Doe", "custemail"=>"user@example.com", "custemailprovider"=>"COMPANY EMAIL", "custcreated"=>"2019-02-07T12:36:14.000Z", "accountid"=>6076, "acctbusinessname"=>"Simply Recharge", "acctcontactperson"=>"Jolaoso Yusuf", "acctcountry"=>"NG", "acctbearsfeeattransactiontime"=>1, "acctparent"=>1, "acctvpcmerchant"=>"N/A", "acctalias"=>nil, "acctisliveapproved"=>0, "orderref"=>"URF_MMGH_1549542975097_8307535", "paymentplan"=>nil, "paymentpage"=>nil, "raveref"=>nil, "meta"=>[]}
+}
+```
+
+If the `chargecode` returned is `02`, it means the transaction is still pending validation else if it returns `00`, it means the transaction is successfully completed.
+
+#### Full Zambia Mobile Money Transaction Flow:
+
+```ruby
+
+require 'rave_ruby'
+
+
+# This is a rave object which is expecting public and secret keys
+rave = RaveRuby.new("FLWPUBK-xxxxxxxxxxxxxxxxxxxxx-X", "FLWSECK-xxxxxxxxxxxxxxxxxxxx-X")
+
+
+# This is used to perform zambia mobile money charge
+
+payload = {
+    "amount" => "30",
+    "phonenumber" => "054709929300",
+    "firstname" => "John",
+    "lastname" => "Doe",
+    "network" => "MTN",
+    "email" => "user@example.com",
+    "IP" => '355426087298442',
+    "redirect_url" => "https://webhook.site/6eb017d1-c605-4faa-b543-949712931895",
+}
+
+# To initiate zambia mobile money transaction
+charge_zambia_mobile_money = ZambiaMobileMoney.new(rave)
+
+response = charge_zambia_mobile_money.initiate_charge(payload)
+
+print response
+
+# To verify the zambia mobile money transaction
+response = charge_zambia_mobile_money.verify_charge(response["txRef"])
+
+print response
+
+```
+
 ## `Ussd.new(rave)`
 
 `NOTE:` This option is currently unavailable.

data/lib/rave_ruby.rb

@@ -8,6 +8,7 @@ require_relative "rave_ruby/rave_objects/transfer"
 require_relative "rave_ruby/rave_objects/mpesa"
 require_relative "rave_ruby/rave_objects/mobile_money"
 require_relative "rave_ruby/rave_objects/uganda_mobile_money"
+require_relative "rave_ruby/rave_objects/zambia_mobile_money"
 require_relative "rave_ruby/rave_objects/payment_plan"
 require_relative "rave_ruby/rave_objects/subscription"
 require_relative "rave_ruby/rave_objects/ussd"

data/lib/rave_ruby/rave_objects/subscription.rb

@@ -13,15 +13,15 @@ class Subscription < SubscriptionBase
 
     #method to fetch a subscription
 
-    def fetch_subscription(id, email)
+    def fetch_subscription(trans_id)
         base_url = rave_object.base_url
         secret_key = rave_object.secret_key.dup
 
-        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup, "id" => id, "email": email})
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup, "transaction_id" => trans_id})
         return handle_fetch_subscription_response(response)
     end 
 
-    def cancel_subscription(id)
+    def cancel_subscription(trans_id)
         base_url = rave_object.base_url
         secret_key = rave_object.secret_key.dup
 
@@ -30,11 +30,11 @@ class Subscription < SubscriptionBase
         }
 
         payload = payload.to_json
-        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/#{id}/cancel",payload)
-        return handle_cancel_response(response)
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/#{trans_id}/cancel?fetch_by_tx=1",payload)
+        return handle_cancel_subscription_response(response)
     end
 
-    def activate_subscription(id)
+    def activate_subscription(trans_id)
 
         base_url = rave_object.base_url
         secret_key = rave_object.secret_key.dup
@@ -45,7 +45,7 @@ class Subscription < SubscriptionBase
             "seckey" => secret_key,
         }
         payload = payload.to_json
-        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/#{id}/activate",payload)
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/#{trans_id}/activate?fetch_by_tx=1",payload)
         return handle_activate_subscription_response(response)
     end
 end

data/lib/rave_ruby/rave_objects/zambia_mobile_money.rb

@@ -0,0 +1,58 @@
+require_relative "base/mobile_money_base.rb"
+require 'json'
+
+class ZambiaMobileMoney < MobileMoneyBase
+    # method to initiate zambia mobile money transaction
+    def initiate_charge(data)
+
+        base_url = rave_object.base_url
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+
+
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("txRef")
+            data.merge!({"txRef" => Util.transaction_reference_generator})
+        end
+
+        # only update the payload with the order reference if it isn't already added to the payload
+        if !data.key?("orderRef")
+            data.merge!({"orderRef" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"PBFPubKey" => public_key, "payment_type" => "mobilemoneyzambia", "country" => "NG", "is_mobile_money_ug" => 1, "currency" => "ZMW"})
+
+        required_parameters = ["amount", "email", "phonenumber", "network", "IP"]
+        check_passed_parameters(required_parameters, data)
+
+        encrypt_data = Util.encrypt(hashed_secret_key, data)
+
+        payload = {
+            "PBFPubKey" => public_key,
+            "client" => encrypt_data,
+            "alg" => "3DES-24"
+        }
+
+        payload = payload.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}", payload) 
+
+        return handle_charge_response(response)
+
+    end
+
+    # method to verify zambia mobile money transaction
+    def verify_charge(txref)
+        base_url = rave_object.base_url
+
+        payload = {
+            "txref" => txref,
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::VERIFY_ENDPOINT}", payload)
+        return handle_verify_response(response)
+    end
+
+end

data/lib/rave_ruby/version.rb

@@ -1,3 +1,3 @@
 module RaveRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rave_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - MaestroJolly
@@ -112,6 +112,7 @@ files:
 - lib/rave_ruby/rave_objects/transfer.rb
 - lib/rave_ruby/rave_objects/uganda_mobile_money.rb
 - lib/rave_ruby/rave_objects/ussd.rb
+- lib/rave_ruby/rave_objects/zambia_mobile_money.rb
 - lib/rave_ruby/version.rb
 - rave_ruby.gemspec
 homepage: https://github.com/MaestroJolly/rave-ruby