teligem 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84581fe3996b6c54b45af438b1211d82c6c1242f
-  data.tar.gz: 0c4dcfcf64509de20436f4a9909d13a1e5f33a18
+  metadata.gz: 43ff7f46e4ecf7ef3f9105b97ae66151be6e8bb8
+  data.tar.gz: 8822daa689f8f22805b62633244c6dc228161687
 SHA512:
-  metadata.gz: ab327140565ba5190aac61d4b11fd023ec951a93021ff958a96b0c112971580eba2283a573546c8475ef20b9b037cfab7d2a9addd9f3c2dabfa2e43057a6140b
-  data.tar.gz: d4714ee41046cd02b8ae4f2ff8f28ce22759fdc464306084a82bc4917ac03a2d12ad437ea32a8606a4735ce1096224204b437f3f1de66e287ce9e8758b362992
+  metadata.gz: 8697ce223379ac15366d18b35c86f953068269995db7310361833e752080b7db72b83c68bfa29229541c5f41ec77d7ec9319e04b12f94074eb374defa4884641
+  data.tar.gz: acec9bcafd7d3ad0d564bc3ba75c98a52bd080c2af9708b2299be255b490667bd5ab07c5d3af205b23fcf21ad93ac206d59aaabb9bbb1f1a60d54e1b663798f8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teligem (0.0.2)
+    teligem (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/README.markdown

@@ -19,38 +19,9 @@ Then run 'bundle install'
 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,
+You must at least have those attributes in your payment model: 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)
@@ -60,29 +31,57 @@ Add to your config/secrets.yml (don't forget to add it to .gitignore)
 ```
 
 ## USAGE
+### security_check
+To check if the payment really comes from the Telipass website, set your params and call the security check method.
 
-To check if the payment really comes from the Telipass website, set your params and just call call:
+```ruby
+  # in payment_controller.rb
+
+  def create
+    params = {
+      security_code: params[:security_code],
+      enduser_ip: params[:enduser_ip],
+      ntu: params[:ntu]
+    }
+
+    if Telipass.new.security_check(params) do
+      # ex: Create payment, give some user coins
+    else
+      # ex: Create payment, send a security alert
+    end
+  end
+
+```
+The security check method will return true if the payment really comes from Telipass, otherwise it will return false.
+
+### check_status
+Before giving coins to your user, you may want to check if the status of the transaction is valid, differed, rejected or is test.
+Call the check_status function.
 
 ```ruby
-  params = {
-    security_code: params[:security_code],
-    enduser_ip: params[:enduser_ip],
-    ntu: params[:ntu]
-  }
-
-  if Telipass.new.security_check(params) do
-    # ex: Give some user coins
+  if Telipass.new.check_status(params[:status])
+    # Give coins to user
   else
-    # ex: Send a alert security
+    # Don't give user some coins
   end
-
 ```
-It will return true if the payment really comes from Telipass, otherwise it will return false.
+It will return true if status is valid, and return false if status is test or rejected or differed.
+
+### get_earning
+First, set earnings per point_name:
+  ```
+    Teligem::EARNING = {
+      "FRSMS10" => 10,
+      "FRSMS20" => 20
+    }
+  ```
+Then call the get_earning method to the get the earning.
+```
+  Teligem.new.get_earning(params[:point_name])
+  # It will return 10 if point_name is FRSMS10.
+```
+When the point_name is unknown, it will return 0.
 
-## TODO
-* Check if telikey is here otherwise show logger error info
-* Get payment detailed info in order to set easier the earning
-(most important infos are: module_name, payment_method, point_name, amount, credit)
 
 
 ## How to contribute?

data/lib/teligem.rb

@@ -30,6 +30,36 @@ class Teligem
     return response
   end
 
+  # === check_status(status)
+  # Return true if status is 1 (valid)
+  # Otherwise return false
+  def check_status(status)
+    case status
+    when 1 # Valid
+      true
+    when 2 # Rejected
+      false
+    when 3 # Differed
+      false
+    when 4 # Test
+      false
+    else
+      false
+    end
+  end
+
+  # === get_earning(point_name)
+  # Get earning from the hash Teligem::EARNING
+  # Hash exemple:
+  # Teligem::EARNING =
+  # { "FRSMS10" => 10,
+  #   "FRSMS20" => 20
+  # }
+  # Return 0 if key unknown
+  def get_earning(point_name)
+    return Teligem::EARNING[point_name].to_i
+  end
+
   private
     def get_security_code(enduser_ip, ntu)
       code = enduser_ip.to_s + ntu.to_s + @configs['telikey'].to_s

data/spec/lib/teligem_spec.rb

@@ -41,4 +41,31 @@ RSpec.describe Teligem do
     end
   end
 
+  describe '#check_status' do
+    it 'should return true if status valid' do
+      expect(Teligem.new.check_status(1)).to eq true
+    end
+    it 'should return false if status rejected' do
+      expect(Teligem.new.check_status(2)).to eq false
+    end
+    it 'should return false if status differed' do
+      expect(Teligem.new.check_status(3)).to eq false
+    end
+    it 'should return true if status test' do
+      expect(Teligem.new.check_status(4)).to eq false
+    end
+  end
+
+  describe '#get_earning' do
+    it 'should return correct earning' do
+      Teligem::EARNING = {
+        "FRSMS10" => 10,
+        "FRSMS20" => 20
+      }
+
+      expect(Teligem.new.get_earning("FRSMS10")).to eq 10
+      expect(Teligem.new.get_earning("FRSMS20")).to eq 20
+      expect(Teligem.new.get_earning("UNKNOWN")).to eq 0
+    end
+  end
 end

data/teligem.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'teligem'
-  s.version     = '0.0.4'
+  s.version     = '0.0.5'
   s.date        = '2015-07-22'
   s.platform = Gem::Platform::RUBY
   s.summary     = "A gem to implement Telipass micropayment"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teligem
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Arpsara, CT2C