payneteasy-payneteasyapi 0.1.0

data/lib/paynet_easy/paynet_easy_api/error/validation_error.rb

@@ -0,0 +1,6 @@
+require 'error/paynet_error'
+
+module PaynetEasy::PaynetEasyApi::Error
+  class ValidationError < PaynetError
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/billing_address.rb

@@ -0,0 +1,41 @@
+require 'payment_data/data'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class BillingAddress < Data
+    # Customer’s address line 1
+    #
+    # @var [String]
+    attr_accessor :first_line
+
+    # Customer’s city
+    #
+    # @var [String]
+    attr_accessor :city
+
+    # Customer’s state (two-letter US state code).
+    # Not applicable outside the US.
+    #
+    # @var [String]
+    attr_accessor :state
+
+    # Customer’s ZIP code
+    #
+    # @var [String]
+    attr_accessor :zip_code
+
+    # Customer’s country (two-letter country code)
+    #
+    # @var [String]
+    attr_accessor :country
+
+    # Customer’s full international phone number, including country code.
+    #
+    # @var [String]
+    attr_accessor :phone
+
+    # Customer’s full international cell phone number, including country code.
+    #
+    # @var [String]
+    attr_accessor :cell_phone
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/credit_card.rb

@@ -0,0 +1,32 @@
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class CreditCard < Data
+    # CreditCard CVV2
+    #
+    # @var [String]
+    attr_accessor :cvv2
+
+    # Card holder name
+    #
+    # @var [String]
+    attr_accessor :card_printed_name
+
+    # Credit card number
+    #
+    # @var [String]
+    attr_accessor :credit_card_number
+
+    # Card expiration year
+    #
+    # @var [String]
+    attr_accessor :expire_year
+
+    # Card expiration month
+    #
+    # @var [String]
+    attr_accessor :expire_month
+
+    def credit_card_number=(credit_card_number)
+      @credit_card_number = credit_card_number.gsub(/\s|-|_|\.|,/, '')
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/customer.rb

@@ -0,0 +1,35 @@
+require 'payment_data/data'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class Customer < Data
+    # Customer’s first name
+    #
+    # @var [String]
+    attr_accessor :first_name
+
+    # Customer’s last name
+    #
+    # @var [String]
+    attr_accessor :last_name
+
+    # Customer’s email address
+    #
+    # @var [String]
+    attr_accessor :email
+
+    # Customer’s IP address
+    #
+    # @var [String]
+    attr_accessor :ip_address
+
+    # Customer’s date of birth, in the format MMDDYY
+    #
+    # @var [String]
+    attr_accessor :birthday
+
+    # Last four digits of the customer’s social security number
+    #
+    # @var [String]
+    attr_accessor :ssn
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/data.rb

@@ -0,0 +1,13 @@
+require 'util/property_accessor'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class Data
+    include PaynetEasy::PaynetEasyApi::Util
+
+    def initialize(data_hash = {}, fail_on_unknown_field = true)
+      data_hash.each do |property_path, value|
+        PropertyAccessor.set_value self, property_path, value, fail_on_unknown_field
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/payment.rb

@@ -0,0 +1,190 @@
+require 'payment_data/data'
+require 'payment_data/customer'
+require 'payment_data/billing_address'
+require 'payment_data/credit_card'
+require 'payment_data/recurrent_card'
+require 'payment_data/payment_transaction'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class Payment < Data
+    # Payment is new, and not processing
+    STATUS_NEW        = 'new'
+
+    # Payment is under preauth, or preauth is finished
+    STATUS_PREAUTH    = 'preauth'
+
+    # Payment is under capture, or capture is finished
+    STATUS_CAPTURE    = 'capture'
+
+    # Payment is under return, or return is finished
+    STATUS_RETURN     = 'return'
+
+    # All allowed payment statuses
+    @@allowed_statuses =
+    [
+      STATUS_PREAUTH,
+      STATUS_CAPTURE,
+      STATUS_RETURN
+    ]
+
+    # Unique identifier of payment assigned by merchant
+    #
+    # @var [String]
+    attr_accessor :client_id
+
+    # Unique identifier of payment assigned by PaynetEasy
+    #
+    # @var [String]
+    attr_accessor :paynet_id
+
+    # Brief payment description
+    #
+    # @var [String]
+    attr_accessor :description
+
+    # Destination to where the payment goes
+    #
+    # @var [String]
+    attr_accessor :destination
+
+    # Amount to be charged
+    #
+    # @var [Float]
+    attr_accessor :amount
+
+    # Currency the transaction is charged in (three-letter currency code)
+    #
+    # @var [String]
+    attr_accessor :currency
+
+    # A short comment for payment
+    #
+    # @var [String]
+    attr_accessor :comment
+
+    # Payment status
+    #
+    # @var [String]
+    attr_accessor :status
+
+    # Payment customer
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::Customer]
+    attr_accessor :customer
+
+    # Payment billing address
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::BillingAddress]
+    attr_accessor :billing_address
+
+    # Payment credit card
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::CreditCard]
+    attr_accessor :credit_card
+
+    # Payment source recurrent card
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::RecurrentCard]
+    attr_accessor :recurrent_card_from
+
+    # Payment destination recurrent card
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::RecurrentCard]
+    attr_accessor :recurrent_card_to
+
+    # Payment transactions for payment
+    #
+    # @var  [Array]
+    attr_accessor :payment_transactions
+
+    def amount_in_cents
+      (amount * 100).to_i if amount
+    end
+
+    def customer=(customer)
+      @customer = customer
+    end
+
+    def customer
+      @customer ||= Customer.new
+    end
+
+    def billing_address=(billing_address)
+      @billing_address = billing_address
+    end
+
+    def billing_address
+      @billing_address ||= BillingAddress.new
+    end
+
+    def credit_card=(credit_card)
+      @credit_card = credit_card
+    end
+
+    def credit_card
+      @credit_card ||= CreditCard.new
+    end
+
+    def recurrent_card_from=(recurrent_card)
+      @recurrent_card_from = recurrent_card
+    end
+
+    def recurrent_card_from
+      @recurrent_card_from ||= RecurrentCard.new
+    end
+
+    def recurrent_card_to=(recurrent_card)
+      @recurrent_card_to = recurrent_card
+    end
+
+    def recurrent_card_to
+      @recurrent_card_to ||= RecurrentCard.new
+    end
+
+    def payment_transactions
+      @payment_transactions ||= []
+    end
+
+    def add_payment_transaction(payment_transaction)
+      unless has_payment_transaction? payment_transaction
+        @payment_transactions << payment_transaction
+      end
+
+      unless payment_transaction.payment === self
+        payment_transaction.payment = self
+      end
+    end
+
+    def has_payment_transaction?(payment_transaction)
+      payment_transactions.include? payment_transaction
+    end
+
+    # True, if the payment has a transaction that is currently being processed
+    def has_processing_transaction?
+      payment_transactions.one? &:processing?
+    end
+
+    def status=(status)
+      unless @@allowed_statuses.include? status
+        raise ArgumentError, "Unknown payment status given: '#{status}'"
+      end
+
+      @status = status
+    end
+
+    # True, if payment is new
+    def new?
+      status == STATUS_NEW
+    end
+
+    # True, is payment is paid up
+    def paid?
+      [STATUS_PREAUTH, STATUS_CAPTURE].include? status
+    end
+
+    # True, if funds returned to customer
+    def returned?
+      status == STATUS_RETURN
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/payment_transaction.rb

@@ -0,0 +1,188 @@
+require 'payment_data/data'
+
+# :KLUDGE:    Imenem    22.08.2013
+#
+# Prevent error "Uninitialized constant PaymentTransaction" in Payment
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class PaymentTransaction < Data
+  end
+end
+
+require 'payment_data/payment'
+require 'payment_data/query_config'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class PaymentTransaction < Data
+    # Payment transaction processed by payment query
+    PROCESSOR_QUERY       = 'query'
+
+    # Payment transaction processed by PaynetEasy callback
+    PROCESSOR_CALLBACK    = 'callback'
+
+    # Payment transaction is new
+    STATUS_NEW        = 'new'
+
+    # Payment transaction is now processing
+    STATUS_PROCESSING = 'processing'
+
+    # Payment transaction approved
+    STATUS_APPROVED   = 'approved'
+
+    # Payment transaction declined by bank
+    STATUS_DECLINED   = 'declined'
+
+    # Payment transaction declined by PaynetEasy filters
+    STATUS_FILTERED   = 'filtered'
+
+    #Payment transaction processed with error
+    STATUS_ERROR      = 'error'
+
+    # All allowed callback types
+    @@allowed_processor_types =
+    [
+      PROCESSOR_QUERY,
+      PROCESSOR_CALLBACK
+    ]
+
+    # All allowed payment transaction statuses
+    @@allowed_statuses =
+    [
+      STATUS_NEW,
+      STATUS_PROCESSING,
+      STATUS_APPROVED,
+      STATUS_DECLINED,
+      STATUS_FILTERED,
+      STATUS_ERROR
+    ]
+
+    # Payment transaction processor type
+    #
+    # @var  [String]
+    attr_accessor :processor_type
+
+    # Payment transaction processor name
+    #
+    # @var  [String]
+    attr_accessor :processor_name
+
+    # Payment transaction status
+    #
+    # @var  [String]
+    attr_accessor :status
+
+    # Payment transaction payment
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::Payment]
+    attr_accessor :payment
+
+    # Payment transaction query config
+    #
+    # @var  [PaynetEasy::PaynetEasyApi::PaymentData::QueryConfig]
+    attr_accessor :query_config
+
+    # Payment transaction processing errors
+    #
+    # @var  [Array]
+    attr_accessor :errors
+
+    def processor_type=(processor_type)
+      unless @@allowed_processor_types.include? processor_type
+        raise ArgumentError, "Unknown transaction processor type given: '#{processor_type}'"
+      end
+
+      if @processor_type
+        raise RuntimeError, 'You can set payment transaction processor type only once'
+      end
+
+      @processor_type = processor_type
+    end
+
+    def processor_name=(processor_name)
+      if @processor_name
+        raise RuntimeError, 'You can set payment transaction processor name only once'
+      end
+
+      @processor_name = processor_name
+    end
+
+    def status=(status)
+      unless @@allowed_statuses.include? status
+        raise ArgumentError, "Unknown transaction status given: '#{status}'"
+      end
+
+      @status = status
+    end
+
+    def status
+      @status ||= STATUS_NEW
+    end
+
+    # True, if payment transaction is new
+    def new?
+      status == STATUS_NEW
+    end
+
+    # True, if payment transaction is now processing
+    def processing?
+      status == STATUS_PROCESSING
+    end
+
+    # True, if payment transaction approved
+    def approved?
+      status == STATUS_APPROVED
+    end
+
+    # True, if payment transaction declined or filtered
+    def declined?
+      [STATUS_DECLINED, STATUS_FILTERED].include? status
+    end
+
+    # True, if error occurred when processing payment transaction by PaynetEasy gateway
+    def error?
+      status == STATUS_ERROR
+    end
+
+    # True, if payment transaction processing is finished
+    def finished?
+      !new? && !processing?
+    end
+
+    def payment=(payment)
+      @payment = payment
+
+      unless @payment.has_payment_transaction? self
+        @payment.add_payment_transaction self
+      end
+    end
+
+    def payment
+      @payment ||= Payment.new
+    end
+
+    def query_config=(query_config)
+      @query_config = query_config
+    end
+
+    def query_config
+      @query_config ||= QueryConfig.new
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def add_error(error)
+      unless errors.include? error
+        errors << error
+      end
+    end
+
+    def has_errors?
+      errors.any?
+    end
+
+    def last_error
+      errors.last if has_errors?
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/query_config.rb

@@ -0,0 +1,95 @@
+require 'payment_data/data'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class QueryConfig < Data
+    # Execute query to PaynetEasy sandbox gateway
+    GATEWAY_MODE_SANDBOX      = 'sandbox'
+
+    # Execute query to PaynetEasy production gateway
+    GATEWAY_MODE_PRODUCTION   = 'production'
+
+    # Allowed gateway modes
+    @@allowed_gateway_modes =
+    [
+      GATEWAY_MODE_SANDBOX,
+      GATEWAY_MODE_PRODUCTION
+    ]
+
+    # Merchant end point
+    #
+    # @var [String]
+    attr_accessor :end_point
+
+    # Merchant login
+    #
+    # @var [String]
+    attr_accessor :login
+
+    # Merchant key for payment signing
+    #
+    # @var [String]
+    attr_accessor :signing_key
+
+    # URL the original payment is made from
+    #
+    # @var [String]
+    attr_accessor :site_url
+
+    # URL the customer will be redirected to upon completion of the transaction
+    #
+    # @var [String]
+    attr_accessor :redirect_url
+
+    # URL the transaction result will be sent to
+    #
+    # @var [String]
+    attr_accessor :callback_url
+
+    # PaynetEasy gateway mode: sandbox or production
+    #
+    # @var [String]
+    attr_accessor :gateway_mode
+
+    # PaynetEasy sandbox gateway URL
+    #
+    # @var [String]
+    attr_accessor :gateway_url_sandbox
+
+    # PaynetEasy production gateway URL
+    #
+    # @var [String]
+    attr_accessor :gateway_url_production
+
+    def gateway_mode=(gateway_mode)
+      check_gateway_mode gateway_mode
+      @gateway_mode = gateway_mode
+    end
+
+    def gateway_mode
+      @gateway_mode ||= GATEWAY_MODE_SANDBOX
+    end
+
+    # Get gateway url for current gateway mode
+    #
+    # @return   [String]    Sandbox gateway url if gateway mode is sandbox,
+    #                       production gateway url if gateway mode is production
+    def gateway_url
+      case gateway_mode
+      when GATEWAY_MODE_SANDBOX     then gateway_url_sandbox
+      when GATEWAY_MODE_PRODUCTION  then gateway_url_production
+      else raise RuntimeError, 'You must set gateway_mode property first'
+      end
+    end
+
+    protected
+
+    # Checks, is gateway mode allowed or not
+    #
+    # @param    gateway_mode    [String]    Gateway mode to check
+    def check_gateway_mode(gateway_mode)
+      unless @@allowed_gateway_modes.include? gateway_mode
+        raise ArgumentError, "Unknown gateway mode given: '#{gateway_mode}'"
+      end
+    end
+  end
+end

data/lib/paynet_easy/paynet_easy_api/payment_data/recurrent_card.rb

@@ -0,0 +1,40 @@
+require 'payment_data/data'
+
+module PaynetEasy::PaynetEasyApi::PaymentData
+  class RecurrentCard < Data
+    # RecurrentCard reference ID
+    #
+    # @var [String]
+    attr_accessor :paynet_id
+
+    # RecurrentCard CVV2
+    #
+    # @var [String]
+    attr_accessor :cvv2
+
+    # Card holder name
+    #
+    # @var [String]
+    attr_accessor :card_printed_name
+
+    # Card expiration year
+    #
+    # @var [String]
+    attr_accessor :expire_year
+
+    # Card expiration month
+    #
+    # @var [String]
+    attr_accessor :expire_month
+
+    # Bank Identification Number
+    #
+    # @var [String]
+    attr_accessor :bin
+
+    # The last four digits of PAN (card number)
+    #
+    # @var [String]
+    attr_accessor :last_four_digits
+  end
+end