figpay_gateway 1.0.0

data/lib/nmi_gateway/recurring.rb

@@ -0,0 +1,54 @@
+module NMIGateway
+  class Recurring < Api
+
+    # NMIGateway::Recurring.new.create_plan plan_amount: 1.99, plan_name: "Test 1.99", plan_id: "test-1", month_frequency: 1, day_of_month: 1
+    def create_plan(options = {})
+      query = set_query(options)
+      query[:recurring] = 'add_plan'
+      query[:type] = 'recurring'
+      query[:plan_payments] ||= '0'
+      require_fields(:plan_amount, :plan_name, :plan_id)
+      post query
+    end
+
+
+    # NMIGateway::Recurring.new.add_subscription_to_plan plan_id: "test-1", customer_vault_id: 664625840
+    def add_subscription_to_plan(options = {})
+      query = set_query(options)
+      query[:recurring] = 'add_subscription'
+      query[:type] = 'recurring'
+      require_fields(:plan_id)
+      post query
+    end
+
+    # NMIGateway::Recurring.new.add_custom_subscription plan_amount: 1.99, month_frequency: 1, day_of_month: 1,  customer_vault_id: 664625840
+    def add_custom_subscription(options = {})
+      query = set_query(options)
+      query[:recurring] = 'add_subscription'
+      query[:type] = 'recurring'
+      query[:plan_payments] ||= '0'
+      require_fields(:plan_payments, :plan_amount)
+      post query
+    end
+
+    # NMIGateway::Recurring.new.update_subscription subscription_id: "3261766445", first_name: "John", last_name: "Doe"
+    def update_subscription(options = {})
+      query = set_query(options)
+      query[:recurring] = 'update_subscription'
+      query[:type] = 'recurring'
+      require_fields(:subscription_id)
+      post query
+    end
+
+    # NMIGateway::Recurring.new.delete_subscription subscription_id: "3261766445"
+    def delete_subscription(options = {})
+      query = set_query(options)
+      query[:recurring] = 'delete_subscription'
+      query[:type] = 'recurring'
+      require_fields(:subscription_id)
+      post query
+    end
+
+  end
+end
+

data/lib/nmi_gateway/response.rb

@@ -0,0 +1,175 @@
+module NMIGateway
+  class Response
+
+    attr_accessor  :response, :success, :code, :api_type, :transactions, :customers, :response_text, :response_message, :customer_vault_id, :subscription_id, :plan_id, :plan_amount, :orderid, :transactionid, :authcode, :response_code
+
+    def initialize(response, api_type)
+      @response = response
+      @code = response.code
+      @api_type = api_type
+      @success = response.success?
+      send "set_#{api_type}"
+    end
+
+    def set_
+      parsed_response
+      binding.pry
+    end
+
+    def success?
+      !!success
+    end
+
+    private
+
+    def parsed_response
+      if response.body.is_a?(String)
+        if response.body.include?('xml')
+          Hash.from_xml response.body
+        else
+          parsed = CGI.parse(response.body)
+          @response_message = responses[parsed['response'].first]
+          @success = parsed['response'].first == '1'
+          @response_text = parsed['responsetext'].first
+          @response_code = parsed['response_code'].first if parsed['response_code'].first.present?
+          @authcode = parsed['authcode'].first if parsed['authcode'].first.present?
+          @customer_vault_id = parsed['customer_vault_id'].first if parsed['customer_vault_id'].first.present?
+          @plan_id = parsed['plan_id'].first if parsed['plan_id'].first.present?
+          @plan_amount = parsed['plan_amount'].first if parsed['plan_amount'].first.present?
+          @subscription_id = parsed['subscription_id'].first if parsed['subscription_id'].first.present?
+          @orderid = parsed['orderid'].first if parsed['orderid'].first.present?
+          @transactionid = parsed['transactionid'].first if parsed['transactionid'].first.present?
+          parsed
+        end
+      else
+        response
+      end
+    end
+
+
+    def set_transaction
+      parsed_response
+      if parsed_response && parsed_response['nm_response'].present? && parsed_response['nm_response']['transaction'].present?
+        transactions = parsed_response['nm_response']['transaction']
+        if transactions.is_a?(Hash)
+          @transactions = [ NMIGateway::Result::Transaction.new( transactions ) ]
+        elsif transactions.is_a?(Array)
+          @transactions = transactions.map {|c| NMIGateway::Result::Transaction.new( c ) }
+        end
+      else
+        self
+      end
+    end
+    alias_method :set_sale, :set_transaction
+    alias_method :set_auth, :set_transaction
+    alias_method :set_credit, :set_transaction
+    alias_method :set_validate, :set_transaction
+    alias_method :set_capture, :set_transaction
+    alias_method :set_void, :set_transaction
+    alias_method :set_refund, :set_transaction
+    alias_method :set_update, :set_transaction
+
+    def set_customer
+      parsed_response
+    end
+    alias_method :set_add_customer, :set_customer
+    alias_method :set_update_customer, :set_customer
+    alias_method :set_delete_customer, :set_customer
+
+    # def set_receipt
+    #   parsed_response
+    # end
+
+    def set_recurring
+      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']
+        if customers.is_a?(Hash)
+          @customers = [ NMIGateway::Result::Customer.new( customers ) ]
+        elsif customers.is_a?(Array)
+          @customers = customers.map {|c| NMIGateway::Result::Customer.new( c ) }
+        end
+      end
+    end
+
+    def responses
+      {"1" => "Transaction Approved", "2" => "Transaction Declined", "3" => "Error in transaction data or system error"}
+    end
+
+    def response_codes
+      {
+        "100" => "Transaction was approved.",
+        "200" => "Transaction was declined by processor.",
+        "201" => "Do not honor.",
+        "202" => "Insufficient funds.",
+        "203" => "Over limit.",
+        "204" => "Transaction not allowed.",
+        "220" => "Incorrect payment information.",
+        "221" => "No such card issuer.",
+        "222" => "No card number on file with issuer.",
+        "223" => "Expired card.",
+        "224" => "Invalid expiration date.",
+        "225" => "Invalid card security code.",
+        "240" => "Call issuer for further information.",
+        "250" => "Pick up card.",
+        "251" => "Lost card.",
+        "252" => "Stolen card.",
+        "253" => "Fraudulent card.",
+        "260" => "Declined with further instructions available. (See response text)",
+        "261" => "Declined-Stop all recurring payments.",
+        "262" => "Declined-Stop this recurring program.",
+        "263" => "Declined-Update cardholder data available.",
+        "264" => "Declined-Retry in a few days.",
+        "300" => "Transaction was rejected by gateway.",
+        "400" => "Transaction error returned by processor.",
+        "410" => "Invalid merchant configuration.",
+        "411" => "Merchant account is inactive.",
+        "420" => "Communication error.",
+        "421" => "Communication error with issuer.",
+        "430" => "Duplicate transaction at processor.",
+        "440" => "Processor format error.",
+        "441" => "Invalid transaction information.",
+        "460" => "Processor feature not available.",
+        "461" => "Unsupported card type."
+      }
+    end
+
+    def avs_response_codes
+      {
+        "X" => "Exact match, 9-character numeric ZIP",
+        "Y" => "Exact match, 5-character numeric ZIP",
+        "D" => "Exact match, 5-character numeric ZIP",
+        "M" => "Exact match, 5-character numeric ZIP",
+        "A" => "Address match only",
+        "B" => "Address match only",
+        "W" => "9-character numeric ZIP match only",
+        "Z" => "5-character ZIP match only",
+        "P" => "5-character ZIP match only",
+        "L" => "5-character ZIP match only",
+        "N" => "No address or ZIP match only",
+        "C" => "No address or ZIP match only",
+        "U" => "Address unavailable",
+        "G" => "Non-U.S. issuer does not participate",
+        "I" => "Non-U.S. issuer does not participate",
+        "R" => "Issuer system unavailable",
+        "E" => "Not a mail/phone order",
+        "S" => "Service not supported",
+        "O" => "AVS not available"
+      }
+    end
+
+    def cvv_response_codes
+      {
+        "M" => "CVV2/CVC2 match",
+        "N" => "CVV2/CVC2 no match",
+        "P" => "Not processed",
+        "S" => "Merchant has indicated that CVV2/CVC2 is not present on card",
+        "U" => "Issuer is not certified and/or has not provided Visa encryption keys"
+      }
+    end
+
+  end
+end

data/lib/nmi_gateway/result/action.rb

@@ -0,0 +1,38 @@
+module NMIGateway
+  module Result
+    class Action < Data
+
+      attr_accessor :amount, :action_type, :date, :success, :ip_address, :source, :username, :response_text, :batch_id, :processor_batch_id, :response_code, :processor_response_text, :processor_response_code, :device_license_number, :device_nickname
+
+      attr_accessor
+
+      def initialize(action)
+        set_attributes(action)
+        $actions ||= []
+        $actions << action.keys
+      end
+
+      private
+
+      def set_attributes(action)
+        @amount                  = action["amount"]
+        @action_type             = action["action_type"]
+        @date                    = action["date"]
+        @success                 = action["success"]
+        @ip_address              = action["ip_address"]
+        @source                  = action["source"]
+        @username                = action["username"]
+        @response_text           = action["response_text"]
+        @batch_id                = action["batch_id"]
+        @processor_batch_id      = action["processor_batch_id"]
+        @response_code           = action["response_code"]
+        @processor_response_text = action["processor_response_text"]
+        @processor_response_code = action["processor_response_code"]
+        @device_license_number   = action["device_license_number"]
+        @device_nickname         = action["device_nickname"]
+
+      end
+
+    end
+  end
+end

data/lib/nmi_gateway/result/customer.rb

@@ -0,0 +1,63 @@
+module NMIGateway
+  module Result
+    class Customer < Data
+
+      attr_accessor :id, :first_name, :last_name, :address_1, :address_2, :company, :city, :state, :postal_code, :country, :email, :phone, :fax, :cell_phone, :customertaxid, :website, :shipping_first_name, :shipping_last_name, :shipping_address_1, :shipping_address_2, :shipping_company, :shipping_city, :shipping_state, :shipping_postal_code, :shipping_country, :shipping_email, :shipping_carrier, :tracking_number, :shipping_date, :shipping, :cc_number, :cc_hash, :cc_exp, :cc_start_date, :cc_issue_number, :check_account, :check_hash, :check_aba, :check_name, :account_holder_type, :account_type, :sec_code, :processor_id, :cc_bin, :customer_vault_id
+
+
+      def initialize(customer)
+        set_attributes(customer)
+      end
+
+      private
+      def set_attributes(customer)
+        @id                   = customer["id"]
+        @first_name           = customer["first_name"]
+        @last_name            = customer["last_name"]
+        @address_1            = customer["address_1"]
+        @address_2            = customer["address_2"]
+        @company              = customer["company"]
+        @city                 = customer["city"]
+        @state                = customer["state"]
+        @postal_code          = customer["postal_code"]
+        @country              = customer["country"]
+        @email                = customer["email"]
+        @phone                = customer["phone"]
+        @fax                  = customer["fax"]
+        @cell_phone           = customer["cell_phone"]
+        @customertaxid        = customer["customertaxid"]
+        @website              = customer["website"]
+        @shipping_first_name  = customer["shipping_first_name"]
+        @shipping_last_name   = customer["shipping_last_name"]
+        @shipping_address_1   = customer["shipping_address_1"]
+        @shipping_address_2   = customer["shipping_address_2"]
+        @shipping_company     = customer["shipping_company"]
+        @shipping_city        = customer["shipping_city"]
+        @shipping_state       = customer["shipping_state"]
+        @shipping_postal_code = customer["shipping_postal_code"]
+        @shipping_country     = customer["shipping_country"]
+        @shipping_email       = customer["shipping_email"]
+        @shipping_carrier     = customer["shipping_carrier"]
+        @tracking_number      = customer["tracking_number"]
+        @shipping_date        = customer["shipping_date"]
+        @shipping             = customer["shipping"]
+        @cc_number            = customer["cc_number"]
+        @cc_hash              = customer["cc_hash"]
+        @cc_exp               = customer["cc_exp"]
+        @cc_start_date        = customer["cc_start_date"]
+        @cc_issue_number      = customer["cc_issue_number"]
+        @check_account        = customer["check_account"]
+        @check_hash           = customer["check_hash"]
+        @check_aba            = customer["check_aba"]
+        @check_name           = customer["check_name"]
+        @account_holder_type  = customer["account_holder_type"]
+        @account_type         = customer["account_type"]
+        @sec_code             = customer["sec_code"]
+        @processor_id         = customer["processor_id"]
+        @cc_bin               = customer["cc_bin"]
+        @customer_vault_id    = customer["customer_vault_id"]
+      end
+
+    end
+  end
+end

data/lib/nmi_gateway/result/transaction.rb

@@ -0,0 +1,74 @@
+
+
+module NMIGateway
+  module Result
+    class Transaction < Data
+
+      attr_accessor :transaction_id, :partial_payment_id, :partial_payment_balance, :platform_id, :transaction_type, :condition, :order_id, :authorization_code, :ponumber, :order_description, :first_name, :last_name, :address_1, :address_2, :company, :city, :state, :postal_code, :country, :email, :phone, :fax, :cell_phone, :customertaxid, :customerid, :website, :shipping_first_name, :shipping_last_name, :shipping_address_1, :shipping_address_2, :shipping_company, :shipping_city, :shipping_state, :shipping_postal_code, :shipping_country, :shipping_email, :shipping_carrier, :tracking_number, :shipping_date, :shipping, :shipping_phone, :cc_number, :cc_hash, :cc_exp, :cavv, :actions
+
+      def initialize(transaction)
+        set_attributes(transaction)
+      end
+
+      private
+
+      def set_attributes(transaction)
+        @transaction_id          = transaction["transaction_id"]
+        @partial_payment_id      = transaction["partial_payment_id"]
+        @partial_payment_balance = transaction["partial_payment_balance"]
+        @platform_id             = transaction["platform_id"]
+        @transaction_type        = transaction["transaction_type"]
+        @condition               = transaction["condition"]
+        @order_id                = transaction["order_id"]
+        @authorization_code      = transaction["authorization_code"]
+        @ponumber                = transaction["ponumber"]
+        @order_description       = transaction["order_description"]
+        @first_name              = transaction["first_name"]
+        @last_name               = transaction["last_name"]
+        @address_1               = transaction["address_1"]
+        @address_2               = transaction["address_2"]
+        @company                 = transaction["company"]
+        @city                    = transaction["city"]
+        @state                   = transaction["state"]
+        @postal_code             = transaction["postal_code"]
+        @country                 = transaction["country"]
+        @email                   = transaction["email"]
+        @phone                   = transaction["phone"]
+        @fax                     = transaction["fax"]
+        @cell_phone              = transaction["cell_phone"]
+        @customertaxid           = transaction["customertaxid"]
+        @customerid              = transaction["customerid"]
+        @website                 = transaction["website"]
+        @shipping_first_name     = transaction["shipping_first_name"]
+        @shipping_last_name      = transaction["shipping_last_name"]
+        @shipping_address_1      = transaction["shipping_address_1"]
+        @shipping_address_2      = transaction["shipping_address_2"]
+        @shipping_company        = transaction["shipping_company"]
+        @shipping_city           = transaction["shipping_city"]
+        @shipping_state          = transaction["shipping_state"]
+        @shipping_postal_code    = transaction["shipping_postal_code"]
+        @shipping_country        = transaction["shipping_country"]
+        @shipping_email          = transaction["shipping_email"]
+        @shipping_carrier        = transaction["shipping_carrier"]
+        @tracking_number         = transaction["tracking_number"]
+        @shipping_date           = transaction["shipping_date"]
+        @shipping                = transaction["shipping"]
+        @shipping_phone          = transaction["shipping_phone"]
+        @cc_number               = transaction["cc_number"]
+        @cc_hash                 = transaction["cc_hash"]
+        @cc_exp                  = transaction["cc_exp"]
+        @cavv                    = transaction["cavv"]
+        set_actions(transaction["action"])
+      end
+
+      def set_actions(actions)
+        if actions.is_a?(Hash)
+          @actions = [ NMIGateway::Result::Action.new( actions ) ]
+        elsif actions.is_a?(Array)
+          @actions = actions.map {|c| NMIGateway::Result::Action.new( c ) }
+        end if actions.present?
+      end
+
+    end
+  end
+end

data/lib/nmi_gateway/transaction.rb

@@ -0,0 +1,110 @@
+module NMIGateway
+  class Transaction < Api
+
+    # NMIGateway::Transaction.new.sale ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.sale payment_token: 'abc123', first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.sale customer_vault_id: '123456789', amount: 22.30
+    def sale(options = {})
+      query = set_query(options)
+      query[:type] = 'sale'
+      if query[:customer_vault_id]
+        require_fields(:customer_vault_id, :amount)
+      elsif query[:payment_token]
+        require_fields(:payment_token, :first_name, :last_name, :email, :amount)
+      else
+        require_fields(:ccnumber, :ccexp, :first_name, :last_name, :email, :amount)
+      end
+      post query
+    end
+
+    # NMIGateway::Transaction.new.authorize ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.25, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.authorize payment_token: 'abc123', first_name: "John", last_name: "Doe", amount: 22.25, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.authorize customer_vault_id: '123456789', amount: 22.25
+    def authorize(options = {})
+      query = set_query(options)
+      query[:type] = 'auth'
+      if query[:customer_vault_id]
+        require_fields(:customer_vault_id, :amount)
+      elsif query[:payment_token]
+        require_fields(:payment_token, :first_name, :last_name, :email, :amount)
+      else
+        require_fields(:ccnumber, :ccexp, :first_name, :last_name, :email, :amount)
+      end
+      post query
+    end
+
+    # NMIGateway::Transaction.new.capture transactionid: 3261830498, amount: 22.30
+    def capture(options = {})
+      query = set_query(options)
+      query[:type] = 'capture'
+      require_fields(:transactionid, :amount )
+      post query
+    end
+
+    # NMIGateway::Transaction.new.void transactionid: 3261830498, amount: 22.30
+    def void(options = {})
+      query = set_query(options)
+      query[:type] = 'void'
+      require_fields(:transactionid)
+      post query
+    end
+
+    # NMIGateway::Transaction.new.refund transactionid: 3261844010, amount: 5
+    def refund(options = {})
+      query = set_query(options)
+      query[:type] = 'refund'
+      require_fields(:transactionid) # amount
+      post query
+    end
+
+    # NMIGateway::Transaction.new.update transactionid: 3261844010, first_name: "joe"
+    def update(options = {})
+      query = set_query(options)
+      query[:type] = 'update'
+      require_fields(:transactionid)
+      post query
+    end
+
+    # NMIGateway::Transaction.new.find transactionid: 3261844010
+    def find(options = {})
+      query = set_query(options)
+      query[:report_type] ||= 'transaction'
+      get query
+    end
+
+    # Disabled for our merchant account
+    # NMIGateway::Transaction.new.credit ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.credit payment_token: 'abc123', first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.credit customer_vault_id: '123456789', amount: 22.30
+    def credit(options = {})
+      query = set_query(options)
+      query[:type] = 'credit'
+      if query[:customer_vault_id]
+        require_fields(:customer_vault_id, :amount)
+      elsif query[:payment_token]
+        require_fields(:payment_token, :first_name, :last_name, :email, :amount)
+      else
+        require_fields(:ccnumber, :ccexp, :first_name, :last_name, :email, :amount)
+      end
+      post query
+    end
+
+    # Disabled for our merchant account
+    # NMIGateway::Transaction.new.validate ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.validate payment_token: 'abc123', first_name: "John", last_name: "Doe", email: "john@doe.com", country: "US"
+    # NMIGateway::Transaction.new.validate customer_vault_id: '123456789'
+    def validate(options = {})
+      query = set_query(options)
+      query[:type] = 'validate'
+      if query[:customer_vault_id]
+        require_fields(:customer_vault_id)
+      elsif query[:payment_token]
+        require_fields(:payment_token, :first_name, :last_name, :email)
+      else
+        require_fields(:ccnumber, :ccexp, :first_name, :last_name, :email)
+      end
+      post query
+    end
+
+  end
+end

data/lib/nmi_gateway.rb

@@ -0,0 +1,29 @@
+require "rubygems"
+require "active_support/all"
+require "httparty"
+require "ostruct"
+
+require "figpay_gateway/version"
+
+require "nmi_gateway/api"
+require "nmi_gateway/data"
+require "nmi_gateway/result/action"
+require "nmi_gateway/result/transaction"
+require "nmi_gateway/result/customer"
+require "nmi_gateway/customer_vault"
+
+require "nmi_gateway/error"
+require "nmi_gateway/recurring"
+require "nmi_gateway/response"
+require "nmi_gateway/transaction"
+
+module FigpayGateway
+  # Expose NMIGateway classes under the FigpayGateway namespace
+  Api = NMIGateway::Api
+  Transaction = NMIGateway::Transaction
+  CustomerVault = NMIGateway::CustomerVault
+  Recurring = NMIGateway::Recurring
+  Response = NMIGateway::Response
+  Error = NMIGateway::Error
+  Data = NMIGateway::Data
+end