has_secure_token 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 779e9aa5c015cf598382638c8bf438f5765a4063
-  data.tar.gz: 708da57acbbbe47d93240d2edb3ca153f4f8c558
+  metadata.gz: 1148bcff41e4dab40603ae600aae8129d4fd4dab
+  data.tar.gz: 1686f165bdc43dba2030e09a5d72c847763b718c
 SHA512:
-  metadata.gz: 38f2c9928827176cbc83d04620994a86de70ffcd894f2c3c53b43f8b35f5cb7f9cf8cdc87208bcb237f4774e08a1a03572a46bb4b2b867deb546188fd87796c6
-  data.tar.gz: 261107656b335bca54aa0089f0c1bec76e632c38d5323219f9d4f0396939774625aca41b7937947235dd478e57b5a2be13f1914c44455c31ed36b76aa759ad4c
+  metadata.gz: b0f969596f567eefe82d69bac7a2d5258100018f904cef879c3c4fa65690d7eddc380e7cb1c6532e380da2c2f8d6972703eb12e85693798a8c9cb5bb34a80601
+  data.tar.gz: 7a414116ae3415f7121fe401256e23a0997d6ad7ad38b9d0b1ec6ac7e7b8af1c02ce4b2222cee86eae9f4b234cdbb74cea7da50b252aa761e1ce066226a5669f

data/README.md

@@ -9,7 +9,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'has_secure_password'
+    gem 'has_secure_token'
 
 And then execute:
 
@@ -17,12 +17,12 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install has_secure_password
+    $ gem install has_secure_token
 
 ##Setting your Model
 
 ```ruby
-class User
+class User < ActiveRecord::Base
   has_secure_token :token1, :token2
 end
 
@@ -33,7 +33,7 @@ user.token2 => "226dd46af6be78953bde1641622497a8"
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/has_secure_password/fork )
+1. Fork it ( https://github.com/robertomiranda/has_secure_password/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/has_secure_token.rb

@@ -4,22 +4,50 @@ require 'securerandom'
 module HasSecureToken
   extend ActiveSupport::Concern
   module ClassMethods
-    def has_secure_token(*attrs)
+    # Example using Active Record (which automatically includes ActiveModel::SecurePassword):
+    #
+    #   # Schema: User(auth_token:string, invitation_token:string)
+    #   class User < ActiveRecord::Base
+    #     has_secure_token :auth_token, :invitation_token
+    #   end
+    #
+    #   user = User.new
+    #   user.save
+    #   user.auth_token # => "44539a6a59835a4ee9d7b112"
+    #   user.invitation_token # => "226dd46af6be78953bde1648"
+    #   user.regenerate_auth_token # => true
+    #   user.regenerate_invitation_token # => true
+    def has_secure_token(*args)
+      # Load securerandom only when has_secure_key is used.
+      require 'securerandom'
       include InstanceMethodsOnActivation
-      cattr_accessor :token_columns
-      self.token_columns = attrs
-      before_create :_generate_token
+      cattr_accessor :token_columns, :options
+      options = args.extract_options!
+
+      key_length = options.fetch(:key_length, 24)
+      bytes = (key_length / 2.0).ceil
+
+      args.each do |attribute|
+        define_method("regenerate_#{attribute}!") do
+          send(:generate_unique_secure_token, attribute, bytes, key_length)
+          save
+        end
+      end
+
+      before_create do
+        args.each do |attribute|
+          self.generate_unique_secure_token(attribute, bytes, key_length)
+        end
+      end
     end
   end
 
   module InstanceMethodsOnActivation
-    def _generate_token
-      self.class.token_columns.each do |attribute|
-        self.send("#{attribute}=", loop do
-          random_token = SecureRandom.hex
-          break random_token unless self.class.exists?(attribute => random_token)
-        end)
-      end
+    def generate_unique_secure_token(attribute, bytes, key_length)
+      self.send("#{attribute}=", loop do
+        random_token =  SecureRandom.hex(bytes)[0..key_length]
+        break random_token unless self.class.exists?(attribute => random_token)
+      end)
     end
   end
 end

data/lib/has_secure_token/version.rb

@@ -1,3 +1,3 @@
 module HasSecureToken
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/has_secure_password_test.rb

@@ -4,10 +4,34 @@ class HasSecureTokenTest < MiniTest::Unit::TestCase
   def setup
     @user = User.new
     @user.run_callbacks :create
+    @visitor = Visitor.new
+    @visitor.run_callbacks :create
   end
 
   def test_assing_token_values
     assert_not_nil @user.auth_token
     assert_not_nil @user.invitation_token
   end
+
+  def test_default_length_of_secure_token_is_set_to_24
+    assert_equal 24, @user.auth_token.length
+    assert_equal 24, @user.invitation_token.length
+  end
+
+  def test_create_record_with_customised_length_of_secure_token
+    assert_equal 30, @visitor.auth_token.length
+    assert_equal 30, @visitor.invitation_token.length
+  end
+
+  def test_regenerate_the_secure_key_for_the_attribute
+    old_auth_token = @user.auth_token
+    old_invitation_token = @user.invitation_token
+    @user.regenerate_auth_token!
+    @user.regenerate_invitation_token!
+
+    assert @user.auth_token != old_auth_token
+    assert @user.invitation_token != old_invitation_token
+    assert_equal 24, @user.auth_token.length
+    assert_equal 24, @user.invitation_token.length
+  end
 end

data/test/models/user.rb

@@ -11,4 +11,8 @@ class User
   def self.exists?(attrs)
     false
   end
+
+  def save
+    true
+  end
 end

data/test/models/visitor.rb

@@ -0,0 +1,15 @@
+class Visitor
+  extend ActiveModel::Callbacks
+  include ActiveModel::SecurePassword
+  include HasSecureToken
+
+  define_model_callbacks :create
+
+  has_secure_token :auth_token, :invitation_token, key_length: 30
+
+  attr_accessor :auth_token, :invitation_token
+
+  def self.exists?(attrs)
+    false
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_secure_token
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Roberto Miranda Altamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -84,6 +84,7 @@ files:
 - lib/has_secure_token/version.rb
 - test/has_secure_password_test.rb
 - test/models/user.rb
+- test/models/visitor.rb
 - test/test_helper.rb
 homepage: https://github.com/robertomiranda/has_secure_token
 licenses:
@@ -112,4 +113,5 @@ summary: Create uniques random tokens for any model in ruby on rails.
 test_files:
 - test/has_secure_password_test.rb
 - test/models/user.rb
+- test/models/visitor.rb
 - test/test_helper.rb