figpay_gateway 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03aa3ece2a07c3c8357a821ae7132f426d662e5eaf4d83953742fc42edb35946
-  data.tar.gz: 8c0ea4eaad5351909cef1f25a41ecebc92fa47b1bb3ba9bf2850dce07d30b104
+  metadata.gz: 0fe878288323339cb8ff06b8a483a4966c21aadfbec9cac083b2fd251e3e5737
+  data.tar.gz: c44c285af844da93fbc5bf874a742156590a6d8739ba2fb31cef4ef64edeb89b
 SHA512:
-  metadata.gz: 88183bb02b6029d9da56ae4ea077375a57e851bb7de00eeeebfe08284e16a4debeece51f624174e157b062a854f9084fbd0aab88f980c4343b593add65722b29
-  data.tar.gz: ed560173896abfe6ea4de038b9d5ff880b45e12598bfc7f26a282936f88f80f10cf165bcbafd989e6fec612fec5637bebe8b223cd8df5a555234c86e49d54eef
+  metadata.gz: db4f813d03fdd3fdbc398206c2ced3dc0e4043376b72c5a41cb4f882cbb5918285b9f8e170732021445579eddf00c123a9794e3989d00756eab12bfb3cddbdfc
+  data.tar.gz: 2863a295a038446ae9a2fb07e422ce754e75db67cd4ab47e2e2067925158a01129e546543a105822940c436bb3da8840b1980f518a54f0efd4e17a1f920e8eb3

data/README.md

@@ -38,6 +38,10 @@ The library needs to be configured with your account's security key, which is av
 
 ### Configuration
 
+You can configure the library in two ways:
+
+#### Option 1: Environment Variables
+
 Set your security key as an environment variable:
 
 ```bash
@@ -56,6 +60,22 @@ For testing, you can use the demo account security key:
 NMI_SECURITY_KEY=6457Thfj624V5r7WUwc5v6a68Zsd6YEm
 ```
 
+#### Option 2: Initializer (Recommended for Rails)
+
+Create an initializer file (e.g., `config/initializers/figpay_gateway.rb`):
+
+```ruby
+FigpayGateway.configure do |config|
+  config.security_key = Rails.application.credentials.dig(:nmi, :security_key)
+  # Optional: customize gateway URLs (defaults shown)
+  # config.transaction_url = 'https://figpay.transactiongateway.com/api/transact.php'
+  # config.query_url = 'https://figpay.transactiongateway.com/api/query.php'
+  # config.test_mode = 'enabled' # Enable test mode
+end
+```
+
+**Note:** You can use either `FigpayGateway.configure` or `NMIGateway.configure` - both work identically. Configuration values set via the initializer take precedence over environment variables.
+
 ### Quick Start
 
 ```ruby
@@ -86,6 +106,17 @@ The FigPay Gateway library is organized around three main API sets:
 
 Process credit card transactions including sales, authorizations, captures, and refunds.
 
+#### Recommendation - use collect.js to tokenize cards client side
+
+The payment gateway supports credit card tokenization via [Collect.js](https://figpay.transactiongateway.com//merchants/resources/integration/integration_portal.php#cjs_methodology). The benefit of this approach is that sensitive PCI information will be submitted directly to payment processor servers, they will return a token that you would send back to your servers, and reduce the PCI SAQ compliance requirements from SAQ-C or SAQ-D to SAQ-A. This greatly simplifies compliance, as no credit information would ever touch your logs or servers.
+
+Test Token example: `00000000-000000-000000-000000000000`
+This is tied to a test card: `Card: 4111111111111111, Expiration: October 2025, CVV: 999`
+
+Usage, in all examples, rather than passing in `ccnumber` and `ccexp`, these can be updated to use the token obtained via Collect.js and passed in as a `payment_token` param instead.
+
+There is a Test Public Key that can be used with Collect.js: `48r3R6-M39Jx5-467srN-VWVbD3`
+
 #### Create a Sale
 
 Process a direct sale (authorization and capture combined):
@@ -186,7 +217,7 @@ Retrieve transaction details:
 
 ```ruby
 details = FigpayGateway::Transaction.new.find(
-  transactionid: '3261844010'
+  transaction_id: '3261844010'
 )
 ```
 

data/lib/figpay_gateway/version.rb

@@ -1,3 +1,3 @@
 module FigpayGateway
-  VERSION = "1.0.1"
+  VERSION = "1.0.4"
 end

data/lib/figpay_gateway.rb

@@ -1,3 +1,18 @@
 # FigPay Gateway is a wrapper around the NMI Gateway
 # This allows the gem to be portable across different NMI white-label providers
 require "nmi_gateway"
+
+module FigpayGateway
+  # Alias configuration methods to NMIGateway
+  def self.configure(&block)
+    NMIGateway.configure(&block)
+  end
+
+  def self.configuration
+    NMIGateway.configuration
+  end
+
+  def self.configuration=(config)
+    NMIGateway.configuration = config
+  end
+end

data/lib/nmi_gateway/api.rb

@@ -1,23 +1,30 @@
 module NMIGateway
   class Api
-    TRANSACTION_URL = ENV.fetch("NMI_TRANSACTION_URL", "https://figpay.transactiongateway.com/api/transact.php")
-    QUERY_URL = ENV.fetch("NMI_QUERY_URL", "https://figpay.transactiongateway.com/api/query.php")
     include HTTParty
 
-    attr_accessor :security_key, :query
+    attr_accessor :security_key, :query, :configuration
 
-    def initialize(options = {})
-      @security_key = options[:security_key] || ENV["NMI_SECURITY_KEY"]
+    def initialize(options = {}, configuration = NMIGateway.configuration)
+      @configuration = configuration
+      @security_key = options[:security_key] || configuration.security_key
+    end
+
+    def transaction_url
+      @configuration.transaction_url
+    end
+
+    def query_url
+      @configuration.query_url
     end
 
     def get(options={})
-      response = self.class.get(QUERY_URL, query: options.merge(credentials), timeout: 30, headers: headers)
+      response = self.class.get(query_url, query: options.merge(credentials), timeout: 30, headers: headers)
       api_type = options[:type] || options[:report_type]
       handle_response(response, api_type)
     end
 
     def post(options={})
-      response = self.class.get(TRANSACTION_URL, query: options.merge(credentials), timeout: 30, headers: headers)
+      response = self.class.get(transaction_url, query: options.merge(credentials), timeout: 30, headers: headers)
       api_type = options[:type] || options[:customer_vault]
       handle_response(response, api_type)
     end
@@ -38,7 +45,7 @@ module NMIGateway
 
     def credentials
       creds = {security_key: security_key}
-      creds[:test_mode] = ENV['NMI_TEST_MODE'] if ENV['NMI_TEST_MODE']
+      creds[:test_mode] = configuration.test_mode if configuration.test_mode
       creds
     end
 
@@ -67,6 +74,9 @@ module NMIGateway
       query[:ccexp]                        = options[:ccexp] # FORMAT MMYY
       query[:cvv]                          = options[:cvv] # Recommended
 
+      # Payment Token
+      query[:payment_token]                = options[:payment_token] # from Collect.js
+
       # Payment
       query[:amount]                       = options[:amount]
       query[:currency]                     = options[:currency] || 'USD'
@@ -83,7 +93,7 @@ module NMIGateway
       # Recurring Billing
       query[:recurring]                    = options[:recurring ] # add_subscription
       query[:plan_id]                      = options [:plan_id]
-      query[:plan_name]                      = options [:plan_name]
+      query[:plan_name]                    = options [:plan_name]
       query[:plan_payments]                = options [:plan_payments] # 0 until canceled
       query[:plan_amount]                  = options [:plan_amount]
       query[:day_frequency]                = options [:day_frequency]

data/lib/nmi_gateway/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NMIGateway
+  class Configuration
+    attr_accessor :security_key, :transaction_url, :query_url, :test_mode
+
+    def initialize(options = {})
+      @security_key = options.dig(:security_key) || ENV["NMI_SECURITY_KEY"]
+      @transaction_url = options.dig(:transaction_url) || ENV.fetch("NMI_TRANSACTION_URL", "https://figpay.transactiongateway.com/api/transact.php")
+      @query_url = options.dig(:query_url) || ENV.fetch("NMI_QUERY_URL", "https://figpay.transactiongateway.com/api/query.php")
+      @test_mode = options.dig(:test_mode) || ENV["NMI_TEST_MODE"]
+    end
+  end
+end

data/lib/nmi_gateway/customer_vault.rb

@@ -2,11 +2,15 @@ module NMIGateway
   class CustomerVault < Api
 
     # NMIGateway::CustomerVault.new.create ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe"
+    # NMIGateway::CustomerVault.new.create payment_token: "00000000-000000-000000-000000000000", first_name: "John", last_name: "Doe"
     def create(options = {})
       query = set_query(options)
       query[:customer_vault] = 'add_customer'
-
-      require_fields(:ccnumber, :ccexp)
+      if query[:payment_token]
+        require_fields(:payment_token, :first_name, :last_name)
+      else
+        require_fields(:ccnumber, :ccexp, :first_name, :last_name)
+      end
       post query
     end
 

data/lib/nmi_gateway/transaction.rb

@@ -65,7 +65,7 @@ module NMIGateway
       post query
     end
 
-    # NMIGateway::Transaction.new.find transactionid: 3261844010
+    # NMIGateway::Transaction.new.find transaction_id: 3261844010
     def find(options = {})
       query = set_query(options)
       query[:report_type] ||= 'transaction'

data/lib/nmi_gateway.rb

@@ -5,6 +5,7 @@ require "ostruct"
 
 require "figpay_gateway/version"
 
+require "nmi_gateway/configuration"
 require "nmi_gateway/api"
 require "nmi_gateway/data"
 require "nmi_gateway/result/action"
@@ -17,6 +18,20 @@ require "nmi_gateway/recurring"
 require "nmi_gateway/response"
 require "nmi_gateway/transaction"
 
+module NMIGateway
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= NMIGateway::Configuration.new
+  end
+end
+
 module FigpayGateway
   # Expose NMIGateway classes under the FigpayGateway namespace
   Api = NMIGateway::Api

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: figpay_gateway
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Ben Eggett
@@ -233,6 +233,7 @@ files:
 - lib/figpay_gateway/version.rb
 - lib/nmi_gateway.rb
 - lib/nmi_gateway/api.rb
+- lib/nmi_gateway/configuration.rb
 - lib/nmi_gateway/customer_vault.rb
 - lib/nmi_gateway/data.rb
 - lib/nmi_gateway/error.rb