token_attr 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27e5d3e895c988371564f5bf875ddc5ca127e780
-  data.tar.gz: 79b85868b6e66a37d2641a9afeff44e15cdcd103
+  metadata.gz: f2b3cdab36a03426a385de026e0b16b271e94b79
+  data.tar.gz: 39bbbec8a942559030535a44f3b0ead803550177
 SHA512:
-  metadata.gz: 2285b96a0f45dbe7cc4457ca51f5d6b8180752506a4ca833b87bed229fdeb53c26a0892348d2ed2badd1c8d426a0de00429dd68e3cdbc4231f2c90a30f808d03
-  data.tar.gz: 497a279733f62dc93abea258ceb1934bc02f116d85d47d056be9dc0c85147c5d80b6f8af54f74e06d7a61ba22c8021dab733bb9922dbbb13579b1b207182b078
+  metadata.gz: d6f07c48755e3b73c7f07741fcce0a17f0a58fd113d2c87a6edcf873c31b9f5041f629409e60ee2a4bcd2bef53737e194421ad3e71137df6ce6d46c5075e6706
+  data.tar.gz: 6d7668305f5a4868b1ac2a1b460a24b9b8f5bf520367bea6ce560aca5033bcd641aa23cac3954c2e5e03f6342d6ff4c47e8e72d21c6d3abcbc1b11683d2793a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    token_attr (0.0.1)
+    token_attr (0.1.0)
       activerecord (>= 4.0.0)
 
 GEM

data/README.md

@@ -1,16 +1,58 @@
 # token_attr
 
-[Description]
+Unique random token generator for ActiveRecord.
 
 ## Installation
 
 Add `token_attr` to your Gemfile:
 
-    gem 'token_attr'
+    gem 'token_attr', '~> 0.1.0'
 
 ## Usage
 
-[TODO]
+```
+class User < ActiveRecord::Base
+  include TokenAttr
+  token_attr :token
+end
+
+user = User.new
+user.valid?
+user.token # => "b8bd30ff"
+```
+
+The token is generated in a `before_validation` callback.
+
+### Options
+
+#### Length
+
+The length of the token to generate.
+
+Default: 8
+
+```
+token_attr :token, length: 40
+```
+
+#### Alphabet
+
+The alphabet to use to generate the token.
+
+Uses hexadecimal characters by default.
+
+Accepted values:
+- `:alphabetic` - any character from a to z (both lower and upper case)
+- `:numeric` - any number
+- `:alphanumeric` - any character or number
+- a string - a string of your choice of the characters you want to use
+
+```
+token_attr :token, alphabet: :numeric # => "82051173"
+token_attr :token, alphabet: :alphabetic # => "xqnInSJa"
+token_attr :token, alphabet: :alphanumeric # => "61nD0lUo"
+token_attr :token, alphabet: "token" # => "ktnekoet"
+```
 
 ## Contributing
 

data/lib/token_attr/version.rb

@@ -1,3 +1,3 @@
 module TokenAttr
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/token_attr.rb

@@ -6,7 +6,9 @@ module TokenAttr
   extend ActiveSupport::Concern
 
   DEFAULT_TOKEN_LENGTH  = 8.freeze
-  DEFAULT_SLUG_ALPHABET = [('a'..'z'),('A'..'Z'),(0..9)].map(&:to_a).flatten.freeze
+  ALPHABETIC_ALPHABET   = [('a'..'z'),('A'..'Z')].map(&:to_a).flatten.freeze
+  NUMERIC_ALPHABET      = [(0..9)].map(&:to_a).flatten.freeze
+  ALPHANUMERIC_ALPHABET = [ALPHABETIC_ALPHABET, NUMERIC_ALPHABET].flatten.freeze
 
   class TooManyAttemptsError < StandardError
     attr_reader :attribute, :token
@@ -35,8 +37,16 @@ module TokenAttr
         token_length = options.fetch(:length, DEFAULT_TOKEN_LENGTH)
 
         if alphabet = options[:alphabet]
-          alphabet = DEFAULT_SLUG_ALPHABET if alphabet == :slug
-          alphabet_array = alphabet.split('')
+          alphabet_array = case alphabet
+          when :alphanumeric
+            ALPHANUMERIC_ALPHABET
+          when :alphabetic
+            ALPHABETIC_ALPHABET
+          when :numeric
+            NUMERIC_ALPHABET
+          else
+            alphabet.split('')
+          end
           (0...token_length).map{ alphabet_array.sample }.join
         else
           hex_length = (token_length / 2.0).ceil # 2 characters per length

data/spec/token_attr_spec.rb

@@ -19,10 +19,22 @@ describe TokenAttr do
     token_attr :token, alphabet: 'abc123'
   end
 
-  class ModelWithSlugAlphabet < ActiveRecord::Base
+  class ModelWithAlphanumericAlphabet < ActiveRecord::Base
     self.table_name = 'models'
     include TokenAttr
-    token_attr :token, alphabet: :slug
+    token_attr :token, alphabet: :alphanumeric
+  end
+
+  class ModelWithAlphabeticAlphabet < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token, alphabet: :alphabetic
+  end
+
+  class ModelWithNumericAlphabet < ActiveRecord::Base
+    self.table_name = 'models'
+    include TokenAttr
+    token_attr :token, alphabet: :numeric
   end
 
   class ModelWithMultipleTokens < ActiveRecord::Base
@@ -88,13 +100,28 @@ describe TokenAttr do
           model.token.length.should == 12
         end
 
-        it "generates a token with the default slug alphabet if the alphabet is :slug" do
-          model = ModelWithSlugAlphabet.new
-          stub_const('TokenAttr::DEFAULT_SLUG_ALPHABET', 'token')
+        it "generates a token with alphanumeric characters when the alphabet is :alphanumeric" do
+          fake_alphabet('TokenAttr::ALPHANUMERIC_ALPHABET', times: 8, sample: 'T')
+
+          model = ModelWithAlphanumericAlphabet.new
           model.valid?
-          model.token.split('').all? do |c|
-            'token'.include?(c)
-          end.should be_true
+          model.token.should == 'TTTTTTTT'
+        end
+
+        it "generates a token with alphabetic characters when the alphabet is :alphabetic" do
+          fake_alphabet('TokenAttr::ALPHABETIC_ALPHABET', times: 8, sample: 't')
+
+          model = ModelWithAlphabeticAlphabet.new
+          model.valid?
+          model.token.should == 'tttttttt'
+        end
+
+        it "generates a token with numeric characters when the alphabet is :numeric" do
+          fake_alphabet('TokenAttr::NUMERIC_ALPHABET', times: 8, sample: '0')
+
+          model = ModelWithNumericAlphabet.new
+          model.valid?
+          model.token.should == '00000000'
         end
       end
 
@@ -119,4 +146,13 @@ describe TokenAttr do
     end
   end
 
+  protected
+
+  def fake_alphabet(alphabet_const, times: 8, sample: 'T')
+    fake = double('Array')
+    fake.stub(:split).and_return(fake)
+    fake.should_receive(:sample).exactly(times).times.and_return(sample)
+    stub_const(alphabet_const, fake)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_attr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Michel Billard