bancomer-active_merchant 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jorge Calás
+
+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.rdoc

@@ -0,0 +1,19 @@
+= bancomer-active_merchant
+
+Active Merchant Integration for Bancomer (Mexico)
+
+= WARNING: This is still pre-alfa don't use in production.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jorge Calás. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bancomer-active_merchant"
+    gem.summary = %Q{Bancomer Integration for ActiveMerchant}
+    gem.description = %Q{A plugin for ActiveMerchant to provide Bancomer Integration}
+    gem.email = "calas@railsdog.com"
+    gem.homepage = "http://github.com/calas/bancomer-active_merchant"
+    gem.authors = ["Jorge Calás"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bancomer-active_merchant #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/active_merchant/bancomer/helper.rb

@@ -0,0 +1,50 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bancomer
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+
+          def initialize(order, account, options = {})
+            super
+            add_field('Ds_Merchant_Currency', 484)
+            add_field('Ds_Merchant_TransactionType', 0)
+            add_field('Ds_Merchant_Order', format_order_number(order))
+            add_field('Ds_Merchant_MerchantCode', account)
+            add_field('Ds_Merchant_Terminal', 1)
+          end
+
+          # Limited to 12 digits max
+          def format_order_number(number)
+            number.to_s.gsub(/[A-Z]/, '').rjust(12, "0")
+          end
+
+          def sha1secret(value)
+            @sha1secret = value
+          end
+
+          def form_fields
+            @fields.merge('Ds_Merchant_MerchantSignature' => generate_sha1check)
+          end
+
+          def generate_sha1string
+            SHA1_CHECK_FIELDS.map {|key| @fields[key.to_s]} * "" + @sha1secret
+          end
+
+          def generate_sha1check
+            Digest::SHA1.hexdigest(generate_sha1string)
+          end
+
+          SHA1_CHECK_FIELDS = [ 'Ds_Merchant_Amount', 'Ds_Merchant_Order',
+                                'Ds_Merchant_MerchantCode', 'Ds_Merchant_Currency',
+                                'Ds_Merchant_TransactionType' ]
+
+          mapping :amount, 'Ds_Merchant_Amount'
+          mapping :notify_url, 'Ds_Merchant_MerchantURL'
+          mapping :return_url, 'Ds_Merchant_UrlOk'
+          mapping :cancel_return_url, 'Ds_Merchant_UrlKo'
+          mapping :description, 'Ds_Merchant_ProductDescription'
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/bancomer/notification.rb

@@ -0,0 +1,78 @@
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bancomer
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          ['Ds_Date', 'Ds_Hour', 'Ds_Amount', 'Ds_Currency',
+           'Ds_Order', 'Ds_MerchantCode', 'Ds_Terminal',
+           'Ds_Signature', 'Ds_Response', 'Ds_MerchantData',
+           'Ds_SecurePayment', 'Ds_TransactionType',
+           'Ds_ConsumerLanguage', 'Ds_ErrorCode' ].each do |attr|
+            define_method(attr.downcase) do
+              params[attr]
+            end
+          end
+
+          def complete?
+            status == '000'
+          end
+
+          def item_id
+            ds_order
+          end
+
+          def transaction_id
+            ds_order
+          end
+
+          def received_at
+            DateTime.strptime("#{ds_date} #{ds_hour}", "%d/%m/%Y %H:%M")
+          end
+
+          def security_key
+            ds_signature
+          end
+
+          def currency
+            ds_currency
+          end
+
+          def gross
+            "%.2f" % (gross_cents / 100.0)
+          end
+
+          def gross_cents
+            ds_amount.to_i
+          end
+
+          # Was this a test transaction?
+          def test?
+            false
+          end
+
+          def status
+            ds_response
+          end
+
+          SHA1_CHECK_FIELDS = [ 'Ds_Amount', 'Ds_Order', 'Ds_MerchantCode', 'Ds_Currency', 'Ds_Response' ]
+
+          def generate_sha1string
+            SHA1_CHECK_FIELDS.map { |key| params[key.to_s] } * "" + @options[:sha1secret]
+          end
+
+          def generate_sha1check
+            Digest::SHA1.hexdigest(generate_sha1string)
+          end
+
+          # Quickpay doesn't do acknowledgements of callback notifications
+          # Instead it uses and SHA1 hash of all parameters
+          def acknowledge
+            generate_sha1check == ds_signature
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/bancomer.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/bancomer/helper.rb'
+require File.dirname(__FILE__) + '/bancomer/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bancomer
+        mattr_accessor :service_url
+
+        self.service_url = 'https://www.bancomer.eglobal.com.mx/sis/entradaPagos'
+
+        def self.notification(post)
+          Notification.new(post)
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,98 @@
+require 'active_merchant'
+require 'test/unit'
+require 'mocha'
+require 'yaml'
+
+begin
+  gem 'actionpack'
+rescue LoadError
+  raise StandardError, "The view tests need ActionPack"
+end
+
+require 'action_controller'
+require 'action_controller/test_process'
+require 'active_merchant/billing/integrations/action_view_helper'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_merchant/bancomer'
+
+module ActiveMerchant
+  module Assertions
+    def assert_field(field, value)
+      clean_backtrace do
+        assert_equal value, @helper.fields[field]
+      end
+    end
+
+    # Allows the testing of you to check for negative assertions:
+    #
+    #   # Instead of
+    #   assert !something_that_is_false
+    #
+    #   # Do this
+    #   assert_false something_that_should_be_false
+    #
+    # An optional +msg+ parameter is available to help you debug.
+    def assert_false(boolean, message = nil)
+      message = build_message message, '<?> is not false or nil.', boolean
+
+      clean_backtrace do
+        assert_block message do
+          not boolean
+        end
+      end
+    end
+
+    # A handy little assertion to check for a successful response:
+    #
+    #   # Instead of
+    #   assert_success response
+    #
+    #   # DRY that up with
+    #   assert_success response
+    #
+    # A message will automatically show the inspection of the response
+    # object if things go afoul.
+    def assert_success(response)
+      clean_backtrace do
+        assert response.success?, "Response failed: #{response.inspect}"
+      end
+    end
+
+    # The negative of +assert_success+
+    def assert_failure(response)
+      clean_backtrace do
+        assert_false response.success?, "Response expected to fail: #{response.inspect}"
+      end
+    end
+
+    def assert_valid(validateable)
+      clean_backtrace do
+        assert validateable.valid?, "Expected to be valid"
+      end
+    end
+
+    def assert_not_valid(validateable)
+      clean_backtrace do
+        assert_false validateable.valid?, "Expected to not be valid"
+      end
+    end
+
+    private
+    def clean_backtrace(&block)
+      yield
+    rescue Test::Unit::AssertionFailedError => e
+      path = File.expand_path(__FILE__)
+      raise Test::Unit::AssertionFailedError, e.message, e.backtrace.reject { |line| File.expand_path(line) =~ /#{path}/ }
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include ActiveMerchant::Billing
+  include ActiveMerchant::Assertions
+  include ActiveMerchant::Utils
+end

data/test/test_bancomer-active_merchant.rb

@@ -0,0 +1,91 @@
+require "helper"
+
+class BancomerModuleTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def test_notification_method
+    assert_instance_of Bancomer::Notification, Bancomer.notification('name=cody')
+  end
+end
+
+class BancomerHelperTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def setup
+    @helper = Bancomer::Helper.new('R987654321','1234567', :amount => 500)
+    @helper.sha1secret "mysecretsha1string"
+    @helper.return_url 'http://example.com/ok'
+    @helper.cancel_return_url 'http://example.com/cancel'
+    @helper.notify_url 'http://example.com/notify'
+    @helper.description 'Product Description'
+  end
+
+  def test_basic_helper_fields
+    assert_field 'Ds_Merchant_MerchantCode', '1234567'
+    assert_field 'Ds_Merchant_Amount',       '500'
+    assert_field 'Ds_Merchant_Order',        '000987654321'
+    assert_field 'Ds_Merchant_UrlOk',        'http://example.com/ok'
+    assert_field 'Ds_Merchant_UrlKo',        'http://example.com/cancel'
+    assert_field 'Ds_Merchant_MerchantURL',  'http://example.com/notify'
+    assert_field 'Ds_Merchant_ProductDescription',  'Product Description'
+  end
+
+  def test_minimum_fields
+    assert @helper.form_fields.size >= 9
+  end
+
+  def test_secret_generation
+    assert_not_nil @helper.form_fields['Ds_Merchant_MerchantSignature']
+  end
+
+  def test_unknown_mapping
+    assert_nothing_raised do
+      @helper.company_address :address => '500 Dwemthy Fox Road'
+    end
+  end
+
+  def test_setting_invalid_address_field
+    fields = @helper.fields.dup
+    @helper.billing_address :street => 'My Street'
+    assert_equal fields, @helper.fields
+  end
+end
+
+class BancomerNotificationTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def setup
+    @bancomer = Bancomer::Notification.new(http_raw_data, :sha1secret => "mysecretsha1string")
+  end
+
+  def test_accessors
+    assert @bancomer.complete?
+    assert_equal "000", @bancomer.status
+    assert_equal "000987654321", @bancomer.transaction_id
+    assert_equal "000987654321", @bancomer.item_id
+    assert_equal "5.00", @bancomer.gross
+    assert_equal "484", @bancomer.currency
+    assert_equal DateTime.parse('2009 Feb 2, 10:25'), @bancomer.received_at
+  end
+
+  # Replace with real successful acknowledgement code
+  def test_acknowledgement
+    assert @bancomer.acknowledge
+  end
+
+  def test_respond_to_acknowledge
+    assert @bancomer.respond_to?(:acknowledge)
+  end
+
+  private
+
+  # Digest::SHA1.hexdigest("5000009876543211234567484000mysecretsha1string")
+  def http_raw_data
+    "Ds_Date=02%2F02%2F2009&Ds_Hour=10:25&Ds_Amount=500" +
+      "&Ds_Currency=484&Ds_Order=000987654321&Ds_MerchantCode=1234567" +
+      "&Ds_Terminal=1&Ds_Signature=4ab324115ec93c45a969656dda0f1d6aa79e807a" +
+      "&Ds_Response=000&Ds_MerchantData=&Ds_SecurePayment=1" +
+      "&Ds_TransactionType=0&Ds_ConsumerLanguage=0"
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: bancomer-active_merchant
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Jorge Cal\xC3\xA1s"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A plugin for ActiveMerchant to provide Bancomer Integration
+email: calas@railsdog.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_merchant/bancomer.rb
+- lib/active_merchant/bancomer/helper.rb
+- lib/active_merchant/bancomer/notification.rb
+- test/helper.rb
+- test/test_bancomer-active_merchant.rb
+has_rdoc: true
+homepage: http://github.com/calas/bancomer-active_merchant
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Bancomer Integration for ActiveMerchant
+test_files: 
+- test/helper.rb
+- test/test_bancomer-active_merchant.rb