codecal 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a9497c1ebd3be3858b93cf5b998d449556a2db4
-  data.tar.gz: 8746807358f6365760509bf8f7d43c99d75a25f2
+  metadata.gz: 906b6f9a01fba1bbe351b720d0c627b908cbd1fa
+  data.tar.gz: 936507f7d62bb95cd9a4a8b8de08e34fb25e8fa7
 SHA512:
-  metadata.gz: 1e574f8ec7fab16a439e042a1035aa294e4159ca9b64db0558698fbf75e2e6352aa7f0802727aa5c08be275800f7db599feef5a246b800fc551a8c926a90ceb0
-  data.tar.gz: 751d4f1609d91a2d0d7443b264ee2b91f210da0e29ef1617464faa6c9195ccf3822092a7006f08a4ce043d4b00849924eb41f9e9d5e3254496d992508745bb6a
+  metadata.gz: 610df9b32e98baaa6209e84aa83c0be8df835a20016b949421846639e8a4fb22dff19916d624e775ad4be5dd5ceb0c87516bfc75f40a8e524cdd67d8c5b26cb1
+  data.tar.gz: 0d55b7353a451a50464c27db02d743d1e72afce2475856b1185f4e6e4103207461e1c9bf4cebbc9f218ea62e17cf4deaa708d2e36d2e49f25e163cd240f9be24

data/.gitignore

@@ -7,6 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+.DS_Store
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -25,19 +25,9 @@ codecal = Codecal::Calc.new()
 
 codecal = Codecal::Calc.new('fdsa32jkh89704lncmxzvrueopwytq')
 
-# Generate customer code for user account
-# Parameters:
-#   number     : Integer(<=9) -- code to be calculated and masked
-#   currency   : String       --currency name
-# Return: Hash
-#   success       : boolean -- generate customer code success
-#   customer code : String  -- 16 numbers string when success == true
-#   error         : String  -- error message of parameters when success == false
-codecal.bank_customer_code_generate(number, currency)
-
 # Generate simple code for account
 # Parameters:
-#   number  : Integer(<=9)  -- code to be calculated and masked
+#   number  : Integer       -- code to be calculated and masked
 # Return: Hash
 #   success       : boolean -- generate customer code success
 #   customer code : String  -- numbers(number.length + 1) string when success == true
@@ -54,13 +44,6 @@ codecal.simple_code_generate(number)
 #   error         : String  -- error message of parameters when success == false
 codecal.code_generate_with_mask(mask, number)
 
-# Validate customer code
-# Parameters:
-#   customer_code : String
-# Return:
-#   valid : boolean
-codecal.validate_bank_customer_code(String)
-
 # Validate simple code
 # Parameters:
 #   simple_code : String
@@ -83,10 +66,3 @@ codecal.validate_masked_code(String)
 # Return:
 #   code  : String(>=6) ||  false : boolean
 codecal.get_unmasked_code(String)
-
-# Get currency name
-# Parameters:
-#   currency_code : String(4)
-# Return:
-#   currency name : String -- nil if not found
-codecal.get_currency_name(String)

data/lib/codecal.rb

@@ -1,12 +1,16 @@
 require "codecal/version"
-require_relative "./code"
+require_relative "./lib/modulo"
+require_relative "./lib/mask"
+require_relative "./lib/validation"
 
 module Codecal
 
   class Calc
-    @@MASK_ALPHABET = ['a','4','p','9','h','r','7','q','c','3','b','2','j','s','6','d','t','8','k','u','e','v','f','w','x','5','m','y','g','z','n']
-    @@generate_seed = [2,7,5,3,8,9,5,9,1,6,7,3,5]
-    @@simple_seed = [5,4,6,2,3,1,5,4,6,2,3,1]
+    include Validation
+    include Modulo
+    include Mask
+
+    @@MASK_ALPHABET = ['a','4','p','9','h','r','7','q','c','3','b','2','j','s','6','d','t','8','k','u','e','v','f','w','x','5','m','y','g','z','n']    
 
     def initialize(mask_alphabet = nil)
       if mask_alphabet.is_a?(String) && 
@@ -15,61 +19,38 @@ module Codecal
           mask_alphabet.size == mask_alphabet.split('').uniq.size
         @mask_alphabet = mask_alphabet.split('')
       else
-        @mask_alphabet = @@MASK_ALPHABET      
-      end
-    end
-
-    def bank_customer_code_generate(account_id, currency)
-      errormsg = ""
-      if account_id == nil || currency == nil
-        errormsg += "parameter is nil. " 
-        return {success:false, error: errormsg}
-      end
-      errormsg += "parameter 1 type should be Integer and length not longer than 9. " unless account_id.is_a?(Integer) && account_id.to_s.size <= 9
-      currency.is_a?(String) ? currency.upcase! : errormsg += "parameter 2 type should be String. "
-      currency_code = Code.new[currency]
-      errormsg += "currency not found. " unless currency_code
-      if errormsg.size == 0
-        cal_array = ("%09d" % account_id + "%04d" % currency_code.to_i).split("").map! {|i| i.to_i}
-        {success:true,customer_code: code_calculate(cal_array, @@generate_seed) }
-      else
-        {success:false, error: errormsg}
+        @mask_alphabet = @@MASK_ALPHABET  
       end
     end
 
-    def simple_code_generate(account_id)
+    def simple_code_generate(number)
       errormsg = ""
-      if account_id == nil
+      if number == nil
         errormsg += "parameter is nil. "
         return {success:false, error: errormsg}
       end
-      errormsg += "the type of the code to be encrypted should be Integer. " unless all_digits?(account_id.to_s)
+      errormsg += "the type of the code to be encrypted should be Integer. " unless all_digits?(number.to_s)
       if errormsg.size == 0
-        cal_array = (account_id.to_i.to_s).split("").map! {|i| i.to_i}
-        {success:true,customer_code: simple_code_calculate(cal_array, @@simple_seed) }
+        cal_array = (number.to_i.to_s).split("").map! {|i| i.to_i}
+        {success:true, customer_code: simple_code_calculate(cal_array) }
       else
         {success:false, error: errormsg}
       end
     end
 
-    def code_generate_with_mask(mask, account_id)
+    def code_generate_with_mask(mask, number)
       errormsg = "mark should be string of letter or number and length should >= 5" unless is_legal_mask?(mask)
       return {success:false, error: errormsg} if errormsg
-      result = simple_code_generate(account_id)
+      result = simple_code_generate(number)
       return result unless result[:success]
       offset = get_mask_offset(mask)
+      # puts "masked code: #{result[:customer_code]}"
       {success:true, customer_code: mask_code(offset, result[:customer_code])}
     end
 
-    def validate_bank_customer_code(customer_code)
-      return false unless customer_code && customer_code.is_a?(String) && customer_code.size == 16
-      calcode = code_calculate(customer_code[0..12].split("").map! {|i| i.to_i}, @@generate_seed)
-      return customer_code == calcode
-    end
-
     def validate_simple_code(simple_code)
       return false unless simple_code && simple_code.to_i > 0 && simple_code.size > 1
-      calcode = simple_code_calculate(simple_code[0..-2].split("").map! {|i| i.to_i}, @@simple_seed)
+      calcode = simple_code_calculate(simple_code[0..-2].split("").map! {|i| i.to_i})
       return simple_code == calcode
     end
 
@@ -85,10 +66,6 @@ module Codecal
       return masked_code == mask_code(offset, result[:customer_code])
     end
 
-    def convert_masked_code_typo(masked_code)
-      masked_code.gsub('1', 'l')
-    end
-
     def get_unmasked_code(mask, masked_code)
       return false unless is_legal_masked_code?(masked_code)
       return false unless is_legal_mask?(mask)
@@ -99,87 +76,5 @@ module Codecal
       masked_code.size == code.size ? code : false
     end
 
-    def get_currency_name(currency_code)
-      return nil if !currency_code || currency_code.size !=4 || !currency_code.is_a?(String)
-      return Code.new.get_name(currency_code)
-    end
-
-    private
-    def code_calculate(array, seed)
-      code = array.each_with_index.inject(0){|count, (i, index)| count += i*seed[index]}
-      return array.join + ("%03d" % code).to_s
-    end
-
-    def simple_code_calculate(array, seed)
-      code = array.reverse.each_with_index.inject(0){|count, (i, index)| count += i*( index < 11 ? seed.reverse[index + 1] : (index+1).times.inject(1) {|c| c *= 3} % 7 ) }
-      return (array.join + ( code % 7 ).to_s).to_i.to_s
-    end
-
-    def mask_code(offset, code)
-      code_arr = code.size > 5 ? code.split("") : ("%06d" % code).split("")
-      masked_code = code_arr.each_with_index.inject([]) do |code, (c, i)|
-        code.push(mask_char(c, offset[ i % offset.size ]))
-      end
-      start_code = masked_code.pop
-      masked_code.unshift(start_code).join
-    end
-
-    def unmask_code(offset, masked_code)
-      masked_code = masked_code[1..-1] + masked_code[0]
-      code = masked_code.downcase.split("").each_with_index.inject([]) do |code, (c, i)|
-        code.push(un_mask_char(c, offset[ i % offset.size ]))
-      end
-      code.join
-    end
-
-    def get_mask_offset(mask)
-      mask.split("").inject([]) do |offset,c|
-        [[*'a'..'z'], [*'A'..'Z'], [*'0'..'9']].each do |m|
-          if m.include?(c)
-            offset.push(m.find_index(c))
-            break
-          end
-        end
-        offset
-      end
-    end
-
-    def all_letters_or_digits?(str)
-      str[/[a-zA-Z0-9]+/]  == str
-    end
-
-    def all_digits?(str)
-      str[/[0-9]+/]  == str
-    end
-
-    def is_legal_mask?(mask)
-      return false if !mask.is_a?(String) || mask.size < 6 || !all_letters_or_digits?(mask) 
-      return true
-    end
-
-    def is_legal_masked_code?(masked_code)
-      return false unless masked_code.is_a?(String) && masked_code.size > 5
-      return false unless mask_alphabet_include?(masked_code)
-      return true
-    end
-
-    def mask_alphabet_include?(code)
-      code.split('').each do |c|
-        return false unless @mask_alphabet.include?(c)
-      end
-      true
-    end
-
-    def mask_char(char, offset)
-      if all_digits?(char) && char.size == 1
-        @mask_alphabet[(@mask_alphabet.find_index(@mask_alphabet[char.to_i]) + offset) % @mask_alphabet.size]
-      end
-    end
-
-    def un_mask_char(char, offset)
-      if mask_alphabet_include?(char)
-        (@mask_alphabet.find_index(char) - offset) % @mask_alphabet.size
-      end
-    end
   end
 end

data/lib/codecal/version.rb

@@ -1,3 +1,3 @@
 module Codecal
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/lib/mask.rb

@@ -0,0 +1,55 @@
+module Codecal
+  module Mask
+    def mask_code(offset, code)
+      code_arr = code.size > 5 ? code.split("") : ("%06d" % code).split("")
+      masked_code = code_arr.each_with_index.inject([]) do |codes, (c, i)|
+        codes.push(mask_char(c, offset[ i % offset.size ]))
+      end
+      start_code = masked_code.pop
+      masked_code.unshift(start_code).join
+    end
+
+    def unmask_code(offset, masked_code)
+      masked_code = masked_code[1..-1] + masked_code[0]
+      masked_code.downcase.split("").each_with_index.inject([]) do |code, (c, i)|
+        code.push(un_mask_char(c, offset[ i % offset.size ]))
+      end.join
+    end
+
+    def get_mask_offset(mask)
+      mask.split("").inject([]) do |offset,c|
+        [[*'a'..'z'], [*'A'..'Z'], [*'0'..'9']].each do |m|
+          if m.include?(c)
+            offset.push(m.find_index(c))
+            break
+          end
+        end
+        offset
+      end
+    end
+
+    def mask_alphabet_include?(code)
+      code.split('').each do |c|
+        return false unless @mask_alphabet.include?(c)
+      end
+      true
+    end
+
+    def mask_char(char, offset)
+      if all_digits?(char) && char.size == 1
+        @mask_alphabet[(@mask_alphabet.find_index(@mask_alphabet[char.to_i]) + offset) % @mask_alphabet.size]
+      end
+    end
+
+    def un_mask_char(char, offset)
+      if mask_alphabet_include?(char)
+        (@mask_alphabet.find_index(char) - offset) % @mask_alphabet.size
+      end
+    end
+
+    # not used
+    def convert_masked_code_typo(masked_code)
+      masked_code.gsub('1', 'l')
+    end
+  end
+end

data/lib/lib/modulo.rb

@@ -0,0 +1,46 @@
+# this is a modulo 17 Galois field
+
+module Codecal
+  module Modulo
+    ## module 7
+    @@MODULO_NUMBER = 7
+    @@MODULO_WEIGHT = [5,4,6,2,3,1,5,4,6,2,3,1]
+    ## module 17
+    # @@MODULO_NUMBER = 17
+    # @@MODULO_WEIGHT = %w[01 06 02 12 04 07 08 14 16 11 15 05 13 10 09 03 01]
+    ## module 11
+    # @@MODULO_NUMBER = 11
+    # @@MODULO_WEIGHT = %w[07 09 10 05 08 04 02 01 06 03 07 09 10 05 08 04 02 01]
+    ## module 13
+    # @@MODULO_NUMBER = 13
+    # @@MODULO_WEIGHT = %w[3 8 4 2 1 7 10 5 9 11 12 6 3 8 4 2 1]
+    @@SEVENTEEN_SYMBOL = '0123456789abcdefg'
+
+    def simple_code_calculate(int_array)
+      code = int_array.reverse.each_with_index.inject(0) do |count, (i, index)| 
+        count += i * ( index < @@MODULO_WEIGHT.size ? 
+                        @@MODULO_WEIGHT.reverse[index + 1].to_i : 
+                        ( index + 1 ).times.inject(1) { |c| c *= 3 } % @@MODULO_NUMBER
+                      )
+      end
+      symbol = convert_to_symbol(code % @@MODULO_NUMBER)
+      (int_array.join + symbol).to_i.to_s
+    end
+
+    # def simple_code_calculate(array)
+    #   code = array.reverse.each_with_index.inject(0){|count, (i, index)| count += i*( index < 11 ? @@MODULO_WEIGHT.reverse[index + 1] : (index+1).times.inject(1) {|c| c *= 3} % 7 ) }
+    #   return (array.join + ( code % 7 ).to_s).to_i.to_s
+    # end
+
+    private
+
+    def convert_to_symbol(number)
+      @@SEVENTEEN_SYMBOL[number]
+    end
+
+    def convert_to_number(symbol)
+      @@SEVENTEEN_SYMBOL.find_index(symbol)
+    end
+
+  end
+end

data/lib/lib/validation.rb

@@ -0,0 +1,22 @@
+module Codecal
+  module Validation
+    def all_letters_or_digits?(str)
+      str[/[a-zA-Z0-9]+/]  == str
+    end
+
+    def all_digits?(str)
+      str[/[0-9]+/]  == str
+    end
+
+    def is_legal_mask?(mask)
+      return false if !mask.is_a?(String) || mask.size < 6 || !all_letters_or_digits?(mask) 
+      return true
+    end
+
+    def is_legal_masked_code?(masked_code)
+      return false unless masked_code.is_a?(String) && masked_code.size > 5
+      return false unless mask_alphabet_include?(masked_code)
+      return true
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codecal
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Roger Fang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -86,10 +87,11 @@ files:
 - bin/console
 - bin/setup
 - codecal.gemspec
-- lib/code.rb
 - lib/codecal.rb
 - lib/codecal/version.rb
-- lib/currencies.yml
+- lib/lib/mask.rb
+- lib/lib/modulo.rb
+- lib/lib/validation.rb
 homepage: https://github.com/roger-fang-bct/codecal.git
 licenses:
 - MIT

data/lib/code.rb

@@ -1,19 +0,0 @@
-require 'yaml'
-
-
-class Code
-  def data
-    @data ||= begin
-      YAML.load_file(File.join(File.dirname(__FILE__),"currencies.yml"))
-    end
-  end
-
-  def [] key
-    data[key]
-  end
-
-  def get_name value
-    data.key(value)
-  end
-
-end