transbank-sdk 1.0.1

data/lib/transbank/sdk/onepay/utils/request_builder.rb

@@ -0,0 +1,88 @@
+module Transbank
+  module Onepay
+    module Utils
+      module RequestBuilder
+        # Create a [Transaction] request. Used internally by [Transaction]#create
+        # @param shopping_cart [ShoppingCart] the user's ShoppingCart, with [Item]s
+        # he/she intends to purchase
+        # @param channel [String] The channel the operation is made on. Valid values
+        # are on the [Channel] class
+        # @param external_unique_number [String, nil] a unique value (per Merchant, not global) that is used to identify a Transaction
+        # @param options [Hash, nil] a hash with config overrides
+        def create_transaction(shopping_cart:, channel:, external_unique_number: nil, options: nil)
+          channel = Base.default_channel if channel.nil?
+          external_unique_number = time_as_number if external_unique_number.nil?
+          options = complete_options(options)
+          issued_at = Time.now.to_i
+
+          request = TransactionCreateRequest.new(external_unique_number: external_unique_number,
+                                                 total: shopping_cart.total,
+                                                 items_quantity: shopping_cart.items_quantity,
+                                                 issued_at: issued_at,
+                                                 items: shopping_cart.items,
+                                                 callback_url: Base.callback_url,
+                                                 channel: channel,
+                                                 app_scheme: Base.app_scheme)
+          request.set_keys_from_options(options)
+          request.app_key = Base::current_integration_type_app_key
+          request.sign(options.fetch(:shared_secret))
+        end
+
+        # Used internally by [Transaction]#commit
+        # @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] a hash with config overrides
+        def commit_transaction(occ:, external_unique_number:, options: nil)
+          options = complete_options(options)
+          issued_at = Time.now.to_i
+          request = TransactionCommitRequest.new(occ, external_unique_number, issued_at)
+          request.set_keys_from_options(options)
+          request.app_key = Base::current_integration_type_app_key
+          request.sign(options.fetch(:shared_secret))
+        end
+
+        # Used internally by [Refund]#create
+        # @param refund_amount [Integer] the full amount of the [Transaction] to refund. No partial refunds allowed.
+        # @param occ [String] Merchant purchase order of the order to refund
+        # @param external_unique_number [String] external unique number of the [Transaction] to refund
+        # @param authorization_code [String] authorization code for the [Transaction] to refund.
+        # This is given when you successfully #commit a [Transaction]
+        # @param options [Hash, nil] a hash with config overrides
+        def refund_transaction(refund_amount:, occ:, external_unique_number:, authorization_code:, options: nil)
+          options = complete_options(options)
+          issued_at = Time.now.to_i
+          request = RefundCreateRequest.new(nullify_amount: refund_amount,
+                                            occ: occ,
+                                            external_unique_number: external_unique_number,
+                                            authorization_code: authorization_code,
+                                            issued_at: issued_at)
+          request.set_keys_from_options(options)
+          request.app_key = Base::current_integration_type_app_key
+          request.sign(options.fetch(:shared_secret))
+        end
+
+        def time_as_number
+          # Float#truncate(number_of_digits_to_leave) is from Ruby 2.4 onwards
+          number, decimals = Time.now.to_f.to_s.split('.')
+          (number + decimals[0..2]).to_i
+        end
+
+        # Fill options with default values
+        def complete_options(options = {})
+          options = {} if options.nil?
+          default_options.merge(options)
+        end
+
+        # Return the default options values:
+        # api_key: Base::api_key
+        # app_key: Base::current_integration_type_app_key
+        # shared_secret: Base::shared_secret
+        # @return [Hash] a hash with the aforementioned keys/values
+        def default_options
+          { api_key: Base::api_key,
+            shared_secret: Base::shared_secret }
+        end
+      end
+    end
+  end
+end

data/lib/transbank/sdk/onepay/utils/signature_utils.rb

@@ -0,0 +1,49 @@
+module Transbank
+  module Onepay
+    module Utils
+      # Utils for creating signatures, included on classes that need to be signed
+      module SignatureUtils
+        # Transform the instance of the class that calls this method into a
+        # string in the format required for the signature, using the params defined
+        # in the class' SIGNATURE_PARAMS array constant
+        # @raise [RuntimeError] if self.class::SIGNATURE_PARAMS is nil or empty
+        def to_data
+          if self.class::SIGNATURE_PARAMS.nil? || self.class::SIGNATURE_PARAMS.empty?
+            raise RuntimeError, 'SIGNATURE_PARAMS is empty or nil!'
+          end
+          self.class::SIGNATURE_PARAMS.reduce('') do |data_string, current_value|
+            value_of_getter = send(current_value)
+            # Integer#digits is ruby 2.4 upwards :(
+            data_string + value_of_getter.to_s.length.to_s + value_of_getter.to_s
+          end
+        end
+
+        # Digest data and secret, creating a hashed string
+        # @param data [String] a string created from the signable, created using #to_data
+        # @param secret [String] the string to hash the data with.
+        # @return [String] the result of the hashing of data with secret.
+        def hmac_sha256(data, secret)
+          OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), secret, data)
+        end
+
+        # Return the base64 of the hmac_sha256'd data & secret
+        # @param data [String] a string created from the signable, created using #to_data
+        # @param secret [String] the string to hash the data with.
+        # @return [String] Base64 representation of the hmac_sha256 hashing of data & secret
+        def signature_for(data, secret)
+          Base64.encode64(hmac_sha256(data, secret)).strip
+        end
+
+        # Compare the @signature of self with the one recreated from self using
+        # the secret param. Return true if equal
+        # @param secret [String] the secret used to create the signature with.
+        # @return [boolean] return true if signatures match, false otherwise
+        def valid_signature?(secret)
+          # We should be able to recreate the same signature from the signable's data
+          # and the secret
+          self.signature == signature_for(self.to_data, secret)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'transbank/sdk/onepay/utils/json_utils'
+require 'transbank/sdk/onepay/utils/net_helper'
+require 'transbank/sdk/onepay/utils/signature_utils'
+require 'transbank/sdk/onepay/utils/request_builder'
+
+module Transbank
+  module Onepay
+  end
+end

data/lib/transbank/sdk/version.rb

@@ -0,0 +1,5 @@
+module Transbank
+  module Sdk
+    VERSION = "1.0.1"
+  end
+end

data/sdk_test.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+docker-compose run --rm web rake test

data/transbank-sdk.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "transbank/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "transbank-sdk"
+  spec.version       = Transbank::Sdk::VERSION
+  spec.authors       = ["Transbank Developers"]
+  spec.email         = ["transbankdevelopers@continuum.cl"]
+
+  spec.summary       = %q{Transbank SDK for Ruby}
+  spec.homepage      = "https://www.transbankdevelopers.cl/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 0.59.2"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1.9'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: transbank-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Transbank Developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- transbankdevelopers@continuum.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".built"
+- ".bundled"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE.md
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/transbank/sdk.rb
+- lib/transbank/sdk/onepay/base.rb
+- lib/transbank/sdk/onepay/errors/errors.rb
+- lib/transbank/sdk/onepay/errors/integration_type_error.rb
+- lib/transbank/sdk/onepay/errors/invalid_options_error.rb
+- lib/transbank/sdk/onepay/errors/item_error.rb
+- lib/transbank/sdk/onepay/errors/refund_create_error.rb
+- lib/transbank/sdk/onepay/errors/response_error.rb
+- lib/transbank/sdk/onepay/errors/shopping_cart_error.rb
+- lib/transbank/sdk/onepay/errors/signature_error.rb
+- lib/transbank/sdk/onepay/errors/transaction_commit_error.rb
+- lib/transbank/sdk/onepay/errors/transaction_create_error.rb
+- lib/transbank/sdk/onepay/errors/transbank_error.rb
+- lib/transbank/sdk/onepay/models/channels.rb
+- lib/transbank/sdk/onepay/models/item.rb
+- lib/transbank/sdk/onepay/models/models.rb
+- lib/transbank/sdk/onepay/models/refund.rb
+- lib/transbank/sdk/onepay/models/shopping_cart.rb
+- lib/transbank/sdk/onepay/models/transaction.rb
+- lib/transbank/sdk/onepay/requests/refund_create_request.rb
+- lib/transbank/sdk/onepay/requests/request.rb
+- lib/transbank/sdk/onepay/requests/requests.rb
+- lib/transbank/sdk/onepay/requests/transaction_commit_request.rb
+- lib/transbank/sdk/onepay/requests/transaction_create_request.rb
+- lib/transbank/sdk/onepay/responses/refund_create_response.rb
+- lib/transbank/sdk/onepay/responses/response.rb
+- lib/transbank/sdk/onepay/responses/responses.rb
+- lib/transbank/sdk/onepay/responses/transaction_commit_response.rb
+- lib/transbank/sdk/onepay/responses/transaction_create_response.rb
+- lib/transbank/sdk/onepay/utils/json_utils.rb
+- lib/transbank/sdk/onepay/utils/net_helper.rb
+- lib/transbank/sdk/onepay/utils/request_builder.rb
+- lib/transbank/sdk/onepay/utils/signature_utils.rb
+- lib/transbank/sdk/onepay/utils/utils.rb
+- lib/transbank/sdk/version.rb
+- sdk_test.sh
+- transbank-sdk.gemspec
+homepage: https://www.transbankdevelopers.cl/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Transbank SDK for Ruby
+test_files: []