paynow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c72ebbaf1cb6a4415c9f3341bdfe0212d30a72e1ae8583437dc9c77fc038639
+  data.tar.gz: 04d35972c4aa846a8859ec60f177167a6593a70874dced3a0165fd8fef6483e9
+SHA512:
+  metadata.gz: bbbd3ad28e9c700b71efc716360c204ac9a63f2cbba55615ef0d660f8dc3a0b823b69f58d0d883bc962f84a2889a8aee69afe949bedf069854bbebcbd1b6e910
+  data.tar.gz: 4be4ec1a05f13b4276f1c524370b28ee5e4943ff1f4e3c86a9c6f3f81faf32e81a74a8594df793f17d9ed621f7ba390262b13de2c8ebc3a0a499394c4d7bad39

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Blessing Muchaya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Paynow ZW
+Paynow ZW is a simple and slightly opinionated Ruby abstraction of the Paynow API
+
+The aim of this library is to provide a clean interface when interacting with the PAYNOW API. Wrappers in other languages offer a similar interface to create payments but Paynow ZW is simpler, it unifies creating regular and express payments.
+
+## Installation ##
+
+Installation from rubygems:
+
+```bash
+gem install paynow-zw
+```
+
+Or, if you're using bundler, add the following line to your Gemfile:
+
+```bash
+gem 'paynow-zw'
+```
+
+And then run:
+
+```bash
+bundle install
+```
+
+Run the following generator:
+
+```bash
+rails g paynow:install
+```
+
+Finally, head over to config/initializers/paynow.rb. Uncomment the configs and alter them with values applicable to your application.
+
+## Usage ##
+
+The following example demonstrates how to do a payment using Paynow ZW 
+
+```ruby
+result = Paynow::Payment.create(
+  amount: 20.21,
+  reference: 1984,
+  method: "pay_with_paynow",
+  additional_info: "Dance to the end of love weekend pass"
+)
+
+if result.success?
+  #some so order stuff
+  redirect_to paynow_redirect_url
+else
+  puts result.status
+end
+```
+
+The next example demonstrates how to do an express payment using Paynow ZW
+
+```ruby
+result = Paynow::Payment.create(
+  amount: 19.98,
+  reference: 405,
+  method: "ecocash",
+  phone: "0771111111",
+  authemail: "bles@heyheyhey.com",
+  additional_info: "The Hanging Gardens of Beatenberg"
+)
+                    
+if result.success?
+ #do some order stuff
+ #poll the status of the payment using the poll_url method ie. result.poll_url
+end
+```
+You can use **pay_with_paynow** to redirect to Paynow as shown in the first example. You can also use **poll_url** to check for the status of both express and basic payments.
+
+
+You can only specify four payment methods. The 'pay_with_paynow' option redirects to paynow. 
+
+Method        | Value  
+----------------- | -----------------
+Ecocash | ecocash
+OneMoney | onemoney
+Paynow | pay_with_paynow
+Visa or Mastercard | vmc
+
+
+
+## List of mandatory and optional fields when setting up your payments ##
+
+#### Basic payments that redirect to Paynow ####
+Mandatory         | Optional  
+----------------- | -----------------
+amount | additionalinfo
+method | authemail
+reference | tokenize
+
+
+#### Ecocash and OneMoney #### 
+Mandatory         |
+----------------- | 
+authemail |
+amount | 
+method |
+phone |
+reference | 
+
+#### Visa and Mastercard #### 
+Mandatory         | Optional  
+----------------- | -----------------
+authemail | billingline2
+amount | billingprovince
+billingcity | tokenize
+billingcountry | 
+billingline1 |
+cardnumber | 
+cardname | 
+cardcvv | 
+cardexpiry |
+method |
+reference |
+token |
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+task default: :test

data/lib/generators/paynow/install_generator.rb

@@ -0,0 +1,13 @@
+module Paynow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Create Paynow configuration file"
+
+      def copy_config
+        template 'config/initializers/paynow.rb'
+      end
+    end
+  end
+end

data/lib/generators/paynow/templates/config/initializers/paynow.rb

@@ -0,0 +1,15 @@
+#Use this hook to configure the parameters necessary for your payments to work
+#Uncomment all the commented configs and use values applicable to your own application
+#Paynow credentials can be obtained from the Paynow website 
+#Consider using rails credentials for sensitive secrets 
+Paynow.setup do |config|
+
+  # ==> Configure Paynow Secrets
+  #config.integration_id = Rails.application.credentials.paynow[:integration_id]
+  #config.integration_key = Rails.application.credentials.paynow[:integration_key]
+
+  # ==> Configure Paynow Urls
+  #config.resulturl = "http://www.worldieweirdos.com/search?q=resulturl"
+  #config.returnurl = "http://www.worldieweirdos.com/search?q=returnurl"
+
+end

data/lib/paynow.rb

@@ -0,0 +1,12 @@
+require 'paynow/client'
+require 'paynow/configuration'
+require 'paynow/config_dev'
+require 'paynow/errors'
+require 'paynow/hash_generator'
+require 'paynow/payment'
+require 'paynow/payment_attributes'
+require 'paynow/payment_builder'
+
+
+
+

data/lib/paynow/client.rb

@@ -0,0 +1,79 @@
+require 'net/http'
+
+module Paynow
+  class Client
+    attr_reader :body
+
+    def self.create_payment(body)
+      new(body).create_payment
+    end
+
+    def initialize(body)
+      @body = body
+    end
+
+    def create_payment
+      puts(raw_payment)
+      logger.info("[PAYNOW] STARTED POST #{uri}")
+
+      response = Net::HTTP.post(uri, payment_data,headers)
+
+      decoded_response = URI.decode_www_form(response.read_body).to_h.transform_keys(&:to_sym)
+
+      if response.code =~ /^[4-5]/
+        logger.error("[PAYNOW] ERROR GET #{uri} status=#{response.code} message=#{decoded_response.error}")
+      else
+        logger.info("[PAYNOW] COMPLETED  GET #{uri} status=#{response.code} response=#{decoded_response}")
+      end
+
+      payment.new(
+        raw_payment.merge(
+          poll_url: decoded_response[:pollurl],
+          paynow_redirect_url: decoded_response[:browserurl],
+          status: decoded_response[:status]
+          )
+        )
+    end
+
+    private
+
+    def uri
+      if raw_payment.has_key?(:method)
+        URI(Paynow::Config.initiate_express_transaction_url)
+      else
+        URI(Paynow::Config.initiate_transaction_url)
+      end
+    end
+
+    def payment_data
+      URI.encode_www_form(raw_payment.merge({hash: _hash}))
+    end
+
+    def raw_payment
+      payment_builder.build(body)
+    end
+
+    def _hash
+      Paynow::HashGenerator._hmac(raw_payment)
+    end 
+
+    def headers
+      {'content-type': 'application/x-www-form-urlencoded'}
+    end
+
+    def payment
+      Paynow::Config.payment
+    end
+
+    def payment_builder
+      Paynow::Config.payment_builder
+    end
+
+    def logger
+      Paynow::Config.logger
+    end
+  end
+end
+
+ 
+

data/lib/paynow/config_dev.rb

@@ -0,0 +1,6 @@
+Paynow.setup do |config|
+  config.integration_id = "11493"
+  config.integration_key = "b02e5e6e-7cf4-4c5e-b11c-f3c9090b345b"
+  config.resulturl = "http://www.google.com/search?q=resulturl"
+  config.returnurl = "http://www.google.com/search?q=returnurl"
+end

data/lib/paynow/configuration.rb

@@ -0,0 +1,45 @@
+require "logger"
+
+module Paynow
+  class << self
+    attr_accessor :integration_id,
+                  :integration_key,
+                  :resulturl,
+                  :returnurl
+
+    def setup(&block)
+      instance_eval(&block)
+    end
+  end
+
+  class Config
+    attr_writer :logger
+
+    class << self
+      def client
+        Paynow::Client
+      end
+
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+
+      def payment
+        Paynow::Payment
+      end
+
+      def payment_builder
+        Paynow::PaymentBuilder
+      end
+
+      def initiate_transaction_url
+        "https://www.paynow.co.zw/interface/initiatetransaction/"
+      end
+      
+      def initiate_express_transaction_url
+        "https://www.paynow.co.zw/interface/remotetransaction/"
+      end
+    end
+  end
+end
+

data/lib/paynow/errors.rb

@@ -0,0 +1,13 @@
+module Paynow
+  class UnknownAttributeError < StandardError
+    def initialize(msg="No such attribute. Refer to docs for an applicable attribute")
+      super
+    end
+  end
+
+  class MissingAttributeError < StandardError
+    def initialize(msg="Attribute is missing")
+      super
+    end
+  end  
+end

data/lib/paynow/hash_generator.rb

@@ -0,0 +1,38 @@
+require 'digest'
+
+module Paynow
+  class HashGenerator
+    attr_reader :data
+
+    class << self
+      def _hmac(data)
+        new(data)._hmac
+      end
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    def _hmac
+      return unless data
+
+      hash_data = concatenate_hash_values_and_append_key(data)
+      puts(hash_data)
+      
+      _hash = Digest::SHA512.hexdigest(hash_data).upcase 
+    end
+
+    private
+
+    def concatenate_hash_values_and_append_key(h)
+      str = ""
+      h.each { |k,v| str += v.to_s }
+      str += key
+    end    
+
+    def key
+      Paynow.integration_key
+    end
+  end
+end

data/lib/paynow/payment.rb

@@ -0,0 +1,49 @@
+module Paynow
+  class Payment
+    attr_reader :amount,
+                :additionalinfo,
+                :authemail, 
+                :billingline1, 
+                :billingline2, 
+                :billingcity,
+                :billingprovince, 
+                :billingcountry,
+                :cardnumber, 
+                :cardname, 
+                :cardcvv, 
+                :cardexpiry,   
+                :id,
+                :merchanttrace,
+                :method, 
+                :phone,
+                :poll_url,               
+                :reference,
+                :returnurl,
+                :resulturl,
+                :status,                
+                :token,
+                :tokenize,
+                
+    def self.create(*args)
+      Paynow::Config.client.create_payment(*args)
+    end
+
+    def initialize(attrs)
+      attrs.each do |k,v|
+        variable_name = "@#{k}"
+        instance_variable_set(variable_name,v) unless v.nil?
+      end
+    end
+
+    def success?
+      status == 'Ok'
+    end
+
+    def failed?
+      !success?
+    end
+
+  end
+end
+
+

data/lib/paynow/payment_attributes.rb

@@ -0,0 +1,37 @@
+module Paynow
+  class PaymentAttributes
+    REQUISITE = [
+      :amount,
+      :reference,
+      :method
+    ]
+
+    OPTIONAL = [
+      :additionalinfo,
+      :authemail,
+      :tokenize
+    ]
+
+    CARD = [
+      :cardnumber,
+      :cardname,
+      :cardcvv,
+      :cardexpiry,
+      :billingline1,
+      :billingcity,
+      :billingcountry,
+      :token,
+      :authemail
+    ]
+
+    OPTIONAL_CARD = [
+      :billingline2,
+      :billingprovince
+    ]
+
+    MOBILE = [
+      :phone,
+      :authemail
+    ]
+  end
+end

data/lib/paynow/payment_builder.rb

@@ -0,0 +1,116 @@
+require 'securerandom'
+
+module Paynow
+  class PaymentBuilder
+    def self.build(params)
+      new.build(params)
+    end
+
+    def build(attrs)
+      payment = { id: id, returnurl: returnurl, resulturl: resulturl, status: "Message"}
+
+      payment.merge!(
+        required_info(attrs),
+        optional_info(attrs)
+      )
+
+      payment.tap do |p|
+        p.delete(:method) if p[:method] == pay_with_paynow
+        p.merge!(card_info(attrs), optional_card_info(attrs)) if p[:method] == visa_or_mastercard
+        p.merge!(mobile_info(attrs)) if p[:method] == mobile_money
+      end
+    end
+
+    private
+
+    PAYMENT_METHOD_TYPES = %w[ecocash onemoney vmc pay_with_paynow]
+
+    def id
+      Paynow.integration_id
+    end
+
+    def merchanttrace
+      SecureRandom.alphanumeric(32)
+    end
+
+    def resulturl
+      Paynow.resulturl
+    end
+
+    def returnurl
+      Paynow.returnurl
+    end
+
+    def required_info(attrs)
+      data = {}
+
+      Paynow::PaymentAttributes::REQUISITE.each do |attr|
+        data.merge!({attr => attrs.fetch(attr)})
+      end
+      
+      data.update(amount: sprintf('%.2f',attrs[:amount]),method: payment_method(attrs))
+    end
+
+    def optional_info(attrs)
+      data = {}
+
+      Paynow::PaymentAttributes::OPTIONAL.each do |attr|
+        data.merge!({attr => attrs.fetch(attr)}) if attrs.has_key?(attr)
+      end
+
+      data
+    end
+
+    def card_info(attrs)
+      data = {}
+
+      Paynow::PaymentAttributes::CARD.each do |attr|
+        data.merge!({attr => attrs.fetch(attr)})
+      end
+
+      data
+    end
+
+    def optional_card_info(attrs)
+      data = {}
+
+      Paynow::PaymentAttributes::OPTIONAL_CARD.each do |attr|
+        data.merge!({attr => attrs.fetch(attr)}) if attrs.has_key?(attr)
+      end
+
+      data
+    end
+
+    def mobile_info(attrs)
+      data = {}
+
+      Paynow::PaymentAttributes::MOBILE.each do |attr|
+        data.merge!({attr => attrs.fetch(attr)})
+      end
+
+      data
+    end
+
+    def payment_method(attrs)
+      if attrs.has_key?(:method) && !PAYMENT_METHOD_TYPES.include?(attrs[:method])
+        raise Paynow::UnknownAttributeError, "Payment method should either be ecocash, onemoney, vmc or other"
+      elsif !attrs.has_key?(:method)
+        raise Paynow::MissingAttributeError, "Payment method is missing"
+      else
+        attrs.fetch(:method)
+      end
+    end
+
+    def mobile_money
+      "ecocash" || "onemoney"
+    end
+
+    def visa_or_mastercard
+      "vmc"
+    end
+
+    def pay_with_paynow
+      "pay_with_paynow"
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: paynow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bles Muchaya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-10 00:00:00.000000000 Z
+dependencies: []
+description: A simple and slightly opinionated Ruby abstraction for the Paynow API
+  in Zimbabwe
+email:
+- btmuchaya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/paynow/install_generator.rb
+- lib/generators/paynow/templates/config/initializers/paynow.rb
+- lib/paynow.rb
+- lib/paynow/client.rb
+- lib/paynow/config_dev.rb
+- lib/paynow/configuration.rb
+- lib/paynow/errors.rb
+- lib/paynow/hash_generator.rb
+- lib/paynow/payment.rb
+- lib/paynow/payment_attributes.rb
+- lib/paynow/payment_builder.rb
+- lib/paynow/three_d_secure.rb
+homepage: https://github.com/muchaya/paynow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Paynow API wrapper for Ruby on Rails
+test_files: []