platbamobilom 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30e89a5b45a51ba40cdd6376daf7be1688e4f7a6
+  data.tar.gz: 26c377da04745e555fd3d64b8867d26b6c3f9dc9
+SHA512:
+  metadata.gz: e15a1b4a84a0271aeb6e406c108d24bf704c49a800f32d47072d213227577569d1ee1275de596565de8f07503d5684da64f3b3e106607f9d2b6f5a2c89d97a04
+  data.tar.gz: 247015ba56de82f9aaf7550d7232b6455e41414f751e26c56ccd9bec9cf1d77a42206936f20cb413d2fa75618b04237c2ab15ff008334c3576dbd041e9955a97

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ahmed Al Hafoudh
+
+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,71 @@
+# platbamobilom [![Build Status](https://travis-ci.org/alhafoudh/platbamobilom.svg?branch=develop)](https://travis-ci.org/alhafoudh/platbamobilom)
+
+This gem provides a set of helpers to generate and verify signatures of [platbamobilom.sk](http://www.platbamobilom.sk) service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'platbamobilom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install platbamobilom
+
+## Usage
+
+
+```ruby
+# Generate signature
+
+secret = 'test'
+
+redirect = Platbamobilom::Redirect.new(
+  pid:   '1',
+  id:    '445566',
+  desc:  'some description',
+  price: '3.10',
+  url:   'http://redirect.url',
+  email: 'sales@example.com'
+)
+
+signature = redirect.sign(secret) # => 'AF7E772D957225E8A40E5D77801D095AFD82FBBE600BC9CB9DE06A514621D02F'
+
+# Generate signed URL
+
+redirect.signed_url(signature) # => 'https://pay.platbamobilom.sk/test/?PID=1&ID=445566&DESC=some+description&PRICE=3.10&URL=http%3A%2F%2Fredirect.url&EMAIL=sales%40example.com&SIGN=AF7E772D957225E8A40E5D77801D095AFD82FBBE600BC9CB9DE06A514621D02F'
+
+# Verify signature
+
+verification = Platbamobilom::Verification.new(
+  id:        '445566',
+  result:    'OK',
+  phone:     '421903000000',
+  signature: '2FD327601CC033ED60A610EAF1239C5E958774426F6CC1D6B48DE422336784A3'
+)
+
+verification.verify(secret) # => true
+
+verification = Platbamobilom::Verification.new(
+  id:        '445566',
+  result:    'FAIL',
+  phone:     '421903000000',
+  signature: '2FD327601CC033ED60A610EAF1239C5E958774426F6CC1D6B48DE422336784A3'
+)
+
+verification.verify(secret) # => false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/alhafoudh/platbamobilom/fork )
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test
+

data/lib/platbamobilom.rb

@@ -0,0 +1,17 @@
+require 'rack/utils'
+
+require 'platbamobilom/version'
+require 'platbamobilom/redirect'
+require 'platbamobilom/verification'
+
+module Platbamobilom
+  class << self
+    attr_accessor :test_mode
+
+    def reset!
+      self.test_mode = true
+    end
+  end
+end
+
+Platbamobilom.reset!

data/lib/platbamobilom/redirect.rb

@@ -0,0 +1,50 @@
+module Platbamobilom
+  class Redirect
+    PRODUCTION_URL = 'https://pay.platbamobilom.sk/pay/'.freeze
+    TEST_URL       = 'https://pay.platbamobilom.sk/test/'.freeze
+
+    def self.production_url; PRODUCTION_URL end
+    def self.test_url; TEST_URL end
+    def self.url; (Platbamobilom.test_mode ? test_url : production_url) end
+
+    attr_reader :pid
+    attr_reader :id
+    attr_reader :desc
+    attr_reader :price
+    attr_reader :url
+    attr_reader :email
+
+    def initialize(pid:, id:, desc:, price:, url:, email:)
+      @pid   = pid
+      @id    = id
+      @desc  = desc
+      @price = price
+      @url   = url
+      @email = email
+    end
+
+    def sign(secret)
+      signing_data  = [pid, id, desc, price, url, email].join
+      digest        = OpenSSL::Digest.new('sha256')
+      hmac          = OpenSSL::HMAC.digest(digest, secret, signing_data)
+      signature     = hmac.unpack('H*').join.upcase
+    end
+
+    def signed_query_string(signature)
+      Rack::Utils.build_query({
+        PID: pid,
+        ID: id,
+        DESC: desc,
+        PRICE: price,
+        URL: url,
+        EMAIL: email,
+        SIGN: signature
+      })
+    end
+
+    def signed_url(signature)
+      '%s?%s' % [self.class.url, signed_query_string(signature)]
+    end
+    
+  end
+end

data/lib/platbamobilom/verification.rb

@@ -0,0 +1,24 @@
+module Platbamobilom
+  class Verification
+    attr_reader :id
+    attr_reader :result
+    attr_reader :phone
+    attr_reader :signature
+
+    def initialize(id:, result:, phone:, signature:)
+      @id        = id
+      @result    = result
+      @phone     = phone
+      @signature = signature
+    end
+
+    def verify(secret)
+      signing_data  = [id, result, phone].join
+      digest        = OpenSSL::Digest.new('sha256')
+      hmac          = OpenSSL::HMAC.digest(digest, secret, signing_data)
+      our_signature = hmac.unpack('H*').join.upcase
+
+      our_signature == signature
+    end
+  end
+end

data/lib/platbamobilom/version.rb

@@ -0,0 +1,3 @@
+module Platbamobilom
+  VERSION = '1.0.0'
+end

data/platbamobilom.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'platbamobilom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'platbamobilom'
+  spec.version       = Platbamobilom::VERSION
+  spec.authors       = ['Ahmed Al Hafoudh']
+  spec.email         = ['alhafoudh@freevision.sk']
+  spec.summary       = %q{Gem for platbamobilom.sk signature generation and verification}
+  spec.description   = %q{This gem provides a set of helpers to generate and verify signatures of http://www.platbamobilom.sk service.}
+  spec.homepage      = 'https://github.com/alhafoudh/platbamobilom'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 1.3.0', '< 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.4.2'
+  spec.add_development_dependency 'pry', '~> 0.9.12.6'
+
+  spec.add_dependency 'rack', '~> 1.5.2'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'platbamobilom'
+
+require 'minitest/autorun'

data/test/test_platbamobilom.rb

@@ -0,0 +1,23 @@
+require 'minitest_helper'
+
+describe Platbamobilom do
+  before(:each) do
+    Platbamobilom.reset!
+  end
+
+  it 'has a version number' do
+    refute_nil ::Platbamobilom::VERSION
+  end
+
+  it 'is in test mode as default' do
+    assert_equal true, Platbamobilom.test_mode
+  end
+
+  it 'can disable test mode' do
+    assert_equal true, Platbamobilom.test_mode
+
+    Platbamobilom.test_mode = false
+
+    assert_equal false, Platbamobilom.test_mode
+  end
+end

data/test/test_redirect.rb

@@ -0,0 +1,57 @@
+require 'minitest_helper'
+
+describe Platbamobilom::Redirect do
+  before(:each) do
+    Platbamobilom.test_mode = true
+  end
+
+  let(:described_class) { Platbamobilom::Redirect }
+  let(:subject) do
+    described_class.new(
+      pid:    '1',
+      id:     '445566',
+      desc:   'some description',
+      price:  '3.10',
+      url:    'http://redirect.url',
+      email:  'sales@example.com'
+    )
+  end
+  let(:secret) { 'test' }
+  let(:signature) { 'AF7E772D957225E8A40E5D77801D095AFD82FBBE600BC9CB9DE06A514621D02F' }
+  let(:signed_query_string) { 'PID=1&ID=445566&DESC=some+description&PRICE=3.10&URL=http%3A%2F%2Fredirect.url&EMAIL=sales%40example.com&SIGN=AF7E772D957225E8A40E5D77801D095AFD82FBBE600BC9CB9DE06A514621D02F' }
+  let(:signed_url) { 'https://pay.platbamobilom.sk/test/?PID=1&ID=445566&DESC=some+description&PRICE=3.10&URL=http%3A%2F%2Fredirect.url&EMAIL=sales%40example.com&SIGN=AF7E772D957225E8A40E5D77801D095AFD82FBBE600BC9CB9DE06A514621D02F' }
+
+  it 'has redirect url for specific environment' do
+    assert_equal 'https://pay.platbamobilom.sk/pay/', described_class.production_url
+    assert_equal 'https://pay.platbamobilom.sk/test/', described_class.test_url
+  end
+
+  it 'initializes with all required parameters' do
+    assert_equal subject.pid, '1'
+    assert_equal subject.id, '445566'
+    assert_equal subject.desc, 'some description'
+    assert_equal subject.price, '3.10'
+    assert_equal subject.url, 'http://redirect.url'
+    assert_equal subject.email, 'sales@example.com'
+  end
+
+  it 'signes the parameters correctly' do
+    assert_equal signature, subject.sign(secret)
+  end
+
+  it 'generates signed query string' do
+    assert_equal signed_query_string, subject.signed_query_string(signature)
+  end
+
+  it 'generates signed url' do
+    assert_equal signed_url, subject.signed_url(signature)
+  end
+
+  it 'has different url based on test mode' do
+    Platbamobilom.test_mode = true
+    assert_equal described_class.test_url, described_class.url
+
+    Platbamobilom.test_mode = false
+    assert_equal described_class.production_url, described_class.url
+  end
+end

data/test/test_verification.rb

@@ -0,0 +1,34 @@
+require 'minitest_helper'
+
+describe Platbamobilom::Verification do
+  let(:described_class) { Platbamobilom::Verification }
+  let(:subject) do
+    described_class.new(
+      id:        '445566',
+      result:    'OK',
+      phone:     '421903000000',
+      signature: '2FD327601CC033ED60A610EAF1239C5E958774426F6CC1D6B48DE422336784A3'
+    )
+  end
+  let(:bad_subject) do
+    described_class.new(
+      id:        '445566',
+      result:    'FAIL',
+      phone:     '421903000000',
+      signature: '2FD327601CC033ED60A610EAF1239C5E958774426F6CC1D6B48DE422336784A3'
+    )
+  end
+  let(:secret) { 'test' }
+
+  it 'initializes with all required parameters' do
+    assert_equal subject.id, '445566'
+    assert_equal subject.result, 'OK'
+    assert_equal subject.phone, '421903000000'
+    assert_equal subject.signature, '2FD327601CC033ED60A610EAF1239C5E958774426F6CC1D6B48DE422336784A3'
+  end
+
+  it 'verifies signature correctly' do
+    assert_equal true, subject.verify(secret)
+    assert_equal false, bad_subject.verify(secret)
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: platbamobilom
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ahmed Al Hafoudh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.4.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: This gem provides a set of helpers to generate and verify signatures
+  of http://www.platbamobilom.sk service.
+email:
+- alhafoudh@freevision.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/platbamobilom.rb
+- lib/platbamobilom/redirect.rb
+- lib/platbamobilom/verification.rb
+- lib/platbamobilom/version.rb
+- platbamobilom.gemspec
+- test/minitest_helper.rb
+- test/test_platbamobilom.rb
+- test/test_redirect.rb
+- test/test_verification.rb
+homepage: https://github.com/alhafoudh/platbamobilom
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for platbamobilom.sk signature generation and verification
+test_files:
+- test/minitest_helper.rb
+- test/test_platbamobilom.rb
+- test/test_redirect.rb
+- test/test_verification.rb