offsite_payments 2.7.10 → 2.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6784710cabbc90a43b307a4cc412047c96a6171
-  data.tar.gz: d86bd553ec1eae59bc7482169ee53d9047b036e2
+SHA256:
+  metadata.gz: 80e586df2a8864f246dc9aaa3ab3f53d3cc04b4f14200f195a504cf8cb3bb551
+  data.tar.gz: dbbf5498a71aa62aafc296834d849f7c2c307a1c6abcae457c50a4385108860f
 SHA512:
-  metadata.gz: 2c0ef45575498d7af98ebfd5b39a6abca73ddf8b0dfa1588c8db87528e05406ea09c853854a543f18c808c14cecca2a36dc242286f0d7dd4c6aa890c90a43f8e
-  data.tar.gz: 813a8370cd80285e9bbc94759d2a5eeb0f293f2c496708f2fb5cf76933aa7cc9d6141d39be893976ac9c5521cb6f95ca58e1f7387a2dc509220ec1bfecea1d87
+  metadata.gz: 0c032a24a16ff43cf25fc011f1eddd2b0fde6f3064e14ae6982977d280f9eb6a99cc79d559e6091f6fc311a846a7ee21087b24f87448c07faa38eff46cb6fe37
+  data.tar.gz: d7205f0cc31e891d3f88b8c7c4419516f2f59232ccf342a39f32bd1a24f53ec623e51c190c17e7372fae04a6763b5aecf922893b6de875a33dc5d749c3c53f36

data/lib/offsite_payments/helper.rb

@@ -15,6 +15,17 @@ module OffsitePayments #:nodoc:
       subclass.mappings ||= {}
     end
 
+    # @param order [String] unique id of this order
+    # @param account [String] merchant account id from gateway provider
+    # @param options [Hash] convenience param to set common attributes including:
+    # * amount
+    # * currency
+    # * credential2
+    # * credential3
+    # * credential4
+    # * notify_url
+    # * return_url
+    # * redirect_param
     def initialize(order, account, options = {})
       options.assert_valid_keys([:amount, :currency, :test, :credential2, :credential3, :credential4, :country, :account_name, :description, :transaction_type, :authcode, :notify_url, :return_url, :redirect_param, :forward_url, :checkout_token])
       @fields             = {}
@@ -33,10 +44,52 @@ module OffsitePayments #:nodoc:
       self.checkout_token = options[:checkout_token]
     end
 
+    # Add a mapping between attribute name and gateway specific field name.
+    # This mapping can then be used in form helper to assign values to each
+    # attributes. For example, a `mapping :height, "HEIGHT"` means user can
+    # write `f.height 182` in 'payment_service_for' form helper, and an
+    # input tag with the name "HEIGHT" and value of 182 will be generated.
+    # This is an abstraction over the `add_field` method.
+    #
+    # @param attribute [Symbol] attribute name
+    # @param options [String, Array, Hash] input name from gateway's side.
+    #
+    # String:
+    # Name of generated input
+    #
+    # Array:
+    # Names of generated inputs, for creating synonym inputs.
+    # Each generated input will have the same value.
+    #
+    # Hash:
+    # Keys as attribute name and values as generated input names.
+    # Used to group related fields together, such as different segments
+    # of an address, for example:
+    #
+    # mapping :address, :region => 'REGION',
+    # :city => 'CITY',
+    # :address => 'ADD'
     def self.mapping(attribute, options = {})
       self.mappings[attribute] = options
     end
 
+    # Add an input in the form. Useful when gateway requires some uncommon
+    # fields not provided by the gem.
+    #
+    # # inside `payment_service_for do |service|` block
+    # service.add_field('c_id','_xclick')
+    #
+    # Gateway implementor can also use this to add default fields in the form:
+    #
+    # # in a subclass of ActiveMerchant::Billing::Integrations::Helper
+    # def initialize(order, account, options = {})
+    # super
+    # # mandatory fields
+    # add_field('Rvg2c', 1)
+    # end
+    #
+    # @param name [String] input name
+    # @param value [String] input value
     def add_field(name, value)
       return if name.blank? || value.blank?
       @fields[name.to_s] = value.to_s
@@ -72,10 +125,15 @@ module OffsitePayments #:nodoc:
       @fields
     end
 
+    # @return [Boolean] whether in test mode
     def test?
       @test_mode ||= OffsitePayments.mode == :test || !!@test
     end
 
+    # Specifies the HTTP method used in form submmition.
+    # Set to POST which gateway implementor can override if other http method is desired (e.g. PUT).
+    #
+    # @return [String] form submit action, default is "POST".
     def form_method
       "POST"
     end

data/lib/offsite_payments/integrations/paytm.rb

@@ -11,7 +11,7 @@ module OffsitePayments #:nodoc:
 
       # self.test_url = 'https://pguat.paytm.com/oltp-web/processTransaction'
       # self.production_url = 'https://secure.paytm.in/oltp-web/processTransaction'
-      
+
       self.test_url = 'https://securegw-stage.paytm.in/theia/processTransaction'
       self.production_url = 'https://securegw.paytm.in/theia/processTransaction'
 
@@ -109,7 +109,7 @@ module OffsitePayments #:nodoc:
       end
 
       class Notification < OffsitePayments::Notification
-        PAYTM_RESPONSE_PARAMS = %w(MID BANKTXNID TXNAMOUNT CURRENCY STATUS RESPCODE RESPMSG TXNDATE GATEWAYNAME BANKNAME PAYMENTMODE PROMO_CAMP_ID PROMO_STATUS PROMO_RESPCODE ORDERID TXNID REFUNDAMOUNT REFID MERC_UNQ_REF CUSTID).freeze
+        PAYTM_RESPONSE_PARAMS = %w(MID BANKTXNID TXNAMOUNT CURRENCY STATUS RESPCODE RESPMSG TXNDATE GATEWAYNAME BANKNAME PAYMENTMODE PROMO_CAMP_ID PROMO_STATUS PROMO_RESPCODE ORDERID TXNID REFUNDAMOUNT REFID MERC_UNQ_REF CUSTID TXNDATETIME).freeze
 
         def initialize(post, options = {})
           super

data/lib/offsite_payments/version.rb

@@ -1,3 +1,3 @@
 module OffsitePayments
-  VERSION = "2.7.10"
+  VERSION = "2.7.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: offsite_payments
 version: !ruby/object:Gem::Version
-  version: 2.7.10
+  version: 2.7.11
 platform: ruby
 authors:
 - Tobias Luetke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -278,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Framework and tools for dealing with offsite (hosted) payment pages.