bygpay 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eba6289ec42335e24a1ce372079719faabc5508
-  data.tar.gz: 22924b061515d6ae970cbf1c92f5e66c1f474446
+  metadata.gz: 7a059301c0d3e744230e6498b1f7df5058c88aaf
+  data.tar.gz: d082d4051373a2d33f24aaec0f8a6bd2399a256c
 SHA512:
-  metadata.gz: a8e6220d4436977f89621f79da72f0f553a1ce5218d0836606826ca2026cf6fc955675f02c67bafa65bfbd7fe61f9fe99006cbdd335638e4404cf62e6701d366
-  data.tar.gz: 18a3d34c8edb7a57aab5180c03e7ac482b0571730b5c536389c4860c8ed2f277133a49d78dcff9f5f46318050f08ef4aa658e4ddd56ce4d29c9afdbd796462a2
+  metadata.gz: af82337c4032f15986d51b443222e793d3075e6f8ca7f21674231f037667ff2685f12c13aea6b350ac856ca91d8e7ee3281ee414ffdca1182504469c1da1a97f
+  data.tar.gz: 136c3f524bbe10a71b320508606b0de8be236df99ad18dc6200f6d544444b8bcc1d1492c1bcdc7159b6f252fea70752eacb3b775286be11b3bf00d372e12ca71

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## CHANGE LOG
+
+#####v0.1.1
+* Created SDK
+* MoMo Deposits Support
+
+#####v0.2.0
+* Fixed Bugs
+* MoMo Withdrawal Support

data/README.md

@@ -1,3 +1,5 @@
+[![Code Climate](https://codeclimate.com/github/nukturnal/bygpay/badges/gpa.svg)](https://codeclimate.com/github/nukturnal/bygpay)
+
 # Bygpay
 
 Ruby wrapper around Bygpay Payment Gateway. Bygpay is a self hosted payment processing gateway which gives merchants / business better flexiblity and control when it comes to payment processing.
@@ -27,11 +29,95 @@ Bygpay.configure do |config|
   config.base_url = 'http://gateway.bygpay-server.com/api'
   config.api_key = '8b4e5a9c-6eba-4cdd-94b6-65e6b514'
 
-  # Optional Configurations 
+  # Optional Configurations (Every code below this line)
   # (In case you've changed routes in your Bygpay Installation)
-  config.deposits_mobile_path = '/deposits/mobile'
-  config.deposits_status_overide_path = '/deposits/status-overide'
+  config.deposit_mobile_path = '/deposits/mobile'
+  config.deposit_status_overide_path = '/deposits/status-overide'
   config.deposit_status_path = '/deposits'
+  
+  config.withdraw_mobile_path = '/withdrawals/mobile'
+  config.withdraw_status_overide_path = '/withdrawals/status-overide'
+  config.withdraw_status_path = '/withdrawals'
+end
+```
+
+## Transaction Statuses
+
+Bygpay gateway uses four types of status messages to mark transactions.
+* `accepted` A transaction is marked as `accepted` when it's initially receives the request from a client
+* `pending` A transaction is marked a `pending` when the Gateway begins processing
+* `success` A final status message `success` is used when processing completes successfully
+* `fail` A final status message `fail' is used when the processing completes unsuccessfully
+
+## Deposit Requests
+
+#### Mobile Money
+
+Currently SDK supports MTN, AIRTEL, TIGO, VODAFONE, you may refer to your Bygpay Gateway documentations for more provider options.
+
+```ruby
+# Making a Mobile Money Deposit Request
+deposit = Bygpay::Deposit::Mobile.new
+result = deposit.charge(1.99,{walletno: '0244124550', provider: 'MTN'})
+if result
+  puts deposit.uuid
+  puts deposit.status # accepted, :pending, :fail, :success
+  puts deposit.transaction_id
+else
+  puts deposit.response_text
+  puts deposit.status
+end
+```
+
+Query Transaction status
+```ruby
+# Checking transaction status
+# You always need the transaction UUID to get status response
+deposit = Bygpay::Deposit::Mobile.new
+result = deposit.transaction_status('e81216aa-9ef7-4c5c-aed0-6e5ff1fe')
+if result
+  puts deposit.uuid
+  puts deposit.status # accepted, :pending, :fail, :success
+  puts deposit.transaction_id
+else
+  puts deposit.response_text
+  puts deposit.status
+end
+```
+
+## Withdraw Requests
+
+#### Mobile Money
+
+Currently SDK supports MTN, AIRTEL, TIGO, VODAFONE, you may refer to your Bygpay Gateway documentations for more provider options.
+
+```ruby
+# Making a Mobile Money Withdrawal Request
+withdraw = Bygpay::Withdraw::Mobile.new
+result = withdraw.send(1.99,{walletno: '0244124550', provider: 'MTN'})
+if result
+  puts withdraw.uuid
+  puts withdraw.status # accepted, :pending, :fail, :success
+  puts withdraw.transaction_id
+else
+  puts withdraw.response_text
+  puts withdraw.status
+end
+```
+
+Query Transaction status
+```ruby
+# Checking transaction status
+# You always need the transaction UUID to get status response
+withdraw = Bygpay::Withdraw::Mobile.new
+result = withdraw.transaction_status('e81216aa-9ef7-4c5c-aed0-6e5ff1fe')
+if result
+  puts withdraw.uuid
+  puts withdraw.status # accepted, :pending, :fail, :success
+  puts withdraw.transaction_id
+else
+  puts withdraw.response_text
+  puts withdraw.status
 end
 ```
 
@@ -43,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bygpay. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nukturnal/bygpay. 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

data/lib/bygpay/configuration.rb

@@ -1,16 +1,21 @@
 module Bygpay
   class Configuration
     attr_accessor :base_url, :api_key,
-                  :deposits_mobile_path, :deposits_status_overide_path, :deposit_status_path
+                  :deposit_mobile_path, :deposit_status_overide_path, :deposit_status_path,
+                  :withdraw_mobile_path, :withdraw_status_overide_path, :withdraw_status_path
 
     def initialize
       @base_url = nil
       @api_key = nil
 
       # Preset default paths but allow for changes
-      @deposits_mobile_path = '/deposits/mobile'
-      @deposits_status_overide_path = '/deposits/status-overide'
+      @deposit_mobile_path = '/deposits/mobile'
+      @deposit_status_overide_path = '/deposits/status-overide'
       @deposit_status_path = '/deposits'
+
+      @withdraw_mobile_path = '/withdrawals/mobile'
+      @withdraw_status_overide_path = '/withdrawals/status-overide'
+      @withdraw_status_path = '/withdrawals'
     end
   end
 end

data/lib/bygpay/deposit/mobile.rb

@@ -4,7 +4,6 @@ module Bygpay
 
       # {
       #     "walletno" : "0276967627",
-      #     "amount": 0.10,
       #     "provider": "TIGO",
       #     "extrnx_code": null
       # }
@@ -15,7 +14,7 @@ module Bygpay
 
       # Return deposit transaction status
       def transaction_status(uuid)
-        get_status(deposits_status_endpoint,uuid)
+        get_status(deposit_status_endpoint,uuid)
       end
 
     end

data/lib/bygpay/utils.rb

@@ -8,17 +8,28 @@ module Bygpay
 
     # Mobile Deposit transactions endpoint
     def mobile_deposit_endpoint
-      Bygpay.configuration.deposits_mobile_path
+      Bygpay.configuration.deposit_mobile_path
     end
 
     # Deposit transactions status check endpoint
-    def deposits_status_endpoint
+    def deposit_status_endpoint
       Bygpay.configuration.deposit_status_path
     end
 
+    # Mobile Withdrawal transactions endpoint
+    def mobile_withdraw_endpoint
+      Bygpay.configuration.withdraw_mobile_path
+    end
+
+    # Withdraw transactions status check endpoint
+    def withdraw_status_endpoint
+      Bygpay.configuration.withdraw_status_path
+    end
+
     # Post payload
     def post(endpoint, payload = {})
       url = "#{Bygpay.configuration.base_url}#{endpoint}"
+      puts "URL: #{url}"
       result = http_connect.post(url, json: payload)
 
       parse_response(result.body)
@@ -34,6 +45,7 @@ module Bygpay
 
     # {
     #     "status": "success",
+    #     "message": "Some messages",
     #     "data": {
     #         "uuid": "d1f3395e-ea08-4599-b8a5-41f5e7a4",
     #         "status": "accepted",

data/lib/bygpay/version.rb

@@ -1,3 +1,3 @@
 module Bygpay
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/bygpay/withdraw/mobile.rb

@@ -0,0 +1,22 @@
+module Bygpay
+  module Withdraw
+    class Mobile < Bygpay::Withdrawals
+
+      # {
+      #     "walletno" : "0276967627",
+      #     "provider": "TIGO",
+      #     "extrnx_code": null
+      # }
+      # Perform a mobile deposit request
+      def send(amount, payload ={})
+        post(mobile_withdraw_endpoint, payload.merge({amount: amount}))
+      end
+
+      # Return deposit transaction status
+      def transaction_status(uuid)
+        get_status(withdraw_status_endpoint,uuid)
+      end
+
+    end
+  end
+end

data/lib/bygpay/withdrawals.rb

@@ -0,0 +1,6 @@
+module Bygpay
+  class Withdrawals
+    include Bygpay::Utils
+
+  end
+end

data/lib/bygpay.rb

@@ -3,11 +3,10 @@ require 'bygpay/configuration'
 require 'bygpay/utils'
 require 'bygpay/deposits'
 require 'bygpay/deposit/mobile'
+require 'bygpay/withdrawals'
+require 'bygpay/withdraw/mobile'
 
 module Bygpay
-  SUCCESS = 'success'
-  FAIL = 'fail'
-  PENDING = 'pending'
 
   class << self
     attr_accessor :configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bygpay
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alfred Rowe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -90,6 +91,8 @@ files:
 - lib/bygpay/deposits.rb
 - lib/bygpay/utils.rb
 - lib/bygpay/version.rb
+- lib/bygpay/withdraw/mobile.rb
+- lib/bygpay/withdrawals.rb
 homepage: https://github.com/nukturnal/bygpay
 licenses:
 - MIT