payment_3p 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in payment_3p.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eslam Foad
+
+MIT License
+
+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,61 @@
+# Payment3p
+
+Provides integration with payment gateways (MIGS initially) to perform 3-Party online payment
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'payment_3p'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payment_3p
+
+Now run a generator to create payment_3p.yml configuration file which contains the payment gateway configurations
+
+	$ rails generate payment3p:config
+
+Add your specific configurations for the secure secret, access code and merchant id.
+
+That's it, you're now ready to go.
+
+## Usage
+
+Generate the payment URL that you'll redirect your users to
+
+	Payment3p.payment_url(
+      vpc_MerchTxnRef: "1",
+      vpc_ReturnURL: "http://example.com/payment_callback",
+      vpc_OrderInfo: "CART_1",
+      vpc_Amount: "100",
+    )
+
+Where 
+- `vpc_MerchTxnRef` usually contains the transaction number used to identify this transaction in your application
+- `vpc_ReturnURL` the callback URL with payment result, the payment gateway will redirect to this URL
+- `vpc_OrderInfo` usually contains additional order information like cart number or order id for example
+- `vpc_Amount` is the amount in CENTS
+
+Now validate the payment response in your callback, this validates that the response is a payment gateway response
+
+	Payment3p.validate_response(response)
+
+Which will return a boolean indicating whether the response was validated or not
+
+> **NOTE:**
+> 
+> You still need to validate that the transaction paid through the payment gateway is the same transaction that was generated by your application, don't just rely on validating the payment gateway response there are a lot of bad people out there!!!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/payment_3p.rb

@@ -0,0 +1,93 @@
+require "payment_3p/version"
+require "payment_3p/generators/config_generator"
+require 'payment_3p/railtie' if defined?(Rails)
+
+require 'yaml'
+
+module Payment3p
+  # Your code goes here...
+  def self.gem_root
+    File.expand_path '../..', __FILE__
+  end
+
+  @config = HashWithIndifferentAccess.new(YAML.load_file(File.join(gem_root,'lib','payment_3p','generators','templates','payment_3p.yml')))
+
+  @valid_config_keys = @config.keys
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k] = v if @valid_config_keys.include? k}
+  end
+
+  # Configure through yaml file
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = HashWithIndifferentAccess.new(YAML::load(IO.read(path_to_yaml_file)))
+    rescue Errno::ENOENT
+      Rails.logger.warn("YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      Rails.logger.warn("YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+
+  #vpc_MerchTxnRef, vpc_ReturnURL, vpc_OrderInfo, vpc_Amount
+  def self.payment_url parameters
+    vpcURL=@config[:payment_endpoint]
+
+    md5HashData = @config[:secure_secret]
+    vpc_parameters = {vpc_Version: "1", vpc_Command: "pay", vpc_AccessCode: @config[:vpc_AccessCode], vpc_MerchTxnRef: parameters[:vpc_MerchTxnRef], vpc_Merchant: @config[:vpc_Merchant], vpc_OrderInfo: parameters[:vpc_OrderInfo], vpc_Amount: parameters[:vpc_Amount], vpc_Locale: "en", vpc_ReturnURL: parameters[:vpc_ReturnURL]}
+
+    vpc_ordered_parameters =  vpc_parameters.sort_by {|key, value| key} #returns array of arrays
+
+    url_params = []
+    vpc_ordered_parameters.each do |key, value|
+      if value.length > 0
+        url_params << Rack::Utils.escape(key)+"="+Rack::Utils.escape(value)
+        md5HashData += value
+      end
+    end
+    vpcURL += url_params.join("&")
+    if(@config[:secure_secret].length > 0)
+      vpcURL += "&vpc_SecureHash=" + Digest::MD5.hexdigest(md5HashData).upcase
+    end
+
+    vpcURL
+  end
+
+  #TODO: another validation needs to be added for the transaction number and amount
+
+  def self.validate_response response
+    
+    #strip the input hash from other parameters than vpc_ parameters
+    vpc_response = response.reject{|key,value| !(key =~ /vpc_(.*)/) }
+
+    vpc_Txn_Secure_Hash = vpc_response.delete(:vpc_SecureHash)
+
+    if (@config[:secure_secret].length > 0 && vpc_response[:vpc_TxnResponseCode] != "7" && vpc_response[:vpc_TxnResponseCode] != "No Value Returned")
+      md5HashData = @config[:secure_secret]
+      vpc_response.each do |key, value|
+        if (key != "vpc_SecureHash" || value.length > 0)
+          md5HashData += value
+        end
+      end
+      if (vpc_Txn_Secure_Hash.upcase == Digest::MD5.hexdigest(md5HashData).upcase)
+        true
+      else
+        false
+      end
+
+    else
+      # No 'SECURE_SECRET' present.
+      false
+    end
+  end
+
+
+end

data/lib/payment_3p/generators/config_generator.rb

@@ -0,0 +1,12 @@
+require "rails/generators"
+module Payment3p
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_files
+        template "payment_3p.yml", "config/payment_3p.yml"
+      end
+    end
+  end
+end

data/lib/payment_3p/generators/templates/payment_3p.yml

@@ -0,0 +1,4 @@
+secure_secret: ""
+payment_endpoint: "https://migs.mastercard.com.au/vpcpay?"
+vpc_AccessCode: ""
+vpc_Merchant: ""

data/lib/payment_3p/railtie.rb

@@ -0,0 +1,8 @@
+module Payment3p
+  class Railtie < Rails::Railtie
+    initializer "my_railtie.configure_rails_initialization" do
+      #initialization code (if more lines will be added move this code to a separate file)
+      Payment3p.configure_with("#{Rails.root}/config/payment_3p.yml")
+    end
+  end
+end

data/lib/payment_3p/version.rb

@@ -0,0 +1,3 @@
+module Payment3p
+  VERSION = "0.0.1"
+end

data/payment_3p.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payment_3p/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "payment_3p"
+  gem.version       = Payment3p::VERSION
+  gem.authors       = ["Eslam Foad"]
+  gem.email         = ["eslam.foad@gmail.com"]
+  gem.description   = "Provides 3-Party online payment with migs network initially"
+  gem.summary       = "Provides 3-Party online payment"
+  gem.homepage      = "https://github.com/rayasocialmedia/payment_3p"
+
+  gem.files         = `git ls-files`.split($/)
+  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"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: payment_3p
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eslam Foad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies: []
+description: Provides 3-Party online payment with migs network initially
+email:
+- eslam.foad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/payment_3p.rb
+- lib/payment_3p/generators/config_generator.rb
+- lib/payment_3p/generators/templates/payment_3p.yml
+- lib/payment_3p/railtie.rb
+- lib/payment_3p/version.rb
+- payment_3p.gemspec
+homepage: https://github.com/rayasocialmedia/payment_3p
+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: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Provides 3-Party online payment
+test_files: []
+has_rdoc: