tbk 1.0.1 → 1.0.2

data/lib/tbk/webpay/payment.rb

@@ -0,0 +1,169 @@
+module TBK
+  module Webpay
+    class Payment
+      attr_accessor :commerce
+      attr_accessor :request_ip
+      attr_accessor :amount
+      attr_accessor :order_id
+      attr_accessor :session_id
+      attr_accessor :confirmation_url
+      attr_accessor :success_url
+      attr_accessor :failure_url
+
+      def initialize(options = {})
+        self.commerce = options[:commerce] || TBK::Commerce.default_commerce
+        self.request_ip = options[:request_ip]
+        self.amount = options[:amount]
+        self.order_id = options[:order_id]
+        self.session_id = options[:session_id]
+        self.confirmation_url = options[:confirmation_url]
+        self.success_url = options[:success_url]
+        self.failure_url = options[:failure_url]
+      end
+
+      # Transaction ids are generated randombly on the client side
+      def transaction_id
+        @transaction_id ||= (rand * 10000000000).to_i
+      end
+
+      def redirect_url
+        "#{ self.process_url }?TBK_VERSION_KCC=#{ TBK::VERSION::KCC }&TBK_TOKEN=#{ self.token }"
+      end
+
+      def to_html_form(options = {}, &block)
+        form = <<-EOF
+          <form method="POST"
+            class="#{ options[:class] || 'tbk_payment_form'}"
+            id="#{ options[:id] }"
+            action="#{ self.process_url }">
+            <input type="hidden" name="TBK_PARAM" value="#{ self.param }">
+            <input type="hidden" name="TBK_VERSION_KCC" value="#{ TBK::VERSION::KCC }">
+            <input type="hidden" name="TBK_CODIGO_COMERCIO" value="#{ self.commerce.id }">
+            <input type="hidden" name="TBK_KEY_ID" value="#{ self.commerce.webpay_key_id }">
+            #{ yield if block_given? }
+          </form>
+        EOF
+
+        form = form.html_safe if form.respond_to? :html_safe
+
+        form
+      end
+
+      def token
+        unless @token
+          @token = fetch_token
+          TBK::Webpay.logger.payment(self)
+        end
+
+        @token
+      end
+
+      protected
+        def process_url
+          if self.commerce.test?
+            "https://certificacion.webpay.cl:6443/filtroUnificado/bp_revision.cgi"
+          else
+            "https://webpay.transbank.cl:443/filtroUnificado/bp_revision.cgi"
+          end
+        end
+
+        def validation_url
+          if self.commerce.test?
+            "https://certificacion.webpay.cl:6443/filtroUnificado/bp_validacion.cgi"
+          else
+            "https://webpay.transbank.cl:443/filtroUnificado/bp_validacion.cgi"
+          end
+        end
+
+        def fetch_token
+          uri = URI.parse( self.validation_url )
+
+          response = nil
+          until response && response['location'].nil?
+            uri = URI.parse( response.nil? ? self.validation_url : response['location'] )
+
+            response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+              post = Net::HTTP::Post.new uri.path
+              post["user-agent"] = "TBK/#{ TBK::VERSION::GEM } (Ruby/#{ RUBY_VERSION }; +#{ TBK::VERSION::WEBSITE })"
+              post.set_form_data({
+                'TBK_VERSION_KCC' => TBK::VERSION::KCC,
+                'TBK_CODIGO_COMERCIO' => self.commerce.id,
+                'TBK_KEY_ID' => self.commerce.webpay_key_id,
+                'TBK_PARAM' => self.param
+              })
+
+              # http.read_timeout = Webpay::Config.timeout
+              http.request post
+            end
+          end
+
+          unless response.code == "200"
+            raise TBK::Webpay::PaymentError, "Payment token generation failed"
+          end
+
+          response = self.commerce.webpay_decrypt(response.body)[:body]
+
+          unless /ERROR=([a-zA-Z0-9]+)/.match(response)[1] == "0"
+            raise TBK::Webpay::PaymentError, "Payment token generation failed"
+          end
+
+          /TOKEN=([a-zA-Z0-9]+)/.match(response)[1]
+        end
+
+
+        def param
+          @param ||= begin
+            self.verify!
+            self.commerce.webpay_encrypt(raw_params)
+          end
+        end
+
+        def verify!
+          raise TBK::Webpay::PaymentError, "Commerce required" if self.commerce.nil?
+          raise TBK::Webpay::PaymentError, "Invalid amount (#{self.amount.inspect})" unless self.amount && self.amount > 0
+          raise TBK::Webpay::PaymentError, "Order ID required" if self.order_id.nil?
+          raise TBK::Webpay::PaymentError, "Success URL required" if self.success_url.nil?
+          raise TBK::Webpay::PaymentError, "Confirmation URL required" if self.confirmation_url.nil?
+          confirmation_uri = URI.parse(self.confirmation_url)
+          raise TBK::Webpay::PaymentError, "Confirmation URL host MUST be an IP address" unless /(\d{1,3}\.){3}\d{1,3}/.match(confirmation_uri.host)
+          raise TBK::Webpay::PaymentError, "Confirmation URL port MUST be 80 or 8080" unless [80, 8080].include?(confirmation_uri.port)
+        end
+
+        def raw_params(splitter="#", include_pseudomac=true)
+          params = []
+
+          params << "TBK_ORDEN_COMPRA=#{ self.order_id }"
+          params << "TBK_CODIGO_COMERCIO=#{ self.commerce.id }"
+          params << "TBK_ID_TRANSACCION=#{ self.transaction_id }"
+
+          uri = URI.parse(self.confirmation_url)
+
+          params << "TBK_URL_CGI_COMERCIO=#{ uri.path }"
+          params << "TBK_SERVIDOR_COMERCIO=#{ uri.host }"
+          params << "TBK_PUERTO_COMERCIO=#{ uri.port }"
+
+          params << "TBK_VERSION_KCC=#{ TBK::VERSION::KCC }"
+          params << "TBK_KEY_ID=#{ self.commerce.webpay_key_id }"
+          params << "PARAMVERIFCOM=1"
+
+          if include_pseudomac
+            # An old pseudo mac generation carried from an old implementation
+            digest = OpenSSL::Digest::MD5.new
+            digest << self.raw_params('&',false) << self.commerce.id.to_s << "webpay"
+            mac = digest.to_s
+
+            params << "TBK_MAC=#{ mac }"
+          end
+
+
+          params << "TBK_MONTO=#{ (self.amount * 100).to_i }"
+          params << "TBK_ID_SESION=#{ self.session_id }" if self.session_id
+          params << "TBK_URL_EXITO=#{ self.success_url }"
+          params << "TBK_URL_FRACASO=#{ self.failure_url || self.success_url }"
+          params << "TBK_TIPO_TRANSACCION=TR_NORMAL"
+
+          params.join(splitter)
+        end
+    end
+  end
+end

data/spec/commerce_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe TBK::Commerce do
+  context "creation" do
+    it "can be done with all it's arguments" do
+      @commerce = TBK::Commerce.new({
+        :id => 12345,
+        :key => TBK::Commerce::TEST_COMMERCE_KEY
+      })
+
+      expect(@commerce.id).to be_eql 12345
+    end
+
+    it "raises an exception if no id is given" do
+      expect{
+          TBK::Commerce.new({
+            :key => TBK::Commerce::TEST_COMMERCE_KEY
+          })
+        }.to raise_error TBK::CommerceError
+    end
+
+    it "raises an exception if no key is given" do
+      expect{
+          TBK::Commerce.new({
+            :id => 12345
+          })
+        }.to raise_error TBK::CommerceError
+    end
+
+  end
+
+  context "default_commerce" do
+    it "should be nil if no default is configured" do
+      TBK.config.should_receive(:commerce_id).and_return nil
+      expect(TBK::Commerce.default_commerce).to be_nil
+    end
+
+    it "should return a valid commerce if configured" do
+      TBK.config.should_receive(:commerce_id).at_least(:once).and_return 12345
+      TBK.config.should_receive(:commerce_key).at_least(:once).and_return TBK::Commerce::TEST_COMMERCE_KEY
+
+      expect(TBK::Commerce.default_commerce).not_to be_nil
+      expect(TBK::Commerce.default_commerce.id).to be_eql 12345
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe TBK::Config do
+
+  it "should inject configuration methods on base module" do
+
+    expect(TBK).to respond_to :configure
+    expect(TBK).to respond_to :config
+    expect(TBK.config).to be_kind_of TBK::Config
+
+    TBK.configure do |config|
+      expect(config).to be_kind_of TBK::Config
+      expect(config).to be == TBK.config
+    end
+
+  end
+
+  context('#commerce_id') do
+    it "should be nil by default" do
+      expect(TBK.config.commerce_id).to be_nil
+    end
+
+    it "should read it's default value from the environment" do
+      ENV.should_receive(:[]).with('TBK_COMMERCE_ID').and_return "12345"
+
+      expect(TBK.config.commerce_id).to be_eql "12345"
+    end
+  end
+
+  context('#commerce_key') do
+    it "should be nil by default" do
+      expect(TBK.config.commerce_key).to be_nil
+    end
+
+    it "should read it's default value from the environment" do
+      ENV.should_receive(:[]).with('TBK_COMMERCE_KEY').and_return "PKEY"
+
+      expect(TBK.config.commerce_key).to be_eql "PKEY"
+    end
+  end
+
+  context('#environment') do
+    it "should be production by default" do
+      expect(TBK.config.environment).to be_eql :production
+    end
+
+    it "should read it's default value from the environment" do
+      ENV.should_receive(:[]).with('TBK_COMMERCE_ENVIRONMENT').and_return "test"
+
+      expect(TBK.config.environment).to be_eql :test
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'tbk'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }

data/spec/support/syntax.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expect|
+    expect.syntax = :expect
+  end
+end

data/spec/support/test_commerce.rb

@@ -0,0 +1,12 @@
+module TestCommerce
+  def test_commerce
+    @test_commerce ||= TBK::Commerce.new({
+      :id => 597026007976,
+      :test => true
+    })
+  end
+end
+
+RSpec.configure do |config|
+  config.include TestCommerce
+end

data/spec/webpay/confirmation_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe TBK::Webpay::Confirmation do
+end

data/spec/webpay/encryption_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe TBK::Webpay::Encryption do
+end

data/spec/webpay/payment_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/tbk.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tbk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tbk"
+  gem.version       = TBK::VERSION::GEM
+  gem.authors       = ["Seba Gamboa"]
+  gem.email         = ["me@sagmor.com"]
+  gem.description   = %q{Ruby implementation of Transbank's Webpay protocol}
+  gem.summary       = "Pure Ruby implementation of Transbank's Webpay KCC #{TBK::VERSION::KCC}"
+  gem.homepage      = TBK::VERSION::WEBSITE
+
+  gem.files         = `git ls-files`.split($/).grep(%r{^(?!example)})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "tzinfo"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tbk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Seba Gamboa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -58,7 +58,40 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tbk.rb
+- lib/tbk/commerce.rb
+- lib/tbk/config.rb
+- lib/tbk/errors.rb
+- lib/tbk/keys.rb
+- lib/tbk/keys/test_commerce.pem
+- lib/tbk/keys/webpay.101.pem
+- lib/tbk/keys/webpay_test.101.pem
+- lib/tbk/version.rb
+- lib/tbk/webpay.rb
+- lib/tbk/webpay/confirmation.rb
+- lib/tbk/webpay/encryption.rb
+- lib/tbk/webpay/logger.rb
+- lib/tbk/webpay/logger/base_logger.rb
+- lib/tbk/webpay/logger/null_logger.rb
+- lib/tbk/webpay/logger/official_logger.rb
+- lib/tbk/webpay/payment.rb
+- spec/commerce_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- spec/support/syntax.rb
+- spec/support/test_commerce.rb
+- spec/webpay/confirmation_spec.rb
+- spec/webpay/encryption_spec.rb
+- spec/webpay/payment_spec.rb
+- tbk.gemspec
 homepage: http://sagmor.com/tbk/
 licenses: []
 metadata: {}
@@ -82,5 +115,13 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Pure Ruby implementation of Transbank's Webpay KCC 6.0
-test_files: []
+test_files:
+- spec/commerce_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+- spec/support/syntax.rb
+- spec/support/test_commerce.rb
+- spec/webpay/confirmation_spec.rb
+- spec/webpay/encryption_spec.rb
+- spec/webpay/payment_spec.rb
 has_rdoc: