transact_pro 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 489d0c8023577678e52bab6119b2752c195e71b0
-  data.tar.gz: f0e4f7c450dfa3ad7bad504d4aba575e8f240fee
+  metadata.gz: 0e0af839e8839922430d553e7e220075ba9374cb
+  data.tar.gz: e6c2999131f36cc1560b2d22e397800375a1202f
 SHA512:
-  metadata.gz: 4ce087a2af93f2850fe44c5ac06c4c86cdc2f1acccb399c08c3d36291a8806dd9742b3f9d649b61bd9971afa79a2562aa639ff88c15dcb51a4b191a6c61ba2d3
-  data.tar.gz: 99e49fd89f9e81c6ca614a2181d16f7c634fdd3aa76486ab924eceb6b5783e5ae268367cdbaa05a6a548aaa6a1812f9d1b4825c1a1befda45a9f69903033d291
+  metadata.gz: c55a5fa322591602ca3cddc1ece2cd62bf9e473b7c02af6f52cae1a70c217d1b7d60d40a2313e4d93b6f7e02733cccdb93eba45f5754d3c2d6fb6c886fe26855
+  data.tar.gz: 611f31f00ff8ffb80af259252e13ae96d8b8ff550cddc6fcbe92eeffb65ead3e10a55ff39f048362c9722da03e2bcef90051bb6d24ceb83573561f50789b339f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    transact_pro (0.9.2)
+    transact_pro (0.9.3)
       rest-client (~> 2.0.2)
 
 GEM

data/README.md

@@ -50,7 +50,10 @@ gem 'transact_pro'
 The gem implements `gateway`, `request` and `response` objects that handle communication with the remote API for you.  
 All communication is done synchroniously and without failsafes, so if something goes wrong during the remote request (HTTP timeout etc.), you get the raw error and get to handle it.  
 
-Please note that in this gem all configuration option hash keys are constant-case symbols like `:GUID` whereas all parameter keys for requests to the API are snake-case symbols like `:merchant_transaction_id`.
+Consult `lib/transact_pro/request_specs.rb` for details
+on what parameters the various requests expect.  
+
+Please note that in this gem all configuration option hash keys are constant-case symbols like `:GUID` whereas all parameter keys for requests to the API are snake-case symbols like `:merchant_transaction_id`. Make sure all values are `String`s.
 
 ### 1. `TransactPro::Gateway`
 
@@ -81,6 +84,9 @@ options = {
 }
 
 gateway = TransactPro::Gateway.new(options)
+
+# Access an initialized gateway instance's underlying options, for example
+gateway.options[:HOSTED_FIELDS_JS_URI] # for HostedFields 
 ```
 
 ### 2. `TransactPro::Request`
@@ -90,6 +96,8 @@ Use the `Gateway` instance's `#request` method to build and perform requests.
 ```rb
 options = {
   method: :status_request, # mandatory, exclusively symbol objects for value
+  # + request parameters from `lib/transact_pro/request_specs.rb`
+  
   request_type: 'transaction_status',
   init_transaction_id: "abc123",
   # Note that passing :guid and :pwd is possible and `#call` will always override  
@@ -103,9 +111,8 @@ options = {
 }
 
 request_instance = gateway.request(options)
+request_instance.details #=> {url: "...", params: {...}} # see what will be POSTed to where
 request_instance.call #=> response
-
-# TransactPro::Request instances also have #to_s method to inspect what parameters are used in the request.
 ```
 
 ### 3. `TransactPro::Response`

data/lib/transact_pro/request.rb

@@ -25,6 +25,16 @@ class TransactPro::Request
   end
 
   def call
+    # does prep
+    details
+
+    @raw_response = RestClient.post(@url, @postable_params)
+    @response = TransactPro::Response.new(@raw_response.to_s)
+  end
+
+  def details
+    return @details if defined?(@details)
+
     @defaults ||= TransactPro::RequestSpecs.const_get(
       "#{method.to_s.upcase}_DEFAULTS"
     )
@@ -58,11 +68,11 @@ class TransactPro::Request
 
     @url = "#{@request_options[:API_URI]}?a=#{sendable_method}"
 
-    @raw_response = RestClient.post(@url, @postable_params)
-    @response = TransactPro::Response.new(@raw_response.to_s)
+    @details = {url: @url, params: @postable_params}
   end
 
   private
+
     def validate(key, string, regex)
       unless string[regex]
         raise TransactPro::Request::ValidationError.new(

data/lib/transact_pro/request_specs.rb

@@ -40,6 +40,7 @@ module TransactPro
     BIN_PHONE = %r'\A[0-9\-_]{3,25}\z' # ns(3..25)
     MERCHANT_SITE_URL = %r'\A.{1,255}\z' # ans(1..255)
     MERCHANT_REFERRING_NAME = %r'\A.{1,21}\z' # ans(1..21)
+    BACK_URL = %r'\A.{1,255}\z' # ans(1..255)
     F_EXTENDED = %r'\A\d+\z' # n
 
     # 10. Table
@@ -72,7 +73,10 @@ module TransactPro
     # merchant_site_url ans(1..255) Purchase site URL.
     # merchant_referring_name ans(1..21) Must not be send by default. See chapter 3.5 for description if you need
     # to use it.
+    # custom_return_url ans(1..255) Custom return URL
+    # custom_callback_url ans(1..255) Custom callback URL
     INIT_SPEC = {
+      # method: :init
       guid: {mandatory: true, format: GUID_REGEX},
       pwd: {mandatory: true, format: PASSWORD_DIGEST_REGEX},
       rs: {mandatory: true, format: ROUTING_REGEX},
@@ -93,7 +97,9 @@ module TransactPro
       bin_name: {mandatory: false, format: BIN_NAME},
       bin_phone: {mandatory: false, format: BIN_PHONE},
       merchant_site_url: {mandatory: true, format: MERCHANT_SITE_URL},
-      merchant_referring_name: {mandatory: false, format: MERCHANT_REFERRING_NAME}
+      merchant_referring_name: {mandatory: false, format: MERCHANT_REFERRING_NAME},
+      custom_return_url: {mandatory: false, format: BACK_URL},
+      custom_callback_url: {mandatory: false, format: BACK_URL}
     }.freeze
 
     INIT_DEFAULTS = {
@@ -103,6 +109,7 @@ module TransactPro
     }.freeze
 
     INIT_RECURRING_REGISTRATION_SPEC = INIT_SPEC.
+      # method: :init_recurring_registration
       dup.merge(save_card: {mandatory: true, format: %r'\d+'}).freeze
     INIT_RECURRING_REGISTRATION_DEFAULTS = INIT_DEFAULTS.
       dup.merge(save_card: "1").freeze
@@ -117,6 +124,7 @@ module TransactPro
     # amount n Transaction amount, in MINOR units (i.e. 2150 for $21.50 transaction)
     # description uns(5..255) Order items description
     INIT_RECURRENT_SPEC = {
+      # method: :init_recurrent
       guid: {mandatory: true, format: GUID_REGEX},
       pwd: {mandatory: true, format: PASSWORD_DIGEST_REGEX},
       rs: {mandatory: true, format: ROUTING_REGEX},
@@ -135,6 +143,7 @@ module TransactPro
     # init_transaction_id h(40) init_transaction_id received for this recurrent transaction
     # f_extended n Return extended charge details (optional)
     CHARGE_RECURRENT_SPEC = {
+      # method: :charge_recurrent
       guid: {mandatory: true, format: GUID_REGEX},
       pwd: {mandatory: true, format: PASSWORD_DIGEST_REGEX},
       init_transaction_id: {mandatory: true, format: TID_REGEX},
@@ -154,6 +163,7 @@ module TransactPro
     # guid ans(19) Your GUID
     # pwd h(40) SHA1 hash of your processing password
     STATUS_REQUEST_SPEC = {
+      # method: :status_request
       guid: {mandatory: true, format: GUID_REGEX},
       pwd: {mandatory: true, format: PASSWORD_DIGEST_REGEX},
       request_type: {mandatory: true, format: 'transaction_status'},

data/lib/transact_pro/version.rb

@@ -1,3 +1,3 @@
 module TransactPro
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transact_pro
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Epigene