pixelpay_sdk 1.0.0.pre.beta.1 → 1.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a0d8a459d1e32c060be76638e28ca35ff75c0817e57888ae6ac8a2c0c39649
-  data.tar.gz: e03267b8f5e39ff4a6a25c90d0327b1f7d120c3d81a1aafbefd96be971e6fe03
+  metadata.gz: 961abbeb4b8500cf6a7b72d56b6e989f9ad272eea07ac70cf84f6358e5770edd
+  data.tar.gz: 8d74a9ce9e7cdcebea00c63cbb6b2cee9c80c658cba56a679a8caa4ce94fdff2
 SHA512:
-  metadata.gz: 91cdacddd093d1029bc4dbd60e8f8b7631cdb20bf078f35cb47b0752a1e02f45c3e876922349a075abd0288e9c15da153245bcefb89ce109f8a520cb79c0a9d5
-  data.tar.gz: 106cfdca78930e679bd3ed67beb8baf48f72e31040ed0c882b122269ab9ea4e735cf536abb0eab2d8f8814f9f962bc535a6e880993714a6233841ad93bb2a5e0
+  metadata.gz: 572a75320c2523a9ba0a42ec5dfa17da844d1c51381486bc584a1d516b10c5bf617b30cacf55d4eb0b078134a76f6559a5a18d95c619adba1d2d8082aae1487c
+  data.tar.gz: efabb3851beab2c6dbc4430a5d54bbafb49418d4ce7e251e08eb34a53fb8129d52effaa247611b8bab34181a9ec2de91ddce97bf7a95a12800756b56cf330935

data/CHANGELOG.md

@@ -5,6 +5,27 @@ 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.0-beta.1] - 2022-05-12
+## [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.
+
+### Fixed
+- Se cambia a estáticos los métodos de `TransactionResult` y `CardResult`.
+
+## [1.0.0-beta.1] - 2023-05-12
 ### Added
 - 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.1)
+    pixelpay_sdk (1.0.0.pre.beta.3)
 
 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.1
+gem install pixelpay_sdk-1.0.0-beta.3
 ```
 
 O puedes colocar en el archivo Gemfile la siguiente línea:
 ``` bash
-gem 'pixelpay_sdk', '~> 1.0.0.pre.beta.1'
+gem 'pixelpay_sdk', '~> 1.0.0.pre.beta.3'
 ```
 
 Y luego ejecutar:
 ``` bash
 bundle install
-```
+```

data/bitbucket-pipelines.yml

@@ -1,9 +1,3 @@
-#  Template Ruby build
-#
-#  This template allows you to validate your Ruby code.
-#  The workflow allows running tests and release on master branch.
-#  Requires environment variables to be configured:
-#     RUBYGEMS_API_KEY: RubyGem.org API Key
 image: ruby:2.7
 
 pipelines:

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/Response.rb

@@ -68,11 +68,4 @@ class Response
 
     @data[key.to_s]
   end
-
-  # Serialize object to JSON string.
-  # Returns:
-  #   string: JSON string.
-  # def object_to_json
-  #   Helpers.object_to_json(self)
-  # end
 end

data/lib/pixelpay_sdk/base/ServiceBehaviour.rb

@@ -24,7 +24,7 @@ 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 = settings
   rescue StandardError => e
@@ -100,7 +100,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)."
@@ -179,7 +179,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 +200,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 +221,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/CardResult.rb

@@ -56,7 +56,7 @@ class CardResult
   #   response (Reponse): Response to validate.
   # Returns:
   #   bool: is valid response.
-  def validate_response(response)
+  def self.validate_response(response)
     response.instance_of?(SuccessResponse)
   end
 
@@ -65,7 +65,7 @@ class CardResult
   #   response (Reponse): Input response.
   # Returns:
   #   CardResult: mapped result.
-  def from_response(response)
+  def self.from_response(response)
     entity = CardResult.new
 
     entity.instance_variables.each do |var_name|

data/lib/pixelpay_sdk/entities/TransactionResult.rb

@@ -81,7 +81,7 @@ class TransactionResult
   #   response (Reponse): Response to validate.
   # Returns:
   #   bool: is valid response.
-  def validate_response(response)
+  def self.validate_response(response)
     response.instance_of?(SuccessResponse) || response.instance_of?(PaymentDeclinedResponse) || response.instance_of?(InputErrorResponse) || response.instance_of?(TimeoutResponse)
   end
 
@@ -90,7 +90,7 @@ class TransactionResult
   #   response (Reponse): Input response.
   # Returns:
   #   TransactionResult: mapped result.
-  def from_response(response)
+  def self.from_response(response)
     entity = TransactionResult.new
 
     entity.instance_variables.each do |var_name|

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/request/CardTokenization.rb

@@ -59,7 +59,7 @@ 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
@@ -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
+  #   financing_type (str): installment type
+  def set_installment(months, financing_type)
+    @installment_months = months.to_s
+    @installment_type = financing_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

@@ -11,7 +11,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 +26,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 +42,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 +58,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 +71,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 +84,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.1"
+  VERSION = "1.0.0-beta.3"
 end

data/lib/pixelpay_sdk.rb

@@ -10,6 +10,7 @@ require_relative "pixelpay_sdk/request/AuthTransaction"
 require_relative "pixelpay_sdk/request/CaptureTransaction"
 require_relative "pixelpay_sdk/request/CardTokenization"
 require_relative "pixelpay_sdk/request/PaymentTransaction"
+require_relative "pixelpay_sdk/request/SaleTransaction"
 require_relative "pixelpay_sdk/request/StatusTransaction"
 require_relative "pixelpay_sdk/request/VoidTransaction"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixelpay_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0.pre.beta.3
 platform: ruby
 authors:
 - Sonia Villeda
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: