paynow_sdk 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c11a04492e6602903f3cad2293b665015e7eb82e9d4bea7624f0207ee40d46b6
-  data.tar.gz: 11a44f1ebe69d2d0bba1885aee5fea4a67f2d1474521487bbdf539dbe9a69723
+  metadata.gz: 915520deb8152f31cccee97a7a6447ecba4daf5dc6e0cb01b078a45b184ca7d7
+  data.tar.gz: 3c059a6f47ad40f5f4186c31eab15d39957a0b341349f6a946e789a58ac9bf92
 SHA512:
-  metadata.gz: aeb75814e52a89e4bb3c8ce15e19412858d57eaba1dfb128b812e395452f1aafc15e5ea1741528b3df36c040c4b9dea5dd49437ce320cf5a25815d73469cd5e2
-  data.tar.gz: b53de4887d9a737d8a5e7996dc53ba7b252f0f34db7fcf9a7960f4a8c1b10b5f4c859c0c57ac357e1f539cca2ff6aa98c2321475a6d276fa0b066f123aea56b2
+  metadata.gz: e13f40ca7bad71ab2de96790ce9388720b2a2d1733ec6834888ab1b217114a28d9b2343301a3a5c744facc4476ad75210d658da42c5fe830fdcfee6e72002483
+  data.tar.gz: bdc28bc160350a5a77312e3ec5970ff77c6cdb01a2128b2a162b12bf9b0cf47015b2e544e84817368d6d2cf48bc244e9c68cb831ced1f9fd5b2e8185c1451279

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paynow_sdk (1.0.9)
+    paynow_sdk (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/paynow_sdk.rb

@@ -24,8 +24,7 @@ module PaynowStatus
     response = http.request(request)
     response.read_body
 
-    response_object = rebuild(response.read_body)
-    URI.decode_www_form(response_object).to_h
+    response_object = URI.decode_www_form(response.read_body).to_h
   end
 end
 

data/lib/paynow_sdk/version.rb

@@ -1,3 +1,3 @@
 module PaynowSdk
-  VERSION = "1.0.9"
+  VERSION = "1.1.0"
 end

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/.vscode/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paynow_sdk.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "minitest-reporters", "~> 1.4", ">= 1.4.2"
+gem "httparty"
+gem "rest-client", "~> 2.1"

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    paynow_sdk (1.0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby-progressbar (1.10.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.4, >= 1.4.2)
+  paynow_sdk!
+  rake (~> 12.0)
+  rest-client (~> 2.1)
+
+BUNDLED WITH
+   2.1.4

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/README.md

@@ -0,0 +1,152 @@
+# PaynowSdk Ruby gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paynow_sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install paynow_sdk
+
+## Usage
+
+Create an instance of the Paynow class optionally setting the result and return url(s)
+
+```ruby
+paynow = Paynow.new(
+	'INTEGRATION_ID',
+	'INTEGRATION_KEY',
+	'http://returnurl.com',
+	'http://resulturl.com'
+	)
+```
+
+Create a new payment passing in the reference for that payment (e.g invoice id, or anything that you can use to identify the transaction and the user's email address
+
+```ruby
+payment = paynow.create_payment('Order #100', 'test@example.com')
+```
+
+You can then start adding items to the payment
+
+```ruby
+# Passing in the name of the item and the price of the item
+payment.add('Bananas', 2.50)
+payment.add('Apples', 3.40)
+```
+
+When you're finally ready to send your payment to Paynow, you can use the `send` method in the `paynow` object.
+
+```ruby
+# Save the response from paynow in a variable
+response = paynow.send(payment)
+```
+
+The response from Paynow will be have some useful information like whether the request was successful or not. If it was, for example, it contains the url to redirect the user so they can make the payment.
+
+If request was successful, you should consider saving the poll url sent from Paynow in the database
+
+```ruby
+if response.success
+    # The link to redirect the user to paynow to make the payment
+	link = response.redirect_url
+	# Get the poll url (used to check the status of a transaction). You might want to save this in your DB
+    pollUrl = response.poll_url
+end
+```
+
+---
+
+> Mobile Transactions
+
+If you want to send an express (mobile) checkout request instead, the only thing that differs is the last step. You make a call to the `send_mobile` in the `paynow` object
+instead of the `send` method.
+
+The `send_mobile` method unlike the `send` method takes in two additional arguments i.e The phone number to send the payment request to and the mobile money method to use for the request. **Note that currently only ecocash is supported**
+
+```ruby
+# Save the response from paynow in a variable
+response = paynow.send_mobile(payment, '0777777777', 'ecocash')
+```
+
+The response object is almost identical to the one you get if you send a normal request. With a few differences, firstly, you don't get a url to redirect to. Instead you instructions (which ideally should be shown to the user instructing them how to make payment on their mobile phone)
+
+```ruby
+if response.success
+	# Get the poll url (used to check the status of a transaction). You might want to save this in your DB
+    poll_url = response.poll_url
+
+    instructions = response.instructions
+end
+```
+
+# Checking transaction status
+
+The SDK exposes a handy method that you can use to check the status of a transaction.
+
+```ruby
+# Check the status of the transaction with the specified poll url
+#if you saved your poll url in the database you can use this function "PaynowStatus.check_transcation_status(poll_url)" to check the status of the payment
+
+status = PaynowStatus.check_transcation_status(poll_url)
+
+if status.paid
+	render page
+	print "Payment successfull"
+else
+	print "Not Paid"
+end
+```
+
+# Full Usage Example
+
+```ruby
+gem 'paynow_sdk'
+```
+
+And then execute:
+
+```ruby
+    $ bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+    $ gem install paynow_sdk
+```
+
+```ruby
+paynow = Paynow.new(
+	'INTEGRATION_ID',
+	'INTEGRATION_KEY',
+	'http://returnurl.com',
+	'http://resulturl.com'
+	)
+
+payment = paynow.create_payment('Order Number', 'test@example.com')
+
+payment.add('Payment for stuff', 99.99)
+
+response = paynow.send(payment)
+
+
+if response.success
+ # The link to redirect the user to paynow to make the payment
+    link = response.redirect_url
+
+    poll_url = response.poll_url
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gitnyasha/paynow-ruby-sdk.

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "paynow_sdk"
+
+# 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/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/vendor/bundle/ruby/2.7.0/gems/paynow_sdk-1.0.9/lib/paynow_sdk.rb

@@ -0,0 +1,433 @@
+require "paynow_sdk/version"
+require "cgi"
+require "digest"
+require "uri"
+require "net/http"
+
+#throws error when hash from Paynow does not match locally generated hash
+module PaynowStatus
+  def self.paid
+    status_paid = check_transaction_status(poll_url)
+    status_paid["status"] == "Paid"
+  end
+
+  def self.check_transaction_status(poll_url)
+    url = URI(poll_url)
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Post.new(url)
+    request["content-type"] = "application/x-www-form-urlencoded"
+
+    response = http.request(request)
+    response.read_body
+
+    response_object = URI.decode_www_form(response.read_body).to_h
+  end
+end
+
+class HashMismatchException < Exception
+  def initialize(message)
+    super(message)
+  end
+end
+
+#Returns the status of the payment
+
+class StatusResponse
+  @@status = ""
+  @@amount = 0.0
+  @@reference = ""
+  @@paynow_reference = ""
+  @@hash = ""
+
+  def status_update(data)
+    return "Not implemented"
+  end
+
+  def initialize(data, update)
+    if update
+      status_update(data)
+    else
+      if data.include?("status")
+        @status = data["status"]
+      end
+      if data.include?("amount")
+        @amount = data["amount"]
+      end
+      if data.include?("reference")
+        @reference = data["reference"]
+      end
+      if data.include?("paynowreference")
+        @paynow_reference = data["paynowreference"]
+      end
+      if data.include?("hash")
+        @hash = data["hash"]
+      end
+    end
+  end
+
+  def self.status; @@status; end
+  def self.status=(val); @@status = val; end
+
+  def status; @status = @@status if @status.nil?; @status; end
+  def status=(val); @status = val; end
+
+  def self.amount; @@amount; end
+  def self.amount=(val); @@amount = val; end
+
+  def amount; @amount = @@amount if @amount.nil?; @amount; end
+  def amount=(val); @amount = val; end
+
+  def self.reference; @@reference; end
+  def self.reference=(val); @@reference = val; end
+
+  def reference; @reference = @@reference if @reference.nil?; @reference; end
+  def reference=(val); @reference = val; end
+
+  def self.paynow_reference; @@paynow_reference; end
+  def self.paynow_reference=(val); @@paynow_reference = val; end
+
+  def paynow_reference; @paynow_reference = @@paynow_reference if @paynow_reference.nil?; @paynow_reference; end
+  def paynow_reference=(val); @paynow_reference = val; end
+
+  def self.hash; @@hash; end
+  def self.hash=(val); @@hash = val; end
+
+  def hash; @hash = @@hash if @hash.nil?; @hash; end
+  def hash=(val); @hash = val; end
+end
+
+class InitResponse
+  @@success = true
+  @@instructions = ""
+  @@has_redirect = true
+  @@hash = ""
+  @@redirect_url = ""
+  @@error = ""
+  @@poll_url = ""
+
+  def initialize(data)
+    @status = data["status"]
+    @success = data["status"].downcase != "error"
+    @has_redirect = data.include?("browserurl")
+    @hash = data.include?("hash")
+    if @success
+      @poll_url = data["pollurl"]
+    end
+    if !@success
+      @error = data["error"]
+    end
+    if @has_redirect
+      @redirect_url = data["browserurl"]
+    end
+    if data.include?("instructions")
+      @instruction = data["instructions"]
+    end
+  end
+
+  def self.success; @@success; end
+  def self.success=(val); @@success = val; end
+
+  def success; @success = @@success if @success.nil?; @success; end
+  def success=(val); @success = val; end
+
+  def self.instructions; @@instructions; end
+  def self.instructions=(val); @@instructions = val; end
+
+  def instructions; @instructions = @@instructions if @instructions.nil?; @instructions; end
+  def instructions=(val); @instructions = val; end
+
+  def self.has_redirect; @@has_redirect; end
+  def self.has_redirect=(val); @@has_redirect = val; end
+
+  def has_redirect; @has_redirect = @@has_redirect if @has_redirect.nil?; @has_redirect; end
+  def has_redirect=(val); @has_redirect = val; end
+
+  def self.hash; @@hash; end
+  def self.hash=(val); @@hash = val; end
+
+  def hash; @hash = @@hash if @hash.nil?; @hash; end
+  def hash=(val); @hash = val; end
+
+  def self.redirect_url; @@redirect_url; end
+  def self.redirect_url=(val); @@redirect_url = val; end
+
+  def redirect_url; @redirect_url = @@redirect_url if @redirect_url.nil?; @redirect_url; end
+  def redirect_url=(val); @redirect_url = val; end
+
+  def self.error; @@error; end
+  def self.error=(val); @@error = val; end
+
+  def error; @error = @@error if @error.nil?; @error; end
+  def error=(val); @error = val; end
+
+  def self.poll_url; @@poll_url; end
+  def self.poll_url=(val); @@poll_url = val; end
+
+  def poll_url; @poll_url = @@poll_url if @poll_url.nil?; @poll_url; end
+  def poll_url=(val); @poll_url = val; end
+end
+
+class Payment
+  @@reference = ""
+  @@items = []
+  @@auth_email = ""
+
+  def initialize(reference, auth_email)
+    @reference = reference
+    @auth_email = auth_email
+  end
+
+  def add(title, amount)
+    @items = []
+    @items.push([title, amount])
+    self
+  end
+
+  def total
+    total = 0
+    for item in @items
+      total += item[1]
+    end
+    total.round(2)
+  end
+
+  def info
+    out = ""
+    for item in @items
+      out += item[0]
+    end
+    out
+  end
+
+  def self.reference; @@reference; end
+  def self.reference=(val); @@reference = val; end
+
+  def reference; @reference = @@reference if @reference.nil?; @reference; end
+  def reference=(val); @reference = val; end
+
+  def self.items; @@items; end
+  def self.items=(val); @@items = val; end
+
+  def items; @items = @@items if @items.nil?; @items; end
+  def items=(val); @items = val; end
+
+  def self.auth_email; @@auth_email; end
+  def self.auth_email=(val); @@auth_email = val; end
+
+  def auth_email; @auth_email = @@auth_email if @auth_email.nil?; @auth_email; end
+  def auth_email=(val); @auth_email = val; end
+end
+
+class Paynow
+  def initialize(integration_id, integration_key, return_url, result_url)
+    @integration_id = integration_id
+    @integration_key = integration_key
+    @return_url = return_url
+    @result_url = result_url
+  end
+
+  def set_result_url(url)
+    @result_url = url
+  end
+
+  def set_return_url(url)
+    @return_url = url
+  end
+
+  def create_payment(reference, auth_email)
+    Payment.new(reference, auth_email)
+  end
+
+  def send(payment)
+    init(payment)
+  end
+
+  def send_mobile(payment, phone, method)
+    init_mobile(payment, phone, method)
+  end
+
+  def process_status_update(data)
+    StatusResponse.new(data, true)
+  end
+
+  def init(payment)
+    if payment.total <= 0
+      raise TypeError, "Transaction total cannot be less than 1"
+    end
+
+    data = build(payment)
+
+    url = URI("https://www.paynow.co.zw/interface/initiatetransaction/")
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Post.new(url)
+    request["content-type"] = "application/x-www-form-urlencoded"
+    request.body = data
+
+    response = http.request(request)
+    response.read_body
+
+    response_object = rebuild_response(response.read_body)
+
+    if response_object["status"].to_s.downcase == "error"
+      InitResponse.new(response_object)
+    end
+    if !verify_hash(response_object)
+      raise HashMismatchException, "Hashes do not match"
+    end
+    InitResponse.new(response_object)
+  end
+
+  def init_mobile(payment, phone, method)
+    if payment.total <= 0
+      raise TypeError, "Transaction total cannot be less than 1"
+    end
+    if !payment.auth_email || payment.auth_email.size <= 0
+      raise TypeError, "Auth email is required for mobile transactions. You can pass the auth email as the second parameter in the create_payment method call"
+    end
+
+    data = build_mobile(payment, phone, method)
+
+    url = URI("https://www.paynow.co.zw/interface/remotetransaction")
+
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+    request = Net::HTTP::Post.new(url)
+    request["content-type"] = "application/x-www-form-urlencoded"
+    request.body = data
+
+    response = http.request(request)
+    response.read_body
+
+    response_object = rebuild_response(response.read_body)
+
+    if response_object["status"].to_s.downcase == "error"
+      InitResponse.new(response_object)
+    end
+    if !verify_hash(response_object)
+      raise HashMismatchException, "Hashes do not match"
+    end
+    InitResponse.new(response_object)
+  end
+
+  #web payments
+
+  def build(payment)
+    body = {
+      "id": @integration_id,
+      "reference": payment.reference,
+      "amount": payment.total,
+      "additionalinfo": payment.info,
+      "returnurl": @return_url,
+      "resulturl": @result_url,
+      "authemail": payment.auth_email,
+      "status": "Payment for goods",
+    }
+
+    joined = body.values.join
+    add_key = joined += @integration_key
+    body["hash"] = createdhash(add_key)
+    body = URI.encode_www_form(body)
+    body
+  end
+
+  #mobile payments
+
+  def build_mobile(payment, phone, method)
+    body = {
+      "resulturl": @result_url,
+      "returnurl": @return_url,
+      "reference": payment.reference,
+      "amount": payment.total,
+      "id": @integration_id,
+      "additionalinfo": payment.info,
+      "authemail": payment.auth_email,
+      "phone": phone,
+      "method": method,
+      "status": "Message",
+    }
+
+    joined = body.values.join
+    add_key = joined += @integration_key
+    body["hash"] = createdhash(add_key)
+    body = URI.encode_www_form(body)
+    body
+  end
+
+  def createdhash(out)
+    Digest::SHA2.new(512).hexdigest(out).upcase
+  end
+
+  #verify the hash send to paynow is equal to the hash from paynow
+  def verify_hash(response)
+    if !response.include?("hash")
+      raise TypeError, "Response from Paynow does not contain a hash"
+    end
+    old_hash = response["hash"]
+    new_hash = verify(response)
+    old_hash == new_hash
+  end
+
+  def verify(item)
+    out = ""
+    for key, value in item
+      if key.to_s == "hash"
+        next
+      end
+      out += value.to_s
+    end
+    out += @integration_key.downcase
+    Digest::SHA2.new(512).hexdigest(out).upcase
+  end
+
+  #  rebuild a response from paynow into hash like the we send
+
+  def rebuild_response(response)
+    URI.decode_www_form(response).to_h
+  end
+
+  def self.url_initiate_transaction; @@url_initiate_transaction; end
+  def self.url_initiate_transaction=(val); @@url_initiate_transaction = val; end
+
+  def url_initiate_transaction; @url_initiate_transaction = @@url_initiate_transaction if @url_initiate_transaction.nil?; @url_initiate_transaction; end
+  def url_initiate_transaction=(val); @url_initiate_transaction = val; end
+
+  def self.url_initiate_mobile_transaction; @@url_initiate_mobile_transaction; end
+  def self.url_initiate_mobile_transaction=(val); @@url_initiate_mobile_transaction = val; end
+
+  def url_initiate_mobile_transaction; @url_initiate_mobile_transaction = @@url_initiate_mobile_transaction if @url_initiate_mobile_transaction.nil?; @url_initiate_mobile_transaction; end
+  def url_initiate_mobile_transaction=(val); @url_initiate_mobile_transaction = val; end
+
+  def self.integration_id; @@integration_id; end
+  def self.integration_id=(val); @@integration_id = val; end
+
+  def integration_id; @integration_id = @@integration_id if @integration_id.nil?; @integration_id; end
+  def integration_id=(val); @integration_id = val; end
+
+  def self.integration_key; @@integration_key; end
+  def self.integration_key=(val); @@integration_key = val; end
+
+  def integration_key; @integration_key = @@integration_key if @integration_key.nil?; @integration_key; end
+  def integration_key=(val); @integration_key = val; end
+
+  def self.return_url; @@return_url; end
+  def self.return_url=(val); @@return_url = val; end
+
+  def return_url; @return_url = @@return_url if @return_url.nil?; @return_url; end
+  def return_url=(val); @return_url = val; end
+
+  def self.result_url; @@result_url; end
+  def self.result_url=(val); @@result_url = val; end
+
+  def result_url; @result_url = @@result_url if @result_url.nil?; @result_url; end
+  def result_url=(val); @result_url = val; end
+end