payneteasy-payneteasyapi 0.1.0

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

@@ -0,0 +1,302 @@
+require 'digest/sha1'
+require 'payment_data/payment_transaction'
+require 'util/property_accessor'
+require 'util/validator'
+require 'transport/request'
+require 'transport/response'
+require 'error/validation_error'
+
+module PaynetEasy::PaynetEasyApi::Query::Prototype
+  class Query
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Transport
+    include PaynetEasy::PaynetEasyApi::Util
+    include PaynetEasy::PaynetEasyApi::Error
+
+    # Request fields definition in format
+    # [
+    #   [<first field name>:string,  <first property path>:string,   <is field required>:boolean, <validation rule>:string],
+    #   [<second field name>:string, <second property path>:string,  <is field required>:boolean, <validation rule>:string],
+    #     ...
+    #   [<last field name>:string,   <last property path>:string,    <is field required>:boolean, <validation rule>:string]
+    # ]
+    @request_fields_definition = []
+
+    # Request control code definition in format
+    # [<first part property path>:string, <second part property path>:string ... <last part property path>:string]
+    @signature_definition = []
+
+    # Response fields definition in format:
+    # [<first field_name>:string, <second field_name>:string ... <last field_name>:string]
+    @response_fields_definition = []
+
+    # Success response type
+    @success_response_type = ''
+
+    def initialize(api_method)
+      @api_method = api_method
+    end
+
+    # Create API gateway request from payment transaction data
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for query
+    #
+    # @return                         [Request]               Request object
+    def create_request(payment_transaction)
+      validate_payment_transaction payment_transaction
+
+      request = payment_transaction_to_request payment_transaction
+
+      request.api_method  = @api_method
+      request.end_point   = payment_transaction.query_config.end_point
+      request.gateway_url = payment_transaction.query_config.gateway_url
+      request.signature   = create_signature payment_transaction
+
+      request
+    rescue Exception => error
+      payment_transaction.add_error error
+      payment_transaction.status = PaymentTransaction::STATUS_ERROR
+
+      raise error
+    end
+
+    # Process API gateway response and update payment transaction
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for update
+    # @param    response              [Response]              API gateway response
+    #
+    # @return                         [Response]              API gateway response
+    def process_response(payment_transaction, response)
+      if response.processing? || response.approved?
+        validate = :validate_response_on_success
+        update   = :update_payment_transaction_on_success
+      else
+        validate = :validate_response_on_error
+        update   = :update_payment_transaction_on_error
+      end
+
+      begin
+        send validate, payment_transaction, response
+      rescue Exception => error
+        payment_transaction.add_error error
+        payment_transaction.status = PaymentTransaction::STATUS_ERROR
+
+        raise error
+      end
+
+      send update, payment_transaction, response
+
+      if response.error?
+        raise response.error
+      end
+
+      response
+    end
+
+    protected
+
+    # Validates payment transaction before request constructing
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation
+    def validate_payment_transaction(payment_transaction)
+      validate_query_config payment_transaction
+
+      error_message   = ''
+      missed_fields   = []
+      invalid_fields  = []
+
+      request_fields_definition.each do |field_name, property_path, is_field_required, validation_rule|
+        field_value = PropertyAccessor.get_value payment_transaction, property_path, false
+
+        if field_value
+          begin
+            Validator.validate_by_rule field_value, validation_rule
+          rescue ValidationError => error
+            invalid_fields << "Field '#{field_name}' from property path '#{property_path}', #{error.message}."
+          end
+        elsif is_field_required
+          missed_fields << "Field '#{field_name}' from property path '#{property_path}' missed or empty."
+        end
+      end
+
+      unless missed_fields.empty?
+        error_message << "Some required fields missed or empty in PaymentTransaction: \n#{missed_fields.join "\n"}\n"
+      end
+
+      unless invalid_fields.empty?
+        error_message << "Some fields invalid in PaymentTransaction: \n#{invalid_fields.join "\n"}\n"
+      end
+
+      unless error_message.empty?
+        raise ValidationError, error_message
+      end
+    end
+
+    # Creates request from payment transaction
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for request constructing
+    #
+    # @return                         [Request]               Request object
+    def payment_transaction_to_request(payment_transaction)
+      request_fields = {}
+
+      request_fields_definition.each do |field_name, property_path, _|
+        field_value = PropertyAccessor.get_value payment_transaction, property_path
+
+        if field_value
+          request_fields[field_name] = field_value
+        end
+      end
+
+      Request.new request_fields
+    end
+
+    # Generates the control code is used to ensure that it is a particular
+    # Merchant (and not a fraudster) that initiates the transaction.
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction to generate control code
+    #
+    # @return                         [String]                Generated control code
+    def create_signature(payment_transaction)
+      control_code = ''
+
+      signature_definition.each do |property_path|
+        control_code << PropertyAccessor.get_value(payment_transaction, property_path).to_s
+      end
+
+      Digest::SHA1.hexdigest control_code
+    end
+
+    # Validates response before payment transaction updating
+    # if payment transaction is processing or approved
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for validating
+    def validate_response_on_success(payment_transaction, response)
+      if response.type != success_response_type
+        raise ValidationError, "Response type '#{response.type}' does " +
+                               "not match success response type '#{success_response_type}'"
+      end
+
+      missed_fields = []
+
+      response_fields_definition.each do |field_name|
+        missed_fields << field_name unless response.key? field_name
+      end
+
+      unless missed_fields.empty?
+        raise ValidationError, "Some required fields missed or empty in Response: #{missed_fields.join ', '}"
+      end
+
+      validate_client_id payment_transaction, response
+    end
+
+    # Validates response before payment transaction updating
+    # if payment transaction is not processing or approved
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for validating
+    def validate_response_on_error(payment_transaction, response)
+      unless [success_response_type, 'error', 'validation-error'].include? response.type
+        raise ValidationError, "Unknown response type '#{response.type}'"
+      end
+
+      validate_client_id payment_transaction, response
+    end
+
+    # Updates payment transaction by query response data
+    # if payment transaction is processing or approved
+    #
+    # @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.status = response.status
+      set_paynet_id payment_transaction, response
+    end
+
+    # Updates payment transaction by query response data
+    # if payment transaction is not processing or approved
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    # @param    response              [Response]              Response for payment transaction updating
+    def update_payment_transaction_on_error(payment_transaction, response)
+      if response.declined?
+        payment_transaction.status = response.status
+      else
+        payment_transaction.status = PaymentTransaction::STATUS_ERROR
+      end
+
+      payment_transaction.add_error response.error
+      set_paynet_id payment_transaction, response
+    end
+
+    # Validates payment transaction query config
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction
+    def validate_query_config(payment_transaction)
+      unless payment_transaction.query_config.signing_key
+        raise ValidationError, "Property 'signingKey' does not defined in PaymentTransaction property 'queryConfig'"
+      end
+    end
+
+    # Validates query object definition
+    def validate_query_definition
+      raise RuntimeError, 'You must configure @request_fields_definition'  if request_fields_definition.empty?
+      raise RuntimeError, 'You must configure @signature_definition'       if signature_definition.empty?
+      raise RuntimeError, 'You must configure @response_fields_definition' if response_fields_definition.empty?
+      raise RuntimeError, 'You must configure @success_response_type'      if success_response_type.nil?
+    end
+
+    # Check, is payment transaction client order id and query response client order id equal or not.
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for update
+    # @param    response              [Response]              API gateway response
+    def validate_client_id(payment_transaction, response)
+      payment_id  = payment_transaction.payment.client_id
+      response_id = response.payment_client_id
+
+      if response_id && payment_id.to_s != response_id.to_s   # Different types with equal values must pass validation
+        raise ValidationError, "Response client_id '#{response_id}' does not match Payment client_id '#{payment_id}'"
+      end
+    end
+
+    # Set PaynetEasy payment id to payment transaction Payment
+    #
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for update
+    # @param    response              [Response]              API gateway response
+    def set_paynet_id(payment_transaction, response)
+      if response.payment_paynet_id
+        payment_transaction.payment.paynet_id = response.payment_paynet_id
+      end
+    end
+
+    class << self
+      # Make instance variables available in child classes
+      def inherited(subclass)
+        instance_variables.each do |variable_name|
+          subclass.instance_variable_set variable_name, instance_variable_get(variable_name)
+        end
+      end
+    end
+
+    # @return   [Array]
+    def request_fields_definition
+      self.class.instance_variable_get :@request_fields_definition
+    end
+
+    # @return   [Array]
+    def signature_definition
+      self.class.instance_variable_get :@signature_definition
+    end
+
+    # @return   [Array]
+    def response_fields_definition
+      self.class.instance_variable_get :@response_fields_definition
+    end
+
+    # @return   [String]
+    def success_response_type
+      self.class.instance_variable_get :@success_response_type
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'util/string'
+require 'query/prototype/query'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class QueryFactory
+    # Create API query object by API query method
+    #
+    # @param    api_query_name    [String]              API query method name
+    #
+    # @return                     [Prototype::Query]    API query object
+    def query(api_query_name)
+      query_class = "#{api_query_name.camelize}Query"
+      query_file  = "query/#{api_query_name.gsub('-', '_')}_query"
+
+      require query_file
+      PaynetEasy::PaynetEasyApi::Query.const_get(query_class).new(api_query_name)
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'query/prototype/payment_query'
+require 'payment_data/payment'
+require 'util/validator'
+require 'error/validation_error'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class ReturnQuery < Prototype::PaymentQuery
+    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],
+      ['amount',             'payment.amount',                   true,   Validator::AMOUNT],
+      ['currency',           'payment.currency',                 true,   Validator::CURRENCY],
+      ['comment',            'payment.comment',                  true,   Validator::MEDIUM_STRING],
+      ['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_RETURN
+
+    protected
+
+    # @param    payment_transaction   [PaymentTransaction]    Payment transaction for validation
+    def validate_payment_transaction(payment_transaction)
+      unless payment_transaction.payment.paid?
+        raise ValidationError, 'Payment must be paid up to return funds'
+      end
+
+      super payment_transaction
+    end
+  end
+end

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

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

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

@@ -0,0 +1,53 @@
+require 'query/prototype/payment_query'
+require 'payment_data/payment'
+require 'util/validator'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class SaleQuery < 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],
+      ['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],
+      ['card_printed_name',      'payment.credit_card.card_printed_name',   true,   Validator::LONG_STRING],
+      ['credit_card_number',     'payment.credit_card.credit_card_number',  true,   Validator::CREDIT_CARD_NUMBER],
+      ['expire_month',           'payment.credit_card.expire_month',        true,   Validator::MONTH],
+      ['expire_year',            'payment.credit_card.expire_year',         true,   Validator::YEAR],
+      ['cvv2',                   'payment.credit_card.cvv2',                true,   Validator::CVV2],
+      ['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],
+      ['destination',            'payment.destination',                     false,  Validator::LONG_STRING],
+      ['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'
+    ]
+
+    @payment_status = Payment::STATUS_CAPTURE
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'query/prototype/query'
+require 'transport/response'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class StatusQuery < Prototype::Query
+    include PaynetEasy::PaynetEasyApi::Util
+    include PaynetEasy::PaynetEasyApi::Transport
+
+    @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',
+      'paynet-order-id',
+      'merchant-order-id',
+      'serial-number'
+    ]
+
+    @success_response_type = 'status-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_html?
+        response.needed_action = Response::NEEDED_SHOW_HTML
+      elsif response.processing?
+        response.needed_action = Response::NEEDED_STATUS_UPDATE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'query/prototype/payment_query'
+require 'payment_data/payment'
+require 'util/validator'
+
+module PaynetEasy::PaynetEasyApi::Query
+  class TransferByRefQuery < Prototype::PaymentQuery
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Util
+
+    @request_fields_definition =
+    [
+      # mandatory
+      ['client_orderid',             'payment.client_id',                            true,    Validator::ID],
+      ['amount',                     'payment.amount',                               true,    Validator::AMOUNT],
+      ['currency',                   'payment.currency',                             true,    Validator::CURRENCY],
+      ['ipaddress',                  'payment.customer.ip_address',                  true,    Validator::IP],
+      ['destination-card-ref-id',    'payment.recurrent_card_to.paynet_id',          true,    Validator::ID],
+      ['login',                      'query_config.login',                           true,
+       Validator::MEDIUM_STRING],
+      # optional
+      ['order_desc',                 'payment.description',                          false,   Validator::LONG_STRING],
+      ['source-card-ref-id',         'payment.recurrent_card_from.paynet_id',        false,   Validator::ID],
+      ['cvv2',                       'payment.recurrent_card_from.cvv2',             false,   Validator::CVV2],
+      ['redirect_url',               'query_config.redirect_url',                    false,   Validator::URL],
+      ['server_callback_url',        'query_config.callback_url',                    false,   Validator::URL]
+    ]
+
+    @signature_definition =
+    [
+      'query_config.login',
+      'payment.client_id',
+      'payment.recurrent_card_from.paynet_id',
+      'payment.recurrent_card_to.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/transfer_form_query.rb

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

data/lib/paynet_easy/paynet_easy_api/transport/callback_response.rb

@@ -0,0 +1,21 @@
+require 'transport/response'
+
+module PaynetEasy::PaynetEasyApi::Transport
+  class CallbackResponse < Response
+    def amount
+      fetch 'amount', nil
+    end
+
+    def comment
+      fetch 'comment', nil
+    end
+
+    def merchant_data
+      fetch 'merchant_data', nil
+    end
+
+    def type=(type)
+      store 'type', type
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/transport/gateway_client.rb

@@ -0,0 +1,91 @@
+require 'net/http'
+require 'uri'
+require 'cgi'
+
+require 'transport/request'
+require 'transport/response'
+require 'util/validator'
+
+require 'error/validation_error'
+require 'error/request_error'
+
+module PaynetEasy::PaynetEasyApi::Transport
+  class GatewayClient
+    include Net
+    include PaynetEasy::PaynetEasyApi::Util
+    include PaynetEasy::PaynetEasyApi::Error
+
+    # Make request to the PaynetEasy gateway
+    #
+    # @param    request   [Request]     Request data
+    #
+    # @return             [Response]    Response data
+    def make_request(request)
+      validate_request request
+      response = send_request request
+      parse_response response
+    end
+
+    protected
+
+    # Executes request
+    #
+    # @param    request   [Request]         Request to execute
+    #
+    # @return             [HTTPResponse]    PaynetEasy response as HTTPResponse
+    def send_request(request)
+      begin
+        uri = URI "#{request.gateway_url}/#{request.api_method}/#{request.end_point}"
+
+        response = HTTP.start uri.hostname, uri.port, :use_ssl => uri.scheme == 'https' do |http|
+          post = HTTP::Post.new uri.request_uri
+          post.set_form_data request.request_fields
+          http.request post
+        end
+      rescue Exception => e
+        raise RequestError, "Error occurred. #{e.message}"
+      end
+
+      unless HTTPOK === response
+        raise RequestError, "Error occurred. HTTP code: '#{response.code}'. Server message: '#{response.message}'"
+      end
+
+      response
+    end
+
+    # Parse PaynetEasy response from string to Response object
+    #
+    # @param    response    [HTTPResponse]    PaynetEasy response as HTTPResponse
+    #
+    # @return               [Response]        PaynetEasy response as Response
+    def parse_response(response)
+      unless response.body
+        raise ResponseError, 'PaynetEasy response is empty'
+      end
+
+      # Change hash format from {'key' => ['value']} to {'key' => 'value'} in map block
+      response_fields = Hash[CGI.parse(response.body).map {|key, value| [key, value.first]}]
+
+      Response.new response_fields
+    end
+
+    # Validates Request
+    #
+    # @param    request   [Request]           Request for validation
+    def validate_request(request)
+      validation_errors = []
+
+      validation_errors << 'Request api method is empty'  unless request.api_method
+      validation_errors << 'Request end point is empty'   unless request.end_point
+      validation_errors << 'Request data is empty'        unless request.request_fields.any?
+
+      unless Validator.validate_by_rule request.gateway_url, Validator::URL, false
+        validation_errors << 'Gateway url does not valid in Request'
+      end
+
+      if validation_errors.any?
+        raise ValidationError, "Some Request fields are invalid:\n#{validation_errors.join(";\n")}"
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/transport/request.rb

@@ -0,0 +1,20 @@
+module PaynetEasy::PaynetEasyApi::Transport
+  class Request
+    attr_accessor :api_method
+    attr_accessor :end_point
+    attr_accessor :gateway_url
+    attr_reader :request_fields
+
+    def initialize(request_fields = {})
+      @request_fields = request_fields
+    end
+
+    def gateway_url=(gateway_url)
+      @gateway_url = gateway_url.chomp '/'
+    end
+
+    def signature=(signature)
+      request_fields['control'] = signature
+    end
+  end
+end