paynow_sdk 0.1.8 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 225ccefb9727d2d3ed6ce68879c3f7f67c365986719e49e5bb830ead2eca239d
-  data.tar.gz: ca64fefbaeb0880cbcdc368e3ca12de5461da738a5a08e7d3ebadfaaca7a1ce3
+  metadata.gz: 10c20a3ef61786a5c7be8ae9df0f066b990e707eecb9f2fb353f7f2b53f85732
+  data.tar.gz: d97738672c1d5689b766e5a4d2e47a160a48146c38861e5bfb74e0b4e75df6ff
 SHA512:
-  metadata.gz: a3e9438fb4d06e8ff02b4e64a8c1c61cd11e8b655beb8c3cc1e2ffac002a440ce4701c5d09c5919347307647bb3f52f252b6bb7a54e9be2c42490f2c4ab15ed8
-  data.tar.gz: 6737ae30441c2e3dcf5f03374f984e83a9d3ce63a7f95667a2d1c2a1511adc88db66a92ec3eb5f445369ddb709db69978535d794c9d0fd8d5f6c30aa48414194
+  metadata.gz: d02300e6ce43602719e110d52e05d42a7615307dcea347ea43e20bc6941b55c4df4cb7801f6a3dee3e991a87388d8f12b80fd9f7b0d138301b30cf326e62657e
+  data.tar.gz: d1457dff979df53376550979a6d5da6f41eafaf1989e97293a8e25564b682003f191eedf78e9f6cb307fe5464e4780c67223ccfff69c1a9a5a258dc2f23470b6

data/.gitignore

@@ -3,6 +3,8 @@
 /_yardoc/
 /coverage/
 /doc/
+/.vscode/
 /pkg/
 /spec/reports/
 /tmp/
+test.rb

data/Gemfile

@@ -7,3 +7,4 @@ gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "minitest-reporters", "~> 1.4", ">= 1.4.2"
 gem "httparty"
+gem "rest-client", "~> 2.1"

data/Gemfile.lock

@@ -1,13 +1,18 @@
 PATH
   remote: .
   specs:
-    paynow_sdk (0.1.8)
+    paynow_sdk (1.0.2)
 
 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)
@@ -21,8 +26,17 @@ GEM
       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
@@ -33,6 +47,7 @@ DEPENDENCIES
   minitest-reporters (~> 1.4, >= 1.4.2)
   paynow_sdk!
   rake (~> 12.0)
+  rest-client (~> 2.1)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,8 +1,4 @@
-# PaynowSdk
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paynow_sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+# PaynowSdk Ruby gem
 
 ## Installation
 
@@ -22,15 +18,139 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create an instance of the Paynow class optionally setting the result and return url(s)
 
-## Development
+```ruby
+paynow = Paynow.new(
+	'INTEGRATION_ID',
+	'INTEGRATION_KEY',
+	'http://returnurl.com',
+	'http://resulturl.com'
+	)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+payment = paynow.create_payment('Order #100', 'test@example.com')
+```
 
-## Contributing
+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. Once you have instantiated the Paynow class.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paynow_sdk.
+```ruby
+# Check the status of the transaction with the specified poll url
+# Now you see why you need to save that url ;-)
+status = paynow.check_transaction_status(poll_url)
+
+if status.paid
+	# Yay! Transaction was paid for. Update transaction?
+else
+    # Handle that
+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', 'test@example.com')
+
+payment.add('Payment for stuff', 1)
+
+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
+
+    print "Poll Url: " + poll_url
+
+    status = paynow.check_transaction_status(poll_url)
+
+    print "Payment Status: " + status.status
+end
+```
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/gitnyasha/paynow-ruby-sdk.

data/lib/paynow_sdk.rb

@@ -1,7 +1,8 @@
 require "paynow_sdk/version"
-require "httparty"
 require "cgi"
 require "digest"
+require "uri"
+require "net/http"
 
 #throws error when hash from Paynow does not match locally generated hash
 
@@ -11,26 +12,28 @@ class HashMismatchException < Exception
   end
 end
 
+#Returns the status of the payment
+
 class StatusResponse
   @@paid = true
-  @@status = String
-  @@amount = Float
-  @@reference = String
-  @@paynow_reference = String
-  @@hash = String
+  @@status = ""
+  @@amount = 0.0
+  @@reference = ""
+  @@paynow_reference = ""
+  @@hash = ""
 
-  def __status_update(data)
+  def status_update(data)
     return "Not implemented"
   end
 
   def initialize(data, update)
-    if is_bool(update)
-      __status_update(data)
+    if update
+      status_update(data)
     else
       @status = data["status"].downcase
       @paid = @status == "paid"
       if data.include?("amount")
-        @amount = data["amount"].to_f
+        @amount = data["amount"].round(2)
       end
       if data.include?("reference")
         @reference = data["reference"]
@@ -83,26 +86,25 @@ end
 
 class InitResponse
   @@success = true
-  @@instructions = String
+  @@instructions = ""
   @@has_redirect = true
-  @@hash = String
-  @@redirect_url = String
-  @@error = String
-  @@poll_url = String
+  @@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 is_bool(!@success)
-      return
+    if @success
+      @poll_url = data["pollurl"]
     end
-    @poll_url = data["pollurl"]
-    if is_bool(!@success)
+    if !@success
       @error = data["error"]
     end
-    if is_bool(@has_redirect)
+    if @has_redirect
       @redirect_url = data["browserurl"]
     end
     if data.include?("instructions")
@@ -154,9 +156,9 @@ class InitResponse
 end
 
 class Payment
-  @@reference = String
+  @@reference = ""
   @@items = []
-  @@auth_email = String
+  @@auth_email = ""
 
   def initialize(reference, auth_email)
     @reference = reference
@@ -166,23 +168,23 @@ class Payment
   def add(title, amount)
     @items = []
     @items.push([title, amount])
-    return self
+    self
   end
 
-  def total()
-    total = 0.0
+  def total
+    total = 0
     for item in @items
-      total += item[1].to_f
+      total += item[1]
     end
-    return total
+    total.round(2)
   end
 
-  def info()
+  def info
     out = ""
     for item in @items
-      out += item[0] + ", "
+      out += item[0]
     end
-    return out
+    out
   end
 
   def self.reference; @@reference; end
@@ -205,13 +207,6 @@ class Payment
 end
 
 class Paynow
-  @@url_initiate_transaction = URI("https://www.paynow.co.zw/interface/initiatetransaction")
-  @@url_initiate_mobile_transaction = "https://www.paynow.co.zw/interface/remotetransaction"
-  @@integration_id = String
-  @@integration_key = String
-  @@return_url = ""
-  @@result_url = ""
-
   def initialize(integration_id, integration_key, return_url, result_url)
     @integration_id = integration_id
     @integration_key = integration_key
@@ -228,124 +223,177 @@ class Paynow
   end
 
   def create_payment(reference, auth_email)
-    return Payment.new(reference, auth_email)
+    Payment.new(reference, auth_email)
   end
 
   def send(payment)
-    return __init(payment)
+    init(payment)
   end
 
   def send_mobile(payment, phone, method)
-    return __init_mobile(payment, phone, method)
+    init_mobile(payment, phone, method)
   end
 
   def process_status_update(data)
-    return StatusResponse.new(data, true)
-  end
-
-  def qs_to_hash(querystring)
-    keyvals = querystring.split("&").inject({}) do |result, q|
-      k, v = q.split("=")
-      if !v.nil?
-        result.merge({ k => v })
-      elsif !result.key?(k)
-        result.merge({ k => true })
-      else
-        result
-      end
-    end
-    keyvals
+    StatusResponse.new(data, true)
   end
 
-  def __init(payment)
-    if payment.total() <= 0
+  def init(payment)
+    if payment.total <= 0
       raise TypeError, "Transaction total cannot be less than 1"
     end
-    data = __build(payment)
-    response = HTTParty.post(@url_initiate_transaction, data)
-    response_object = __rebuild_response(CGI.parse(response))
+
+    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"
-      return InitResponse.new(response_object)
+      InitResponse.new(response_object)
     end
-    if is_bool(!__verify_hash(response_object, @integration_key))
+    if !verify_hash(response_object)
       raise HashMismatchException, "Hashes do not match"
     end
-    return InitResponse.new(response_object)
+    InitResponse.new(response_object)
   end
 
-  def __init_mobile(payment, phone, method)
-    if payment.total() <= 0
+  def init_mobile(payment, phone, method)
+    if payment.total <= 0
       raise TypeError, "Transaction total cannot be less than 1"
     end
-    if is_bool(!payment.auth_email || payment.auth_email.size <= 0)
+    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)
-    response = HTTParty.post(@url_initiate_mobile_transaction, data)
-    response_object = __rebuild_response(CGI.parse(response))
+
+    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"
-      return InitResponse.new(response_object)
+      InitResponse.new(response_object)
     end
-    if is_bool(!__verify_hash(response_object, @integration_key))
+    if !verify_hash(response_object)
       raise HashMismatchException, "Hashes do not match"
     end
-    return InitResponse.new(response_object)
+    InitResponse.new(response_object)
   end
 
   def check_transaction_status(poll_url)
-    response = HTTParty.post(poll_url, data: {})
-    response_object = __rebuild_response(CGI.parse(response))
-    return StatusResponse.new(response_object, false)
+    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 = rebuild_response(response.read_body)
+    StatusResponse.new(response_object, false)
   end
 
-  def __build(payment)
-    body = { "resulturl" => @result_url, "returnurl" => @return_url, "reference" => payment.reference, "amount" => payment.total(), "id" => @integration_id, "additionalinfo" => payment.info(), "authemail" => payment.auth_email || "", "status" => "Message" }
-    for (key, value) in body
-      body[key] = CGI::escape(value.to_s)
-    end
-    body["hash"] = __hash(body, @integration_key)
+  #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
 
-  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" }
-    for (key, value) in body
-      if key == "authemail"
-        next
-      end
-      body[key] = CGI::escape(value.to_s)
-    end
-    body["hash"] = __hash(body, @integration_key)
+  #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 __hash(items, integration_key)
-    out = ""
-    for (key, value) in items
-      if key.to_s.downcase == "hash"
-        next
-      end
-      out += value.to_s
-    end
-    out += integration_key.downcase
+  def createdhash(out)
     Digest::SHA2.new(512).hexdigest(out).upcase
   end
 
-  def __verify_hash(response, integration_key)
+  #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 = __hash(response, integration_key)
-    return old_hash == new_hash
+    new_hash = verify(response)
+    old_hash == new_hash
   end
 
-  def __rebuild_response(response)
-    res = {}
-    for (key, value) in response.to_a
-      res[key] = value[0].to_s
+  def verify(item)
+    out = ""
+    for key, value in item
+      if key.to_s == "hash"
+        next
+      end
+      out += value.to_s
     end
-    return res
+    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