tbk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99cb29a42231d962dba1a8c07dc0711c53ea7dd5
-  data.tar.gz: 712f5a91ebc80e5a5d2dbfb50d8c41eb648ed14d
+  metadata.gz: 23651dab425128f9a304cfc75827c22133accc87
+  data.tar.gz: cccbb98ef6fc50bf809e57e02fa8a018c96aa30b
 SHA512:
-  metadata.gz: 6403bd694ccc81e3a614ff8b45600861b6f4e90f7605943df23e23fdd17528540810314ac4c57e7127b01ed47cec648c851039ff7910e0f06d8216194686681a
-  data.tar.gz: a2b3ed5bf65e15f30b96651ba4819bb91688c32072a7fca7951d218288c237720a106808f908b400a66aaaf21115dcd22df370f9f249e00579b91fed8781898d
+  metadata.gz: ec0da50f8c95611d8c9eff7badd39551848dd4b45bb20c545549d6d31e6deded37309badc69ee3cb15a1b5f72bcace893a707acb6374725c97462219a817d72d
+  data.tar.gz: 35783d42fec9ac1bade1ccd4016a223d2bf602481dd66cf1843e2422eb6124927727a492944760d6b45bb8d4c43ddfdd8c2fd9589da2de9907edf6569e8d45ee

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.rspec
+.rvmrc
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+bundler_args: --without docs
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+addons:
+   code_climate:
+     repo_token: 993125436d81e62150b5b089e19b7d51a677b4f0ce59012b8cc9e17b4d72fb60
+

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--hide-void-return
+
+--markup=markdown
+--markup-provider=redcarpet

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tbk.gemspec
+gemspec
+
+platforms :jruby do
+  gem "jruby-openssl"
+end
+
+group :docs do
+  gem 'yard'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem "codeclimate-test-reporter", require: false
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Seba Gamboa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+### About
+[![Gem Version](https://badge.fury.io/rb/tbk.png)](http://badge.fury.io/rb/tbk)
+[![Build Status](https://travis-ci.org/sagmor/tbk.png)](https://travis-ci.org/sagmor/tbk)
+[![Code Climate](https://codeclimate.com/github/sagmor/tbk.png)](https://codeclimate.com/github/sagmor/tbk)
+
+This is a pure ruby replacement of Transbank's Binary Integration Kit (aka. KCC)
+developed to simplify the integration with it's payment gateway Webpay.
+
+
+### Disclaimer
+
+This library is not developed, supported nor endorsed in any way by Transbank S.A.
+and is the result of reverse engineering Transbank's Integration Kit (aka. KCC)
+for interoperability purposes as allowed by
+[Chilean Law 20.435 Article 71 Ñ Section b](http://www.leychile.cl/Navegar?idNorma=1012827)
+
+### Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tbk'
+```
+
+Configure your commerce
+
+```ruby
+TBK.configure do |config|
+  config.commerce_id YOUR_COMMERCE_ID
+  config.commerce_key YOUR_RSA_KEY
+
+  # When certifying with Transbank you'll need to use the official logger
+  config.webpay_logger :official do |logger|
+    # On this path will be the config file and logs in the KCC format.
+    logger.directory Rails.root.join('log/webpay')
+  end
+end
+```
+
+To start a payment from your application
+
+```ruby
+class WebpayController < ApplicationController
+
+  # ...
+
+  # Start a payment
+  def pay
+    # Setup the payment
+    @payment = TBK::Webpay::Payment.new({
+      request_ip: request.ip,
+      amount: ORDER_AMOUNT,
+      order_id: ORDER_ID,
+      success_url: webpay_success_url,
+      # Webpay can only access the HTTP protocol to a direct IP address (keep that in mind)
+      confirmation_url: webpay_confirmation_url(host: SERVER_IP_ADDRESS, protocol: 'http'),
+
+      # Optionaly supply:
+      session_id: SOME_SESSION_VALUE,
+      failure_url: webpay_failure_url # success_url is used by default
+    })
+
+    # Redirect the user to Webpay
+    redirect_to @payment.redirect_url
+  end
+
+  # ...
+end
+```
+
+And to process a payment
+
+```ruby
+class WebpayController < ApplicationController
+
+  # ...
+
+  # Confirmation callback executed from Webpay servers
+  def confirmation
+    # Read the confirmation data from the request
+    @confirmation = TBK::Webpay::Confirmation.new({
+      request_ip: request.ip,
+      body: request.raw_post
+    })
+
+    if # confirmation is invalid for some reason (wrong order_id or amount, double payment, etc...)
+      render text: @confirmation.reject
+      return # reject and stop execution
+    end
+
+    if @confirmation.success?
+      # EXITO!
+      # perform everything you have to do here.
+    end
+
+    # Acknowledge payment
+    render text: @confirmation.acknowledge
+  end
+
+  # ...
+
+end
+```
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sagmor/tbk/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tbk.rb

@@ -0,0 +1,12 @@
+require "base64"
+require "openssl"
+require "securerandom"
+require "net/https"
+require "cgi"
+
+require "tbk/version"
+require "tbk/config"
+require "tbk/errors"
+require "tbk/keys"
+require "tbk/commerce"
+require "tbk/webpay"

data/lib/tbk/commerce.rb

@@ -0,0 +1,69 @@
+
+module TBK
+  # Represents a commerce registered with Transbank
+  class Commerce
+
+    # The registered commerce id
+    # @return [Integer] the commerce id
+    attr_reader :id
+
+    # The commerce secret RSA key
+    # @return [OpenSSL::PKey::RSA] the commerce key
+    attr_reader :key
+
+    # The commerce environment
+     # @return [Symbol] the commerce environment
+    attr_reader :environment
+
+    # Initializes a new commerce
+    # @param [Hash] attributes The commerce attributes
+    # @option attributes [Integer] :id The commerce ID
+    # @option attributes [String|OpenSSL::PKey::RSA] :key The commerce RSA private key
+    # @option attributes [Boolean] :test flag to set commerce in test mode
+    def initialize(attributes)
+      @environment = (attributes[:environment] || :production).to_sym
+      raise TBK::CommerceError, "Invalid commerce environment" unless [:production,:test].include? @environment
+
+      @id = attributes[:id]
+      raise TBK::CommerceError, "Missing commerce id" if self.id.nil?
+
+      @key = case attributes[:key]
+      when String
+        OpenSSL::PKey::RSA.new(attributes[:key])
+      when OpenSSL::PKey::RSA
+        attributes[:key]
+      when nil
+        TEST_COMMERCE_KEY if self.test?
+      end
+
+      raise TBK::CommerceError, "Missing commerce key" if self.key.nil?
+      raise TBK::CommerceError, "Commerce key must be a RSA private key" unless self.key.private?
+    end
+
+    # @return [Boolean] whether or not the commerce is in test mode
+    def test?
+      self.environment == :test
+    end
+
+    # @return [Boolean] whether or not the commerce is in production mode
+    def production?
+      self.environment == :production
+    end
+
+    # @return [Integer] RSA key bytes
+    def key_bytes
+      self.key.n.num_bytes
+    end
+
+    # @return [TBK::Commerce] The default commerce
+    def self.default_commerce
+      @default_commerce ||= Commerce.new({
+        :id => TBK.config.commerce_id,
+        :key => TBK.config.commerce_key,
+        :environment => TBK.config.environment
+      }) unless TBK.config.commerce_id.nil?
+    end
+
+    TEST_COMMERCE_KEY = TBK.parse_key('test_commerce')
+  end
+end

data/lib/tbk/config.rb

@@ -0,0 +1,43 @@
+module TBK
+  class Config
+
+    # Set and gets the default commerce id
+    def commerce_id(id = nil)
+      @id = id if id
+      @id || ENV['TBK_COMMERCE_ID']
+    end
+
+    # Sets and gets the default commerce key
+    def commerce_key(key = nil)
+      @key = key if key
+      @key || ENV['TBK_COMMERCE_KEY']
+    end
+
+    # Sets the default commerce environment
+    # @return [Symbol] the default commerce environment
+    def environment(environment = nil)
+      @environment = environment if environment
+      (@environment || ENV['TBK_COMMERCE_ENVIRONMENT'] || :production).to_sym
+    end
+  end
+
+  # Returns the configuration object
+  # @return [TBK::Config] the configuration object
+  def self.config
+    @config ||= Config.new
+  end
+
+  # Configure the app defaults simply by doing
+  #
+  #     TBK.configure do |config|
+  #       config.commerce_id 123456
+  #       config.commerce_key File.read(COMMERCE_KEY_PATH)
+  #     end
+  #
+  # @yield [TBK::Config] The config object
+  def self.configure(&block)
+    yield(self.config)
+    nil
+  end
+
+end

data/lib/tbk/errors.rb

@@ -0,0 +1,16 @@
+module TBK
+  class Error < StandardError
+    attr_reader :origin
+    def initialize(msg, origin=nil)
+      super(msg)
+      @origin = origin
+    end
+  end
+
+  class CommerceError < Error; end
+
+  module Webpay
+    class PaymentError < Error; end
+    class EncryptionError < Error; end
+  end
+end

data/lib/tbk/keys.rb

@@ -0,0 +1,5 @@
+module TBK
+  def self.parse_key(name)
+    OpenSSL::PKey::RSA.new( File.read(File.expand_path("../keys/#{name}.pem",__FILE__)) )
+  end
+end

data/lib/tbk/keys/test_commerce.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAn3HzPC1ZBzCO3edUCf/XJiwj3bzJpjjTi/zBO9O+DDzZCaMp
+14aspxQryvJhv8644E19Q+NHfxtz1cxd2wnSYKvay1gJx30ZlTOAkzUj4QMimR16
+vomLlQ3T2MAz1znt/PVPVU7T/JOG9R+EbiHNVKa/hUjwJEFVXLQNME97nHoLjb3v
+V5yV2aVhmox7b54n6F3UVPHvCsHKbJpXpE+vnLpVmdETbNpFVrDygXyG+mnEvyiO
+BLIwEY3XTMrgXvS069groLi5Gg8C5LDaYOWjE9084T4fiWGrHhn2781R1rykunTu
+77wiWPuQHMS0+YC7mhnsk8Z/ilD+aWz/vhsgHwIDAQABAoIBAQCM+Nrt4cpNKQmn
++Ne8348CGRS9ACXp6WRg6OCQXO4zM7lRZAminVgZgSQXE6aJR+T9rIWMeG7GWydX
+aJGzEEQJZOjV0MkUr+7mk9qiTOGkGHmGlyHnRQU8jDU59vXe3UEl3l5+NmwHbQht
+waf9F7XLmoLK/WoVJA6tICRpCl1oQrpziqN+gjdmMpz9i8I1sMFE7+Y7xf+7S2u7
+c1MRPUWqgdS9yViQVh3vZi25m5CyKRVnOB0hpNuZ7nrJymtADYSWt9wV2W1fX+MX
+UUoYfxyQQvWryHhGdedU7GGAnoEdblUcDkBuAaFmsm1P8K4HQZLWP4v6pYlW2JLa
+Zoaerb3BAoGBANCRevl0CLB0HBU7sCs0eN9fTkIEsh3OVIxPSBqDnKsynJrIWovK
+cs37Vb6phzdQO3ADoFJvR9ck8+v6Cv0KR8IOFl9wfC4ZoxkKBBeq94ZLN+YhE2PW
+KiRFybqcgCtzxKS3MyWgpIcT9xFtHVjlorZ8Jk51fgLZbGzamtLhderVAoGBAMO0
+mIiiV4l2vXzu4tFfkpu/GOx/D9/vAic3X9FOky09BNCyuMXMQgI8e3wWsGEZghls
+Vg9KDV5EPxAmpumcdPFK2IMACaH41ac7vys3ZD8kMK0INQkuDAcG4YsxMaTwEPo0
+p1i3zwwEWwknw1yJkOyozz0EcIzS9NrZZEjnBHEjAoGAQ81XdeqzvHEyg/CQd6sq
+NCtubGXMZYYi1C4d2Yi5kKn2YRcK4HDi23V+TWodK+0oNWToZIQKjbVUmn0Bv3rt
+EvezbDlMFUx+SfCIng0VRJIFTQmpnQYNUxdg2gpwXC/ZWFa6CNxtQABMjFy1cqXM
+PJild1IYseJurgBu3mkvBTUCgYBqA/T1X2woLUis2wPIBAv5juXDh3lkB6eU8uxX
+CEe2I+3t2EM781B2wajrKadWkmjluMhN9AGV5UZ8S1P0DStUYwUywdx1/8RNmZIP
+qSwHAGXV9jI0zNr7G4Em0/leriWkRM26w6fHjLx8EyxDfsohSbkqBrOptcWqoEUx
+MOQ5HQKBgAS4sbddOas2MapuhKU2surEb3Kz3RCIpta4bXgTQMt9wawcZSSpvnfT
+zs5sehYvBFszL3MV98Uc50HXMf7gykRCmPRmB9S+f+kiVRvQDHfc9nRNg2XgcotU
+KAE16PQM8GihQ0C+EcXHouyud5CRJGfyurokRlH/jY3BiRAG5c+6
+-----END RSA PRIVATE KEY-----

data/lib/tbk/keys/webpay.101.pem

@@ -0,0 +1,14 @@
+-----BEGIN PUBLIC KEY-----
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAxKKjroxE7X44TQovh9A9
+ZpntP7LrdoyFsnJbDKjOOCoiid92FydN5qemyQCeXhsc7QHUXwGdth22fB8xJr3a
+MZBEUJ+BKFrL+W6yE5V+F5Bj0Uq3lL0QMAIftGhLpgqw0ZMtU89kyd9Q4Rclq4r8
+p2m/ZD7Pn5EmTOFSeyoWTMZQDl7OEoCKh/cZH5NJdWL08lCI+sGLOghRmFzkve4h
+F9JCwKA7NYG7j3BWh39Oj2NIXEY/TO1Y3Y2WfNv9nvTpr46SpFlyp0KOhSiqgvXX
+DgeXlebyqS82ch2DzOV9fjDAw7t71WXJBAev8Gd6HXwIXE/JP6AnLCa2Y+b6Wv8K
+GWBCMIBXWL0m7WHeCaJ9Hx2yXZmHJh8FgeKffFKCwn3X90JiMocOSGsOE+Sfo85S
+h/39Vc7vZS3i7kJDDoz9ab9/vFy30RuJf4p8Erh7kWtERVoG6/EhR+j4N3mgIOBZ
+SHfzDAoOnqP5l7t2RXYcEbRLVN6o+XgUtalX33EJxJRsXoz9a6PxYlesIwPbKteD
+BZ/xyJDwTc2gU2YzSH8G9anKrcvITBDULSAuxQUkYOiLbkb7vSKWDYKe0do6ibO3
+RY/KXI63Q7bGKYaI2aa/8GnqVJ2G1U2s59NpqX0aaWjn59gsA8trA0YKOZP4xJIh
+CvLM94G4V7lxe2IHKPqLscMCAwEAAQ==
+-----END PUBLIC KEY-----

data/lib/tbk/keys/webpay_test.101.pem

@@ -0,0 +1,14 @@
+-----BEGIN PUBLIC KEY-----
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtKe3HHWwRcizAfkbS92V
+fQr8cUb94TRjQPzNTqBduvvj65AD5J98Cn1htE3NzOz+PjPRcnfVe53V4f3+YlIb
+6nnxyeuYLByiwoPkCmpOFBxNp04/Yh3dxN4xgOANXA37rNbDeO4WIEMG6zbdQMNJ
+7RqQUlJSmui8gt3YxtqWBhBVW79qDCYVzxFrv3SH7pRuYEr+cxDvzRylxnJgr6ee
+N7gmjoSMqF16f9aGdQ12obzV0A35BqpN6pRFoS/NvICbEeedS9g5gyUHf54a+juB
+OV2HH5VJsCCgcb7I7Sio/xXTyP+QjIGJfpukkE8F+ohwRiChZ9jMXofPtuZYZiFQ
+/gX08s5Qdpaph65UINP7crYbzpVJdrT2J0etyMcZbEanEkoX8YakLEBpPhyyR7mC
+73fWd9sTuBEkG6kzCuG2JAyo6V8eyISnlKDEVd+/6G/Zpb5cUdBCERTYz5gvNoZN
+zkuq4isiXh5MOLGs91H8ermuhdQe/lqvXf8Op/EYrAuxcdrZK0orI4LbPdUrC0Jc
+Fl02qgXRrSpXo72anOlFc9P0blD4CMevW2+1wvIPA0DaJPsTnwBWOUqcfa7GAFH5
+KGs3zCiZ5YTLDlnaps8koSssTVRi7LVT8HhiC5mjBklxmZjBv6ckgQeFWgp18kuU
+ve5Elj5HSV7x2PCz8RKB4XcCAwEAAQ==
+-----END PUBLIC KEY-----

data/lib/tbk/version.rb

@@ -0,0 +1,7 @@
+module TBK
+  module VERSION
+    GEM = "1.0.2"
+    KCC = "6.0"
+    WEBSITE = "http://sagmor.com/tbk/"
+  end
+end

data/lib/tbk/webpay.rb

@@ -0,0 +1,4 @@
+require 'tbk/webpay/encryption'
+require 'tbk/webpay/payment'
+require 'tbk/webpay/confirmation'
+require 'tbk/webpay/logger'