teligem 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4d4c4251c71acb20e927c26adef2f19791d0abc
+  data.tar.gz: f58cc447814ec1f03841050572127fdca9291fc9
+SHA512:
+  metadata.gz: 6dabd55860d22a0e85f99113a448efaa2918eaa817fe4d9d8c1199c5d9c1609b5de2010eeceefec1e2c323264b60f37b3666ae5bd154163cbef659da691f4446
+  data.tar.gz: 9943af1a13908ef451169a42d46230204cce6efe02d1431a5c2dcf38d9e58aaa490e11d55ac0c91bd08566825d9a31c62f13db4f242b7b3e2ae545e16e6e27f4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    teligem (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  teligem!

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 CT2C
+
+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.markdown

@@ -0,0 +1,81 @@
+# Teligem
+
+Teligem allows you to integrate the notifications of the [Telipass](https://telipass.com/) solution.
+
+## INSTALL
+
+In your Gemfile
+
+```ruby
+  gem 'teligem'
+```
+
+Then run 'bundle install'
+
+## SETUP
+
+### MODEL
+
+When a payment has been made, Telipass sends to the notification url those parameters.
+Pick the ones you are interested in and put it in your payment model.
+
+You must at least have those attributes: security_code:string, enduser_ip:string and ntu:string,
+as they are used to check if the payment really comes from the Telipass plateform.
+
+```ruby
+  # Security
+  t.string :security_code               # SecurityCode
+  # User Infos
+  t.string :enduser_ip                  # UserIP
+  t.string :enduser_host                # Userhost
+  t.string :enduser_useragent           # UserAgent
+  t.string :enduser_userlanguage        # Webbrowser language
+  t.string :enduser_plateform           # Exploitation system
+  # Transaction
+  t.string :ntu, null: false            # Unique transaction number (NTU)
+  t.string :module_name                 # Name of the payment module
+  t.string :module_id                   # Module ID
+  t.string :site_name                   # Website name
+  t.string :solution_name               # Payment solution name
+  t.string :payment_method              # Payment used name
+  t.string :point_name                  # Point name
+  t.string :country_code                # Country code name
+  t.string :country_name                # Country name
+  t.integer :credits                    # Credits (only for virtual money)
+  t.decimal :amount                     # Commission
+  t.integer :status                     # Transaction status
+                                        # 1 = Valid, 2 = Rejected, 3 = Differed, 4 = Test
+  t.string :status_text                 # Transaction status in text
+  t.date   :transaction_date            # Transaction date
+  t.string :transaction_id              # Transaction ID
+  t.string :custom                      # Custom parameters
+```
+
+### RAILS SECRETS
+
+Add to your config/secrets.yml (don't forget to add it to .gitignore)
+
+```ruby
+  telikey: "your-telipass-key"
+```
+
+## USAGE
+
+To check if the payment really comes from the Telipass website, set your params and just call call:
+
+```ruby
+  params = {
+    security_code: params[:security_code],
+    enduser_ip: params[:enduser_ip],
+    ntu: params[:ntu]
+  }
+
+  Telipass.new.security_check(params)
+```
+
+It will return true if the payment really comes from Telipass, otherwise it will return false.
+
+## How to contribute?
+* Fork this repository
+* Create a branch to add some functionalities or solve some bugs
+* Make a pull request - I will try to review and merge it asap

data/config/secrets.yml

@@ -0,0 +1 @@
+telikey: "123456"

data/lib/teligem.rb

@@ -0,0 +1,39 @@
+#encoding: utf-8
+require 'yaml'
+
+class Teligem
+
+  def initialize
+    @configs = YAML.load_file("config/secrets.yml")
+  end
+
+  # === security_check(params)
+  # Hash that must at least contains:
+  # * security_code: the security code sent by telipass
+  # * enduser_ip: the enduser ip address
+  # * ntu: unique transaction number sent by telipass
+  def security_check(params)
+    security_code = params[:security_code]
+    enduser_ip    = params[:enduser_ip]
+    ntu           = params[:ntu]
+
+    unless security_code.nil? || enduser_ip.nil? || ntu.nil?
+      hash = get_security_code(enduser_ip, ntu)
+    end
+
+    if !hash.nil? && (security_code == hash)
+      response = true
+    else
+      response = false
+    end
+
+    return response
+  end
+
+  private
+    def get_security_code(enduser_ip, ntu)
+      code = enduser_ip + ntu + @configs['telikey']
+      Digest::MD5.hexdigest(code)
+    end
+
+end

data/spec/lib/teligem_spec.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+RSpec.describe Teligem do
+
+  describe '#security_check' do
+    before(:each) do
+      @enduser_ip = "123456"
+      @ntu        = "123456"
+
+      hash = YAML.load_file("config/secrets.yml")
+      code = @enduser_ip + @ntu + hash['telikey']
+      @security_code = Digest::MD5.hexdigest(code)
+    end
+    context 'when request comes from telipass' do
+      it 'should set response to true' do
+        @params = {
+          security_code: @security_code,
+          enduser_ip:    @enduser_ip,
+          ntu:           @ntu
+        }
+
+        response = Teligem.new.security_check(@params)
+
+        expect(response).to be true
+      end
+    end
+
+    context 'when not from telipass plateform' do
+      it 'should set response to false' do
+        @params = {
+            security_code: "not_matching_security_code",
+            enduser_ip:    @enduser_ip,
+            ntu:           @ntu
+        }
+
+        response = Teligem.new.security_check(@params)
+
+        expect(response).to be false
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'bundler/setup'
+Bundler.setup
+
+require 'teligem'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/teligem.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'teligem'
+  s.version     = '0.0.2'
+  s.date        = '2015-07-22'
+  s.platform = Gem::Platform::RUBY
+  s.summary     = "A gem to implement Telipass micropayment"
+  s.description = "A gem to implement Telipass micropayment notifications for basic payments"
+
+  s.authors     = ["Arpsara, CT2C"]
+  s.email       = 'contact@ct2c.fr'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+
+  s.homepage    = 'https://github.com/ct2c/teligem.git'
+  s.license       = 'MIT'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: teligem
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Arpsara, CT2C
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A gem to implement Telipass micropayment notifications for basic payments
+email: contact@ct2c.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- config/secrets.yml
+- lib/teligem.rb
+- spec/lib/teligem_spec.rb
+- spec/spec_helper.rb
+- teligem.gemspec
+homepage: https://github.com/ct2c/teligem.git
+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.4.3
+signing_key: 
+specification_version: 4
+summary: A gem to implement Telipass micropayment
+test_files: []