payneteasy-payneteasyapi 0.1.0

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

@@ -0,0 +1,136 @@
+require 'error/paynet_error'
+
+module PaynetEasy::PaynetEasyApi::Transport
+  class Response
+    include PaynetEasy::PaynetEasyApi::Error
+
+    # Need to update payment status
+    NEEDED_STATUS_UPDATE  = 'status_update'
+
+    # Need to show html from response
+    NEEDED_SHOW_HTML      = 'show_html'
+
+    # Need redirect to response url
+    NEEDED_REDIRECT       = 'redirect'
+
+    @@allowed_needed_actions =
+    [
+        NEEDED_STATUS_UPDATE,
+        NEEDED_SHOW_HTML,
+        NEEDED_REDIRECT
+    ]
+
+    attr_accessor :needed_action
+
+    def initialize(response = {})
+      @data = Hash[response.map {|key, value| [key, value.to_s.strip]}]
+    end
+
+    def needed_action=(needed_action)
+      unless @@allowed_needed_actions.include? needed_action
+        raise ArgumentError, "Unknown needed action: '#{needed_action}'"
+      end
+
+      @needed_action = needed_action
+    end
+
+    def status_update_needed?
+      needed_action == NEEDED_STATUS_UPDATE
+    end
+
+    def show_html_needed?
+      needed_action == NEEDED_SHOW_HTML
+    end
+
+    def redirect_needed?
+      needed_action == NEEDED_REDIRECT
+    end
+
+    def html
+      fetch 'html', nil
+    end
+
+    def has_html?
+      !html.nil?
+    end
+
+    def type
+      fetch('type').downcase if key? 'type'
+    end
+
+    def status
+      if !fetch('status', nil) && !%w(validation-error error).include?(type)
+        store 'status', 'processing'
+      end
+
+      fetch('status').downcase if key? 'status'
+    end
+
+    def approved?
+      status == 'approved'
+    end
+
+    def processing?
+      status == 'processing'
+    end
+
+    def declined?
+      %w(filtered declined).include? status
+    end
+
+    def payment_client_id
+      any_key %w(merchant-order-id client_orderid merchant_order)
+    end
+
+    def payment_paynet_id
+      any_key %w(orderid paynet-order-id)
+    end
+
+    def card_paynet_id
+      fetch 'card-ref-id', nil
+    end
+
+    def redirect_url
+      fetch 'redirect-url', nil
+    end
+
+    def has_redirect_url?
+      !redirect_url.nil?
+    end
+
+    def control_code
+      any_key %w(control merchant_control)
+    end
+
+    def error_message
+      any_key %w(error_message error-message)
+    end
+
+    def error_code
+      any_key %w(error_code error-code)
+    end
+
+    def error?
+      %w(validation-error error).include?(type) || status == 'error'
+    end
+
+    def error
+      if error? || declined?
+        PaynetError.new error_message
+      else
+        raise RuntimeError, 'Response has no error'
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      @data.send name, *args, &block
+    end
+
+    protected
+
+    def any_key(keys)
+      keys.each {|key| return fetch key if key? key}
+      nil # if all keys missed in data
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/util/property_accessor.rb

@@ -0,0 +1,60 @@
+module PaynetEasy::PaynetEasyApi::Util
+  module PropertyAccessor
+    # Get property value by property path.
+    #
+    # @param    object          [Object]                  Object with data
+    # @param    property_path   [String]                  Path to property
+    # @param    fail_on_error   [TrueClass|FalseClass]    Throw exception if error occurred or not
+    #
+    # @return                   [Object|NilClass]
+    def self.get_value(object, property_path, fail_on_error = true)
+      if !property_path.include? '.'
+        if object.respond_to? property_path
+          return object.send property_path
+        elsif fail_on_error
+          raise RuntimeError, "Expected object with method '#{property_path}'"
+        else
+          return
+        end
+      end
+
+      first_property, path_rest = property_path.split '.', 2
+      first_object = object.send first_property
+
+      if first_object
+        return self.get_value first_object, path_rest, fail_on_error
+      elsif fail_on_error
+        raise RuntimeError, "Object expected for property path '#{first_property}'"
+      end
+    end
+
+    # Set property value by property path.
+    #
+    # @param    object            [Object]                  Object with data
+    # @param    property_path     [String]                  Path to property
+    # @param    value             [Object]                  Value to set
+    # @param    fail_on_error     [TrueClass|FalseClass]    Throw exception if error occurred or not
+    #
+    # @return                     [Object|NilClass]
+    def self.set_value(object, property_path, value, fail_on_error = true)
+      if !property_path.include? '.'
+        if object.respond_to? "#{property_path}="
+          return object.send "#{property_path}=", value
+        elsif fail_on_error
+          raise RuntimeError, "Expected object with method '#{property_path}='"
+        else
+          return
+        end
+      end
+
+      first_property, path_rest = property_path.split '.', 2
+      first_object = object.send(first_property)
+
+      if first_object
+        return self.set_value first_object, path_rest, value, fail_on_error
+      elsif fail_on_error
+        raise RuntimeError, "Object expected for property path '#{first_property}'"
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/util/string.rb

@@ -0,0 +1,9 @@
+class String
+  # Convert string from format <this_is_the_string> or
+  # <this-is-the-string> to format <ThisIsTheString>
+  #
+  # @return   [String]    New string, converted to camel-case format
+  def camelize
+    split(/_|-/).map(&:capitalize).join('')
+  end
+end

data/lib/paynet_easy/paynet_easy_api/util/validator.rb

@@ -0,0 +1,110 @@
+require 'uri'
+require 'ipaddr'
+require 'error/validation_error'
+
+module PaynetEasy::PaynetEasyApi::Util
+  module Validator
+    include PaynetEasy::PaynetEasyApi::Error
+
+    # Validate value as email
+    EMAIL = 'email'
+
+    # Validate value as IP address
+    IP    = 'ip'
+
+    # Validate value as URL
+    URL   = 'url'
+
+    # Validate value as month
+    MONTH = 'month'
+
+    # Validate value as year
+    YEAR  = 'year'
+
+    # Validate value as phone number
+    PHONE = 'phone'
+
+    # Validate value as payment amount
+    AMOUNT = 'amount'
+
+    # Validate value as currency
+    CURRENCY  = 'currency'
+
+    # Validate value as card verification value
+    CVV2      = 'cvv2'
+
+    # Validate value as zip code
+    ZIP_CODE  = 'zip_code'
+
+    # Validate value as two-letter country or state code
+    COUNTRY   = 'country'
+
+    # Validate value as date in format MMDDYY
+    DATE      = 'date'
+
+    # Validate value as  last four digits of social security number
+    SSN       = 'ssn'
+
+    # Validate value as credit card number
+    CREDIT_CARD_NUMBER = 'credit_card_number'
+
+    # Validate value as different IDs (client, paynet, card-ref)
+    ID        = 'id'
+
+    # Validate value as medium string
+    MEDIUM_STRING = 'medium_string'
+
+    # Validate value as long string
+    LONG_STRING   = 'long_string'
+
+    # Regular expressions for some validation rules
+    @@rule_regexps =
+    {
+        EMAIL                 => /@+/,
+        PHONE                 => /^[0-9\-\+\(\)\s]{6,15}$/i,
+        AMOUNT                => /^[0-9\.]{1,11}$/i,
+        CURRENCY              => /^[A-Z]{1,3}$/i,
+        CVV2                  => /^[\S\s]{3,4}$/i,
+        ZIP_CODE              => /^[\S\s]{1,10}$/i,
+        COUNTRY               => /^[A-Z]{1,2}$/i,
+        YEAR                  => /^[0-9]{1,2}$/i,
+        DATE                  => /^[0-9]{6}$/i,
+        SSN                   => /^[0-9]{1,4}$/i,
+        CREDIT_CARD_NUMBER    => /^[0-9]{1,20}$/i,
+        ID                    => /^[\S\s]{1,20}$/i,
+        MEDIUM_STRING         => /^[\S\s]{1,50}$/i,
+        LONG_STRING           => /^[\S\s]{1,128}$/i
+    }
+
+    # Validates value by given rule.
+    # Rule can be one of Validator constants or regExp.
+    #
+    # @param    value           [Object]                  Value for validation
+    # @param    rule            [String|Regexp]           Rule for validation
+    # @param    fail_on_error   [TrueClass|FalseClass]    Throw exception on invalid value or not
+    #
+    # @return                   [TrueClass|FalseClass]    Validation result
+    def self.validate_by_rule(value, rule, fail_on_error = true)
+      begin
+        valid = case rule
+        when URL    then URI::ABS_URI === value
+        when IP     then IPAddr.new value
+        when MONTH  then (1..12).include? value.to_i
+        else
+          regexp = @@rule_regexps.key?(rule) ? @@rule_regexps[rule] : rule
+          regexp === value.to_s
+        end
+      rescue Exception
+        valid = false
+      end
+
+      if valid
+        true
+      elsif fail_on_error
+        raise ValidationError, "Value '#{value}' does not match rule '#{rule}'"
+      else
+        false
+      end
+    end
+  end
+end

data/payneteasy-payneteasyapi.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name                  = 'payneteasy-payneteasyapi'
+  s.version               = '0.1.0'
+  s.summary               = 'Ruby library for PaynetEasy payment API.'
+  s.author                = 'Artem Ponomarenko'
+  s.email                 = 'imenem@inbox.ru'
+  s.require_paths         = ['lib', 'lib/paynet_easy/paynet_easy_api']
+
+  s.files                 = Dir['lib/**/*.rb'] + %w(.gemtest Gemfile Gemfile.lock Rakefile payneteasy-payneteasyapi.gemspec)
+  s.test_files            = Dir['test/**/*.rb']
+  s.extra_rdoc_files      = Dir['example/**/*.rb'] + Dir['doc/**/*.md'] << 'README.md'
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'rake'
+end

data/test/paynet_easy/paynet_easy_api/callback/callback_factory_test.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'paynet_easy_api'
+require 'callback/callback_factory'
+require 'callback/customer_return_callback'
+require 'callback/paynet_easy_callback'
+
+module PaynetEasy::PaynetEasyApi::Callback
+  class CallbackFactoryTest < Test::Unit::TestCase
+    def setup
+      @object = CallbackFactory.new
+    end
+
+    def test_callback
+      callback = @object.callback 'customer_return'
+      assert_instance_of CustomerReturnCallback, callback
+
+      callback = @object.callback 'sale'
+      assert_instance_of PaynetEasyCallback, callback
+      assert_equal 'sale', callback.instance_variable_get(:@callback_type)
+    end
+  end
+end

data/test/paynet_easy/paynet_easy_api/callback/callback_test_prototype.rb

@@ -0,0 +1,168 @@
+require 'test/unit'
+require 'digest/sha1'
+require 'paynet_easy_api'
+require 'callback/callback_prototype'
+require 'payment_data/payment_transaction'
+require 'payment_data/payment'
+require 'payment_data/query_config'
+require 'transport/callback_response'
+require 'error/validation_error'
+require 'error/paynet_error'
+
+module PaynetEasy::PaynetEasyApi::Callback
+  module CallbackTestPrototype
+    include PaynetEasy::PaynetEasyApi::PaymentData
+    include PaynetEasy::PaynetEasyApi::Transport
+    include PaynetEasy::PaynetEasyApi::Error
+
+    SIGNING_KEY   = 'D5F82EC1-8575-4482-AD89-97X6X0X20X22'
+    CLIENT_ID     = 'CLIENT-112233'
+    PAYNET_ID     = 'PAYNET-112233'
+
+    def test_process_callback_approved
+      raise NotImplementedError
+    end
+
+    def assert_process_callback_approved(callback)
+      payment_transaction = payment_transaction()
+      callback_response   = CallbackResponse.new callback
+      sign_callback callback_response
+
+      callback_processor.process_callback payment_transaction, callback_response
+
+      assert_true payment_transaction.approved?
+      assert_true payment_transaction.finished?
+      assert_false payment_transaction.has_errors?
+
+      [payment_transaction, callback_response]
+    end
+
+    def test_process_callback_declined
+      raise NotImplementedError
+    end
+
+    def assert_process_callback_declined(callback)
+      payment_transaction = payment_transaction()
+      callback_response   = CallbackResponse.new callback
+      sign_callback callback_response
+
+      callback_processor.process_callback payment_transaction, callback_response
+
+      assert_true payment_transaction.declined?
+      assert_true payment_transaction.finished?
+      assert_true payment_transaction.has_errors?
+    end
+
+    def test_process_callback_error
+      raise NotImplementedError
+    end
+
+    def assert_process_callback_error(callback)
+      payment_transaction = payment_transaction()
+      callback_response   = CallbackResponse.new callback
+      sign_callback callback_response
+
+      begin
+        callback_processor.process_callback payment_transaction, callback_response
+      rescue PaynetError => error
+        assert_true payment_transaction.error?
+        assert_true payment_transaction.finished?
+        assert_true payment_transaction.has_errors?
+        assert_equal callback_response.error_message, error.message
+
+        [payment_transaction, callback_response]
+      else
+        flunk 'Exception must be raised'
+      end
+    end
+
+    def test_process_callback_with_empty_control
+      assert_raise ValidationError, "Actual control code '' does not equal expected" do
+        callback_processor.process_callback payment_transaction, Response.new
+      end
+    end
+
+    def test_process_callback_with_empty_fields
+      callback_response = CallbackResponse.new(
+      [
+        'status'            => 'approved',
+        'orderid'           => '_',
+        'client_orderid'    => '_'
+      ])
+
+      sign_callback callback_response
+
+      assert_raise ValidationError, 'Some required fields missed or empty in CallbackResponse' do
+        callback_processor.process_callback payment_transaction, callback_response
+      end
+    end
+
+    def test_process_callback_with_unequal_fields
+      callback_response = CallbackResponse.new(
+      [
+        'status'            => 'approved',
+        'orderid'           => 'unequal',
+        'merchant_order'    => 'unequal',
+        'client_orderid'    => 'unequal'
+      ])
+
+      sign_callback callback_response
+
+      assert_raise ValidationError, 'Some fields from CallbackResponse unequal properties from Payment' do
+        callback_processor.process_callback payment_transaction, callback_response
+      end
+    end
+
+    def test_process_callback_with_invalid_status
+      callback_response = CallbackResponse.new(
+      [
+        'status'            => 'processing',
+        'amount'            =>  0.99,
+        'orderid'           =>  PAYNET_ID,
+        'merchant_order'    =>  CLIENT_ID,
+        'client_orderid'    =>  CLIENT_ID,
+      ])
+
+      sign_callback callback_response
+
+      assert_raise ValidationError, "Invalid callback status: 'processing'" do
+        callback_processor.process_callback payment_transaction, callback_response
+      end
+    end
+
+    protected
+
+    # @return   [CallbackPrototype]
+    def callback_processor
+      raise NotImplementedError
+    end
+
+    # @return   [PaymentTransaction]
+    def payment_transaction
+      PaymentTransaction.new(
+      {
+        'payment'           =>    Payment.new(
+        {
+          'client_id'         =>  CLIENT_ID,
+          'paynet_id'         =>  PAYNET_ID,
+          'amount'            =>  0.99,
+          'currency'          => 'USD',
+        }),
+        'query_config'      =>    QueryConfig.new(
+        {
+          'signing_key'       =>  SIGNING_KEY
+        })
+      })
+    end
+
+    # @param    callback_response   [CallbackResponse]
+    def sign_callback(callback_response)
+      callback_response['control'] = Digest::SHA1.hexdigest(
+        callback_response.status +
+        callback_response.payment_paynet_id.to_s +
+        callback_response.payment_client_id.to_s +
+        SIGNING_KEY
+      )
+    end
+  end
+end

data/test/paynet_easy/paynet_easy_api/callback/customer_return_callback_test.rb

@@ -0,0 +1,95 @@
+require_relative './callback_test_prototype'
+require 'callback/customer_return_callback'
+
+module PaynetEasy::PaynetEasyApi::Callback
+  class CustomerReturnCallbackTest < Test::Unit::TestCase
+    include CallbackTestPrototype
+
+    def test_process_callback_approved
+      [
+        {
+          'status'            => 'approved',
+          'amount'            =>  0.99,
+          'orderid'           =>  PAYNET_ID,
+          'merchant_order'    =>  CLIENT_ID,
+          'client_orderid'    =>  CLIENT_ID,
+        }
+      ].each do |callback|
+        assert_process_callback_approved callback
+      end
+    end
+
+    def test_process_callback_declined
+      [
+        {
+          'status'            => 'declined',
+          'amount'            =>  0.99,
+          'orderid'           =>  PAYNET_ID,
+          'merchant_order'    =>  CLIENT_ID,
+          'client_orderid'    =>  CLIENT_ID,
+        },
+        {
+          'status'            => 'filtered',
+          'amount'            =>  0.99,
+          'orderid'           =>  PAYNET_ID,
+          'merchant_order'    =>  CLIENT_ID,
+          'client_orderid'    =>  CLIENT_ID,
+        }
+      ].each do |callback|
+        assert_process_callback_declined callback
+      end
+    end
+
+    def test_process_callback_error
+      [
+        {
+          'status'            => 'error',
+          'amount'            =>  0.99,
+          'orderid'           =>  PAYNET_ID,
+          'merchant_order'    =>  CLIENT_ID,
+          'client_orderid'    =>  CLIENT_ID,
+          'error_message'     => 'test type error message',
+          'error_code'        =>  5
+        }
+      ].each do |callback|
+        assert_process_callback_error callback
+      end
+    end
+
+    def test_process_callback_with_not_processing_transaction
+      payment_transaction = payment_transaction()
+      payment_transaction.status = PaymentTransaction::STATUS_APPROVED
+
+      callback_response = CallbackResponse.new(
+      [
+        'status'            => 'processing',
+        'amount'            =>  0.99,
+        'orderid'           =>  PAYNET_ID,
+        'merchant_order'    =>  CLIENT_ID,
+        'client_orderid'    =>  CLIENT_ID,
+      ])
+
+      sign_callback callback_response
+
+      assert_raise ValidationError, 'Only processing payment transaction can be processed' do
+        callback_processor.process_callback payment_transaction, callback_response
+      end
+    end
+
+    protected
+
+    alias :callback_test_prototype_payment_transaction :payment_transaction
+
+    # @return   [PaymentTransaction]
+    def payment_transaction
+      payment_transaction = callback_test_prototype_payment_transaction
+      payment_transaction.status = PaymentTransaction::STATUS_PROCESSING
+      payment_transaction
+    end
+
+    # @return   [CustomerReturnCallback]
+    def callback_processor
+      CustomerReturnCallback.new 'customer_return'
+    end
+  end
+end