pixelpay_sdk 1.0.0.pre.beta.1

data/lib/pixelpay_sdk/models/Item.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Item represents the item information for a request.
+class Item
+  attr_accessor :code, :title, :price, :qty, :tax, :total
+
+  # Initialize model
+  def initialize
+    # Item identifier code or UPC/EAN
+    @code = nil
+
+    # Item product title
+    @title = nil
+
+    # Item per unit price
+    @price = 0.00
+
+    # Item quantity
+    @qty = 1
+
+    # Item tax amount per unit
+    @tax = 0.00
+
+    # Item total value
+    @total = 0.00
+  end
+
+  # Totalize item price by quantity.
+  # Returns:
+  #   Item: self.
+  def totalize
+    @total = @price * @qty
+
+    self
+  end
+end

data/lib/pixelpay_sdk/models/Order.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "../base/Helpers"
+
+# Order represents the order information for a request.
+class Order
+  attr_accessor :id, :currency, :amount, :tax_amount, :shipping_amount, :content, :extras, :note,
+                :callback_url, :customer_name, :customer_email
+
+  # Initialize model
+  def initialize
+    # Order ID
+    @id = nil
+
+    # Order currency code alpha-3
+    @currency = nil
+
+    # Order total amount
+    @amount = 0.00
+
+    # Order total tax amount
+    @tax_amount = 0.00
+
+    # Order total shipping amount
+    @shipping_amount = 0.00
+
+    # Order summary of items or products
+    @content = []
+
+    # Order extra properties
+    @extras = {}
+
+    # Order note or aditional instructions
+    @note = nil
+
+    # Order calback webhook URL
+    @callback_url = nil
+
+    # Order customer name
+    @customer_name = nil
+
+    # Order customer email
+    @customer_email = nil
+  end
+
+  # Add item to content list of products/items of the order.
+  # Args:
+  #   item (Item): model Item.
+  # Returns:
+  #   Order: self.
+  def add_item(item)
+    begin
+      Helpers.verify_type(TypeError, Item, item.instance_of?(Item))
+
+      @content.append(item)
+      totalize
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+
+  # Add extra property to order.
+  # Args:
+  #   key (string): represents the id of the extra.
+  #   value (any): represents the content of the extra.
+  # Returns:
+  #   Order: self.
+  def add_extra(key, value)
+    @extras[key] = value.to_s if key.to_s != "" && value.to_s != ""
+
+    self
+  end
+
+  # Totalize order amounts and items.
+  # Returns:
+  #   Order: self.
+  def totalize
+    if @content.length.positive?
+      @amount = 0.00
+      @tax_amount = 0.00
+
+      @content.each do |item|
+        item.totalize
+        @amount += item.total
+        @tax_amount += item.tax * item.qty
+      end
+    end
+
+    self
+  end
+end

data/lib/pixelpay_sdk/models/Settings.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative "../resources/Environment"
+# Settings represents the settings information for a request.
+class Settings
+  attr_accessor :auth_key, :auth_hash, :auth_user, :endpoint, :environment, :lang
+
+  # Initialize model
+  def initialize
+    # Merchant API auth key
+    @auth_key = nil
+
+    # Merchant API auth hash (MD5 of secret key)
+    @auth_hash = nil
+
+    # Merchant API platform auth user (SHA-512 of user email)
+    @auth_user = nil
+
+    # Merchant API endpoint URL
+    @endpoint = "https://pixelpay.app"
+
+    # Merchant API environment
+    @environment = nil
+
+    # Settings response messages language
+    @lang = nil
+  end
+
+  # Setup API endpoint URL.
+  # Args:
+  #   endpoint (string): new endpoint URL.
+  # Returns:
+  #   Settings: self.
+  def setup_endpoint(endpoint)
+    @endpoint = endpoint.to_s
+
+    self
+  end
+
+  # Setup API Credentials.
+  # Args:
+  #   key (string): represents the merchant model key ID.
+  #   hash (string): represents the merchant model secret key.
+  # Returns:
+  #   Settings: self.
+  def setup_credentials(key, hash)
+    @auth_key = key.to_s
+    @auth_hash = hash.to_s
+
+    self
+  end
+
+  # Setup API platform user.
+  # Args:
+  #   hash (string): represents the merchant user's email.
+  # Returns:
+  #   Settings: self.
+  def setup_platform_user(hash)
+    @auth_user = hash.to_s
+
+    self
+  end
+
+  # Setup API platform environment.
+  # Args:
+  #   env (string): new environment.
+  # Returns:
+  #   Settings: self.
+  def setup_environment(env)
+    @environment = env.to_s
+
+    self
+  end
+
+  # Setup defaults to Sandbox credentials.
+  def setup_sandbox
+    @endpoint = "https://pixel-pay.com"
+    @auth_key = "1234567890"
+    @auth_hash = Helpers.hash("MD5", "@s4ndb0x-abcd-1234-n1l4-p1x3l")
+    @environment = Environment::SANDBOX
+  end
+
+  # Setup response messages language.
+  # Args:
+  #   lang (string): represents the language to be used.
+  # Returns:
+  #   Settings: self.
+  def setup_language(lang)
+    @lang = lang.to_s
+
+    self
+  end
+end

data/lib/pixelpay_sdk/request/AuthTransaction.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "./PaymentTransaction"
+
+# AuthTransaction defines an authentication transaction request.
+class AuthTransaction < PaymentTransaction
+end

data/lib/pixelpay_sdk/request/CaptureTransaction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../base/RequestBehaviour"
+
+# CaptureTransaction defines a capture transaction request.
+class CaptureTransaction < RequestBehaviour
+  attr_accessor :payment_uuid, :transaction_approved_amount
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Payment UUID
+    @payment_uuid = nil
+
+    # The total amount to capture, equal to or less than the authorized amount.
+    @transaction_approved_amount = nil
+  end
+end

data/lib/pixelpay_sdk/request/CardTokenization.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "../base/Helpers"
+require_relative "../base/RequestBehaviour"
+
+# CardTokenization defines a card tokenization request.
+class CardTokenization < RequestBehaviour
+  attr_accessor :number, :cvv2, :expire_month, :expire_year, :customer,
+                :cardholder, :address, :country, :state, :city, :zip, :phone, :email
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Card number or PAN
+    @number = nil
+
+    # Card security code
+    @cvv2 = nil
+
+    # Card expire month date (MM)
+    @expire_month = nil
+
+    # Card expire year date (YYYY)
+    @expire_year = nil
+
+    # Tokenized customer identifier (C-* format)
+    @customer = nil
+
+    # Cardholder name
+    @cardholder = nil
+
+    # Customer billing address
+    @address = nil
+
+    # Customer billing country alpha-2 code (ISO 3166-1)
+    @country = nil
+
+    # Customer billing state alpha code (ISO 3166-2)
+    @state = nil
+
+    # Customer billing city
+    @city = nil
+
+    # Customer billing postal code
+    @zip = nil
+
+    # Customer billing phone
+    @phone = nil
+
+    # Customer email
+    @email = nil
+  end
+
+  # Associate and mapping Card model properties to transaction.
+  # Args:
+  #   card (Card): input Card.
+  # Returns:
+  #   CardTokenization: self.
+  def set_card(card)
+    begin
+      Helpers.verify_type(TypeError, Card, card.instance_of?(Card))
+
+      @number = Helpers.trim_value(card.number)
+      @cvv2 = card.cvv2
+      @expire_month = format("%02d", card.expire_month)
+      @expire_year = card.expire_year.to_s
+      @cardholder = Helpers.trim_value(card.cardholder)
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+
+  # Associate and mapping Billing model properties to transaction.
+  # Args:
+  #   billing (Billing): input Billing.
+  # Returns:
+  #   CardTokenization: self.
+  def set_billing(billing)
+    begin
+      Helpers.verify_type(TypeError, Billing, billing.instance_of?(Billing))
+
+      @address = Helpers.trim_value(billing.address)
+      @country = billing.country
+      @state = billing.state
+      @city = Helpers.trim_value(billing.city)
+      @zip = billing.zip
+      @phone = billing.phone
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+end

data/lib/pixelpay_sdk/request/PaymentTransaction.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require_relative "../base/Helpers"
+require_relative "../base/RequestBehaviour"
+
+# PaymentTransaction defines the structure for a payment transaction request.
+class PaymentTransaction < RequestBehaviour
+  attr_accessor :payment_uuid, :card_token, :card_number, :card_cvv, :card_expire, :card_holder, :billing_address,
+                :billing_country, :billing_state, :billing_city, :billing_zip, :billing_phone, :customer_name,
+                :customer_email, :order_id, :order_currency, :order_amount, :order_tax_amount, :order_shipping_amount,
+                :order_content, :order_extras, :order_note, :order_callback, :authentication_request,
+                :authentication_identifier
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Payment UUID
+    @payment_uuid = nil
+
+    # Tokenized card identifier (T-* format)
+    @card_token = nil
+
+    # Card number or PAN
+    @card_number = nil
+
+    # Card security code
+    @card_cvv = nil
+
+    # Card expire year/month date (YYMM)
+    @card_expire = nil
+
+    # Cardholder name
+    @card_holder = nil
+
+    # Customer billing address
+    @billing_address = nil
+
+    # Customer billing country alpha-2 code (ISO 3166-1)
+    @billing_country = nil
+
+    # Customer billing state alpha code (ISO 3166-2)
+    @billing_state = nil
+
+    # Customer billing city
+    @billing_city = nil
+
+    # Customer billing postal code
+    @billing_zip = nil
+
+    # Customer billing phone
+    @billing_phone = nil
+
+    # Order customer name
+    @customer_name = nil
+
+    # Order customer email
+    @customer_email = nil
+
+    # Order ID
+    @order_id = nil
+
+    # Order currency code alpha-3
+    @order_currency = nil
+
+    # Order total amount
+    @order_amount = nil
+
+    # Order total tax amount
+    @order_tax_amount = nil
+
+    # Order total shipping amount
+    @order_shipping_amount = nil
+
+    # Order summary of items or products
+    @order_content = []
+
+    # Order extra properties
+    @order_extras = {}
+
+    # Order note or aditional instructions
+    @order_note = nil
+
+    # Order calback webhook URL
+    @order_callback = nil
+
+    # Activate authentication request (3DS/EMV)
+    @authentication_request = false
+
+    # Authentication transaction identifier
+    @authentication_identifier = nil
+  end
+
+  # Associate and mapping Card model properties to transaction.
+  # Args:
+  #   card (Card): input Card.
+  # Returns:
+  #   PaymentTransaction: self.
+  def set_card(card)
+    begin
+      Helpers.verify_type(TypeError, Card, card.instance_of?(Card))
+
+      @card_number = Helpers.clean_string(card.number)
+      @card_cvv = card.cvv2
+      @card_expire = card.get_expire_format
+      @card_holder = Helpers.trim_value(card.cardholder)
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+
+  # Associate and card token string to transaction.
+  # Args:
+  #   card (string): input card token.
+  # Returns:
+  #   PaymentTransaction: self.
+  def set_card_token(token)
+    @card_token = token.to_s
+
+    self
+  end
+
+  # Associate and mapping Billing model properties to transaction.
+  # Args:
+  #   billing (Billing): input Billing.
+  # Returns:
+  #   PaymentTransaction: self.
+  def set_billing(billing)
+    begin
+      Helpers.verify_type(TypeError, Billing, billing.instance_of?(Billing))
+
+      @billing_address = Helpers.trim_value(billing.address)
+      @billing_country = billing.country
+      @billing_state = billing.state
+      @billing_city = Helpers.trim_value(billing.city)
+      @billing_zip = billing.zip
+      @billing_phone = billing.phone
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+
+  # Associate and mapping Order model properties to transaction.
+  # Args:
+  #   order (Order): input Order.
+  # Returns:
+  #   PaymentTransaction: self.
+  def set_order(order)
+    begin
+      Helpers.verify_type(TypeError, Order, order.instance_of?(Order))
+
+      @order_id = order.id
+      @order_currency = order.currency
+      @order_amount = Helpers.parse_amount(order.amount)
+      @order_tax_amount = Helpers.parse_amount(order.tax_amount)
+      @order_shipping_amount = Helpers.parse_amount(order.shipping_amount)
+      @order_content = order.content.empty? ? [] : order.content
+      @order_extras = order.extras.empty? ? {} : order.extras
+      @order_note = Helpers.trim_value(order.note)
+      @order_callback = order.callback_url
+
+      @customer_name = Helpers.trim_value(order.customer_name)
+      @customer_email = order.customer_email
+    rescue StandardError => e
+      warn("An exception occurred: #{e.message}")
+    end
+
+    self
+  end
+
+  # Enable 3DS/EMV authentication request.
+  def with_authentication_request
+    @authentication_request = true
+  end
+end

data/lib/pixelpay_sdk/request/SaleTransaction.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "./PaymentTransaction"
+
+# SaleTransaction defines a sale transaction request.
+class SaleTransaction < PaymentTransaction
+end

data/lib/pixelpay_sdk/request/StatusTransaction.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "../base/RequestBehaviour"
+
+# StatusTransaction defines a status transaction request.
+class StatusTransaction < RequestBehaviour
+  attr_accessor :payment_uuid
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Payment UUID
+    @payment_uuid = nil
+  end
+end

data/lib/pixelpay_sdk/request/VoidTransaction.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../base/RequestBehaviour"
+
+# VoidTransaction defines a void transaction request.
+class VoidTransaction < RequestBehaviour
+  attr_accessor :payment_uuid, :void_reason
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Payment UUID
+    @payment_uuid = nil
+
+    # Reason for void the order
+    @void_reason = nil
+  end
+end

data/lib/pixelpay_sdk/resources/Environment.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Module for environment types.
+module Environment
+  LIVE = "live"
+  TEST = "test"
+  SANDBOX = "sandbox"
+  STAGING = "staging"
+end

data/lib/pixelpay_sdk/resources/Locations.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "json"
+
+# Utility class.
+class Locations
+  CURRENT_DIR = File.dirname(__FILE__).freeze
+
+  # Returns a list of countries.
+  # Returns:
+  #   hash: hash with available countries.
+  def self.countries_list
+    countries_path = File.join(CURRENT_DIR, "..", "assets", "countries.json")
+    countries_file = File.read(countries_path)
+
+    JSON.parse(countries_file)
+  end
+
+  # Get states list by country ISO code.
+  # Args:
+  #   country_code (string): input country code.
+  # Returns:
+  #   hash: hash with available states if country_code exists, otherwise an empty hash.
+  def self.states_list(country_code)
+    states_path = File.join(CURRENT_DIR, "..", "assets", "states.json")
+    states_file = File.read(states_path)
+    states_hash = JSON.parse(states_file)
+
+    states_hash.key?(country_code.to_s) ? states_hash[country_code.to_s] : {}
+  end
+
+  # Get phone and zip formats list by country ISO code.
+  # Args:
+  #   country_code (string): input country code.
+  # Returns:
+  #   hash: hash with format data if country_code exists, otherwise an empty hash.
+  def self.formats_list(country_code)
+    formats_path = File.join(CURRENT_DIR, "..", "assets", "formats.json")
+    formats_file = File.read(formats_path)
+    formats_hash = JSON.parse(formats_file)
+
+    formats_hash.key?(country_code.to_s) ? formats_hash[country_code.to_s] : {}
+  end
+end

data/lib/pixelpay_sdk/responses/ErrorResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# ErrorResponse provides a specific structure for an error response coming from
+# a transaction.
+class ErrorResponse < Response
+end

data/lib/pixelpay_sdk/responses/FailureResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# FailureResponse provides a specific structure for a failure response coming from
+# a transaction.
+class FailureResponse < Response
+end

data/lib/pixelpay_sdk/responses/InputErrorResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# InputErrorResponse provides a specific structure for an input error response coming from
+# a transaction.
+class InputErrorResponse < Response
+end

data/lib/pixelpay_sdk/responses/NetworkFailureResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# NetworkFailureResponse provides a specific structure for a network failure response
+# coming from a transaction.
+class NetworkFailureResponse < Response
+end

data/lib/pixelpay_sdk/responses/NoAccessResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# NoAccessResponse provides a specific structure for a no access response
+# coming from a transaction.
+class NoAccessResponse < Response
+end

data/lib/pixelpay_sdk/responses/NotFoundResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# NotFoundResponse provides a specific structure for a not found response
+# coming from a transaction.
+class NotFoundResponse < Response
+end

data/lib/pixelpay_sdk/responses/PayloadResponse.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../base/Response"
+
+# PayloadResponse provides a specific structure for a payload response
+# coming from a transaction.
+class PayloadResponse < Response
+end