activemerchant-anz-gateway 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activemerchant-anz.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (C) 2009 by Anuj Luthra
+
+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,62 @@
+# Anz eGate
+
+Provides an ActiveMerchant gateway to interface with ANZ's eGate.
+
+## Usage
+
+This is now available as a gem, as long as you have it in your Gemfile you can use bundler.
+
+Gemfile
+
+    source :rubygems
+
+    gem 'activemerchant-anz-gateway'
+
+Basic Usage
+
+    require 'bundler'
+    Bundler.require
+
+    # Your merchant must have operators, to test prefix your merchant name with TEST
+    gateway = ActiveMerchant::Billing::AnzGateway.new(
+      :merchant_id => 'TESTANZMURCONREG', 
+      :access_code => '31C43EF3'
+    )
+
+    # ANZ only require the card number, month and year
+    card = ActiveMerchant::Billing::CreditCard.new(
+      :number => '5123456789012346',
+      :month  => 5,
+      :year   => 2013
+    )
+
+    params = {
+      :order_id => 'X123F',
+      :invoice  => '10001'
+    }
+
+    # $10 puchase
+    result = gateway.purchase(1000, card, params)
+
+Other Features
+
+There are features for refuding/crediting and querying past records, however these are missing tests and I can't vouch for them.
+
+You can manage your anz merchant account over at https://migs.mastercard.com.au/ma
+
+## Testing
+
+Anz seem to have removed their public testing profile, I've instead set the fixtures to come from environment variables
+
+    export ANZ_MERCHANT=TESTyoumerchantname
+    export ANZ_CODE=youroperatorcode
+
+To set up your testing environment you will need to log in as the _Administrator_ using your merchantid prefixed by test. The password will be the same as your production account.
+
+## Acknowledgements
+
+I had pretty much nothing to do with this library, I just made it into a gem and check on the tests. This is a fork of [Anuj Luthra's](https://github.com/anujluthra) [fantastic work](https://github.com/anujluthra/activemerchant-anz-gateway).
+
+# LICENCE
+
+Licenced under MIT Copyright 2009 by Anuj Luthra, for details see LICENCE

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activemerchant-anz-gateway.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path("../lib/active_merchant-anz/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "activemerchant-anz-gateway"
+  s.version     = ActiveMerchant::Anz::VERSION
+  s.authors     = ["Anuj Luthra", "Dirk Kelly"]
+  s.email       = ["anuj.luthra@gmail.com", "dk@dirkkelly.com"]
+  s.homepage    = ""
+  s.summary     = %q{Gateway for ANZ and ActiveMerchant}
+  s.description = %q{Provides an interface to ANZ for the Activemerchant library, fork of github@anujluthra's work}
+
+  s.rubyforge_project = "activemerchant-anz-gateway"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "mocha"
+
+  s.add_runtime_dependency "activemerchant"
+  s.add_runtime_dependency "activesupport"
+end

data/lib/active_merchant-anz.rb

@@ -0,0 +1,13 @@
+require 'active_merchant'
+require 'active_merchant/billing'
+require 'active_support/core_ext/object'
+
+require "active_merchant-anz/version"
+require "active_merchant/billing/gateways/anz"
+
+
+module ActiveMerchant
+  module Anz
+    # Your code goes here...
+  end
+end

data/lib/active_merchant-anz/version.rb

@@ -0,0 +1,5 @@
+module ActiveMerchant
+  module Anz
+    VERSION = "0.1.0"
+  end
+end

data/lib/active_merchant/billing/gateways/anz.rb

@@ -0,0 +1,143 @@
+require 'cgi'
+require 'active_merchant'
+require 'active_merchant/billing'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class AnzGateway < Gateway
+
+      undef_method :capture 
+
+      self.supported_countries = ['AU']
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club]
+      self.money_format = :cents
+      self.homepage_url = 'http://www.anz.com.au'
+      self.display_name = 'ANZ eGate'
+      GATEWAY_URL = "https://migs.mastercard.com.au/vpcdps"
+      VIRTUAL_PAYMENT_CLIENT_API_VERION = 1
+
+      def initialize(options={})
+        requires!(options, :merchant_id, :access_code)
+        if options[:mode] && (options[:mode].to_sym == :production || options[:mode].to_sym == :test)
+          self.mode = options[:mode]
+        end
+        @options = options
+        super
+      end
+
+      ########################################################
+      # allowed operations for mastercard migs virtual gateway
+      ########################################################
+
+      #actual payment
+      def purchase(money, creditcard, options = {})
+        requires!(options, :invoice, :order_id)
+        params = {}
+        add_credit_card(params, creditcard)
+        add_merchant_transaction_id(params, options[:order_id])
+        add_invoice_number(params, options[:invoice])
+        add_amount(params, money)
+        process_action('pay', params)
+      end
+
+      ###############################################################
+      ## Next two operations require a AMA username and AMA password
+
+      #refunds to the customer's card. autorization id is required
+      def credit(money, authorization_number, options = {})
+        requires!(options, :username, :password, :order_id)
+        params = {}
+        add_merchant_transaction_id(params, options[:order_id])
+        add_authorization_number(params, authorization_number)
+        add_username_password(params, options[:username], options[:password])
+        add_amount(params, money)
+        process_action('refund', params)
+      end
+
+      #query a past payment, unique merchant transaction ref. is required
+      def query(merchant_transaction_id)
+        params = {}
+        add_merchant_transaction_id(params, merchant_transaction_id)
+        process_action('QueryDR', params)
+      end
+
+      private
+      #########################################################
+      #methods to beautify and prepare the params before handing over to bank
+      #########################################################
+
+      def process_action(action, params)
+        payment_params = post_data(action, params)
+        response = ssl_post GATEWAY_URL, payment_params
+        build_response(response)
+      end
+
+      #ADDS
+      #
+      #
+      def post_data(action, params)
+        return params.merge(:vpc_Version      => VIRTUAL_PAYMENT_CLIENT_API_VERION,
+                            :vpc_AccessCode   => @options[:access_code],
+                            :vpc_Merchant     => @options[:merchant_id],
+                            :vpc_Command      => action).to_query
+      end
+
+      def add_invoice_number(params, invoice_number)
+        return params.merge!(:vpc_TicketNo  => invoice_number,
+                            :vpc_OrderInfo => invoice_number)
+      end
+
+      def add_credit_card(params, creditcard)
+        expiry = "#{creditcard.year.to_s[-2,2]}#{sprintf("%.2i", creditcard.month)}"
+        return params.merge!(:vpc_CardNum => creditcard.number,
+                             :vpc_CardSecurityCode => creditcard.verification_value,
+                             :vpc_CardExp => "#{expiry}")
+      end
+
+      def add_amount(params, money)
+        params[:vpc_Amount] = money.to_i
+      end
+
+      #ADDS THE AUTHORIZATION NUMBER OF A PREVIOUS TRANSACTION
+      #IN THE REQUEST PARAMS. THIS IS MOSTLY USED IN A REFUND
+      #OR A QUERY FOR A PREVIOUSLY PERFORMED TRANSACTION
+      def add_authorization_number(params, authorization)
+        return params.merge!(:vpc_TransactionNo => authorization)
+      end
+
+      #ADDS A UNIQUE ID(can be alpanumeric) TO THE PARAMS LIST.
+      #EVERY TRANSACTION SENT TO BANKING GATEWAY SHOULD HAVE A
+      #UNIQUE IDENTIFICATION NUMBER. THIS HELPS IN TRACING THE
+      #TRANSACTION IN CASE OF QUERIES AND AUDITS. THIS IS A REQUIRED
+      #FIELD IN EVERY REQUEST SENT TO GATEWAY.
+      def add_merchant_transaction_id(params, transaction_id)
+        return params.merge!(:vpc_MerchTxnRef => transaction_id)
+      end
+
+      #USED FOR REFUNDS AND QUERYING THE GATEWAY. NEED THE
+      #MA USERNAME AND PASSWORD REQUIRED. THESE ARE SUPPLIED
+      #BY THE BANKING AUTHORITY.
+      def add_username_password(params, username, password)
+        return params.merge!(:vpc_User     => username,
+                                :vpc_Password => password)
+      end
+
+      def build_response(response_str)
+        response = parse(response_str)
+        authorization = response['vpc_TransactionNo']
+        success = (response['vpc_TxnResponseCode'] == '0')
+        message = CGI.unescape(response['vpc_Message'])
+        Response.new(success, message, response, :authorization => authorization, :test => test?)
+      end
+
+      def parse(html_encoded_url)
+        params = CGI::parse(html_encoded_url)
+        hash = {}
+        params.each do|key, value|
+          hash[key] = value[0]
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/activemerchant-anz-gateway.rb

@@ -0,0 +1 @@
+require 'active_merchant-anz'

data/test/fixtures.yml

@@ -0,0 +1,3 @@
+anz:
+  merchant_id: <%= ENV['ANZ_MERCHANT'] %>
+  access_code: <%= ENV['ANZ_CODE'] %>

data/test/remote/gateways/remote_anz_test.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../../test_helper',File.dirname(__FILE__))
+
+class AnzTest < Test::Unit::TestCase
+  def setup
+    @gateway = AnzGateway.new(fixtures(:anz))
+
+    @credit_card_success = credit_card('5123456789012346',
+                                          :month => 5,
+                                          :year => 2013
+                           )
+
+    @credit_card_fail = credit_card('1234567812345678',
+      :month => Time.now.month,
+      :year  => Time.now.year
+    )
+
+    @params = {
+      :order_id => 'X123F',
+      :invoice  => '10001'
+    }
+  end
+
+  def test_invalid_amount
+    assert response = @gateway.purchase(0, @credit_card_success, @params)
+    assert_failure response
+    assert response.test?
+  end
+
+  def test_purchase_success_with_verification_value
+    assert response = @gateway.purchase(100, @credit_card_success, @params)
+    assert_success response
+    assert response.test?
+  end
+
+  def test_invalid_expiration_date
+    @credit_card_success.year = 2005
+    assert response = @gateway.purchase(100, @credit_card_success, @params)
+    assert_failure response
+    assert response.test?
+  end
+
+  def test_purchase_error
+    assert response = @gateway.purchase(100, @credit_card_fail, @params)
+    assert_equal false, response.success?
+    assert response.test?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,178 @@
+begin
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+rescue LoadError => e
+  puts "Error loading bundler (#{e.message}): \"gem install bundler\" for bundler support."
+end
+  
+
+require 'test/unit'
+require 'mocha'
+require 'erb'
+require 'activemerchant-anz-gateway'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+class AnzGateway < ActiveMerchant::Billing::AnzGateway
+end
+
+module ActiveMerchant
+  module Assertions
+    AssertionClass = Test::Unit::AssertionFailedError
+    
+    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
+
+    def assert_deprecation_warning(message, target)
+      target.expects(:deprecated).with(message)
+      yield
+    end
+    
+    private
+    def clean_backtrace(&block)
+      yield    
+    rescue AssertionClass => e
+      path = File.expand_path(__FILE__)
+      raise AssertionClass, e.message, e.backtrace.reject { |line| File.expand_path(line) =~ /#{path}/ }
+    end
+  end
+  
+  module Fixtures
+    HOME_DIR = RUBY_PLATFORM =~ /mswin32/ ? ENV['HOMEPATH'] : ENV['HOME'] unless defined?(HOME_DIR)
+    LOCAL_CREDENTIALS = File.join(HOME_DIR.to_s, '.active_merchant/fixtures.yml') unless defined?(LOCAL_CREDENTIALS)
+    DEFAULT_CREDENTIALS = File.join(File.dirname(__FILE__), 'fixtures.yml') unless defined?(DEFAULT_CREDENTIALS)
+    
+    private
+    def credit_card(number = '4242424242424242', options = {})
+      defaults = {
+        :number => number,
+        :month => 9,
+        :year => Time.now.year + 1,
+        :first_name => 'Longbob',
+        :last_name => 'Longsen',
+        :verification_value => '123',
+        :type => 'visa'
+      }.update(options)
+
+      Billing::CreditCard.new(defaults)
+    end
+    
+    def check(options = {})
+      defaults = {
+        :name => 'Jim Smith',
+        :routing_number => '244183602', 
+        :account_number => '15378535', 
+        :account_holder_type => 'personal', 
+        :account_type => 'checking', 
+        :number => '1'
+      }.update(options)
+      
+      Billing::Check.new(defaults)
+    end
+    
+    def address(options = {})
+      { 
+        :name     => 'Jim Smith',
+        :address1 => '1234 My Street',
+        :address2 => 'Apt 1',
+        :company  => 'Widgets Inc',
+        :city     => 'Ottawa',
+        :state    => 'ON',
+        :zip      => 'K1C2N6',
+        :country  => 'CA',
+        :phone    => '(555)555-5555',
+        :fax      => '(555)555-6666'
+      }.update(options)
+    end
+    
+    def all_fixtures
+      @@fixtures ||= load_fixtures
+    end
+    
+    def fixtures(key)
+      data = all_fixtures[key] || raise(StandardError, "No fixture data was found for '#{key}'")
+      
+      data.dup
+    end
+        
+    def load_fixtures
+      file = File.exists?(LOCAL_CREDENTIALS) ? LOCAL_CREDENTIALS : DEFAULT_CREDENTIALS
+      yaml_data = YAML.load(ERB.new(File.read(file)).result)
+      symbolize_keys(yaml_data)
+    
+      yaml_data
+    end
+    
+    def symbolize_keys(hash)
+      return unless hash.is_a?(Hash)
+      
+      hash.symbolize_keys!
+      hash.each{|k,v| symbolize_keys(v)}
+    end
+  end
+end
+
+Test::Unit::TestCase.class_eval do
+  include ActiveMerchant::Billing
+  include ActiveMerchant::Assertions
+  include ActiveMerchant::Utils
+  include ActiveMerchant::Fixtures
+end

data/test/unit/gateways/anz_test.rb

@@ -0,0 +1,68 @@
+require File.expand_path('../../test_helper',File.dirname(__FILE__))
+
+class AnzTest < Test::Unit::TestCase
+  def setup
+    @gateway = AnzGateway.new(fixtures(:anz))
+
+    @credit_card_success = credit_card('5123456789012346',
+                                          :month => 5,
+                                          :year => 2013
+                           )
+
+    @credit_card_fail = credit_card('1234567812345678',
+      :month => Time.now.month,
+      :year => Time.now.year
+    )
+
+    @options = {
+      :order_id => 'X123F',
+      :invoice  => '10001',
+    }
+
+    @amount = 100
+  end
+
+  def test_successful_purchase
+    @gateway.expects(:ssl_post).returns(successful_purchase_response)
+
+    assert response = @gateway.purchase(@amount, @credit_card_success, @options)
+    assert_instance_of Response, response
+    assert_success response
+    assert !response.authorization.blank?
+  end
+
+  def test_failed_purchase
+    @gateway.expects(:ssl_post).returns(failed_purchase_response)
+
+    assert response = @gateway.purchase(@amount, @credit_card_fail, @options)
+    assert_instance_of Response, response
+    assert_failure response
+  end
+
+  def test_amount_style
+   assert_equal '1034', @gateway.send(:amount, 1034)
+
+   assert_raise(ArgumentError) do
+     @gateway.send(:amount, '10.34')
+   end
+  end
+
+  def test_ensure_does_not_respond_to_authorize
+    assert !@gateway.respond_to?(:authorize)
+  end
+
+  def test_ensure_does_not_respond_to_capture
+    assert !@gateway.respond_to?(:capture)
+  end
+
+  private
+  def successful_purchase_response
+    "vpc_AVSResultCode=Unsupported&vpc_AcqAVSRespCode=Unsupported&vpc_AcqCSCRespCode=Unsupported&vpc_AcqResponseCode=00&vpc_Amount=1400&vpc_AuthorizeId=029968&vpc_BatchNo=20080206&vpc_CSCResultCode=Unsupported&vpc_Card=MC&vpc_Command=pay&vpc_Locale=en_AU&vpc_MerchTxnRef=91bca776862f19b7757f58fc7dfdf99c&vpc_Merchant=TESTANZTEST3&vpc_Message=Approved&vpc_OrderInfo=222223&vpc_ReceiptNo=080206029968&vpc_TransactionNo=1572808&vpc_TxnResponseCode=0&vpc_Version=1"
+  end
+
+  def failed_purchase_response
+    "vpc_Amount=1400&vpc_BatchNo=0&vpc_Command=pay&vpc_Locale=en_AU&vpc_MerchTxnRef=ae4dfece4b1791f47407c8fc9364d885&vpc_Merchant=TESTANZTEST3&vpc_Message=I5154-02061204%3A+Invalid+Card+Number+%3A+CardNum&vpc_OrderInfo=222223&vpc_TransactionNo=0&vpc_TxnResponseCode=7&vpc_Version=1"
+  end
+end
+
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: activemerchant-anz-gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Anuj Luthra
+- Dirk Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70343403500900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343403500900
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70343403500360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343403500360
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: &70343403499820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343403499820
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70343403499280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343403499280
+description: Provides an interface to ANZ for the Activemerchant library, fork of
+  github@anujluthra's work
+email:
+- anuj.luthra@gmail.com
+- dk@dirkkelly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- activemerchant-anz-gateway.gemspec
+- lib/active_merchant-anz.rb
+- lib/active_merchant-anz/version.rb
+- lib/active_merchant/billing/gateways/anz.rb
+- lib/activemerchant-anz-gateway.rb
+- test/fixtures.yml
+- test/remote/gateways/remote_anz_test.rb
+- test/test_helper.rb
+- test/unit/gateways/anz_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: activemerchant-anz-gateway
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Gateway for ANZ and ActiveMerchant
+test_files: []