payu-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1732d292b7b39f5caa2029546ff3a61ecb5fda4b031e4fa10889c8b6dca91d8
+  data.tar.gz: 3013a7bd787eaeab76408c23c8732a22b84750cb40bfff2849de505569ec03ae
+SHA512:
+  metadata.gz: 7f8dadf7909d6a59f189127fbafcb34befe5b6a5926f7fb27a818796030310d575db281450e482fc70d8dbf4c512c8f9b76f9f2b5660b78067c56153cc43072f
+  data.tar.gz: 6b4e6decc7e64d9e343d16e01bd0c4339c6b5c4219efce523d0ab3c46389a6e83e3047caed4c4035c8da8d24889740421da933c896f2e9a0e389d5417b2d8f4a

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'minitest

data/Rakefile

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

data/Readme.md

@@ -0,0 +1,39 @@
+# Payu ruby SDK
+
+## Installation
+
+Add this line to your app's Gemfile:
+
+```rb
+gem 'payu-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payu-sdk
+
+## Usage
+
+Remember to `require 'payu-sdk'` before anything else.
+
+Next, you need to bootstrap using key and salt by following:
+
+```rb
+PayU.init('<payu_key>', '<payu_salt>')
+```
+If you are using rails, the right place to do this might be config/initializers/payu.rb.
+
+### Hash API
+
+```rb
+hash_str = PayU::Hasher.generate_hash txn_id: "5512244", amount: "1000", product_info: 'mobile', first_name: 'Jacob', email: 'test@payu.in'
+
+# Validate reverse hash received from payu after checkout
+
+reverse_hash = '<payu_hash>' # hash received after payment from payu
+is_verified = PayU::Hasher.validate_hash reverse_hash, txn_id: "5512244", amount: "1000", product_info: 'mobile', first_name: 'Jacob', email: 'test@payu.in', status: 'success'
+```

data/lib/payu-sdk.rb

@@ -0,0 +1,17 @@
+require 'payu/constants'
+require 'payu/payu_error';
+require 'payu/validator'
+require 'payu/hasher'
+
+# Base module
+module PayU
+  class << self
+    attr_accessor :key, :salt
+  end
+
+  def self.init(key, salt)
+    self.key = key
+    self.salt = salt
+  end
+
+end

data/lib/payu/constants.rb

@@ -0,0 +1,5 @@
+module PayU
+  VERSION = '1.0.0'.freeze
+  EMAIL_REGEX = /^(?=.{6,254}$)[A-Za-z0-9_\-\.]{1,64}\@[A-Za-z0-9_\-\.]+\.[A-Za-z]{2,}$/.freeze
+  AMOUNT_REGEX = /^\d+(\.\d{1,2})?$/.freeze
+end

data/lib/payu/hasher.rb

@@ -0,0 +1,65 @@
+require 'digest'
+
+module PayU
+  class Hasher
+    class << self
+      def generate_hash(
+        txn_id:,
+        amount:,
+        product_info:,
+        first_name:,
+        email:,
+        udf1: '',
+        udf2: '',
+        udf3: '',
+        udf4: '',
+        udf5: '')
+        PayU::Validator.validate_hash_params({
+          txn_id: txn_id,
+          amount: amount,
+          product_info: product_info,
+          first_name: first_name,
+          email: email,
+          udf1: udf1,
+          udf2: udf2,
+          udf3: udf3,
+          udf4: udf4,
+          udf5: udf5
+        })
+        data = "#{PayU.key}|#{txn_id}|#{amount}|#{product_info}|#{first_name}|#{email}|#{udf1}|#{udf2}|#{udf3}|#{udf4}|#{udf5}||||||#{PayU.salt}"
+        Digest::SHA512.hexdigest data 
+      end
+
+      def validate_hash(hash_str,
+        txn_id:,
+        amount:,
+        product_info:,
+        first_name:,
+        email:,
+        udf1: '',
+        udf2: '',
+        udf3: '',
+        udf4: '',
+        udf5: '',
+        status:,
+        additional_charges: ''
+      )
+      PayU::Validator.validate_hash_params({
+        txn_id: txn_id,
+        amount: amount,
+        product_info: product_info,
+        first_name: first_name,
+        email: email,
+        udf1: udf1,
+        udf2: udf2,
+        udf3: udf3,
+        udf4: udf4,
+        udf5: udf5
+      })
+      data = "|||||#{udf5}|#{udf4}|#{udf3}|#{udf2}|#{udf1}|#{email}|#{first_name}|#{product_info}|#{amount}|#{txn_id}|#{PayU.key}"
+      data = additional_charges + data if additional_charges
+      hash_str == Digest::SHA512.hexdigest("#{PayU.salt}|#{status}|#{data}")
+      end
+    end
+  end
+end

data/lib/payu/payu_error.rb

@@ -0,0 +1,8 @@
+module PayU
+  class PayuError < StandardError
+    def initialize(msg="PayuError", exception_type="Standard")
+      @exception_type = exception_type
+      super(msg)
+    end
+  end
+end

data/lib/payu/validator.rb

@@ -0,0 +1,43 @@
+module PayU
+  class Validator
+    class << self
+      def validate_hash_params(**kwargs)
+        kwargs.each do |k, v|
+          if not v&.is_a? String
+            raise PayU::PayuError.new "#{k} should be of type String"
+          end
+    
+          if kwargs[:txn_id].length > 25
+            raise PayU::PayuError.new "txn_id length should be less than equal to 25"
+          end
+    
+          if kwargs[:product_info].length > 100
+            raise PayU::PayuError.new "product_info length should be less than equal to 100"
+          end
+    
+          if kwargs[:first_name].length > 60
+            raise PayU::PayuError.new "first_name length should be less than equal to 60"
+          end
+    
+          if kwargs[:email].length > 50
+            raise PayU::PayuError.new "email length should be less than equal to 50"
+          end
+    
+          if !PayU::EMAIL_REGEX.match(kwargs[:email])
+            raise PayU::PayuError.new "Invalid Email"
+          end
+
+          if !PayU::AMOUNT_REGEX.match(kwargs[:amount])
+            raise PayU::PayuError.new "amount should contain digits with upto 2 decimal places"
+          end
+          
+          [kwargs[:udf1], kwargs[:udf2], kwargs[:udf3], kwargs[:udf4], kwargs[:udf5]].each do |udf|
+            if udf.length > 255
+              raise PayuError.new "udf length should be less than equal to 255"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/payu-sdk.gemspec

@@ -0,0 +1,17 @@
+
+lib = File.expand_path('lib', Dir.pwd)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payu/constants'
+
+Gem::Specification.new do |s| 
+  s.name        = 'payu-sdk'
+  s.version     = PayU::VERSION
+  s.summary     = "Payu's Ruby API"
+  s.authors     = ['']
+  s.email       = ['dx@payu.in']
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://payu.in'
+  s.license     = 'MIT'
+  s.description = 'Official Ruby SDK for PayU'
+  s.require_paths = ['lib']
+end

data/test/payu/hasher.spec.rb

@@ -0,0 +1,26 @@
+require "minitest/autorun"
+require "payu"
+
+describe PayU do
+  before do
+    PayU.init('bjg$121', 'vhgvs75')
+  end
+
+  describe "when paramters are valid for generate_hash" do
+    it "must return hash string" do
+      _(PayU::Hasher.generate_hash txn_id: "5512244", amount: "1000", product_info: 'mobile', first_name: 'Jacob', email: 'test@payu.in').must_equal 'b035620f2f75e99b74e8064203519daea6d8fb5ac81d4c4c599e1b50b63f2d610195145e9769e527682aff06555e511e9c3ec58ea51291cccdbcc3427b35630d'
+    end
+  end
+
+  describe "when paramters are valid for validate_hash" do
+    it "must return false when hash is not valid" do
+      _(PayU::Hasher.validate_hash 'reverse_hash', txn_id: "5512244", amount: "1000", product_info: 'mobile', first_name: 'Jacob', email: 'test@payu.in', status: 'success').must_equal false
+    end
+
+     it "must return true when hash is valid" do
+      _(PayU::Hasher.validate_hash '10da174f9789c00c3290dbda12947deae227cd7f039d14db587c2be3663b4bde9d405edd4dad0a4458cbc36ee10e92389a81213b54a5d83ce68aad32fa61eef4', txn_id: "5512244", amount: "1000", product_info: 'mobile', first_name: 'Jacob', email: 'test@payu.in', status: 'success').must_equal true
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: payu-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-14 00:00:00.000000000 Z
+dependencies: []
+description: Official Ruby SDK for PayU
+email:
+- dx@payu.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- Readme.md
+- lib/payu-sdk.rb
+- lib/payu/constants.rb
+- lib/payu/hasher.rb
+- lib/payu/payu_error.rb
+- lib/payu/validator.rb
+- payu-sdk.gemspec
+- test/payu/hasher.spec.rb
+homepage: https://payu.in
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Payu's Ruby API
+test_files: []