tbk 0.9.0 → 0.9.2

data/.gitignore

@@ -1,6 +1,8 @@
 *.gem
 *.rbc
 .bundle
+.rspec
+.rvmrc
 .config
 .yardoc
 Gemfile.lock

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+bundler_args: --without docs
 rvm:
   - 1.9.3
   - 1.8.7

data/Gemfile

@@ -6,3 +6,8 @@ gemspec
 platforms :jruby do
   gem "jruby-openssl"
 end
+
+group :docs do
+  gem 'yard'
+  gem 'redcarpet'
+end

data/README.md

@@ -1,4 +1,11 @@
-Pure Ruby implementation of Transbank's Webpay KCC 6.0 protocol
+### 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/badge.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
 
@@ -15,6 +22,15 @@ Add this line to your application's Gemfile:
 gem 'tbk'
 ```
 
+Configure your commerce
+
+```ruby
+TBK.configure do |config|
+  config.commerce_id YOUR_COMMERCE_ID
+  config.commerce_key YOUR_RSA_KEY
+end
+```
+
 To start a payment from your application
 
 ```ruby
@@ -24,15 +40,8 @@ class WebpayController < ApplicationController
 
   # Start a payment
   def pay
-    # Initialyze you commerce
-    @commerce = TBK::Commerce.new({
-      id: YOUR_COMMERCE_ID,
-      key: YOUR_RSA_KEY
-    })
-
     # Setup the payment
     @payment = TBK::Webpay::Payment.new({
-      commerce: @commerce,
       amount: ORDER_AMOUNT,
       order_id: ORDER_ID,
       success_url: webpay_success_url,
@@ -61,17 +70,8 @@ class WebpayController < ApplicationController
 
   # Confirmation callback executed from Webpay servers
   def confirmation
-    # Initialyze you commerce
-    @commerce = TBK::Commerce.new({
-      id: YOUR_COMMERCE_ID,
-      key: YOUR_RSA_KEY
-    })
-
     # Read the confirmation data from the request
-    @confirmation = TBK::Webpay::Confirmation.new({
-      commerce: @commerce,
-      post: request.raw_post
-    })
+    @confirmation = TBK::Webpay::Confirmation.new(request.raw_post)
 
     if # confirmation is invalid for some reason (wrong order_id or amount, double payment, etc...)
       render text: @confirmation.reject

data/lib/tbk.rb

@@ -5,6 +5,7 @@ require "net/https"
 require "cgi"
 
 require "tbk/version"
+require "tbk/config"
 require "tbk/errors"
 require "tbk/keys"
 require "tbk/commerce"

data/lib/tbk/commerce.rb

@@ -4,26 +4,33 @@ module TBK
   class Commerce
 
     # The registered commerce id
-    attr_accessor :id
+    # @return [Integer] the commerce id
+    attr_reader :id
 
     # The commerce secret RSA key
-    attr_accessor :key
+    # @return [OpenSSL::PKey::RSA] the commerce key
+    attr_reader :key
 
-    # Initialyzes a new commerce
+    # 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)
-      @test = attributes[:test]
+      @environment = (attributes[:environment] || :production).to_sym
+      raise TBK::CommerceError, "Invalid commerce environment" unless [:production,:test].include? @environment
 
-      self.id = attributes[:id]
+      @id = attributes[:id]
       raise TBK::CommerceError, "Missing commerce id" if self.id.nil?
 
-      self.key = case attributes[:key]
+      @key = case attributes[:key]
       when String
         OpenSSL::PKey::RSA.new(attributes[:key])
-      when OpenSSL::PKey::RSA.new
+      when OpenSSL::PKey::RSA
         attributes[:key]
       when nil
         TEST_COMMERCE_KEY if self.test?
@@ -33,14 +40,14 @@ module TBK
       raise TBK::CommerceError, "Commerce key must be a RSA private key" unless self.key.private?
     end
 
-    # @return [Boolean] wether or not the commerce is in test mode
+    # @return [Boolean] whether or not the commerce is in test mode
     def test?
-      @test || false
+      self.environment == :test
     end
 
-    # @return [Boolean] wether or not the commerce is in production mode
+    # @return [Boolean] whether or not the commerce is in production mode
     def production?
-      !self.test?
+      self.environment == :production
     end
 
     # @return [Integer] RSA key bytes
@@ -48,6 +55,15 @@ module TBK
       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
+    # @returns [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
+  # @returns [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/version.rb

@@ -1,6 +1,6 @@
 module TBK
   module VERSION
-    GEM = "0.9.0"
+    GEM = "0.9.2"
     KCC = "6.0"
     WEBSITE = "http://sagmor.com/tbk/"
   end

data/lib/tbk/webpay.rb

@@ -1,3 +1,3 @@
 require 'tbk/webpay/encryption'
 require 'tbk/webpay/payment'
-require 'tbk/webpay/confirmation'
+require 'tbk/webpay/confirmation'

data/lib/tbk/webpay/confirmation.rb

@@ -19,7 +19,9 @@ module TBK
       attr_reader :params
 
       def initialize(options)
-        self.commerce = options[:commerce]
+        options = { :post => options } if options.is_a?(String)
+
+        self.commerce = options[:commerce] || TBK::Commerce.default_commerce
         self.parse(options[:post])
       end
 

data/lib/tbk/webpay/payment.rb

@@ -10,7 +10,7 @@ module TBK
       attr_accessor :failure_url
 
       def initialize(options = {})
-        self.commerce = options[:commerce]
+        self.commerce = options[:commerce] || TBK::Commerce.default_commerce
         self.amount = options[:amount]
         self.order_id = options[:order_id]
         self.session_id = options[:session_id]
@@ -72,7 +72,7 @@ module TBK
             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|
+              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({

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/tbk.gemspec

@@ -20,6 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "tzinfo"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tbk
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -59,38 +59,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Ruby implementation of Transbank's Webpay protocol
 email:
 - me@sagmor.com
@@ -107,6 +75,7 @@ files:
 - 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
@@ -117,6 +86,8 @@ files:
 - lib/tbk/webpay/confirmation.rb
 - lib/tbk/webpay/encryption.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
@@ -138,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1481680372280631458
+      hash: 4580346204296967975
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1481680372280631458
+      hash: 4580346204296967975
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -155,6 +126,8 @@ signing_key:
 specification_version: 3
 summary: Pure Ruby implementation of Transbank's Webpay KCC 6.0
 test_files:
+- spec/commerce_spec.rb
+- spec/config_spec.rb
 - spec/spec_helper.rb
 - spec/support/syntax.rb
 - spec/support/test_commerce.rb