rails-gp-webpay 0.1.0

data/lib/gp_webpay/http/verify_card.rb

@@ -0,0 +1,18 @@
+##
+# Service object creates request data for GP Webpay CARD_VERIFICATION operation.
+
+module GpWebpay
+  module Http
+    class VerifyCard < BaseSignedRequest
+      def initialize(attributes, locale, merchant_number: nil, url_attributes: {})
+        super(attributes, locale, 'CARD_VERIFICATION', merchant_number: merchant_number, url_attributes: url_attributes)
+      end
+
+      protected
+
+      def callback_url
+        GpWebpay::Engine.routes.url_helpers.gp_webpay_cards_path({ merchant_number: config.merchant_number, locale: locale }.merge(url_attributes))
+      end
+    end
+  end
+end

data/lib/gp_webpay/openssl_security.rb

@@ -0,0 +1,16 @@
+module GpWebpay
+  module OpensslSecurity
+    def self.generate_digest(configuration, digest_text)
+      private_pem = OpenSSL::PKey::RSA.new(configuration.merchant_pem, configuration.merchant_password)
+      sign = private_pem.sign(OpenSSL::Digest.new('SHA1'), digest_text)
+      Base64.encode64(sign).gsub("\n", '')
+    end
+
+    def self.validate_digests(configuration, data)
+      public_pem = OpenSSL::X509::Certificate.new(configuration.gpe_pem).public_key
+      data.all? do |received, expected|
+        public_pem.verify(OpenSSL::Digest.new('SHA1'), Base64.decode64(received), expected)
+      end
+    end
+  end
+end

data/lib/gp_webpay/response.rb

@@ -0,0 +1,34 @@
+module GpWebpay
+  class Response
+    attr_accessor :original_response,
+                  :result_text,
+                  :token,
+                  :status,
+                  :pr_code,
+                  :sr_code,
+                  :config,
+                  :params
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(original_response:, result_text:, status:, pr_code:, sr_code:, params:, token: nil, merchant_number: nil)
+      @original_response = original_response
+      @result_text = result_text
+      @token = token
+      @status = status
+      @pr_code = pr_code
+      @sr_code = sr_code
+      @params = params
+      @merchant_number = merchant_number
+      @config = GpWebpay.config[merchant_number] || GpWebpay.config.default
+    end
+
+    # rubocop:enable Metrics/ParameterLists
+
+    def valid?
+    end
+
+    def success?
+      pr_code == '0' && sr_code == '0'
+    end
+  end
+end

data/lib/gp_webpay/service.rb

@@ -0,0 +1,15 @@
+module GpWebpay
+  class Service
+    def initialize(*)
+    end
+
+    class << self
+      ruby2_keywords def call(*args)
+        new(*args).call
+      end
+    end
+
+    def call
+    end
+  end
+end

data/lib/gp_webpay/version.rb

@@ -0,0 +1,3 @@
+module GpWebpay
+  VERSION = '0.1.0'.freeze
+end

data/lib/gp_webpay/ws/base_signed_request.rb

@@ -0,0 +1,69 @@
+##
+# Service object signs request which can be send to GP Webpay payment gateway.
+#
+# 1. Use request value object to translate attributes to correct GP Webpay format and order.
+# 2. Append generated signature to attributes. We expect that XML types are prefixed with 'ins0:' by default.
+# 3. send XML WS SOAP API request.
+# 4. generate response object:
+#    - success containing response.
+#    - http error when client-side request fails.
+#    - fail error when external server returns fault.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    class BaseSignedRequest < Service
+      attr_reader :attributes, :config
+
+      OPERATION_NAME = 'override_me'.freeze
+      REQUEST_NAME = 'override_me'.freeze
+      RESPONSE_NAME = 'override_me'.freeze
+      RESPONSE_ENTITY_NAME = 'override_me'.freeze
+      SERVICE_EXCEPTION = :service_exception
+
+      def initialize(attributes, merchant_number: :default)
+        @attributes = attributes
+        @merchant_number = merchant_number
+        @config = GpWebpay.config[@merchant_number] || GpWebpay.config.default
+        super()
+      end
+
+      def call
+        attrs = WsRequest.new(attributes.merge(provider: config.provider, merchant_number: config.merchant_number)).to_gpwebpay
+
+        res = client.call(self.class::OPERATION_NAME, message: { self.class::REQUEST_NAME => attributes_with_signature(attrs) })
+        WsResponse.from_success(res.body, self.class::RESPONSE_NAME, self.class::RESPONSE_ENTITY_NAME, config.merchant_number)
+      rescue Savon::HTTPError => e
+        rescue_from_http(e)
+      rescue Savon::SOAPFault => e
+        rescue_from_soap(e)
+      end
+
+      protected
+
+      def digest_text(attrs)
+        attrs.values.join('|')
+      end
+
+      def attributes_with_signature(attrs)
+        digest = OpensslSecurity.generate_digest(config, digest_text(attrs))
+        attrs.merge('ins0:signature' => digest)
+      end
+
+      def client
+        @client ||= Savon.client(wsdl: config.wsdl_file, endpoint: config.ws_url, pretty_print_xml: true)
+      end
+
+      def rescue_from_http(error)
+        WsResponse.from_http_error(error.to_hash, config.merchant_number)
+      end
+
+      def rescue_from_soap(error)
+        WsResponse.from_fault_error(error.to_hash, self.class::SERVICE_EXCEPTION, config.merchant_number)
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/echo.rb

@@ -0,0 +1,35 @@
+##
+# Service object checks if GP Webpay WS service is available.
+#
+# 1. Send request :echo operation to SOUP API.
+# 2. Receive answer, return true if response is present in desired format.
+# 3. Return false if
+#    - response is not in valid format.
+#    - request fails client-side.
+#    - request returns failure from server.
+#
+# @return [Boolean]  GP Webpay is available
+
+module GpWebpay
+  module Ws
+    class Echo < Service
+      attr_reader :config
+
+      def initialize
+        super
+        @config = GpWebpay.config.default
+      end
+
+      def call
+        res = client.call(:echo)
+        res.body && res.body[:echo_response].present?
+      rescue Savon::HTTPError, Savon::SOAPFault
+        false
+      end
+
+      def client
+        @client ||= Savon.client(wsdl: config.wsdl_file, endpoint: config.ws_url, pretty_print_xml: true)
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/get_master_payment_status.rb

@@ -0,0 +1,32 @@
+##
+# Service object returns current status of credit card token.
+# Should be used to keep credit card status up-to date,
+# should be called before process_token_payment to ensure card is still VERIFIED.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class GetMasterPaymentStatus < BaseSignedRequest
+        OPERATION_NAME = :get_master_payment_status
+        REQUEST_NAME = :master_payment_status_request
+        RESPONSE_NAME = :get_master_payment_status_response
+        RESPONSE_ENTITY_NAME = :master_payment_status_response
+
+        SHORTCUT_TRANSFORMATION = {
+          CR: 'CREATED',
+          PS: 'ISSUED',
+          OK: 'VERIFIED',
+          CM: 'REVOKED',
+          CI: 'DECLINED',
+          CC: 'DECLINED',
+          EC: 'EXPIRED',
+          EP: 'EXPIRED'
+        }.freeze
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/get_payment_status.rb

@@ -0,0 +1,19 @@
+##
+# Service object returns current status of payment.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class GetPaymentStatus < BaseSignedRequest
+        OPERATION_NAME = :get_payment_status
+        REQUEST_NAME = :payment_status_request
+        RESPONSE_NAME = :get_payment_status_response
+        RESPONSE_ENTITY_NAME = :payment_status_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/get_token_status.rb

@@ -0,0 +1,21 @@
+##
+# Service object returns current status of credit card token.
+# Should be used to keep credit card status up-to date,
+# should be called before process_token_payment to ensure card is still VERIFIED.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class GetTokenStatus < BaseSignedRequest
+        OPERATION_NAME = :get_token_status
+        REQUEST_NAME = :token_status_request
+        RESPONSE_NAME = :get_token_status_response
+        RESPONSE_ENTITY_NAME = :token_status_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_cancel_capture.rb

@@ -0,0 +1,20 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessCancelCapture < BaseSignedRequest
+        OPERATION_NAME = :process_authorization_reverse
+        REQUEST_NAME = :authorization_reverse_request
+        RESPONSE_NAME = :process_authorization_reverse_response
+        RESPONSE_ENTITY_NAME = :authorization_reverse_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_capture_reverse.rb

@@ -0,0 +1,20 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessCaptureReverse < BaseSignedRequest
+        OPERATION_NAME = :process_capture_reverse
+        REQUEST_NAME = :capture_reverse_request
+        RESPONSE_NAME = :process_capture_reverse_response
+        RESPONSE_ENTITY_NAME = :capture_reverse_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_card_on_file_payment.rb

@@ -0,0 +1,40 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessCardOnFilePayment < BaseSignedRequest
+        OPERATION_NAME = :process_card_on_file_payment
+        REQUEST_NAME = :card_on_file_payment_request
+        RESPONSE_NAME = :process_card_on_file_payment_response
+        RESPONSE_ENTITY_NAME = :card_on_file_payment_response
+        SERVICE_EXCEPTION = :card_on_file_payment_service_exception
+
+        def rescue_from_soap(exception)
+          response = WsResponse.from_fault_error(exception.to_hash, self.class::SERVICE_EXCEPTION, config.merchant_number)
+
+          if response.valid? && response.params[:authentication_link].present?
+            raise GpWebpayConfirmationRequired.new('GP Webpay requires authentication', response.params[:authentication_link])
+          else
+            response
+          end
+        end
+
+        class GpWebpayConfirmationRequired < GpWebpay::Error
+          attr_reader :authentication_link
+
+          def initialize(msg = nil, authentication_link = nil)
+            super(msg)
+            @authentication_link = authentication_link
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_master_payment_revoke.rb

@@ -0,0 +1,20 @@
+##
+# Service object changes credit card token status to "REVOKED".
+# Should be used when user decides to remove card from system.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessMasterPaymentRevoke < BaseSignedRequest
+        OPERATION_NAME = :process_master_payment_revoke
+        REQUEST_NAME = :master_payment_revoke_request
+        RESPONSE_NAME = :process_master_payment_revoke_response
+        RESPONSE_ENTITY_NAME = :master_payment_status_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_recurring_payment.rb

@@ -0,0 +1,20 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessRecurringPayment < BaseSignedRequest
+        OPERATION_NAME = :process_recurring_payment
+        REQUEST_NAME = :recurring_payment_request
+        RESPONSE_NAME = :process_recurring_payment_response
+        RESPONSE_ENTITY_NAME = :recurring_payment_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_refund_payment.rb

@@ -0,0 +1,20 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessRefundPayment < BaseSignedRequest
+        OPERATION_NAME = :process_refund
+        REQUEST_NAME = :refund_request
+        RESPONSE_NAME = :process_refund_response
+        RESPONSE_ENTITY_NAME = :refund_request_response
+      end
+    end
+  end
+end

data/lib/gp_webpay/ws/services/process_token_payment.rb

@@ -0,0 +1,26 @@
+##
+# Service object creates fast payment without need of leaving user from Wilio web / app.
+# It uses VERIFIED credit card token to skip filling card again and 3D secure step.
+#
+# @param [Hash] attributes for GP Webpay
+#
+# @return [GpwebpayWsResponse] response value object
+
+module GpWebpay
+  module Ws
+    module Services
+      class ProcessTokenPayment < BaseSignedRequest
+        OPERATION_NAME = :process_token_payment
+        REQUEST_NAME = :token_payment_request
+        RESPONSE_NAME = :process_token_payment_response
+        RESPONSE_ENTITY_NAME = :token_payment_response
+        SERVICE_EXCEPTION = :payment_service_exception
+
+        def initialize(attributes)
+          super
+          @attributes = attributes.except(:return_url)
+        end
+      end
+    end
+  end
+end