public_uid 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7323c6067a97bf3479759130f27f3ab6a2629084
-  data.tar.gz: 2a5aa34772776cc391d103d9f1ecb776899f0b0e
+SHA256:
+  metadata.gz: c2d69f6a9e786d8688e3e6c0bcfa330c14fd7b127b5e3472d7ce5b82f2f03b87
+  data.tar.gz: 25d0ab2367c4ff2326b8853fe1835484206ce016d364d21c09a0220a98355519
 SHA512:
-  metadata.gz: 51f04e7f8a1331cacee37033b013237a49cbd9946d9f564998705c4ba5be1a1a2e16960a09d9de298579178cc97bcb612d361301795aa80c21178974eb4ff4c9
-  data.tar.gz: 935f54f79fcd7b681e8ad76f28a5b98d45810236ed2fc86862a6a38dad9e1d1b0a30c13a6815a460d27ffc45c3411ac55b839236c043dc67c5ead9e1eee9d49e
+  metadata.gz: f0b0837bb2a8104ac4cf986fe8bb595b0502ad4f53cdf7c10e9f3f99cf0e4a9f338de1eca825cc29038a14f85f0033a348192094f402b042568b5363af1ce85b
+  data.tar.gz: 9ab628f84f3883aa7f6c2063c74dbfd8b8897a15b6613ccdcb020af3456f45dd3b5c56f487d037e981cae3d5ab2f438c94fc1d1021be9c453e573285de4a8541

data/.travis.yml

@@ -5,4 +5,5 @@ rvm:
   - 2.1.1
   - 2.2.2
   - 2.3.0
-  - ruby-head
+  - 2.4.0
+  - 2.5.1

data/README.md

@@ -141,6 +141,36 @@ generator wont work if your public uniq ID column is a String (as the
 gem would try to set Integer on a String). If you really want a number
 like string you can specify number range for Range String Generator
 
+If you want to generate random Integer using SecureRandom ruby library you can use built-in number secure generator:
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid generator: PublicUid::Generators::NumberSecureRandom.new
+end
+```
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> 4567123
+```
+
+If you want to generate random Hexadecimal String using SecureRandom ruby library you can use built-in hexadecimal string secure generator:
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid generator: PublicUid::Generators::HexStringSecureRandom.new
+end
+```
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> 0b30ffbc7de3b362
+```
+
 ### Customizing generated string
 
 ```ruby
@@ -150,6 +180,14 @@ class User < ActiveRecord::Base
 end
 ```
 
+or in case you are using SecureRandom ruby library: 
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid generator: PublicUid::Generators::HexStringSecureRandom.new(4)  #4 is length of hexadecimal string. If this argument is not set, length of hexadecimal string will be 8 characters. 
+end
+```
+
 ```irb
 u = User.new
 u.public_uid  #=> nil
@@ -177,6 +215,14 @@ class User < ActiveRecord::Base
 end
 ```
 
+or in case you are using SecureRandom ruby library: 
+```ruby
+class User < ActiveRecord::Base
+  UID_RANGE = 1_000..4_000
+  generate_public_uid generator: PublicUid::Generators::NumberSecureRandom.new(UID_RANGE)
+end
+```
+
 ```irb
 u = User.new
 u.public_uid  #=> nil

data/lib/public_uid.rb

@@ -4,7 +4,8 @@ require "public_uid/set_public_uid"
 require "public_uid/model"
 require "public_uid/generators/number_random"
 require "public_uid/generators/range_string"
-
+require "public_uid/generators/number_secure_random"
+require "public_uid/generators/hex_string_secure_random"
 require 'public_uid/tasks' if defined?(Rails)
 
 require 'orm/active_record' if defined?(ActiveRecord::Base)

data/lib/public_uid/generators/hex_string_secure_random.rb

@@ -0,0 +1,20 @@
+require 'securerandom'
+
+module PublicUid
+  module Generators
+    class HexStringSecureRandom
+      def initialize(length=8)
+        @length = length
+      end
+
+      def generate
+        if @length.odd?
+          result = SecureRandom.hex( (@length+1)/2 )  #because in "SecureRandom.hex(@length)" @length means length in bytes = 2 hexadecimal characters  
+          return result[0...-1]
+        else
+         SecureRandom.hex(@length/2)
+        end
+      end
+    end
+  end
+end

data/lib/public_uid/generators/number_secure_random.rb

@@ -0,0 +1,16 @@
+require 'securerandom'
+
+module PublicUid
+  module Generators
+    class NumberSecureRandom
+      def initialize(scale = 1_000_000..9_999_999)
+        @scale = scale
+      end
+
+      def generate()
+        generated_number = SecureRandom.random_number( (@scale.max - @scale.min) )  #because SecureRandom.random_number can have only one argument = max value.
+        return (generated_number + @scale.min)
+      end
+    end
+  end
+end

data/lib/public_uid/model.rb

@@ -34,7 +34,7 @@ module PublicUid
       end
 
       def public_uid_generator
-        @public_uid_generator || Generators::RangeString.new
+        @public_uid_generator || Generators::HexStringSecureRandom.new
       end
 
       private

data/lib/public_uid/version.rb

@@ -1,3 +1,3 @@
 module PublicUid
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/test/lib/generators/hex_string_secure_random_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+describe 'HexStringSecureRandom' do
+
+  describe "#generate" do
+    subject{ instance.generate }
+
+    context 'by default' do
+      let(:instance){ PublicUid::Generators::HexStringSecureRandom.new }
+      it 'generates 8 chars hexa string' do
+        subject.length.must_equal 8
+        subject.must_be_kind_of String
+      end
+
+      it 'generates hexadecimal chars' do
+        subject.must_match(/^[a-f0-9]*$/)
+      end
+    end
+
+    context 'when 10 hexa chars' do
+      let(:instance){ PublicUid::Generators::HexStringSecureRandom.new(10) }
+      it 'generates 10 chars string' do
+        subject.length.must_equal 10
+      end
+    end
+
+    context 'when 11 hexa chars' do
+      let(:instance){ PublicUid::Generators::HexStringSecureRandom.new(11) }
+      it 'generates 11 chars string' do
+        subject.length.must_equal 11
+      end
+    end
+  end
+end

data/test/lib/generators/number_random_test.rb

@@ -20,7 +20,7 @@ describe 'NumberRandom' do
         subject.must_be_kind_of Integer
       end
 
-      it 'generates string containing chars x,y,z' do
+      it 'generates integer has to be 20 or 21' do
         [20, 21].must_include subject
       end
     end

data/test/lib/generators/number_secure_random_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+describe 'NumberSecureRandom' do
+
+  describe "#generate" do
+    subject{ instance.generate }
+
+    context 'by default' do
+      let(:instance){ PublicUid::Generators::NumberSecureRandom.new }
+      it 'generates 7 digits' do
+        subject.to_i.to_s.length.must_equal 7
+        subject.must_be_kind_of Integer
+      end
+    end
+
+    context 'when specifying number between 20 - 21' do
+      let(:instance){ PublicUid::Generators::NumberSecureRandom.new(20..21) }
+      it 'generates 2 digits' do
+        subject.to_i.to_s.length.must_equal 2
+        subject.must_be_kind_of Integer
+      end
+
+      it 'generates integer has to be 20 or 21' do
+        [20, 21].must_include subject
+      end
+    end
+
+    context 'when specifying number between 1000 - 9999' do
+      let(:instance){ PublicUid::Generators::NumberSecureRandom.new(1000..9999) }
+      it 'generates 4 digits' do
+        subject.to_i.to_s.length.must_equal 4
+        subject.must_be_kind_of Integer
+      end
+
+      it 'generates integer has to be between 1000 and 9999' do
+        (1000..9999).must_include subject
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: public_uid
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2018-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
@@ -123,7 +123,9 @@ files:
 - Rakefile
 - lib/orm/active_record.rb
 - lib/public_uid.rb
+- lib/public_uid/generators/hex_string_secure_random.rb
 - lib/public_uid/generators/number_random.rb
+- lib/public_uid/generators/number_secure_random.rb
 - lib/public_uid/generators/range_string.rb
 - lib/public_uid/model.rb
 - lib/public_uid/set_public_uid.rb
@@ -131,7 +133,9 @@ files:
 - lib/public_uid/tasks/generate.rake
 - lib/public_uid/version.rb
 - public_uid.gemspec
+- test/lib/generators/hex_string_secure_random_test.rb
 - test/lib/generators/number_random_test.rb
+- test/lib/generators/number_secure_random_test.rb
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
 - test/lib/tasks/generate_test.rb
@@ -162,12 +166,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Automatic generates public UID column
 test_files:
+- test/lib/generators/hex_string_secure_random_test.rb
 - test/lib/generators/number_random_test.rb
+- test/lib/generators/number_secure_random_test.rb
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
 - test/lib/tasks/generate_test.rb