paynow_sdk 0.2.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a6b7dd3c5c39174dfe585ac3df8a036ad4d3c9aa39c247bf900a4c90672676
-  data.tar.gz: '0050613579b86b1c8038d5d4e9633cf39dfc3050aad5f830c6de4389bb14f27d'
+  metadata.gz: 591801937e8ddabde7485bf4d5a67753554dde0342036aa41c2b885d11036eed
+  data.tar.gz: 847fbb25d8b1581c8f4f6e66b495ec9f663601136e6078a7bebe4a028b8d73e8
 SHA512:
-  metadata.gz: 3271f4b73cfe1acae7085e18802a8521de3920f095fa289042f30f6701909de2195a7c46c47b221032980b0015d874e7a1467d7fb628109366931d3de48f7c73
-  data.tar.gz: 9b6ec46c407bd87d22ee884f4965861048ee1d5795c3bfcb9ef3687d783299b2a4f9ad5d26be8c10fcd26050b0d8ef3ec2338dc97c6da4e6801fb8886cd7958c
+  metadata.gz: ae5bcd5eef063aabc2dc3731c1b8894af6688fcb594a8419c21dc397e405debcc614accff67cf8a8e323990bc7cb350f0b65926101f36893d7ec3f21f104e1d2
+  data.tar.gz: bb421728fb3e0f74659bb6ab2f162063f8dabe63b573fedf4fe3982edc742e3ddc44ce3dd16e0c5c8a4f47a50447b235bc250930e2ce7110cd744c9bcf631795

data/.gitignore

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

data/Gemfile.lock

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

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,9 +1,7 @@
 require "paynow_sdk/version"
 require "cgi"
 require "digest"
-require "httparty"
 require "uri"
-require "rest-client"
 require "net/http"
 
 #throws error when hash from Paynow does not match locally generated hash
@@ -14,26 +12,28 @@ class HashMismatchException < Exception
   end
 end
 
+#Returns the status of the payment
+
 class StatusResponse
   @@paid = true
   @@status = ""
-  @@amount = Float
+  @@amount = 0.0
   @@reference = ""
   @@paynow_reference = ""
   @@hash = ""
 
-  def __status_update(data)
+  def status_update(data)
     return "Not implemented"
   end
 
   def initialize(data, update)
     if update
-      __status_update(data)
+      status_update(data)
     else
       @status = data["status"].downcase
       @paid = @status == "paid"
       if data.include?("amount")
-        @amount = data["amount"].to_f
+        @amount = data["amount"]
       end
       if data.include?("reference")
         @reference = data["reference"]
@@ -47,41 +47,41 @@ class StatusResponse
     end
   end
 
-  # def self.paid; @@paid; end
-  # def self.paid=(val); @@paid = val; end
+  def self.paid; @@paid; end
+  def self.paid=(val); @@paid = val; end
 
-  # def paid; @paid = @@paid if @paid.nil?; @paid; end
-  # def paid=(val); @paid = val; end
+  def paid; @paid = @@paid if @paid.nil?; @paid; end
+  def paid=(val); @paid = val; end
 
-  # def self.status; @@status; end
-  # def self.status=(val); @@status = val; 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 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 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 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 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 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 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 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 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 hash; @hash = @@hash if @hash.nil?; @hash; end
+  def hash=(val); @hash = val; end
 end
 
 class InitResponse
@@ -182,7 +182,7 @@ class Payment
   def info
     out = ""
     for item in @items
-      out += item[0] + ", "
+      out += item[0]
     end
     out
   end
@@ -207,13 +207,6 @@ class Payment
 end
 
 class Paynow
-  @@url_initiate_transaction = "https://www.paynow.co.zw/interface/initiatetransaction/"
-  @@url_initiate_mobile_transaction = "https://www.paynow.co.zw/interface/remotetransaction/"
-  @@integration_id = ""
-  @@integration_key = ""
-  @@return_url = ""
-  @@result_url = ""
-
   def initialize(integration_id, integration_key, return_url, result_url)
     @integration_id = integration_id
     @integration_key = integration_key
@@ -249,46 +242,86 @@ class Paynow
     if payment.total <= 0
       raise TypeError, "Transaction total cannot be less than 1"
     end
-    puts data = build(payment)
 
-    p response = HTTParty.post("https://www.paynow.co.zw/interface/initiatetransaction?#{data.slice(1, -1)}")
+    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_object = rebuild_response(response)
+    response = http.request(request)
+    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)
+    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 is_bool(!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(response)
-  #   if response_object["status"].to_s.downcase == "error"
-  #     InitResponse.new(response_object)
-  #   end
-  #   if is_bool(!verify_hash(response_object, @integration_key))
-  #     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
 
   def check_transaction_status(poll_url)
-    response = HTTParty.post(poll_url, data: {})
-    response_object = rebuild_response(response)
+    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
 
+  #web payments
+
   def build(payment)
     body = {
       "id": @integration_id,
@@ -298,22 +331,36 @@ class Paynow
       "returnurl": @return_url,
       "resulturl": @result_url,
       "authemail": payment.auth_email,
-      "status": "Message",
+      "status": "Payment for goods",
     }
 
-    joined = body.values.join.to_s
+    joined = body.values.join
     add_key = joined += @integration_key
-    body["hash"] = createdhash(joined)
+    body["hash"] = createdhash(add_key)
     body = URI.encode_www_form(body)
-    CGI.escape(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.to_s
+    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 = URI.encode_www_form(body)
     body
   end