paygate-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c14a70c282c1f4f93ac7e45f2de15fe88f9af2bd4f4e0dab3d5274ecb1b6499
-  data.tar.gz: 24158c084acd02c3d26967e5ca8f9c5e9483649e1a0d26cb26883b5d5cd3bb93
+  metadata.gz: 65cf37be0b80974b5bbfea30323cac9a49700b5b019ce61d0c169a0566ca04f0
+  data.tar.gz: 37865beecc0da514d9c104197af2dcebf6fc85d14b76eed79a68cfb583f1b6ca
 SHA512:
-  metadata.gz: d041fa6ccf284ab752f62429da877f31b672b85f1b2846c64dd2d1932a4c49b1b8205eca6563fddaa908114ce67a8c35497c3ce3ec0d05db7e439d8702692578
-  data.tar.gz: 30da4f2cbd4dae440e78b93b3b927486f7a4e5c8040841e71bb57d47bb3a7f215e6ffe26bd5dbdb6ae4ca1acaf96fb3bc3c2041540e734ce3b15064f6a6c3ae5
+  metadata.gz: b3ba8427bdd1e06a0c411ce0cb21d9cd40086402a356a3e488f0c9c2ce34e1476d956fd7ab47807f4a25cc41a1705f71114f9ad762a18268ffd9314ff9438cbf
+  data.tar.gz: c32240809e74a7c6e5ff98c7b897f8366101ce9a82699451d8bbe5f669366d1d5659dde478bf956c66d29c2b2199152fcc35a1c435e589986d523070c717e1da

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# CHANGELOG
+
+## 0.1.2 - 2018-03-16
+
+- Fix Bug - Pass correct value of _amount_ for full refund of a transaction.
+
+## 0.1.1 - 2018-03-09
+
+- Add raw info to the response of refund transaction.
+
+## 0.1.0 - 2017-11-29
+
+- Add view helper for rendering OpenPayAPI payment form with default values.
+- Add Javascript helpers for accessing OpenPayAPI payment form and payment screen.
+- Support full refund of a transaction using CancelAPI.
+- Support future payments (Profile Pay) for existing customers.

data/README.md

@@ -28,7 +28,7 @@ NOTE: Unless otherwise stated, all the following documentation is for making pay
 
 Contents:
 - [1 Purchase](#1-purchase)
-- [2 Cancel](#2-cancel)
+- [2 Refund](#2-refund)
 - [3 Profile Pay](#3-profile-pay)
 
 ### 1 Purchase
@@ -127,7 +127,7 @@ Passing `nil` above would return default currency i.e. "WON".
 
 You need to contact PayGate to know the correct amount for making a successful transaction in test mode.
 
-Remember, in test mode too, PayGate makes real transactions and you need to cancel them for the refunds.
+Remember, in test mode too, PayGate makes real transactions and you need to `refund` them.
 
 **tid**
 
@@ -194,7 +194,7 @@ $('form[name="PGIOForm"]').on('submit', function(event){
 
 And, your payment form is all set to make payments.
 
-### 2 Cancel
+### 2 Refund
 
 Initialize a `Paygate::Member` instance using the Member ID and Secret you have.
 
@@ -213,21 +213,21 @@ member.secret
  => "secret"
 ```
 
-Cancel the transaction.
+#### 2.1 Full refund
 
 ```ruby
-response = member.cancel_transaction('testmid_123456.654321', amount: 1000)
- => #<Paygate::Response:0x007fbf3d111940 @transaction_type=:cancel, @http_code="200", @message="OK", @body="callback({\"replyCode\":\"0000\",\"replyMessage\":\"Response has been completed\",\"content\":{\"object\":\"CancelAPI tid:testmid_123456.654321 SUCCESS payRsltCode:0000\"}})", @json={"replyCode"=>"0000", "replyMessage"=>"Response has been completed", "content"=>{"object"=>"CancelAPI tid:testmid_123456.654321 SUCCESS payRsltCode:0000"}}, @raw_info=
-  #<OpenStruct tid="testmid_123456.654321", tid_enc="AES256XQIdNnkzFwMQmhF7fuJhS3m0\n", request_url="https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=1000">>
+response = member.refund_transaction('testmid_123456.654321')
+ => #<Paygate::Response:0x007fbf3d111940 @transaction_type=:refund, @http_code="200", @message="OK", @body="callback({\"replyCode\":\"0000\",\"replyMessage\":\"Response has been completed\",\"content\":{\"object\":\"CancelAPI tid:testmid_123456.654321 SUCCESS payRsltCode:0000\"}})", @json={"replyCode"=>"0000", "replyMessage"=>"Response has been completed", "content"=>{"object"=>"CancelAPI tid:testmid_123456.654321 SUCCESS payRsltCode:0000"}}, @raw_info=
+  #<OpenStruct tid="testmid_123456.654321", tid_enc="AES256XQIdNnkzFwMQmhF7fuJhS3m0\n", request_url="https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=F">>
 ```
 
-Here, _testmid_123456.654321_ is `tid` of the transaction you want to cancel.
+Here, _testmid_123456.654321_ is `tid` of the transaction you want to refund.
 
 `response` provides some helpful accessor methods too.
 
 ```ruby
 response.transaction_type
- => :cancel
+ => :refund
 
 response.http_code
  => "200"
@@ -236,14 +236,22 @@ response.json
  => {"replyCode"=>"0000", "replyMessage"=>"Response has been completed", "content"=>{"object"=>"CancelAPI tid:testmid_123456.654321 SUCCESS payRsltCode:0000"}}
 
 response.raw_info
- => #<OpenStruct tid="testmid_123456.654321", tid_enc="AES256XQIdNnkzFwMQmhF7fuJhS3m0\n", request_url="https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=1000">
+ => #<OpenStruct tid="testmid_123456.654321", tid_enc="AES256XQIdNnkzFwMQmhF7fuJhS3m0\n", request_url="https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=F">
 
 response.raw_info.request_url
- => "https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=1000"
+ => "https://service.paygate.net/service/cancelAPI.json?callback=callback&mid=testmid&tid=AES256XQIdNnkzFwMQmhF7fuJhS3m0%0A&amount=F"
 ```
 
 Apart from these it also responds to `message` and `body`.
 
+#### 2.2 Partial refund
+
+For partial refunds, pass `amount` as an option to `refund_transaction` method:
+
+```ruby
+response = member.refund_transaction('testmid_123456.654321', amount: 1000)
+```
+
 ### 3 Profile Pay
 
 You can use the `profile_no` returned from the OpenPayAPI after first payment by a customer to make future payments for him.

data/lib/paygate/member.rb

@@ -6,10 +6,10 @@ module Paygate
       @mid, @secret = mid, secret
     end
 
-    def cancel_transaction(txn_id, options = {})
+    def refund_transaction(txn_id, options = {})
       txn = Transaction.new(txn_id)
       txn.member = self
-      txn.cancel(options)
+      txn.refund(options)
     end
 
     def profile_pay(profile_no, currency, amount)

data/lib/paygate/response.rb

@@ -10,7 +10,7 @@ module Paygate
       r.body = response.body
 
       case txn_type
-        when :cancel
+        when :refund
           r.json = JSON.parse response.body.gsub(/^callback\((.*)\)$/, '\1') if response.code.to_i == 200
         when :profile_pay
           r.json = {}

data/lib/paygate/transaction.rb

@@ -4,7 +4,8 @@ require 'net/http'
 
 module Paygate
   class Transaction
-    CANCEL_API_URL = 'https://service.paygate.net/service/cancelAPI.json'.freeze
+    REFUND_API_URL = 'https://service.paygate.net/service/cancelAPI.json'.freeze
+    FULL_AMOUNT_IDENTIFIER = 'F'.freeze
 
     attr_reader :tid
     attr_accessor :member
@@ -13,7 +14,7 @@ module Paygate
       @tid = tid
     end
 
-    def cancel(options = {})
+    def refund(options = {})
       # Encrypt data
       api_key_256 = ::Digest::SHA256.hexdigest(member.secret)
       aes_ctr = AesCtr.encrypt(tid, api_key_256, 256)
@@ -22,14 +23,15 @@ module Paygate
       # Prepare params
       params = { callback: 'callback', mid: member.mid, tid: tid_enc }
       params.merge!(options.slice(:amount))
+      params[:amount] ||= FULL_AMOUNT_IDENTIFIER
       params.delete_if { |_, v| v.blank? }
 
       # Make request
-      uri = URI(CANCEL_API_URL)
+      uri = URI(REFUND_API_URL)
       uri.query = ::URI.encode_www_form(params)
       response = ::Net::HTTP.get_response(uri)
 
-      r = Response.build_from_net_http_response(:cancel, response)
+      r = Response.build_from_net_http_response(:refund, response)
       r.raw_info = OpenStruct.new(tid: tid, tid_enc: tid_enc, request_url: uri.to_s)
       r
     end

data/lib/paygate/version.rb

@@ -1,3 +1,3 @@
 module Paygate
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paygate-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - jagdeepsingh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt