pixelpay_sdk 1.0.0.pre.beta.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5f07580ae9e4680a5cea20ae57c4c74bd09fecbe87c4355866d6a49922f8c0c
-  data.tar.gz: 49a60f57f531f6cd67af47a0b6152817f7d93826635ff34f52ffb29a617628c6
+  metadata.gz: 5d4b20a4b0077958eada69ed725caa66e324eb497a3973879e926b64cb95e32d
+  data.tar.gz: e6fb746c133ae0941f0d6cd45adf0c539fc7298cf777ce655c87478a9d49c4a5
 SHA512:
-  metadata.gz: 1fdbc16e08e20c37435ea86c2098f3da943e71b8ab11e4f9203a5010126d6aa4b7af044c4bf5c6b6ac7bdf23d56d27e17e586d14b3aee51825face6c032072a3
-  data.tar.gz: 5be5b2837421a5ab0a39aa3888d5013886e60d3cf15e8b197ccaf63d2a3b928ae6ee956bbc12c892d9746b5dd6b3cd4bf7cca476d1a8d35e0eb83c8014fd5089
+  metadata.gz: b35dfea4cb2529de9caba5e9606ec48fcdf0dceb5ae28663306f52dd7d3aadc4f438d747b8055dc679fac03fe51bfbd0a7a62e67628e384e700f84bbb318054b
+  data.tar.gz: a634ace97445adbb752999e160969fc050fe7e8ae2f710de39ef85b558e9a8bb60a650f8c621f49a5b1c02cae6e24bca7945097f9b1235acd65500c7a5fb01f1

data/CHANGELOG.md

@@ -5,6 +5,31 @@ El formato se basa en [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 y este proyecto se adhiere a [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 Tipos de cambios: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`.
 
+## [1.0.1] - 2023-09-21
+### Removed
+- Se elimina lógica de encriptación de datos de tarjeta.
+
+## [1.0.0] - 2023-08-09
+### Added
+- Se agregó encriptación de datos de tarjeta.
+- Se omiten los métodos de encriptación si la petición no lo requiere.
+- Se arregló servicios de tokenización enviando fecha de expiración incorrecta si no se llenan los campos.
+- Se agregó campos faltantes de programas en `TransactionResult`.
+
+## [1.0.0-beta.3] - 2023-06-08
+### Added
+- Se agregan campos de cuotas y puntos.
+- Se agrega firma de transacciones de anulación.
+- Se agrega helper `object_to_hash`.
+
+### Fixed
+- Se corrige asignación de la propiedad `order_content` en la clase `PaymentTransaction`.
+- Se corrige test `test_transaction_with_3ds`.
+
+### Changed
+- Se cambia estructura de helper `object_to_json`.
+- Se cambia estructura de helper `verify_type`.
+
 ## [1.0.0-beta.2] - 2023-05-26
 ### Added
 - Se agrega importación de `SaleTransaction` al archivo principal.
@@ -14,4 +39,4 @@ Tipos de cambios: `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Securit
 
 ## [1.0.0-beta.1] - 2023-05-12
 ### Added
-- Se publica primer version de pruebas
+- Se publica primer version de pruebas.

data/CONTRIBUTING.md

@@ -9,3 +9,19 @@ rake test
 ```
 - Agregar al `CHANGELOG.md` las descripciones del cambio.
 - Crear un commit con los cambios, agregar una etiqueta con el número de versión y hacer push con los tags.
+
+## Pruebas
+Ejecutar todos los unit tests:
+```bash
+rake test
+```
+
+Ejecutar todos los unit tests de un archivo:
+```bash
+rake test TEST=test/requests/test_sale_transaction.rb
+```
+
+Ejecutar unit test en particular:
+```bash
+rake test TEST=test/models/test_billing.rb TESTOPTS="--name=test_empty_billing"
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pixelpay_sdk (1.0.0.pre.beta.2)
+    pixelpay_sdk (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,15 +5,15 @@
 Para obtener la versión del SDK de PixelPay con Ruby puedes utilizar este comando para instalar directamente:
 
 ``` bash
-gem install pixelpay_sdk-1.0.0-beta.2
+gem install pixelpay_sdk-1.0.1
 ```
 
 O puedes colocar en el archivo Gemfile la siguiente línea:
 ``` bash
-gem 'pixelpay_sdk', '~> 1.0.0.pre.beta.2'
+gem 'pixelpay_sdk', '~> 1.0.1'
 ```
 
 Y luego ejecutar:
 ``` bash
 bundle install
-```
+```

data/lib/pixelpay_sdk/base/Helpers.rb

@@ -6,17 +6,17 @@ require "json"
 module Helpers
   # Serialize object to JSON string without empties.
   # Args:
-  #   value (hash): hash to serialize.
+  #   value (object): object to serialize.
   # Returns
   #   string: JSON string.
   def self.object_to_json(value)
-    verify_type(TypeError, Object, value.is_a?(Object))
+    verify_type(Object, value.is_a?(Object))
 
     hash = {}
     value.instance_variables.each { |var| hash[var.to_s.delete("@")] = value.instance_variable_get(var) }
 
     hash.each do |attr_name, attr_value|
-      if hash[attr_name].nil? || hash[attr_name].to_s.empty? || hash[attr_value].to_s == "[]" || hash[attr_value].to_s == "{}"
+      if hash[attr_name].nil? || hash[attr_name].to_s.empty? || (attr_value.is_a?(Array) && attr_value.empty?) || (attr_value.is_a?(Hash) && attr_value.empty?)
         hash.delete(attr_name)
       end
     end
@@ -26,6 +26,18 @@ module Helpers
     warn("An exception occurred: #{e.message}")
   end
 
+  # Serialize object to hash.
+  # Args:
+  #   value (object): object to serialize.
+  # Returns
+  #   hash.
+  def self.object_to_hash(value)
+    hash = {}
+    value.instance_variables.each { |var| hash[var.to_s.delete("@")] = value.instance_variable_get(var) }
+
+    hash
+  end
+
   # Hash of a given value using the specified algorithm.
   # Args:
   #   algorithm (string): algorithm to use (e.g. "MD5", "SHA-1", "SHA-256").
@@ -40,6 +52,8 @@ module Helpers
       Digest::SHA1.hexdigest(value.to_s)
     when "SHA-256"
       Digest::SHA256.hexdigest(value.to_s)
+    when "SHA-512"
+      Digest::SHA512.hexdigest(value.to_s)
     else
       ""
     end
@@ -74,19 +88,11 @@ module Helpers
 
   # Verify type of data.
   # Args:
-  #   error_type: error type to raise.
   #   expected: data type expected.
   #   flag: condition.
   # Returns:
   #   throw an error if the condition is met
-  def self.verify_type(error_type, expected, flag)
-    case error_type.to_s
-    when "TypeError"
-      raise TypeError, "This function only accepts parameters of type #{expected}." unless flag
-    when "InvalidCredentialsException"
-      raise InvalidCredentialsException, "This function only accepts parameters of type #{expected}." unless flag
-    when "InvalidTransactionTypeException"
-      raise InvalidTransactionTypeException, "This function only accepts parameters of type #{expected}." unless flag
-    end
+  def self.verify_type(expected, flag)
+    raise TypeError, "This function only accepts parameters of type #{expected}." unless flag
   end
 end

data/lib/pixelpay_sdk/base/RequestBehaviour.rb

@@ -12,10 +12,13 @@ class RequestBehaviour
   def initialize
     # Environment identifier (live|test|sandbox)
     @env = nil
+
     # Transaction response messages language
     @lang = I18n.locale.to_s
+
     # SDK identifier type
     @from = "sdk-ruby"
+
     # SDK version
     @sdk_version = PixelpaySdk::VERSION
 

data/lib/pixelpay_sdk/base/ServiceBehaviour.rb

@@ -5,6 +5,7 @@ require "json"
 require "uri"
 
 require_relative "../base/Helpers"
+require_relative "../base/RequestBehaviour"
 require_relative "../exceptions/InvalidCredentialsException"
 require_relative "../responses/ErrorResponse"
 require_relative "../responses/FailureResponse"
@@ -24,8 +25,9 @@ class ServiceBehaviour
 
   # Initialize service.
   def initialize(settings)
-    Helpers.verify_type(TypeError, Settings, settings.instance_of?(Settings))
+    Helpers.verify_type(Settings, settings.instance_of?(Settings))
 
+    # Settings service model
     @settings = settings
   rescue StandardError => e
     warn("An exception occurred: #{e.message}")
@@ -86,6 +88,7 @@ class ServiceBehaviour
     response = FailureResponse.new
     response.success = false
     response.message = exception.to_s
+    response.set_status(520)
 
     response
   end
@@ -100,7 +103,7 @@ class ServiceBehaviour
   # Returns:
   #   req: prepared request.
   def build_request(uri, method, transaction)
-    Helpers.verify_type(TypeError, RequestBehaviour, transaction.is_a?(RequestBehaviour))
+    Helpers.verify_type(RequestBehaviour, transaction.is_a?(RequestBehaviour))
 
     if settings.auth_key.nil? || settings.auth_hash.nil?
       raise InvalidCredentialsException, "The merchant credentials are not definied (key/hash)."
@@ -127,7 +130,7 @@ class ServiceBehaviour
 
     request["Accept"] = "application/json"
     request["Content-Type"] = "application/json"
-    request["-Agent"] = "PixelPay HTTP/3 SDK Ruby"
+    request["User-Agent"] = "PixelPay HTTP/3 SDK Ruby"
     request["x-auth-key"] = @settings.auth_key
     request["x-auth-hash"] = @settings.auth_hash
 
@@ -179,7 +182,7 @@ class ServiceBehaviour
   # Returns:
   #   response: parsed response.
   def put(url, body)
-    Helpers.verify_type(TypeError, RequestBehaviour, body.is_a?(RequestBehaviour))
+    Helpers.verify_type(RequestBehaviour, body.is_a?(RequestBehaviour))
 
     uri = get_route(url)
     req = build_request(uri, "PUT", body)
@@ -200,7 +203,7 @@ class ServiceBehaviour
   # Returns:
   #   response: parsed response.
   def delete(url, body)
-    Helpers.verify_type(TypeError, RequestBehaviour, body.is_a?(RequestBehaviour))
+    Helpers.verify_type(RequestBehaviour, body.is_a?(RequestBehaviour))
 
     uri = get_route(url)
     req = build_request(uri, "DELETE", body)
@@ -221,7 +224,7 @@ class ServiceBehaviour
   # Returns:
   #   response: parsed response.
   def get(url, body)
-    Helpers.verify_type(TypeError, RequestBehaviour, body.is_a?(RequestBehaviour))
+    Helpers.verify_type(RequestBehaviour, body.is_a?(RequestBehaviour))
 
     uri = get_route(url)
     req = build_request(uri, "GET", body)

data/lib/pixelpay_sdk/entities/TransactionResult.rb

@@ -8,16 +8,20 @@ require_relative "../responses/TimeoutResponse"
 
 # TransactionResult provides a specific structure for a response coming from a transaction.
 class TransactionResult
-  attr_accessor :transaction_type, :transaction_approved_amount, :transaction_amount, :transaction_auth,
-                :transaction_terminal, :transaction_merchant, :response_cvn, :response_avs, :response_cavv,
-                :transaction_id, :transaction_reference, :transaction_time, :transaction_date, :response_approved,
-                :response_incomplete, :response_code, :response_time, :response_reason, :payment_uuid, :payment_hash
+  attr_accessor :transaction_type, :transaction_redeemed_points, :transaction_approved_amount, :transaction_amount,
+                :transaction_auth, :transaction_terminal, :transaction_merchant, :response_cvn, :response_avs,
+                :response_cavv, :transaction_id, :transaction_reference, :transaction_time, :transaction_date,
+                :response_approved, :response_incomplete, :response_code, :response_time, :response_reason,
+                :installment_type, :installment_months, :payment_uuid, :payment_hash
 
   # Initialize enitity.
   def initialize
     # Transaction response type
     @transaction_type = nil
 
+    # Transaction redeemed points
+    @transaction_redeemed_points = nil
+
     # Approved amount on capture/sale
     @transaction_approved_amount = nil
 
@@ -69,6 +73,12 @@ class TransactionResult
     # Proccesor response message
     @response_reason = nil
 
+    # Transaction installment type
+    @installment_type = nil
+
+    # Transaction installment value
+    @installment_months = nil
+
     # Payment unique identifier
     @payment_uuid = nil
 

data/lib/pixelpay_sdk/models/Order.rb

@@ -50,7 +50,7 @@ class Order
   #   Order: self.
   def add_item(item)
     begin
-      Helpers.verify_type(TypeError, Item, item.instance_of?(Item))
+      Helpers.verify_type(Item, item.instance_of?(Item))
 
       @content.append(item)
       totalize

data/lib/pixelpay_sdk/models/Settings.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../base/Helpers"
 require_relative "../resources/Environment"
 # Settings represents the settings information for a request.
 class Settings

data/lib/pixelpay_sdk/request/CardTokenization.rb

@@ -59,12 +59,12 @@ class CardTokenization < RequestBehaviour
   #   CardTokenization: self.
   def set_card(card)
     begin
-      Helpers.verify_type(TypeError, Card, card.instance_of?(Card))
+      Helpers.verify_type(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
+      @expire_month = format("%02d", card.expire_month) if card.expire_month != 0
+      @expire_year = card.expire_year.to_s if card.expire_year != 0
       @cardholder = Helpers.trim_value(card.cardholder)
     rescue StandardError => e
       warn("An exception occurred: #{e.message}")
@@ -80,7 +80,7 @@ class CardTokenization < RequestBehaviour
   #   CardTokenization: self.
   def set_billing(billing)
     begin
-      Helpers.verify_type(TypeError, Billing, billing.instance_of?(Billing))
+      Helpers.verify_type(Billing, billing.instance_of?(Billing))
 
       @address = Helpers.trim_value(billing.address)
       @country = billing.country

data/lib/pixelpay_sdk/request/PaymentTransaction.rb

@@ -98,7 +98,7 @@ class PaymentTransaction < RequestBehaviour
   #   PaymentTransaction: self.
   def set_card(card)
     begin
-      Helpers.verify_type(TypeError, Card, card.instance_of?(Card))
+      Helpers.verify_type(Card, card.instance_of?(Card))
 
       @card_number = Helpers.clean_string(card.number)
       @card_cvv = card.cvv2
@@ -129,7 +129,7 @@ class PaymentTransaction < RequestBehaviour
   #   PaymentTransaction: self.
   def set_billing(billing)
     begin
-      Helpers.verify_type(TypeError, Billing, billing.instance_of?(Billing))
+      Helpers.verify_type(Billing, billing.instance_of?(Billing))
 
       @billing_address = Helpers.trim_value(billing.address)
       @billing_country = billing.country
@@ -151,14 +151,14 @@ class PaymentTransaction < RequestBehaviour
   #   PaymentTransaction: self.
   def set_order(order)
     begin
-      Helpers.verify_type(TypeError, Order, order.instance_of?(Order))
+      Helpers.verify_type(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_content = order.content.map { |item| Helpers.object_to_hash(item) }
       @order_extras = order.extras.empty? ? {} : order.extras
       @order_note = Helpers.trim_value(order.note)
       @order_callback = order.callback_url

data/lib/pixelpay_sdk/request/SaleTransaction.rb

@@ -1,7 +1,39 @@
 # frozen_string_literal: true
 
+require_relative "../base/Helpers"
 require_relative "./PaymentTransaction"
 
 # SaleTransaction defines a sale transaction request.
 class SaleTransaction < PaymentTransaction
+  attr_accessor :installment_type, :installment_months, :points_redeem_amount
+
+  # Initialize request.
+  def initialize
+    super()
+
+    # Transaction installment type
+    @installment_type = nil
+
+    # Transaction installment value
+    @installment_months = nil
+
+    # Transaction total points redeem amount
+    @points_redeem_amount = nil
+  end
+
+  # Set Installment service values to transaction.
+  # Args:
+  #   months (int): installment months.
+  #   installment_type (string): The installment type.
+  def set_installment(months, installment_type)
+    @installment_months = months.to_s
+    @installment_type = installment_type.to_s
+  end
+
+  # Set transaction points redeem amount.
+  # Args:
+  #   amount (float): points redeem amount.
+  def with_points_redeem_amount(amount)
+    @points_redeem_amount = Helpers.parse_amount(amount.to_f)
+  end
 end

data/lib/pixelpay_sdk/request/VoidTransaction.rb

@@ -4,7 +4,7 @@ require_relative "../base/RequestBehaviour"
 
 # VoidTransaction defines a void transaction request.
 class VoidTransaction < RequestBehaviour
-  attr_accessor :payment_uuid, :void_reason
+  attr_accessor :payment_uuid, :void_reason, :void_signature
 
   # Initialize request.
   def initialize
@@ -15,5 +15,8 @@ class VoidTransaction < RequestBehaviour
 
     # Reason for void the order
     @void_reason = nil
+
+    # Required signature for void authentication
+    @void_signature = nil
   end
 end

data/lib/pixelpay_sdk/services/Tokenization.rb

@@ -15,7 +15,7 @@ class Tokenization < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def vault_card(card)
-    Helpers.verify_type(TypeError, CardTokenization, card.instance_of?(CardTokenization))
+    Helpers.verify_type(CardTokenization, card.instance_of?(CardTokenization))
 
     post(BASE_CARD_PATH, card)
   rescue StandardError => e
@@ -29,7 +29,7 @@ class Tokenization < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def update_card(token, card)
-    Helpers.verify_type(TypeError, CardTokenization, card.instance_of?(CardTokenization))
+    Helpers.verify_type(CardTokenization, card.instance_of?(CardTokenization))
 
     put("#{BASE_CARD_PATH}/#{token}", card)
   rescue StandardError => e

data/lib/pixelpay_sdk/services/Transaction.rb

@@ -3,6 +3,9 @@
 require_relative "../base/Helpers"
 require_relative "../base/ServiceBehaviour"
 require_relative "../request/StatusTransaction"
+require_relative "../request/AuthTransaction"
+require_relative "../request/CaptureTransaction"
+require_relative "../request/VoidTransaction"
 require_relative "../exceptions/InvalidTransactionTypeException"
 
 # Transaction provides a specific structure for a transaction to be performed.
@@ -11,7 +14,7 @@ class Transaction < ServiceBehaviour
   # Args:
   #   transaction (PaymentTransaction) : input.
   def eval_authentication_transaction(transaction)
-    Helpers.verify_type(TypeError, PaymentTransaction, transaction.is_a?(PaymentTransaction))
+    Helpers.verify_type(PaymentTransaction, transaction.is_a?(PaymentTransaction))
 
     if transaction.authentication_request
       raise InvalidTransactionTypeException, "This platform does not support 3DS transactions."
@@ -26,7 +29,7 @@ class Transaction < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def do_sale(transaction)
-    Helpers.verify_type(TypeError, SaleTransaction, transaction.instance_of?(SaleTransaction))
+    Helpers.verify_type(SaleTransaction, transaction.instance_of?(SaleTransaction))
 
     err = eval_authentication_transaction(transaction)
     raise InvalidTransactionTypeException, err.message if err.instance_of?(InvalidTransactionTypeException)
@@ -42,7 +45,7 @@ class Transaction < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def do_auth(transaction)
-    Helpers.verify_type(TypeError, AuthTransaction, transaction.instance_of?(AuthTransaction))
+    Helpers.verify_type(AuthTransaction, transaction.instance_of?(AuthTransaction))
 
     err = eval_authentication_transaction(transaction)
     raise InvalidTransactionTypeException, err.message if err.instance_of?(InvalidTransactionTypeException)
@@ -58,7 +61,7 @@ class Transaction < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def do_capture(transaction)
-    Helpers.verify_type(TypeError, CaptureTransaction, transaction.instance_of?(CaptureTransaction))
+    Helpers.verify_type(CaptureTransaction, transaction.instance_of?(CaptureTransaction))
 
     post("api/v2/transaction/capture", transaction)
   rescue StandardError => e
@@ -71,7 +74,7 @@ class Transaction < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def do_void(transaction)
-    Helpers.verify_type(TypeError, VoidTransaction, transaction.instance_of?(VoidTransaction))
+    Helpers.verify_type(VoidTransaction, transaction.instance_of?(VoidTransaction))
 
     post("api/v2/transaction/void", transaction)
   rescue StandardError => e
@@ -84,7 +87,7 @@ class Transaction < ServiceBehaviour
   # Returns:
   #   Response: processed response.
   def get_status(transaction)
-    Helpers.verify_type(TypeError, StatusTransaction, transaction.instance_of?(StatusTransaction))
+    Helpers.verify_type(StatusTransaction, transaction.instance_of?(StatusTransaction))
 
     post("api/v2/transaction/status", transaction)
   rescue StandardError => e

data/lib/pixelpay_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PixelpaySdk
-  VERSION = "1.0.0-beta.2"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixelpay_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Sonia Villeda
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -86,9 +86,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: