bank_audi 1.0.4

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in bank_audi.gemspec
+gemspec
+
+gem 'rspec'
+gem 'active_support'

data/README.markdown

@@ -0,0 +1,27 @@
+BANK AUDI
+=========
+
+Bank Audi is the largest bank of Lebanon. This gem help to integrate with bank system
+(Audi Virtual Payment Client. It is similiar to PayPal)
+
+MAIN STEPS
+----------
+
+1. Merchant Form Submission
+2. Pre-Payment Process
+3. Payment Process
+4. Merchant Response Code
+
+
+BASIC MOMENTS
+-------------
+
+1. Request create `BankAudi::Request.new(attributes)`.
+2. Attributes as secret_code, access_code, merchant, url (where you create request) you
+should set in config/bank_audi.yml
+3. You should set :merchant_txn_ref, order_info, amount  & return_url
+4. You can update update request `request.attributes = {}; request.amount = 100;`
+5. Get request url (with params) `request.full_url`
+6. Response create `BankAudi::Response.new(attributes)`
+7. Check valid of response `response.valid?` (The invalid reason are bad secure hash & bad response code)
+8. You can get messafe of errors if your object (request or response) is invalid? `object.errors`

data/Rakefile

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

data/bank_audi.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bank_audi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bank_audi"
+  s.version     = BankAudi::VERSION
+  s.authors     = ["m.yermolovich"]
+  s.email       = ["m.yermolovich@dev1team.net"]
+  s.homepage    = ""
+  s.summary     = %q{BANK AUDI (operations with money)}
+  s.description = %q{
+                      Bank Audi is Lebanon's largest bank.
+                      And this gem created to help some
+                      make money transactions & integration
+                      with its system.
+                    }
+
+  s.rubyforge_project = "bank_audi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,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 "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/config/bank_audi.yml

@@ -0,0 +1,4 @@
+secret_code: XXXXXX
+access_code: XXXXXX
+merchant: XXXXXX
+url: 'https://gw1.audicards.com/TPGWeb/payment/prepayment.action'

data/lib/bank_audi.rb

@@ -0,0 +1,137 @@
+require "bank_audi/version"
+require 'active_support/all'
+require 'yaml'
+require 'cgi'
+
+module BankAudi
+  OPTIONS = YAML.load_file('config/bank_audi.yml')
+
+  class Request
+    attr_reader :secret_code, :access_code, :merchant, :url, :errors
+    attr_accessor :merchant_txn_ref, :order_info, :amount, :return_url
+    alias :merchant_id :merchant
+
+    def initialize(options = {})
+      @secret_code, @access_code, @merchant, @url =
+        OPTIONS['secret_code'], OPTIONS['access_code'], OPTIONS['merchant'], OPTIONS['url']
+      @merchant_txn_ref, @order_info, @amount, @return_url =
+        options[:merchant_txn_ref], options[:order_info], options[:amount], options[:return_url]
+    end
+
+    def valid?
+      @errors = {}
+      attributes_names.each do |attribute|
+        if self.send(attribute).blank?
+          @errors[attribute] = "can't be blank"
+          return false
+        end
+      end
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def full_url
+      return nil if invalid?
+      params = String.new
+      { 'accessCode' => @access_code, 'merchTxnRef' => @merchant_txn_ref, 'merchant' => @merchant,
+        'orderInfo' => @order_info, 'amount' => @amount, 'returnURL' => @return_url }.each do |name, value|
+          params << '&' if params.present?
+          params << (CGI::escape(name) + '=' + CGI::escape(value.to_s))
+        end
+      params << '&vpc_SecureHash=' + vpc_secure_hash.to_s
+      @url + '?' + params
+    end
+
+    def attributes
+      value = {}
+      attributes_names.each do |attribute|
+        value[attribute.to_sym] = self.send(attribute)
+      end
+      value
+    end
+
+    def attributes=(value = {})
+      value.each do |name, attr_value|
+        self.send("#{name}=", attr_value)
+      end
+    end
+
+    private
+      def attributes_names
+        %w(secret_code access_code merchant url merchant_txn_ref order_info amount return_url)
+      end
+
+      def vpc_secure_hash
+        Digest::MD5.hexdigest(@secret_code.to_s + @access_code.to_s + @amount.to_s + @merchant_txn_ref.to_s +
+          @merchant.to_s + @order_info.to_s + @return_url.to_s).upcase
+      end
+  end
+
+  class Response
+    attr_reader :secret_code, :errors
+    attr_accessor :attributes
+
+    def initialize(options = {})
+      @secret_code, @attributes = OPTIONS['secret_code'], HashWithIndifferentAccess.new(options)
+    end
+
+    def attributes=(options = {})
+      @attributes = HashWithIndifferentAccess.new(options)
+    end
+
+    def valid?
+      @errors = {}
+      valid_vpc_txn_response_code? && valid_vpc_secure_hash?
+    end
+
+    def vpc_secure_hash
+      (@attributes[:vpc_secure_hash] || @attributes[:vpc_SecureHash]).upcase
+    end
+
+    def vpc_txn_response_code
+      @attributes[:vpc_txn_response_code] || @attributes[:vpc_TxnResponseCode]
+    end
+
+    private
+      def valid_vpc_secure_hash?
+        params = @attributes.select { |k,v| !%w(vpc_secure_hash vpc_SecureHash).include?(k.to_s) }
+        vpc_secure_hash_params = @secret_code
+        sort_keys(params.keys).each do |key|
+          vpc_secure_hash_params += @attributes[key].to_s
+        end
+        if Digest::MD5.hexdigest(vpc_secure_hash_params).upcase == vpc_secure_hash
+          true
+        else
+          @errors[:vpc_secure_hash] = 'invalid'
+          false
+        end
+      end
+
+      def valid_vpc_txn_response_code?
+        if vpc_txn_response_code == '0'
+          true
+        else
+          @errors[:vpc_txn_response_code] = "bad code =  #{vpc_txn_response_code}"
+          false
+        end
+      end
+
+      def sort_keys(keys)
+        keys.sort do |a,b|
+          size = [a.length, b.length].min
+          compare = 0
+          size.times do |i|
+            compare = (a[i] <=> b[i])
+            break if compare != 0
+          end
+          if compare != 0
+            compare
+          else
+            (a.length < b.length) ? 1 : -1
+          end
+        end
+      end
+  end
+end

data/lib/bank_audi/version.rb

@@ -0,0 +1,3 @@
+module BankAudi
+  VERSION = "1.0.4"
+end

data/spec/bank_audi_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe BankAudi do
+  describe 'Request' do
+
+    before :each do
+      @request = BankAudi::Request.new
+    end
+
+    def valid(request)
+      request.merchant_txn_ref, request.order_info, request.amount, request.return_url =
+        'merchant-txn-ref', 'order-info', 100, 'http://www.google.com'
+      request
+    end
+
+    it 'should initialize with default attributes' do
+      [:secret_code, :access_code, :merchant, :url].each do |attribute|
+        @request.send(attribute).should_not be_blank
+      end
+    end
+
+    it 'should initialize with options' do
+      request = BankAudi::Request.new :merchant_txn_ref => 'merchant-txn-ref', :order_info => 'order-info',
+        :amount => 100, :return_url => 'http://www.google.com'
+      [:merchant_txn_ref, :order_info, :amount, :return_url].each do |attribute|
+        request.send(attribute).should_not be_blank
+      end
+      request.should be_valid
+    end
+
+    it 'merchant_id is synonym of merchant' do
+      @request.merchant_id.should eq(@request.merchant)
+    end
+
+    it 'should valid' do
+      valid(@request).should be_valid
+    end
+
+    it 'should invalid' do
+      @request.should_not be_valid
+      [:merchant_txn_ref, :order_info, :amount, :return_url].each do |attribute|
+        request = valid(@request)
+        request.send("#{attribute}=", nil)
+        request.should_not be_valid
+      end
+    end
+
+    it 'should return errors (method errors)' do
+      request = valid(@request)
+      request.amount = nil
+      request.should_not be_valid
+      request.errors.first.should_not be_blank
+    end
+
+    it 'should return full url' do
+      url = valid(@request).full_url
+      params = CGI::parse(url)
+      params['vpc_SecureHash'].first.should eq('A37A981709D939C0E04B640E26677471')
+    end
+
+    it 'should return attributes (method attributes)' do
+      default_attributes =  {
+        :secret_code => 'XXXXXX', :access_code => 'XXXXXX', :merchant => 'XXXXXX',
+        :url => 'https://gw1.audicards.com/TPGWeb/payment/prepayment.action'
+      }
+
+      @request.attributes.should eq(
+        default_attributes.merge(:merchant_txn_ref => nil, :order_info => nil, :amount => nil,
+          :return_url => nil)
+      )
+
+      valid(@request).attributes.should eq(
+        default_attributes.merge(:merchant_txn_ref => 'merchant-txn-ref', :order_info => 'order-info',
+          :amount => 100, :return_url => 'http://www.google.com')
+      )
+    end
+
+    it 'should set attirubtes (method attributes=)' do
+      @request.attributes = { :merchant_txn_ref => 'merchant-txn-ref', :order_info => 'order-info',
+        :amount => 100, :return_url => 'http://www.google.com' }
+      @request.attributes.should eq(
+          valid(@request).attributes
+      )
+    end
+  end
+
+  describe 'Responce' do
+
+    before :each do
+      @response = BankAudi::Response.new
+    end
+
+    def valid(response)
+      response.attributes = { :access_code => 'XXXXXX', :amount => 100, :merchant_txn_ref => 'merchant-txn-ref',
+        :merchant => 'XXXXXX', :order_info => 'order-info', :return_url => 'http://www.google.com',
+        :vpc_secure_hash => 'B2384E5659611034CFFC95842C66A4BA', :vpc_txn_response_code => '0' }
+      response
+    end
+
+    it 'should initialize with default attributes' do
+      [:secret_code].each do |attribute|
+        @response.send(attribute).should_not be_blank
+      end
+    end
+
+    it 'should initialize with options' do
+      response = BankAudi::Response.new :some_attribute => 'some-attribute'
+      response.attributes.should_not be_blank
+      response.attributes.should eq({ 'some_attribute' => 'some-attribute' })
+    end
+
+    it 'should be valid' do
+      valid(@response).should be_valid
+    end
+
+    it 'should be invalid' do
+      @response.should_not be_valid
+
+      response = valid(@response)
+      response.attributes[:vpc_txn_response_code] = 'M'
+      response.should_not be_valid
+
+      response = valid(@response)
+      response.attributes[:amount] = 200
+      response.should_not be_valid
+    end
+
+    it 'should return errors (method errors)' do
+      response = valid(@response)
+      response.attributes[:vpc_txn_response_code] = 'Y'
+      response.should_not be_valid
+      response.errors.first.should_not be_blank
+    end
+
+    it 'should return value by different key type (string or symbol)' do
+      response = valid(@response)
+      response.attributes['vpc_txn_response_code'].should_not be_blank
+      response.attributes[:vpc_txn_response_code].should_not be_blank
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rspec'
+require 'bank_audi'
+
+RSpec.configure do
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bank_audi
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
+platform: ruby
+authors:
+- m.yermolovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-24 00:00:00.000000000 Z
+dependencies: []
+description: ! "\n                      Bank Audi is Lebanon's largest bank.\n                      And
+  this gem created to help some\n                      make money transactions & integration\n
+  \                     with its system.\n                    "
+email:
+- m.yermolovich@dev1team.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- bank_audi.gemspec
+- config/bank_audi.yml
+- lib/bank_audi.rb
+- lib/bank_audi/version.rb
+- spec/bank_audi_spec.rb
+- spec/spec_helper.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: bank_audi
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: BANK AUDI (operations with money)
+test_files: []