payneteasy-payneteasyapi 0.1.0

data/lib/paynet_easy/paynet_easy_api/payment_processor.rb

@@ -0,0 +1,251 @@
+require 'payment_data/payment_transaction'
+require 'query/query_factory'
+require 'query/prototype/query'
+require 'callback/callback_factory'
+require 'callback/callback_prototype'
+require 'transport/gateway_client'
+require 'transport/request'
+require 'transport/response'
+require 'transport/callback_response'
+
+module PaynetEasy::PaynetEasyApi
+  class PaymentProcessor
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Transport
+    include PaynetEasy::PaynetEasyApi::Query
+    include PaynetEasy::PaynetEasyApi::Callback
+
+    # Payment changed and should be saved
+    HANDLER_SAVE_CHANGES      = 'save_payment'
+
+    # Payment status not changed and should be updated
+    HANDLER_STATUS_UPDATE     = 'status_update'
+
+    # Html received and should be displayed
+    HANDLER_SHOW_HTML         = 'show_html'
+
+    # Redirect url received, customer should be to it
+    HANDLER_REDIRECT          = 'redirect'
+
+    # Payment processing ended
+    HANDLER_FINISH_PROCESSING = 'finish_processing'
+
+    # Exception handle needed
+    HANDLER_CATCH_EXCEPTION   = 'catch_exception'
+
+    # Allowed handlers list
+    @@allowed_handlers =
+    [
+      HANDLER_SAVE_CHANGES,
+      HANDLER_STATUS_UPDATE,
+      HANDLER_SHOW_HTML,
+      HANDLER_REDIRECT,
+      HANDLER_FINISH_PROCESSING,
+      HANDLER_CATCH_EXCEPTION
+    ]
+
+    attr_accessor :gateway_client
+    attr_accessor :query_factory
+    attr_accessor :callback_factory
+
+    def initialize(handlers = {})
+      @handlers = {}
+      set_handlers handlers
+    end
+
+    # Executes payment API query
+    #
+    # @param    query_name            [String]                Payment API query name
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for processing
+    #
+    # @return                         [Response]              Query response
+    def execute_query(query_name, payment_transaction)
+      query = query(query_name)
+
+      begin
+        request = query.create_request payment_transaction
+        response = make_request request
+        query.process_response payment_transaction, response
+      rescue Exception => error
+        handle_exception error, payment_transaction, response
+        return
+      end
+
+      handle_query_result payment_transaction, response
+
+      response
+    end
+
+    # Executes payment gateway processor for customer return from payment form or 3D-auth
+    #
+    # @param    callback_response     [CallbackResponse]      Callback object with data from payment gateway
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for processing
+    #
+    # @return                         [CallbackResponse]      Validated payment gateway callback
+    def process_customer_return(callback_response, payment_transaction)
+      callback_response.type = 'customer_return'
+      process_paynet_easy_callback callback_response, payment_transaction
+    end
+
+    # Executes payment gateway processor for PaynetEasy payment callback
+    #
+    # @param    callback_response     [CallbackResponse]      Callback object with data from payment gateway
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for processing
+    #
+    # @return                         [CallbackResponse]      Validated payment gateway callback
+    def process_paynet_easy_callback(callback_response, payment_transaction)
+      begin
+        callback(callback_response.type).process_callback(payment_transaction, callback_response)
+      rescue Exception => error
+        handle_exception error, payment_transaction, callback_response
+        return
+      end
+
+      handle_query_result payment_transaction, callback_response
+
+      callback_response
+    end
+
+    # Create API query object by API query method
+    #
+    # @param    api_query_name    [String]              API query method
+    #
+    # @return                     [Prototype::Query]    API query object
+    def query(api_query_name)
+      query_factory.query api_query_name
+    end
+
+    # Create API callback processor by callback response
+    #
+    # @param    callback_type   [String]              Callback response type
+    #
+    # @return                   [CallbackPrototype]   Callback processor
+    def callback(callback_type)
+      callback_factory.callback callback_type
+    end
+
+    # Make request to the PaynetEasy gateway
+    #
+    # @param    request   [Request]     Request data
+    #
+    # @return             [Response]    Response data
+    def make_request(request)
+      gateway_client.make_request request
+    end
+
+    # Set handler callback for processing action.
+    #
+    # @param    handler_name        [String]    Handler name
+    # @param    handler_callback    [Proc]      Handler callback
+    def set_handler(handler_name, &handler_callback)
+      check_handler_name handler_name
+
+      @handlers[handler_name] = handler_callback
+    end
+
+    # Set handlers. Handlers array must follow new format:
+    # {<handlerName>:String => <handlerCallback>:Proc}
+    #
+    # @param    handlers    [Hash]    Handlers callbacks
+    def set_handlers(handlers = {})
+      handlers.each {|handler_name, handler_callback| set_handler handler_name, &handler_callback}
+    end
+
+    # Remove handler for processing action
+    #
+    # @param    handler_name    [String]    Handler name
+    def remove_handler(handler_name)
+      check_handler_name handler_name
+
+      @handlers.delete handler_name
+    end
+
+    # Remove all handlers
+    def remove_handlers
+      @handlers = {}
+    end
+
+    def gateway_client
+      @gateway_client ||= GatewayClient.new
+    end
+
+    def query_factory
+      @query_factory ||= QueryFactory.new
+    end
+
+    def callback_factory
+      @callback_factory ||= CallbackFactory.new
+    end
+
+    protected
+
+    # Handle query result.
+    # Method calls handlers for:
+    #  - HANDLER_SAVE_CHANGES            always
+    #  - HANDLER_STATUS_UPDATE           if needed payment transaction status update
+    #  - HANDLER_SHOW_HTML               if needed to show response html
+    #  - HANDLER_REDIRECT                if needed to redirect to response URL
+    #  - HANDLER_FINISH_PROCESSING       if not additional action needed
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Query result
+    def handle_query_result(payment_transaction, response)
+      call_handler HANDLER_SAVE_CHANGES, payment_transaction, response
+
+      case true
+      when response.redirect_needed?
+          call_handler HANDLER_REDIRECT, response, payment_transaction
+      when response.show_html_needed?
+          call_handler HANDLER_SHOW_HTML, response, payment_transaction
+      when response.status_update_needed?
+          call_handler HANDLER_STATUS_UPDATE, response, payment_transaction
+      else
+          call_handler HANDLER_FINISH_PROCESSING, payment_transaction, response
+      end
+    end
+
+    # Handle raised exception. If configured self::HANDLER_CATCH_EXCEPTION, handler will be called,
+    # if not - exception will be raised again.
+    #
+    # @param    error                 [Exception]
+    # @param    payment_transaction   [PaymentTransaction]
+    # @param    response              [Response]
+    def handle_exception(error, payment_transaction, response = nil)
+      call_handler HANDLER_SAVE_CHANGES, payment_transaction, response
+
+      raise error unless has_handler? HANDLER_CATCH_EXCEPTION
+
+      call_handler HANDLER_CATCH_EXCEPTION, error, payment_transaction, response
+    end
+
+    # Executes handler callback.
+    # Method receives at least one parameter - handler name,
+    # all other parameters will be passed to handler callback.
+    #
+    # @param    handler_name    [String]    Handler name
+    # @param    args            [Array]     Handler parameters
+    def call_handler(handler_name, *args)
+      check_handler_name handler_name
+
+      @handlers[handler_name].(*args) if has_handler? handler_name
+    end
+
+    # Check if handler name is allowed
+    #
+    # @param    handler_name    [String]    Handler name
+    def check_handler_name(handler_name)
+      unless @@allowed_handlers.include? handler_name
+        raise RuntimeError, "Unknown handler name: '#{handler_name}'"
+      end
+    end
+
+    # True if processor has handler callback for given handler name
+    #
+    # @param    handler_name    [String]                  Handler name
+    #
+    # @return                   [TrueClass|FalseClass]    Check result
+    def has_handler?(handler_name)
+      @handlers.key? handler_name
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/paynet_easy_api.rb

@@ -0,0 +1,26 @@
+module PaynetEasy
+  module PaynetEasyApi
+    module PaymentData
+    end
+    module Callback
+    end
+    module Query
+      module Prototype
+      end
+    end
+    module Transport
+    end
+    module Util
+    end
+  end
+end
+
+require 'payment_processor'
+require 'payment_data/query_config'
+require 'payment_data/payment_transaction'
+require 'payment_data/payment'
+require 'payment_data/billing_address'
+require 'payment_data/customer'
+require 'payment_data/credit_card'
+require 'payment_data/recurrent_card'
+require 'transport/callback_response'

data/lib/paynet_easy/paynet_easy_api/query/capture_query.rb

@@ -0,0 +1,30 @@
+require 'query/prototype/payment_query'
+require 'payment_data/payment'
+require 'util/validator'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class CaptureQuery < Prototype::PaymentQuery
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Util
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['client_orderid',     'payment.client_id',             true,   Validator::ID],
+      ['orderid',            'payment.paynet_id',             true,   Validator::ID],
+      ['login',              'query_config.login',            true,   Validator::MEDIUM_STRING]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.login',
+      'payment.client_id',
+      'payment.paynet_id',
+      'payment.amount_in_cents',
+      'payment.currency',
+      'query_config.signing_key'
+    ]
+
+    @payment_status = Payment::STATUS_CAPTURE
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/create_card_ref_query.rb

@@ -0,0 +1,78 @@
+require 'query/prototype/query'
+require 'util/validator'
+require 'error/validation_error'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class CreateCardRefQuery < Prototype::Query
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Util
+    include PaynetEasy::PaynetEasyApi::Error
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['client_orderid',     'payment.client_id',             true,   Validator::ID],
+      ['orderid',            'payment.paynet_id',             true,   Validator::ID],
+      ['login',              'query_config.login',            true,   Validator::MEDIUM_STRING]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.login',
+      'payment.client_id',
+      'payment.paynet_id',
+      'query_config.signing_key'
+    ]
+
+    @response_fields_definition =
+    [
+      'type',
+      'status',
+      'card-ref-id',
+      'serial-number'
+    ]
+
+    @success_response_type = 'create-card-ref-response'
+
+    protected
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation
+    def validate_payment_transaction(payment_transaction)
+      check_payment_transaction_status payment_transaction
+      super payment_transaction
+    end
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for validating
+    def validate_response_on_success(payment_transaction, response)
+      check_payment_transaction_status payment_transaction
+      super payment_transaction, response
+    end
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for validating
+    def validate_response_on_error(payment_transaction, response)
+      check_payment_transaction_status payment_transaction
+      super payment_transaction, response
+    end
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for payment transaction updating
+    def update_payment_transaction_on_success(payment_transaction, response)
+      payment_transaction.payment.recurrent_card_from.paynet_id = response.card_paynet_id
+    end
+
+    # Check, if payment transaction is finished and payment is not new.
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation
+    def check_payment_transaction_status(payment_transaction)
+      unless payment_transaction.finished?
+        raise ValidationError, 'Only finished payment transaction can be used for create-card-ref-id'
+      end
+
+      unless payment_transaction.payment.paid?
+        raise ValidationError, "Can not use new payment for create-card-ref-id. Execute 'sale' or 'preauth' query first"
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/get_card_info_query.rb

@@ -0,0 +1,49 @@
+require 'query/prototype/query'
+require 'util/validator'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class GetCardInfoQuery < Prototype::Query
+    include PaynetEasy::PaynetEasyApi::Util
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['cardrefid',          'payment.recurrent_card_from.paynet_id',         true,    Validator::ID],
+      ['login',              'query_config.login',                            true,    Validator::MEDIUM_STRING]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.login',
+      'payment.recurrent_card_from.paynet_id',
+      'query_config.signing_key'
+    ]
+
+    @response_fields_definition =
+    [
+      'type',
+      'card-printed-name',
+      'expire-year',
+      'expire-month',
+      'bin',
+      'last-four-digits',
+      'serial-number'
+    ]
+
+    @success_response_type = 'get-card-info-response'
+
+    protected
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for payment transaction updating
+    def update_payment_transaction_on_success(payment_transaction, response)
+      recurrent_card = payment_transaction.payment.recurrent_card_from
+
+      recurrent_card.card_printed_name  = response['card-printed-name']
+      recurrent_card.expire_year        = response['expire-year']
+      recurrent_card.expire_month       = response['expire-month']
+      recurrent_card.bin                = response['bin']
+      recurrent_card.last_four_digits   = response['last-four-digits']
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/make_rebill_query.rb

@@ -0,0 +1,37 @@
+require 'query/prototype/payment_query'
+require 'payment_data/payment'
+require 'util/validator'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class MakeRebillQuery < Prototype::PaymentQuery
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Util
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['client_orderid',         'payment.client_id',                            true,    Validator::ID],
+      ['order_desc',             'payment.description',                          true,    Validator::LONG_STRING],
+      ['amount',                 'payment.amount',                               true,    Validator::AMOUNT],
+      ['currency',               'payment.currency',                             true,    Validator::CURRENCY],
+      ['ipaddress',              'payment.customer.ip_address',                  true,    Validator::IP],
+      ['cardrefid',              'payment.recurrent_card_from.paynet_id',        true,    Validator::ID],
+      ['login',                  'query_config.login',                           true,    Validator::MEDIUM_STRING],
+      # optional
+      ['comment',                'payment.comment',                              false,   Validator::MEDIUM_STRING],
+      ['cvv2',                   'payment.recurrent_card_from.cvv2',             false,   Validator::CVV2],
+      ['server_callback_url',    'query_config.callback_url',                    false,   Validator::URL]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.end_point',
+      'payment.client_id',
+      'payment.amount_in_cents',
+      'payment.recurrent_card_from.paynet_id',
+      'query_config.signing_key'
+    ]
+
+    @payment_status = Payment::STATUS_CAPTURE
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/preauth_form_query.rb

@@ -0,0 +1,10 @@
+require 'query/prototype/payment_form_query'
+require 'payment_data/payment'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class PreauthFormQuery < Prototype::PaymentFormQuery
+    include PaynetEasy::PaynetEasyApi::PaymentData
+
+    @payment_status = Payment::STATUS_PREAUTH
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/preauth_query.rb

@@ -0,0 +1,10 @@
+require 'query/sale_query'
+require 'payment_data/payment'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class PreauthQuery < SaleQuery
+    include PaynetEasy::PaynetEasyApi::PaymentData
+
+    @payment_status = Payment::STATUS_PREAUTH
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/prototype/payment_form_query.rb

@@ -0,0 +1,69 @@
+require 'query/prototype/payment_query'
+require 'util/validator'
+require 'transport/response'
+
+module PaynetEasy::PaynetEasyApi::Query::Prototype
+  class PaymentFormQuery < PaymentQuery
+    include PaynetEasy::PaynetEasyApi::Util
+    include PaynetEasy::PaynetEasyApi::Transport
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['client_orderid',         'payment.client_id',                    true,   Validator::ID],
+      ['order_desc',             'payment.description',                  true,   Validator::LONG_STRING],
+      ['amount',                 'payment.amount',                       true,   Validator::AMOUNT],
+      ['currency',               'payment.currency',                     true,   Validator::CURRENCY],
+      ['address1',               'payment.billing_address.first_line',   true,   Validator::MEDIUM_STRING],
+      ['city',                   'payment.billing_address.city',         true,   Validator::MEDIUM_STRING],
+      ['zip_code',               'payment.billing_address.zip_code',     true,   Validator::ZIP_CODE],
+      ['country',                'payment.billing_address.country',      true,   Validator::COUNTRY],
+      ['phone',                  'payment.billing_address.phone',        true,   Validator::PHONE],
+      ['ipaddress',              'payment.customer.ip_address',          true,   Validator::IP],
+      ['email',                  'payment.customer.email',               true,   Validator::EMAIL],
+      ['redirect_url',           'query_config.redirect_url',            true,   Validator::URL],
+      # optional
+      ['first_name',             'payment.customer.first_name',          false,  Validator::MEDIUM_STRING],
+      ['last_name',              'payment.customer.last_name',           false,  Validator::MEDIUM_STRING],
+      ['ssn',                    'payment.customer.ssn',                 false,  Validator::SSN],
+      ['birthday',               'payment.customer.birthday',            false,  Validator::DATE],
+      ['state',                  'payment.billing_address.state',        false,  Validator::COUNTRY],
+      ['cell_phone',             'payment.billing_address.cell_phone',   false,  Validator::PHONE],
+      ['site_url',               'query_config.site_url',                false,  Validator::URL],
+      ['server_callback_url',    'query_config.callback_url',            false,  Validator::URL]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.end_point',
+      'payment.client_id',
+      'payment.amount_in_cents',
+      'payment.customer.email',
+      'query_config.signing_key'
+    ]
+
+    @response_fields_definition =
+    [
+      'type',
+      'status',
+      'paynet-order-id',
+      'merchant-order-id',
+      'serial-number',
+      'redirect-url'
+    ]
+
+    @success_response_type = 'async-form-response'
+
+    protected
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for payment transaction updating
+    def update_payment_transaction_on_success(payment_transaction, response)
+      super payment_transaction, response
+
+      if response.has_redirect_url?
+        response.needed_action = Response::NEEDED_REDIRECT
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/query/prototype/payment_query.rb

@@ -0,0 +1,71 @@
+require 'query/prototype/query'
+require 'error/validation_error'
+
+module PaynetEasy::PaynetEasyApi::Query::Prototype
+  class PaymentQuery < Query
+    # Status for payment, when it is processing by this query
+    @payment_status = ''
+
+    @response_fields_definition =
+    [
+      'type',
+      'status',
+      'paynet-order-id',
+      'merchant-order-id',
+      'serial-number'
+    ]
+
+    @success_response_type = 'async-response'
+
+    class << self;
+      protected
+
+      # @return   [String]
+      def payment_status
+        @payment_status
+      end
+    end
+
+      # @param    payment_transaction   [PaymentTransaction]
+    #
+    # @return                         [Request]
+    def create_request(payment_transaction)
+      request = super payment_transaction
+
+      payment_transaction.payment.status  = payment_status
+      payment_transaction.processor_type  = PaymentTransaction::PROCESSOR_QUERY
+      payment_transaction.processor_name  = @api_method
+      payment_transaction.status          = PaymentTransaction::STATUS_PROCESSING
+
+      request
+    end
+
+    protected
+
+    # @param    payment_transaction   [PaymentTransaction]
+    def validate_payment_transaction(payment_transaction)
+      if payment_transaction.payment.has_processing_transaction?
+        raise ValidationError, 'Payment can not has processing payment transaction'
+      end
+
+      unless payment_transaction.new?
+        raise ValidationError, 'Payment transaction must be new'
+      end
+
+      super payment_transaction
+    end
+
+    def validate_query_definition
+      super
+
+      unless payment_status
+        raise RuntimeError, 'You must configure @payment_status'
+      end
+    end
+
+    # @return   [String]
+    def payment_status
+      self.class.instance_variable_get :@payment_status
+    end
+  end
+end