figpay_gateway 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59cba6b47a82b9e89b53596dfacbab9d878a5d4d9cea9d8203c7b86f16437ad
-  data.tar.gz: a1c7b968a83539aff97dd6ca9ecbcb036b7618ade945572ac6221a3c4aaf96ed
+  metadata.gz: 68c11ff01e6b80e582293dea14fada0b65e335f50f5125e86863522b6438173f
+  data.tar.gz: d1fda8b1abc5233cc39a35eb849b8896143726c4a456724e8128edcd381ecfd5
 SHA512:
-  metadata.gz: 38b028203836e1051721ea735c616c331632833cda9eb0f15e15d9b0fa73236db8d433eb1f6715c8c692db56b918b45e3381c5d30f6738d4a214520fb6c1e8f3
-  data.tar.gz: cc42df57043042e8daa71c4648d0698af797432390d8f00fb2df31f6fbc39c7ef7ac0355d4ec140ab8bccab6613d2b0f9b95b89dbad5acaf00a34eef3928f538
+  metadata.gz: e4f1b9a51388850aa23f9768e7025710f8fb8ba1140ca509800ed08c4d7c3753519abecdc07ad05870d7ff6c0d2d1de8da3bf797bf10796ec4a422d73f381140
+  data.tar.gz: 31ad9e10483fd543a809ad9176af4fd659b4013105f1e38454ae67586e6ac7e50617e8ac7174370ac881a86799b65672bac9296f5cd6b1676a7463ebc97da053

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
@@ -309,6 +329,20 @@ plan = recurring.create_plan(
 )
 ```
 
+#### List All Plans
+
+Retrieve all recurring billing plans:
+
+```ruby
+plans = FigpayGateway::Recurring.new.list_plans
+
+if plans.success?
+  puts "Plans retrieved successfully"
+end
+```
+
+**Note:** The Query API may not be available on all accounts. Contact FigPay support if you encounter issues.
+
 #### Subscribe Customer to a Plan
 
 Add a vaulted customer to an existing plan:

data/lib/figpay_gateway/version.rb

@@ -1,3 +1,3 @@
 module FigpayGateway
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 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
 

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/recurring.rb

@@ -11,6 +11,12 @@ module NMIGateway
       post query
     end
 
+    # NMIGateway::Recurring.new.list_plans
+    def list_plans(options = {})
+      query = set_query(options)
+      query[:report_type] = 'recurring_plans'
+      get query
+    end
 
     # NMIGateway::Recurring.new.add_subscription_to_plan plan_id: "test-1", customer_vault_id: 664625840
     def add_subscription_to_plan(options = {})

data/lib/nmi_gateway/response.rb

@@ -89,6 +89,10 @@ module NMIGateway
       parsed_response
     end
 
+    def set_recurring_plans
+      parsed_response
+    end
+
     def set_customer_vault
       parsed_response
       if parsed_response && parsed_response['nm_response'] && parsed_response['nm_response']['customer_vault'] && customers = parsed_response['nm_response']['customer_vault']['customer']

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.3
+  version: 1.0.5
 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