has_a_token 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11a23b109e18c334de61022309c9047eebd20b1
-  data.tar.gz: 0d2ffe30e87feb5e3ce78ccbc6982a985df341be
+  metadata.gz: e20722781a4d729f3b67521dab495abc49a6ccea
+  data.tar.gz: 97bd518d14cebbc6cbca39fe0c60d4c83fb246f6
 SHA512:
-  metadata.gz: 9e84cccfe4a898c56925b4a97da5b5b76f7498da57ec4c0910fb10d1a71bdbde2e1112bb65d40bfbed4c5db782e101dc5a05e51936b2d3a8b9ce820efd4a0e81
-  data.tar.gz: 05fec3baf200e9f4695105769c37d713b99134faab924bfb6830c1d0076f1a1cc5cb904204acfe4a0f032a95c891883465d0601949a490905e77ed07cf0be8e2
+  metadata.gz: efe23ab4aceb6abb9e4db0e735690488dbd65448d64fe7a17ae9e715615aeb0bd791acc0a4debd8829dcb49f16bdd278a614e554fae4d6c6cb06e9cf5cc354cf
+  data.tar.gz: db012bde53d49f6a4c77d5a3c71e5c899bad79f4aa9f0b1a42a81b1dfeaaf9ea508b66a6e3c8e550210ce8cabff67fdc38ddf8771435390a21b796b5b6801f90

data/README.md

@@ -15,6 +15,7 @@ And then execute:
     $ bundle
 
 ## Usage
+Charsets include: `:unambiguous`, `:alphabetical`, and the default `urlsafe_base64`
 
 Basic usage:
 
@@ -49,3 +50,7 @@ user.reset_password_reset_token! # creates a new token and persists the changes
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Tests
+
+You can run the tests using the `rake test` command.

data/Rakefile

@@ -1 +1,14 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+
+# Tests
+Rake::TestTask::new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+
+
+# Default task
+task default: :test

data/has_a_token.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "simplecov-html"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "simplecov-html", "~> 0.8.0"
+  spec.add_development_dependency "coveralls", "~> 0.7.12"
+  spec.add_development_dependency "rubocop", "~> 0.44.1"
+  spec.add_development_dependency "guard", "~> 2.12.0"
+  spec.add_development_dependency "guard-minitest", "~> 2.4.0"
+  spec.add_development_dependency "guard-rubocop", "~> 1.2.0"
 end

data/lib/has_a_token/generator.rb

@@ -10,6 +10,7 @@ module HasAToken
     # @option [Symbol] :charset charset to token
     #    :unambiguous token will only contain unambiguous letters and numbers
     #    :urlsafe_base64 will return base64 token with '/' & '+' replaced w/ '-' & '_'
+    #    :alphabetical will contain only A-Z characters
     # @option [Fixnum] :length of the resulting token; defaults to 24 (or 8 for unambiguous sets)
     def initialize(charset: :urlsafe_base64, length: nil)
       @length = length || (charset == :unambiguous ? 5 : 24)
@@ -23,7 +24,9 @@ module HasAToken
     def generate
       case @charset
       when :unambiguous
-        generate_unambiguous_token
+        generate_charset_token(UNAMBIGUOUS_CHARSET)
+      when :alphabetical
+        generate_charset_token(("A".."Z").to_a)
       else
         generate_secure_token
       end
@@ -31,17 +34,17 @@ module HasAToken
 
     private
 
-    Contract None => String
-    def generate_unambiguous_token
+    Contract Array => String
+    def generate_charset_token(charset)
       # Fetch a random set of bytes
-      randset = SecureRandom.random_number(UNAMBIGUOUS_CHARSET.size**@length)
+      randset = SecureRandom.random_number(charset.size**@length)
 
       # Assign to ambiguous charset
       @length
         .times
         .map do |i|
-          UNAMBIGUOUS_CHARSET.to_a[
-            (randset / UNAMBIGUOUS_CHARSET.size**i) % UNAMBIGUOUS_CHARSET.size
+          charset.to_a[
+            (randset / charset.size**i) % charset.size
           ]
         end.join
     end

data/lib/has_a_token/version.rb

@@ -1,3 +1,3 @@
 module HasAToken
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/test/test_helper.rb

@@ -2,7 +2,7 @@ require "simplecov"
 require "simplecov-html"
 require "coveralls"
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter::new [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter,
 ]

data/test/{test_token_generator.rb → token_generator_test.rb}

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "./test_helper.rb"
 
 # Test Generator class
 class GeneratorTests < Minitest::Test
@@ -8,9 +8,9 @@ class GeneratorTests < Minitest::Test
   end
 
   def test_unambiguous_charset
-    SecureRandom.stub :random_number, 456_975 do # ZZZZ
+    SecureRandom.stub :random_number, 456_975_123 do # CQYZ
       assert_instance_of String, HasAToken::Generator.new(charset: :unambiguous, length: 1).generate
-      assert_equal "ZZZZ", HasAToken::Generator.new(charset: :unambiguous, length: 4).generate
+      assert_equal "CQYZ", HasAToken::Generator.new(charset: :unambiguous, length: 4).generate
     end
   end
 
@@ -29,4 +29,16 @@ class GeneratorTests < Minitest::Test
       assert_equal "1234", HasAToken::Generator.new(charset: :hex).generate
     end
   end
+
+  def test_alphabetical_length
+    assert HasAToken::Generator.new(charset: :alphabetical, length: 8).generate.length == 8
+    assert HasAToken::Generator.new(charset: :alphabetical, length: 10).generate.length == 10
+  end
+
+  def test_alphabetical_charset
+    SecureRandom.stub :random_number, 456_975_123 do # HSYZ
+      assert_instance_of String, HasAToken::Generator.new(charset: :alphabetical, length: 1).generate
+      assert_equal "HSYZ", HasAToken::Generator.new(charset: :alphabetical, length: 4).generate
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_a_token
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - James Phillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -70,86 +70,86 @@ dependencies:
   name: simplecov-html
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.12
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.44.1
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 description: 
 email:
 - jamesdphillips@gmail.com
@@ -171,7 +171,7 @@ files:
 - lib/has_a_token/generator.rb
 - lib/has_a_token/version.rb
 - test/test_helper.rb
-- test/test_token_generator.rb
+- test/token_generator_test.rb
 homepage: https://www.github.com/jamesdphillips/has_a_token
 licenses:
 - MIT
@@ -198,4 +198,4 @@ specification_version: 4
 summary: Generate simple/complex/readable tokens in Rails models
 test_files:
 - test/test_helper.rb
-- test/test_token_generator.rb
+- test/token_generator_test.rb