transbank-sdk 1.0.1

data/lib/transbank/sdk/onepay/errors/response_error.rb

@@ -0,0 +1,8 @@
+module Transbank
+  module Onepay
+    module Errors
+      class ResponseError < TransbankError
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/errors/shopping_cart_error.rb

@@ -0,0 +1,8 @@
+module Transbank
+  module Onepay
+    module Errors
+      class ShoppingCartError < TransbankError
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/errors/signature_error.rb

@@ -0,0 +1,8 @@
+module Transbank
+  module Onepay
+    module Errors
+      class SignatureError < TransbankError
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/errors/transaction_commit_error.rb

@@ -0,0 +1,8 @@
+module Transbank
+  module Onepay
+    module Errors
+      class TransactionCommitError < TransbankError
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/errors/transaction_create_error.rb

@@ -0,0 +1,8 @@
+module Transbank
+  module Onepay
+    module Errors
+      class TransactionCreateError < TransbankError
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/errors/transbank_error.rb

@@ -0,0 +1,9 @@
+module Transbank
+  module Onepay
+    module Errors
+      class TransbankError < StandardError
+      end
+    end
+  end
+end
+

data/lib/transbank/sdk/onepay/models/channels.rb

@@ -0,0 +1,15 @@
+module Transbank
+  module Onepay
+    class Channel
+      ## Contains static values for all possible channel values
+
+      WEB = 'WEB'.freeze
+      MOBILE = 'MOBILE'.freeze
+      APP = 'APP'.freeze
+
+      def self.values
+        constants.map { |const| const_get const }
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/models/item.rb

@@ -0,0 +1,103 @@
+module Transbank
+  module Onepay
+    class Item
+      include Utils::JSONUtils
+      # An Item to be purchased by the user, and to be added to a [ShoppingCart]
+
+      # @return [String] An item's description
+      attr_reader :description
+
+      # @return quantity [Integer] How many of units of [Item]
+      attr_reader :quantity
+
+      # @return amount [Integer] The value of each unit of [Item]
+      attr_reader :amount
+
+      # @return additional_data [String] A string with whatever additional data the
+      # Merchant might want to add
+      attr_reader :additional_data
+
+      # @return expire [Integer] Expiry for the Item
+      attr_reader :expire
+      # @param [Hash] opts options Hash
+      # @param description [String] The item's description
+      # @param quantity [Integer] How many of units of [Item]
+      # @param amount [Integer] The value of each unit of [Item]
+      # @param additional_data [String] A string with whatever additional data the
+      # Merchant might want to add
+      # @param expire [Integer] Expiry for the Item
+      # @raise [ItemError] when opts is not a [Hash]
+      def initialize(opts = {})
+        raise Errors::ItemError, 'Item must be a Hash' unless opts.is_a? Hash
+        opts = transform_hash_keys opts
+        self.description = opts.fetch(:description)
+        self.quantity = opts.fetch(:quantity)
+        self.amount = opts.fetch(:amount)
+        self.additional_data = opts.fetch(:additional_data, nil)
+        self.expire = opts.fetch(:expire, nil)
+      end
+
+      # @param description [String] An item's description
+      # @raise [ItemError] when description is null
+      def description=(description)
+        raise Errors::ItemError, "Description cannot be null" if description.nil?
+        @description = description
+      end
+
+      # @param quantity [Integer] How many of units of [Item]
+      # @raise [ItemError] when given quantity is nil or less than zero.
+      def quantity=(quantity)
+        raise Errors::ItemError, "Quantity cannot be null" if quantity.nil?
+        if quantity < 0
+          raise Errors::ItemError, "Quantity cannot be less than zero"
+        end
+        @quantity = quantity
+      end
+
+      # @param amount [Integer] The value of each unit of [Item]
+      # @raise [ItemError] when amount cannot be null.
+      # @raise [ArgumentError] when amount is not an Integer.
+      def amount=(amount)
+        raise Errors::ItemError, "Amount cannot be null" if amount.nil?
+        if amount != Integer(amount)
+          raise ArgumentError, "Amount is not an Integer"
+        end
+        @amount = amount
+      end
+
+      # @param additional_data [String] A string with whatever additional data the
+      # Merchant might want to add
+      def additional_data=(additional_data)
+        additional_data = '' if additional_data.nil?
+        @additional_data = additional_data
+      end
+
+      # @param expire [Integer] Expiry for the Item
+      def expire=(expire)
+        expire = expire || 0
+        @expire = expire
+      end
+
+      # Return the total amount to pay for the Item, that is, amount * quantity
+      # @return [Numeric] the total amount to pay for the [Item]
+      def total
+        self.quantity * self.amount
+      end
+
+      # Override == to allow comparison between [Item]s
+      # @return [boolean] true if equal, false otherwise
+      def ==(another_item)
+         self.description == another_item.description &&
+         self.quantity == another_item.quantity &&
+         self.amount == another_item.amount &&
+         self.additional_data == another_item.additional_data &&
+         self.expire == another_item.expire
+      end
+
+      # Alias for #==
+      def eql?(another_item)
+        self.==(another_item)
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/models/models.rb

@@ -0,0 +1,10 @@
+require 'transbank/sdk/onepay/models/item'
+require 'transbank/sdk/onepay/models/channels'
+require 'transbank/sdk/onepay/models/refund'
+require 'transbank/sdk/onepay/models/shopping_cart'
+require 'transbank/sdk/onepay/models/transaction'
+
+module Transbank
+  module Onepay
+  end
+end

data/lib/transbank/sdk/onepay/models/refund.rb

@@ -0,0 +1,51 @@
+module Transbank
+  module Onepay
+    class Refund
+      extend Utils::NetHelper, Utils::RequestBuilder
+      # Manages Refunds
+      REFUND_TRANSACTION = 'nullifytransaction'.freeze
+      TRANSACTION_BASE_PATH = '/ewallet-plugin-api-services/services/transactionservice/'.freeze
+
+      class << self
+        # Create a request for a Refund
+        # @param amount [Integer] Amount to be refunded. Must be the full amount of the
+        # [Transaction] to be refunded
+        # @param occ [String] Merchant purchase order
+        # @param external_unique_number [String] Unique identifier (per Merchant) of the [Transaction] that
+        # will be refunded
+        # @param authorization_code [String] Authorization code. This is given when the [Transaction]
+        # is successfully committed (with the #commit method of [Transaction])
+        # @param options[Hash, nil] an optional Hash with configuration overrides
+        # @raise [RefundCreateError] if the response is nil or has no response code
+        # @raise [RefundCreateError] if response from the service is not equal to 'OK'
+        def create(amount:, occ:, external_unique_number:, authorization_code:, options: nil)
+          refund_request = refund_transaction(refund_amount: amount,
+                                              occ: occ,
+                                              external_unique_number: external_unique_number,
+                                              authorization_code: authorization_code,
+                                              options: options)
+          response = http_post(refund_path, refund_request.to_h)
+
+          if response.nil? || !response['responseCode']
+            raise Errors::RefundCreateError, 'Could not obtain a response from the service.'
+          end
+
+          refund_create_response = RefundCreateResponse.new(response)
+
+          unless refund_create_response.response_ok?
+            raise Errors::RefundCreateError, refund_create_response.full_description
+          end
+
+          refund_create_response
+        end
+
+        # Return the string url to POST to
+        # @return [String] the url to POST to
+        def refund_path
+          Base.current_integration_type_url + TRANSACTION_BASE_PATH + REFUND_TRANSACTION
+        end
+      end
+
+    end
+  end
+end

data/lib/transbank/sdk/onepay/models/shopping_cart.rb

@@ -0,0 +1,65 @@
+module Transbank
+  module Onepay
+    # Represents a Shopping Cart, which contains [Item]s that the user wants to buy
+    class ShoppingCart
+      include Utils::JSONUtils
+
+      # @return [Array<Item>] An [Array<Item>] with the [ShoppingCart] contents
+      attr_reader :items
+
+      # @param items [Array, nil] an array of Hashes that can be converted to [Item]
+      # if nil, an empty shopping cart is created
+      def initialize(items = [])
+        # An [Array<Item>] with the [ShoppingCart] contents
+        @items = []
+        return if items.nil? || items.empty?
+
+        items.each do |it|
+          it = transform_hash_keys it
+          item = Item.new it
+          self << item
+        end
+      end
+
+      # @param item [Item] an instance of [Item]
+      # @return [boolean] return true if item is successfully added
+      def add(item)
+        new_total = total + item.total
+        if new_total < 0
+          raise Errors::ShoppingCartError, "Total amount cannot be less than zero."
+        end
+        @items << item
+      end
+
+      # Alias for #add
+      def << item
+        add item
+      end
+
+      # Remove an [Item] from self
+      # @raise [ShoppingCartError] if item is not found
+      def remove(item)
+        if @items.delete(item).nil?
+          raise Errors::ShoppingCartError, "Item not found"
+        end
+      end
+
+      # Clear the cart, setting @items to []
+      def remove_all
+        @items = []
+      end
+
+      # @return [Integer] The amount in CLP of the [Item]s included in the [ShoppingCart]
+      def total
+        # Array#sum is Ruby 2.4+
+        @items.reduce(0) { |total, item| total + item.total }
+      end
+
+      # Sum the quantity of items in the cart
+      def items_quantity
+        # Array#sum is Ruby 2.4+
+        @items.reduce(0) { |total, item| total + item.quantity }
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/models/transaction.rb

@@ -0,0 +1,141 @@
+module Transbank
+  module Onepay
+    ## Class Transaction
+    #  This class creates or commits a Transaction (that is, a purchase)
+    class Transaction
+      extend Utils::NetHelper, Utils::RequestBuilder
+
+      SEND_TRANSACTION = 'sendtransaction'.freeze
+      COMMIT_TRANSACTION = 'gettransactionnumber'.freeze
+      TRANSACTION_BASE_PATH = '/ewallet-plugin-api-services/services/transactionservice/'.freeze
+
+      class << self
+        # Create a [Transaction], initiating the purchase process.
+        # @param shopping_cart [ShoppingCart] contains the [Item]s to be purchased
+        # @param channel [String] The channel that the transaction is going to be done through. Valid values are contained on the [Transbank::Onepay::Channel] class
+        # @param external_unique_number [String] a unique value (per Merchant, not global) that is used to identify a Transaction
+        # @param options[Hash, nil] an optional Hash with configuration overrides
+        # @return [TransactionCreateResponse] the response to your request.
+        # Includes data that you will need to #commit your [Transaction]
+        # @raise [ShoppingCartError] if shopping cart is nil or empty
+        # @raise [TransactionCreateError] if channel is not valid
+        # @raise [TransactionCreateError] if no response is gotten, or responseCode of the response is not 'OK'
+        def create(shopping_cart:, channel: nil, external_unique_number: nil,
+                   options: nil)
+          if is_options_hash?(channel)
+            options = channel
+            channel = nil
+          end
+
+          if is_options_hash?(external_unique_number)
+            options = external_unique_number
+            external_unique_number = nil
+          end
+
+          validate_channel!(channel)
+          validate_shopping_cart!(shopping_cart)
+
+          options = complete_options(options)
+          create_request = create_transaction(shopping_cart: shopping_cart,
+                                              channel: channel,
+                                              external_unique_number: external_unique_number,
+                                              options: options)
+          response = http_post(transaction_create_path, create_request.to_h)
+          validate_create_response!(response)
+          transaction_create_response = TransactionCreateResponse.new response
+          signature_is_valid = transaction_create_response.valid_signature?(options.fetch(:shared_secret))
+          unless signature_is_valid
+            raise Errors::SignatureError, "The response's signature is not valid."
+          end
+          transaction_create_response
+        end
+
+        # Commit a [Transaction]. It is MANDATORY for this to be done, and you have
+        # 30 seconds to do so, otherwise the [Transaction] is automatically REVERSED
+        # @param occ [String] Merchant purchase order
+        # @param external_unique_number [String] a unique value (per Merchant, not global) that is used to identify a Transaction
+        # @param options[Hash, nil] an optional Hash with configuration overrides
+        # @return [TransactionCommitResponse] The response to your commit request.
+        # @raise [TransactionCommitError] if response is nil or responseCode of the response is not 'OK'
+        def commit(occ:, external_unique_number:, options: nil)
+          options = complete_options(options)
+          commit_request = commit_transaction(occ: occ,
+                                              external_unique_number: external_unique_number,
+                                              options: options)
+          response = http_post(transaction_commit_path, commit_request.to_h)
+          validate_commit_response!(response)
+          transaction_commit_response = TransactionCommitResponse.new(response)
+          signature_is_valid = transaction_commit_response.valid_signature?(options.fetch(:shared_secret))
+          unless signature_is_valid
+            raise Errors::SignatureError, "The response's signature is not valid."
+          end
+          transaction_commit_response
+        end
+
+        private
+
+        def is_options_hash?(hash)
+          return false unless hash.respond_to? :keys
+          # Intersection of the two arrays
+          ([:api_key, :shared_secret] & hash.keys).any?
+        end
+
+        def validate_channel!(channel)
+          if channel_is_app?(channel) && Base::app_scheme.nil?
+            raise Errors::TransactionCreateError, 'You need to set an app_scheme if you want to use the APP channel'
+          end
+
+          if channel_is_mobile?(channel) && Base::callback_url.nil?
+            raise Errors::TransactionCreateError, 'You need to set a valid callback if you want to use the MOBILE channel'
+          end
+        end
+
+        def validate_shopping_cart!(shopping_cart)
+          if shopping_cart.items.nil? || shopping_cart.items.empty?
+            raise Errors::ShoppingCartError, 'Shopping cart is null or empty.'
+          end
+        end
+
+        def validate_commit_response!(response)
+          unless response
+            raise Errors::TransactionCommitError, 'Could not obtain a response from the service.'
+          end
+
+          unless response.fetch('responseCode') == 'OK'
+            msg = "#{response.fetch('responseCode')} : #{response.fetch('description')}"
+            raise Errors::TransactionCommitError,  msg
+          end
+          response
+        end
+
+        def validate_create_response!(response)
+          unless response
+            raise Errors::TransactionCreateError, 'Could not obtain a response from the service.'
+          end
+
+          unless response.fetch('responseCode') == 'OK'
+            msg = "#{response.fetch('responseCode')} : #{response['description']}"
+            raise Errors::TransactionCreateError, msg
+          end
+          response
+        end
+
+        def channel_is_app?(channel)
+          channel && channel == Transbank::Onepay::Channel::APP
+        end
+
+        def channel_is_mobile?(channel)
+          channel && channel == Transbank::Onepay::Channel::MOBILE
+        end
+
+        def transaction_create_path
+          Base.current_integration_type_url + TRANSACTION_BASE_PATH + SEND_TRANSACTION
+        end
+
+        def transaction_commit_path
+          Base.current_integration_type_url + TRANSACTION_BASE_PATH + COMMIT_TRANSACTION
+        end
+      end
+    end
+  end
+end