paynow_sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4419acd2239e550cc8d40002597a688f835f912fb4fe216739a4ca338302cb0b
-  data.tar.gz: e450025e4642c4a5e3f6cceb17499eeb0f4fc9a1290d8f4e8d42dd89cff323b9
+  metadata.gz: 45d0090653691c2ec9f007f763b1d21bf13e5f52818420d2ade1c9ea4195d750
+  data.tar.gz: 55f27a4f21ffdba2ede5cba3519a0916aedd5627ed0aaec34f31f3caca4b5292
 SHA512:
-  metadata.gz: 07d38729dfc4dfe3a805f217ad1cd4afba264655a3618627548689983b71b6b9d9ad55758ae37fa5367c964884aacc96f99460ef4df081d381db6a198891fd21
-  data.tar.gz: 457c0ff50c48bab21a5bf51689c63949cf4b8f92764d353258aa0804447ab566e33c1aa48b30cbf2b2cc26f7f1f78e72c2527f2c2095883ef2f1a51a98a52765
+  metadata.gz: b1920b10a9af39aa0b43df4da7c6cd29c71c63866b3ee635958c0b02a9d263cc65124977a43ab1fb3e1037394b4f78ffa83c36d0508a5d160cfb8a8ddc601a28
+  data.tar.gz: b517952320e9503de2c34fa4c44ec609db427bba82b1a8c2b4ff9a43deb95dd42297b6eeb2dee0df18140c7239d83c87ac15effb101e278f9285ad5c8df42934

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 (1.0.0)
+    paynow_sdk (1.0.1)
 
 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

@@ -312,7 +312,7 @@ class Paynow
 
     request = Net::HTTP::Post.new(url)
     request["content-type"] = "application/x-www-form-urlencoded"
-    request.body = data
+    request.body = {}
 
     response = http.request(request)
     response.read_body

data/lib/paynow_sdk/version.rb

@@ -1,3 +1,3 @@
 module PaynowSdk
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paynow_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - marshall nyasha chikari
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies: []
 description: The gem includes modules and methods to make it easy for integrating
   paynow api to ruby apps.