vantiv 0.3.0 → 1.0.0

data/lib/vantiv/api/request_body_representer.rb

@@ -0,0 +1,54 @@
+require 'representable/json'
+require 'vantiv/api/card'
+require 'vantiv/api/transaction'
+require 'vantiv/api/payment_account'
+require 'vantiv/api/address'
+
+class RequestBodyRepresenter < Representable::Decorator
+  include Representable::JSON
+
+  nested :Credentials do
+    property :merchant_id, as: :AcceptorID
+  end
+
+  nested :Reports do
+    property :report_group, as: :ReportGroup
+  end
+
+  nested :Application do
+    property :application_id, as: :ApplicationID
+  end
+
+  property :transaction, as: :Transaction, class: Vantiv::Api::Transaction do
+    property :id, as: :TransactionID
+    property :order_id, as: :ReferenceNumber
+    property :amount, as: :TransactionAmount
+    property :order_source, as: :OrderSource
+    property :customer_id, as: :CustomerID
+    property :partial_approved_flag, as: :PartialApprovedFlag
+  end
+
+  property :card, as: :Card, class: Vantiv::Api::Card do
+    property :card_number, as: :CardNumber
+    property :account_number, as: :AccountNumber
+    property :expiry_month, as: :ExpirationMonth
+    property :expiry_year, as: :ExpirationYear
+    property :cvv, as: :CVV
+    property :type, as: :Type
+    property :paypage_registration_id, as: :PaypageRegistrationID
+  end
+
+  property :payment_account, as: :PaymentAccount, class: Vantiv::Api::PaymentAccount do
+    property :id, as: :PaymentAccountID
+  end
+
+  property :address, as: :Address, class: Vantiv::Api::Address do
+    property :billing_name, as: :BillingName
+    property :billing_address_1, as: :BillingAddress1
+    property :billing_address_2, as: :BillingAddress2
+    property :billing_city, as: :BillingCity
+    property :billing_state, as: :BillingState
+    property :billing_zipcode, as: :BillingZipcode
+    property :billing_country, as: :BillingCountry
+  end
+end

data/lib/vantiv/api/request_body_representer_xml.rb

@@ -0,0 +1,19 @@
+require 'vantiv/api/transaction'
+require 'vantiv/api/request_body'
+require 'vantiv/api/transaction_request_representer_xml'
+
+class RequestBodyRepresenterXml < Representable::Decorator
+  include Representable::XML
+  self.representation_wrap = :litleOnlineRequest
+
+  property :version, attribute: true
+  property :xmlns, attribute: true
+  property :merchant_id, as: :merchantId, attribute: true
+
+  property :authentication, class: Vantiv::Api::Authentication, as: :authentication do
+    property :user
+    property :password
+  end
+
+  property :transaction, class: Vantiv::Api::Transaction, decorator: TransactionRequestRepresenterXml
+end

data/lib/vantiv/api/response.rb

@@ -1,60 +1,40 @@
+require "forwardable"
+
 module Vantiv
   module Api
     class Response
-      attr_reader :httpok, :http_response_code, :body
+      extend Forwardable
 
-      def load(httpok:, http_response_code:, body:)
-        @httpok = httpok
-        @http_response_code = http_response_code
-        @body = body
-      end
+      attr_accessor :httpok, :http_response_code, :body, :raw_body
 
-      # Only returned by cert API?
-      def request_id
-        body["RequestID"]
-      end
+      def_delegators :litle_transaction_response, :message, :response_code, :transaction_id
 
       def api_level_failure?
         !httpok || litle_response_has_error?
       end
 
-      def message
-        litle_transaction_response["message"]
-      end
-
       def error_message
         api_level_failure? ? api_level_error_message : message
       end
 
-      def response_code
-        litle_transaction_response["response"]
-      end
-
-      def transaction_id
-        litle_transaction_response["TransactionID"]
-      end
-
       private
 
       def litle_response_has_error?
+        body.response == "3" ||
         # NOTE: this kind of sucks, but at the commit point, the DevHub
         #   Api sometimes gives 200OK when litle had a parse issue and returns
         #   'Error validating xml data...' instead of an actual error
-        !!@body["litleOnlineResponse"]["@message"].match(/error/i)
+        !!body.body_message.match(/error/i)
       end
 
       def api_level_error_message
-        body["errormsg"]
+        "API level error"
       end
 
       attr_reader :transaction_response_name
 
-      def litle_response
-        api_level_failure? ? {} : body["litleOnlineResponse"]
-      end
-
       def litle_transaction_response
-        api_level_failure? ? {} : litle_response[transaction_response_name]
+        api_level_failure? ? TransactionResponse.new : body.send(transaction_response_name)
       end
     end
   end

data/lib/vantiv/api/response_body.rb

@@ -0,0 +1,12 @@
+module Vantiv
+  module Api
+    class ResponseBody
+      attr_writer :message, :response_code
+
+      attr_accessor :body_message, :response, :version, :request_id
+
+      attr_accessor :authorization_response, :sale_response, :credit_response, :void_response,
+                    :auth_reversal_response, :capture_response, :register_token_response
+    end
+  end
+end

data/lib/vantiv/api/response_body_representer.rb

@@ -0,0 +1,23 @@
+require 'representable/json'
+require 'vantiv/api/transaction_response_representer'
+require 'vantiv/api/response'
+
+class ResponseBodyRepresenter < Representable::Decorator
+  include Representable::JSON
+
+  nested :litleOnlineResponse do
+    property :body_message, as: :@message
+    property :response, as: :@response
+    property :version, as: :@version
+
+    property :authorization_response, as: :authorizationResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :sale_response, as: :saleResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :credit_response, as: :creditResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :void_response, as: :voidResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :auth_reversal_response, as: :authReversalResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :capture_response, as: :captureResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+    property :register_token_response, as: :registerTokenResponse, decorator: TransactionResponseRepresenter, class: Vantiv::Api::TransactionResponse
+  end
+
+  property :request_id, as: :RequestID
+end

data/lib/vantiv/api/response_body_representer_xml.rb

@@ -0,0 +1,25 @@
+require 'vantiv/api/transaction_response_representer_xml'
+require 'vantiv/api/response'
+
+class ResponseBodyRepresenterXml < Representable::Decorator
+  include Representable::XML
+
+  self.representation_wrap = :litleOnlineResponse
+  remove_namespaces!
+
+  property :body_message, as: :@message
+  property :response, as: :@response
+  property :version, as: :@version
+
+  property :authorization_response, as: :authorizationResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+  property :sale_response, as: :saleResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+  property :credit_response, as: :creditResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+  property :void_response, as: :voidResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+  property :auth_reversal_response, as: :authReversalResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+  property :capture_response, as: :captureResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+
+  property :register_token_response, as: :registerTokenResponse, decorator: TransactionResponseRepresenterXml, class: Vantiv::Api::TransactionResponse
+
+
+  property :request_id, as: :RequestID
+end

data/lib/vantiv/api/tied_transaction_response.rb

@@ -6,11 +6,11 @@ module Vantiv
       }.freeze
 
       TIED_TRANSACTION_RESPONSE_NAMES = {
-        auth_reversal: 'authReversalResponse',
-        capture: "captureResponse",
-        credit: "creditResponse",
-        return: "creditResponse",
-        void: "voidResponse"
+        auth_reversal: 'auth_reversal_response',
+        capture: "capture_response",
+        credit: "credit_response",
+        return: "credit_response",
+        void: "void_response"
       }
 
       def initialize(transaction_name)

data/lib/vantiv/api/tokenization_response.rb

@@ -1,6 +1,10 @@
+require "forwardable"
+
 module Vantiv
   module Api
     class TokenizationResponse < Api::Response
+      extend Forwardable
+
       RESPONSE_CODES = {
         account_successfully_registered: '801',
         account_already_registered: '802',
@@ -14,6 +18,12 @@ module Vantiv
         generic_token_use_error: '899'
       }.freeze
 
+      def_delegators :litle_transaction_response, :payment_account_id
+
+      def card_type
+        litle_transaction_response.type
+      end
+
       def success?
         !api_level_failure? && tokenization_successful?
       end
@@ -22,18 +32,14 @@ module Vantiv
         !success?
       end
 
-      def payment_account_id
-        success? ? litle_transaction_response["PaymentAccountID"] : nil
-      end
-
-      def card_type
-        success? ? litle_transaction_response["Type"] : nil
-      end
-
       def invalid_card_number?
         response_code == RESPONSE_CODES[:credit_card_number_invalid]
       end
 
+      def apple_pay
+        @apple_pay ||=
+          litle_transaction_response.apple_pay_response || ApplePayResponse.new
+      end
       private
 
       def tokenization_successful?
@@ -42,7 +48,7 @@ module Vantiv
       end
 
       def transaction_response_name
-        "registerTokenResponse"
+        "register_token_response"
       end
     end
   end

data/lib/vantiv/api/transaction.rb

@@ -0,0 +1,42 @@
+module Vantiv
+  module Api
+    class Transaction
+      attr_accessor :id, :order_id, :customer_id, :order_source, :partial_approved_flag,
+                    :amount_in_cents, :report_group, :card, :type, :application_id, :address,
+                    :cardholder_authentication
+
+      def initialize(id: nil, amount_in_cents: nil, order_id: nil, customer_id: nil,
+        partial_approved_flag: nil, order_source: nil,  cardholder_authentication: nil)
+        @id = id
+        @amount_in_cents = amount_in_cents
+        @order_id = order_id
+        @customer_id = customer_id
+        @partial_approved_flag = partial_approved_flag
+        @order_source = order_source
+        @cardholder_authentication = cardholder_authentication
+      end
+
+      def amount
+        format_cents_to_decimal(@amount_in_cents) if @amount_in_cents
+      end
+
+      def amount=(value)
+        @amount_in_cents = decimal_string_to_cents(value)
+      end
+
+      def order_id
+        @order_id.to_s if @order_id
+      end
+
+      private
+
+      def decimal_string_to_cents(string)
+        (string.to_f * 100.0).to_i
+      end
+
+      def format_cents_to_decimal(cents)
+        '%.2f' % (cents / 100.0)
+      end
+    end
+  end
+end

data/lib/vantiv/api/transaction_request_representer_xml.rb

@@ -0,0 +1,57 @@
+class TransactionRequestRepresenterXml < Representable::Decorator
+  include Representable::XML
+
+  self.representation_wrap = ->(_) { type }
+
+  property :application_id, as: :id, attribute: true
+  property :id, as: :litleTxnId
+  property :report_group, as: :reportGroup, attribute: true
+  property :customer_id, as: :customerId, attribute: true
+  property :order_id, as: :orderId
+  property :amount_in_cents, as: :amount
+  property :order_source, as: :orderSource
+
+  property :address, class: Vantiv::Api::Address do
+    self.representation_wrap = :billToAddress
+
+    property :billing_name, as: :name
+    property :billing_address_1, as: :addressLine1
+    property :billing_address_2, as: :addressLine2
+    property :billing_city, as: :city
+    property :billing_state, as: :state
+    property :billing_zipcode, as: :zip
+    property :billing_country, as: :country
+  end
+
+  property :card, class: Vantiv::Api::Card, if: ->(_) { type != :registerTokenRequest && !card&.paypage_registration_id } do
+    self.representation_wrap = ->(_) { !!payment_account_id ? :token : :card }
+
+    property :type
+    property :card_number, as: :number
+    property :account_number, as: :number
+    property :payment_account_id, as: :litleToken
+    property :expDate,
+             getter: ->(represented:, **) { represented.expiry_month.to_s + represented.expiry_year.to_s },
+             if: ->(_) { expiry_month && expiry_year }
+    property :cvv, as: :cardValidationNum
+  end
+
+  property :accountNumber,
+           if: ->(_) { type == :registerTokenRequest },
+           getter: ->(represented:, **) { represented.card&.account_number }
+
+  property :cardValidationNum,
+           if: ->(_) { type == :registerTokenRequest },
+           getter: ->(represented:, **) { represented.card&.cvv }
+
+  property :paypageRegistrationId,
+           getter: ->(represented:, **) { represented.card&.paypage_registration_id }
+
+  property :cardholder_authentication, class: Vantiv::Api::CardholderAuthentication do
+    self.representation_wrap = :cardholderAuthentication
+
+    property :authentication_value, as: :authenticationValue
+  end
+
+  property :partial_approved_flag, as: :allowPartialAuth
+end

data/lib/vantiv/api/transaction_response.rb

@@ -0,0 +1,9 @@
+module Vantiv
+  module Api
+    class TransactionResponse
+      attr_accessor :message, :response_code, :transaction_id, :response_time, :id, :report_group, :payment_account_id,
+                    :post_date, :type, :bin, :auth_code, :customer_id, :order_id, :token_response_code, :token_message,
+                    :fraud_result, :account_updater, :token_response, :apple_pay_response
+    end
+  end
+end

data/lib/vantiv/api/transaction_response_representer.rb

@@ -0,0 +1,64 @@
+require 'representable/json'
+require 'vantiv/api/account_updater_response'
+require 'vantiv/api/apple_pay_response'
+
+class TransactionResponseRepresenter < Representable::Decorator
+  include Representable::JSON
+
+  property :auth_code, as: :authCode
+  property :customer_id, as: :@customerId
+  property :order_id, as: :orderId
+
+  property :response_code, as: :response
+  property :response_time, as: :responseTime
+  property :post_date, as: :postDate
+  property :id, as: :@id
+
+  property :fraud_result, as: :fraudResult, class: Vantiv::Api::FraudResult do
+    property :avs_result, as: :avsResult
+    property :card_validation_result, as: :cardValidationResult
+  end
+
+  property :message
+  property :report_group, as: :@reportGroup
+  property :transaction_id, as: :TransactionID
+
+  property :token_response_code, as: :tokenResponseCode
+  property :token_message, as: :tokenMessage
+  property :type, as: :Type
+  property :bin
+  property :payment_account_id, as: :PaymentAccountID
+
+  property :account_updater, as: :accountUpdater, class: Vantiv::Api::AccountUpdaterResponse do
+    property :original_card_token_info, as: :originalCardTokenInfo, class: Vantiv::Api::CardTokenInfo do
+      property :bin
+      property :card_type, as: :Type
+      property :payment_account_id, as: :PaymentAccountID
+      property :expiry_month, as: :ExpirationMonth
+      property :expiry_year, as: :ExpirationYear
+    end
+
+    property :new_card_token_info, as: :newCardTokenInfo, class: Vantiv::Api::CardTokenInfo do
+      property :bin
+      property :card_type, as: :Type
+      property :payment_account_id, as: :PaymentAccountID
+      property :expiry_month, as: :ExpirationMonth
+      property :expiry_year, as: :ExpirationYear
+    end
+
+    property :extended_card_response, as: :extendedCardResponse, class: Vantiv::Api::ExtendedCardResponse do
+      property :code
+      property :message
+    end
+  end
+
+  property :token_response, as: :tokenResponse, class: Vantiv::Api::CardTokenInfo do
+    property :bin
+    property :card_type, as: :Type
+    property :payment_account_id, as: :PaymentAccountID
+  end
+
+  property :apple_pay_response, as: :applepayResponse, class: Vantiv::Api::ApplePayResponse do
+    property :online_payment_cryptogram, as: :onlinePaymentCryptogram
+  end
+end