interswitch 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f545796c457d4aa3181ab31d464801a52d8113e
+  data.tar.gz: 6dfca6ac3d1a093c8aa6275424c883eb34d04f67
+SHA512:
+  metadata.gz: 356153a40cc93cfdf0dfdc40ffc7437b948c7d47babf10c005be63d4cbeadf5257ea32cc30d4e809b812ddc3cd54c3a06ee774b66456cc992aa4c5f95b8ec9a7
+  data.tar.gz: de2c02acac6f96fe8c768ec01b4f6336b91f9a423053f7d7a4adf3c9b095ca32a1600faa4ed0861266c84d332e63f16fe2453b63d22ce1914ce7bdb7244a065f

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nnaemeka.Okoroafor
+
+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,41 @@
+# Interswitch
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/interswitch`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'interswitch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interswitch
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/interswitch.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/interswitch.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interswitch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interswitch"
+  spec.version       = InterswitchVersion::VERSION
+  spec.authors       = ["Nnaemeka.Okoroafor"]
+  spec.email         = ["nnaemeka.okoroafor@interswitchgroup.com"]
+
+  spec.summary       = %q{Perform common actions for interacting with Interswitch payment systems}
+  spec.description   = %q{A utility gem with basic interswitch payment functionalities}
+  spec.homepage      = 'https://github.com/techquest/interswitch_ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'addressable'
+  spec.add_development_dependency 'rest-client'
+  spec.add_development_dependency 'mocha'
+  spec.add_runtime_dependency 'addressable'
+  spec.add_runtime_dependency 'rest-client'
+  spec.add_runtime_dependency 'oauth2'
+
+end

data/lib/interswitch.rb

@@ -0,0 +1,82 @@
+require "interswitch/version"
+require "interswitch/secure_data"
+require "interswitch/rest_secure"
+require "interswitch/auth_data"
+require 'oauth2'
+require 'rest-client'
+
+class Interswitch
+  include SecureData
+  include AuthData
+  include RestSecure
+
+  @client_token = nil
+  @client_id = nil
+  @secret_key = nil
+  @client = nil
+  @environment = nil
+  @token_url = nil
+
+  def init(client_id, secret_key, environment = "SANDBOX")
+    @client_id = client_id
+    @secret_key = secret_key
+    @environment = environment
+    if environment == "SANDBOX"
+      @token_url = InterswitchVersion::SANDBOX_URL
+    else
+      @token_url = InterswitchVersion::PROD_URL
+    end
+
+    @client = OAuth2::Client.new(@client_id, @secret_key, :site => @token_url, :token_url => "/passport/oauth/token")
+    oauth_response = @client.client_credentials.get_token
+    @client_token = oauth_response.token
+
+  end
+
+  def send(uri, http_method, content_type, data, access_token, http_headers={}, signed_parameters = nil)
+    auth_headers = generate_auth_headers(:client_id => @client_id, :secret => @secret_key,
+                                         :http_method => http_method,
+                                         :url => uri, :content_type => content_type)
+    if access_token == nil || access_token.length == 0
+      access_token = @client_token
+    end
+
+    auth_headers['Authorization'] = "Bearer #{access_token}"
+    if !http_headers.empty?
+      http_headers.each { |key, value|
+        auth_headers[key] = value
+      }
+    end
+
+    payload = content_type == 'json' ? data.to_json : data.to_xml
+
+    response = nil
+    begin
+      if (http_method.casecmp("post"))
+        response = RestClient::Request.execute(:url => uri, :method => :post, :payload => payload, :headers => auth_headers, :ssl_version => 'TLSv1_2')
+      elsif (http_method.casecmp("put"))
+        response = RestClient::Request.execute(:url => uri, :method => :put, :payload => payload, :headers => auth_headers, :ssl_version => 'TLSv1_2')
+      else
+        response = RestClient.get(uri, data, :headers => auth_headers)
+      end
+    rescue => e
+      response = e.response
+      puts response
+    end
+
+    return response
+
+  end
+
+  def get_client_token
+    @client_token
+  end
+
+  def get_password_token(username, password)
+    oauth_response = @client.password.get_token(username, password)
+    oauth_response.token
+  end
+
+
+end
+

data/lib/interswitch/auth_data.rb

@@ -0,0 +1,15 @@
+require 'openssl'
+require 'base64'
+
+module AuthData
+
+  def get_auth_data( public_cert, version, pan, exp_date, cvv, pin)
+    auth_data = version + "Z" + pan + "Z" + pin + "Z" + exp_date + "Z" + cvv
+    raw = File.read(public_cert)
+    certificate = OpenSSL::X509::Certificate.new raw
+    public_key = OpenSSL::PKey::RSA.new(certificate.public_key)
+    encrypted_string = Base64.encode64(public_key.public_encrypt(auth_data))
+    return encrypted_string
+  end
+
+end

data/lib/interswitch/rest_secure.rb

@@ -0,0 +1,107 @@
+require 'securerandom'
+require 'addressable/uri'
+require 'open-uri'
+require 'digest'
+require 'base64'
+require 'rack'
+
+module RestSecure
+  def generate_auth_headers(hash={})
+
+    if !valid_params(hash)
+      return nil
+    end
+
+    client_id = hash[:client_id]
+    secret = hash[:secret]
+    http_method = hash[:http_method]
+    url = hash[:url]
+    tran_parameters = hash[:tran_parameters]
+    content_type = hash[:content_type]
+
+    nonce = generate_nonce
+    authorization = generate_authorization client_id
+    timestamp = generate_timestamp
+    signature = generate_signature(client_id, secret, url, http_method, timestamp, nonce, tran_parameters)
+
+    headers = {
+        "Signature" => signature,
+        "Timestamp" => timestamp,
+        "Nonce" => nonce,
+        "Authorization" => authorization,
+        "SignatureMethod" => "SHA1",
+        "Content-Type" => content_type
+    }
+
+    return headers
+
+  rescue => e
+    puts "Error occured #{e.message}"
+    return nil
+  end
+
+  def generate_signature(client_id, secret, url, http_method, timestamp, nonce, tran_parameters)
+
+    url = url.sub("http://", "https://")
+    encoded_url = Rack::Utils.escape(url).to_s
+    puts encoded_url
+    base_string = http_method + "&" +
+        encoded_url + "&" +
+        timestamp + "&" +
+        nonce + "&" +
+        client_id + "&" +
+        secret
+
+    temp_parameters = ""
+    if tran_parameters && tran_parameters.kind_of?(Array) && tran_parameters.count > 0
+      tran_parameters.each do |tran_parameter|
+        temp_parameters = temp_parameters + "&" + tran_parameter.to_s
+      end
+    end
+
+    full_string_to_be_signed = base_string + temp_parameters
+    signature = Base64.encode64((Digest::SHA1.new() << full_string_to_be_signed).digest).strip
+
+    return signature
+  end
+
+  def generate_authorization(client_id)
+    "InterswitchAuth #{Base64.encode64(client_id)}"
+  end
+
+
+  def generate_timestamp
+    Time.now.to_i.to_s
+  end
+
+  def generate_nonce
+    SecureRandom.random_number(99999999999999999999999).to_s
+  end
+
+
+  def valid_params(hash={})
+
+    if hash[:client_id].to_s.strip.length == 0
+      puts ">>>Empty client id supplied.."
+      return false
+    end
+
+    if hash[:secret].to_s.strip.length == 0
+      puts ">>>Empty secret supplied.."
+      return false
+    end
+
+    if hash[:http_method].to_s.strip.length == 0
+      puts ">>>Empty http method supplied.."
+      return false
+    end
+
+    if hash[:url].to_s.strip.length == 0
+      puts ">>>Empty url supplied.."
+      return false
+    end
+
+    return true
+
+  end
+end

data/lib/interswitch/secure_data.rb

@@ -0,0 +1,149 @@
+require 'openssl'
+require 'base64'
+module SecureData
+
+
+  def get_secure_data(public_cert_path, pan, exp_date, cvv, pin, transaction_parameters = {})
+
+    pin_des_key = SecureRandom.hex(16)
+    mac_des_key = "00000000000000000000000000000000"
+    header_bytes = "4D"
+
+    format_version_bytes = "10"
+    mac_version_bytes = "10"
+    pan_diff = 20 - pan.length
+    pan = pan_diff.to_s + pan
+
+    if pan.to_s.strip.length != 0
+      pan = pan.ljust(20, 'F')
+    end
+    customer_id_bytes = pan
+    mac_data = self.get_mac_data_version_9(transaction_parameters)
+    mac_bytes = hex_to_bin(get_mac(mac_data, mac_des_key, 11))[0..7]
+
+
+    footer_bytes = "5A"
+    other_bytes = "0000000000000000000000000000"
+    secure_bytes = header_bytes + format_version_bytes + mac_version_bytes +
+        pin_des_key + mac_des_key + customer_id_bytes + mac_bytes +other_bytes + footer_bytes
+
+    raw = File.read(public_cert_path)
+    certificate = OpenSSL::X509::Certificate.new raw
+    public_key = OpenSSL::PKey::RSA.new(certificate.public_key)
+    encrypted_secure = public_key.public_encrypt(hex_to_bin(secure_bytes)).unpack('H*').first
+    pin_block = get_pin_block(pin, cvv, exp_date, pin_des_key)
+
+    secure_data = {}
+    secure_data[:secure] = encrypted_secure
+    secure_data[:pin_block] = pin_block
+    return secure_data
+
+  end
+
+  def generate_key
+    triple_des = OpenSSL::Cipher::Cipher.new('des-ede-cbc')
+    triple_des.encrypt
+    return triple_des.random_key.unpack('H*').first
+  end
+
+
+  def bin_to_hex(string)
+    string.each_byte.map { |b| b.to_s(16) }.join
+  end
+
+  def hex_to_bin(string)
+    string.scan(/../).map { |x| x.hex }.join
+  end
+
+  def get_mac (mac_data, mac_key, mac_version)
+    mac_cipher = ""
+    if mac_version.to_i == 8
+      cipher = OpenSSL::Cipher::Cipher.new('AES-128-CBC-HMAC-SHA1')
+      cipher.encrypt
+      key = cipher.random_key
+      mac_cipher = cipher.update(mac_data) + cipher.final
+    elsif mac_version.to_i == 12
+      cipher = OpenSSL::Cipher::Cipher.new('AES-256-CBC-HMAC-SHA1')
+      cipher.encrypt
+      mac_cipher = cipher.update(mac_data) + cipher.final
+    else
+      cipher = OpenSSL::Cipher::Cipher.new('DES-EDE-CBC')
+      cipher.encrypt
+      cipher.key = mac_key
+      mac_cipher = cipher.update(mac_data) + cipher.final
+    end
+    return mac_cipher.unpack('H*').first
+  end
+
+
+  def get_mac_data_version_9(transaction_parameters)
+    mac_data = ""
+    puts transaction_parameters
+    if transaction_parameters["tid"] != nil
+      mac_data += transaction_parameters["tid"].to_s
+    end
+
+    if transaction_parameters['msisdn'] != nil
+      mac_data += transaction_parameters['msisdn'].to_s
+    end
+
+    if transaction_parameters["cardName"] != nil
+      mac_data += transaction_parameters["cardName"].to_s
+    end
+
+    if transaction_parameters["ttid"] != nil
+      mac_data += transaction_parameters["ttid"].to_s
+    end
+
+    if transaction_parameters["amt"] != nil
+      mac_data += transaction_parameters["amt"].to_s
+    end
+
+    if transaction_parameters["toAcctNo"] != nil
+      mac_data += transaction_parameters["toAcctNo"].to_s
+    end
+
+    if transaction_parameters["toBankCode"] != nil
+      mac_data = transaction_parameters["toBankCode"].to_s
+    end
+
+    if transaction_parameters["toBankCode"] != nil
+      mac_data = transaction_parameters["toBankCode"].to_s
+    end
+
+
+    return mac_data
+  end
+
+  def get_pin_block(pin, cvv2, expiry_date, key_bytes)
+    pin_new = pin == nil || pin.length == 0 ? "0000" : pin
+    cvv2_new = cvv2 == nil || cvv2.length == 0 ? "000" : cvv2
+    expiry_date_new = expiry_date == nil || expiry_date.length == 0 ? "0000" : expiry_date
+
+    pin_block_string = pin_new + cvv2_new + expiry_date_new
+
+    pin_block_string_length = pin_block_string.length.to_s
+    pin_block_string_length_length = pin_block_string_length.length
+    clear_pin_block = pin_block_string_length_length.to_s + pin_block_string_length.to_s + pin_block_string
+
+    random_digit = 0
+    pin_pad_length = 16 - clear_pin_block.length
+
+    for i in 1..pin_pad_length
+
+      clear_pin_block = clear_pin_block + random_digit.to_s
+    end
+
+
+    des_ede = OpenSSL::Cipher::Cipher.new('des-ede')
+    des_ede.padding = 1
+    des_ede.key = key_bytes
+    des_ede.encrypt
+    encrypted_pin_block = des_ede.update(clear_pin_block) + des_ede.final
+    pin_block_hex = encrypted_pin_block.unpack('H*').first
+
+    return pin_block_hex[0..15]
+
+  end
+
+end

data/lib/interswitch/version.rb

@@ -0,0 +1,5 @@
+module InterswitchVersion
+  VERSION = "1.0.1"
+  PROD_URL = "https://saturn.interswitch.ng"
+  SANDBOX_URL = "https://sandbox.interswitch.ng"
+end

data/test/interswitch/rest_secure_test.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'interswitch/rest_secure'
+require 'base64'
+class RestSecureTest < Test::Unit::TestCase
+  include RestSecure
+  def test_generate_authorization
+    assert_equal "InterswitchAuth " + Base64.encode64('IKIAC48CB151885D99D0F15395F124AA6E4C24BE952D'), generate_authorization('IKIAC48CB151885D99D0F15395F124AA6E4C24BE952D')
+  end
+
+
+  def test_generate_auth_headers
+    http_method = "POST"
+    url = "https://developer.interswitchng.com"
+    tran_parameters = ["44", "sum"]
+    client_id  = 'IKIAC48CB151885D99D0F15395F124AA6E4C24BE952D'
+    secret  = 'W60Ce5PlidQ72fMEyZ2qXlFPrStoQb004zFmtJHF5Z0='
+
+    headers = generate_auth_headers(
+        :client_id => client_id,
+        :secret => secret,
+        :http_method => http_method,
+        :url => url,
+        :tran_parameters => tran_parameters
+    )
+    #TODO test headers
+  end
+end

data/test/interswitch/secure_data_test.rb

@@ -0,0 +1,14 @@
+require "interswitch/secure_data"
+
+class SecureDataTest < Test::Unit::TestCase
+  include SecureData
+  def test_get_secure_data
+    cert_path = "C:/paymentgateway.crt"
+    pan = "6280511000000095"
+    pin = "1111"
+    expiry_date = "5004"
+    cvv = "111"
+    secure_data = get_secure_data(cert_path, pan, expiry_date, cvv, pin, {})
+    assert secure_data != nil
+  end
+end

data/test/interswitch_test.rb

@@ -0,0 +1,14 @@
+require 'interswitch'
+
+require 'test/unit'
+require 'mocha/test_unit'
+require 'json'
+class InterswitchTest < Test::Unit::TestCase
+
+  def test_init
+    interswitch = Interswitch.new
+    interswitch.init("IKIA9614B82064D632E9B6418DF358A6A4AEA84D7218", "XCTiBtLy1G9chAnyg0z3BcaFK4cVpwDg/GTw2EmjTZ8=")
+    assert interswitch.client_token != nil
+  end
+
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: interswitch
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Nnaemeka.Okoroafor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A utility gem with basic interswitch payment functionalities
+email:
+- nnaemeka.okoroafor@interswitchgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interswitch.gemspec
+- lib/interswitch.rb
+- lib/interswitch/auth_data.rb
+- lib/interswitch/rest_secure.rb
+- lib/interswitch/secure_data.rb
+- lib/interswitch/version.rb
+- test/interswitch/rest_secure_test.rb
+- test/interswitch/secure_data_test.rb
+- test/interswitch_test.rb
+homepage: https://github.com/techquest/interswitch_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: Perform common actions for interacting with Interswitch payment systems
+test_files:
+- test/interswitch/rest_secure_test.rb
+- test/interswitch/secure_data_test.rb
+- test/interswitch_test.rb