king_tokens 1.0.0

data/lib/king_tokens.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/king_tokens/token_code'
+require File.dirname(__FILE__) + '/king_tokens/tokenizer'
+ActiveRecord::Base.send(:include, KingTokens::Tokenizer)

data/tasks/tokenizer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tokenizer do
+#   # Task goes here
+# end

data/test/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :token_codes do |t|
+    t.integer :object_id
+    t.string :object_type, :name, :token
+    t.datetime :used_at, :valid_until
+    t.timestamps
+  end
+  
+  create_table :users do |t|
+    t.string        :name
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+
+# in active support 2.2.2 assert_difference helper has moved
+# Must find a method to detect if method can be found
+require 'active_support/test_case'
+#require 'active_support/testing/assertions'
+#require ActiveSupport::TestCase
+require "#{File.dirname(__FILE__)}/../lib/king_tokens"
+
+ActiveRecord::Base.establish_connection({
+    'adapter' => 'sqlite3',
+    'database' => ':memory:'
+  })
+load(File.join(File.dirname(__FILE__), 'schema.rb'))

data/test/tokenizer_test.rb

@@ -0,0 +1,141 @@
+require(File.join(File.dirname(__FILE__), 'test_helper'))
+
+# TODO:
+# - make some nice mock objects!
+# - Tests still mixed for two classes
+class User < ActiveRecord::Base
+  can_has_tokens :forgot_password, :change_email
+end
+class Article < ActiveRecord::Base; end
+
+class TokenizerTest < Test::Unit::TestCase
+  include ActiveSupport::Testing::Assertions
+  def test_should_respond_to_all_tokenizer_methods
+    assert_respond_to User, "find_by_token"
+    %w{set_forgot_password_token forgot_password_token forgot_password_token?}.each do |m|
+      assert_respond_to User.new, m
+    end
+  end
+  
+  def test_should_set_the_token_automatically
+    user = User.create(:name=>"joe")
+    assert_difference "TokenCode.count" do
+      user.set_forgot_password_token
+    end
+    assert user.forgot_password_token
+  end
+
+  def test_should_respond_to_token?
+    user = User.create(:name=>"joe")
+    assert_equal false, user.forgot_password_token?
+    user.set_forgot_password_token
+    assert user.forgot_password_token?
+    
+  end
+
+  def test_unique_name_in_polymorphic_scope
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token
+    assert_no_difference "TokenCode.count" do
+      user.set_forgot_password_token
+    end
+  end
+  
+  def test_same_token_should_be_deleted
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token
+    token1 = user.forgot_password_token
+    assert_no_difference "TokenCode.count" do
+      user.set_forgot_password_token
+      token2 = user.forgot_password_token
+      assert user.token('forgot_password').valid? # check unique name validation
+      assert_not_equal token1, token2
+    end
+  end
+
+  def test_token_should_only_valid_for_a_limited_time
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token
+    assert_in_delta user.token(:forgot_password).valid_until.to_i, 5.days.from_now.to_i, 10
+  end
+  
+  def test_token_to_string
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token(:valid=>2.days)
+    assert_not_nil user.token(:forgot_password).to_s
+
+  end
+  def test_token_valid_until_should_be_editable
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token(:valid=>2.days)
+    assert_in_delta user.token(:forgot_password).valid_until.to_i, 2.days.from_now.to_i,10
+  end
+  
+  def test_should_use_and_return_unavailable
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token
+    assert user.get_forgot_password_token.use!
+    assert user.get_forgot_password_token.used?
+    assert !user.get_forgot_password_token.valid_for_use?
+  end
+
+  def test_should_unuse_dates
+    user = User.create(:name=>"joe")
+    user.set_forgot_password_token
+    assert user.get_forgot_password_token.use!
+    assert user.get_forgot_password_token.unuse!
+    assert user.get_forgot_password_token.valid_for_use?
+  end
+
+  def test_should_delete_all_used
+    user = User.create(:name=>"joe")
+    # set a couple of tokens
+    user.set_forgot_password_token
+    user.set_change_email_token
+    cnt = TokenCode.count
+    # use those tokens
+    user.get_forgot_password_token.use!
+    user.get_change_email_token.use!
+    # now kick all used
+    TokenCode.delete_used
+    #tokens from other tests are still present, so we compare by count
+    assert cnt > TokenCode.count
+    assert_nil user.get_forgot_password_token
+    assert_nil user.get_change_email_token
+  end
+
+  def test_should_delete_all_expired
+    user = User.create(:name=>"joe")
+    # set a couple of dead tokens
+    token = user.create_token(:forgot_password, :valid_until=>1.year.ago)
+    token1 = user.create_token(:change_email, :valid_until=>2.weeks.ago)
+    cnt = TokenCode.count
+    # now kick all expired
+    TokenCode.delete_expired
+    #tokens from other tests are still present, so we compare by count
+    assert cnt > TokenCode.count
+    assert_nil user.get_forgot_password_token
+    assert_nil user.get_change_email_token
+  end
+
+  def test_should_find_polymorphic_object
+    user = User.create(:name=>"joe")
+    token = user.create_token(:forgot_password, :valid_until=>2.days.from_now)
+    assert_kind_of User, User.find_by_token(:forgot_password, token.token)
+  end
+
+  def test_should_not_find_object_with_invalid_token
+    user = User.create(:name=>"joe")
+    token = user.create_token(:forgot_password, :valid_until=>1.days.ago)
+    assert_nil User.find_by_valid_token(:forgot_password, token.token)
+  end
+
+  def test_should_find_object_with_valid_token
+    user = User.create(:name=>"joe")
+    token = user.create_token(:forgot_password, :valid_until=>2.days.from_now)
+    assert_equal user, User.find_by_valid_token(:forgot_password, token.token)
+  end
+  def test_should_not_leak_token_options
+    
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: king_tokens
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Tokens are a usefull way to give users access to an application. This can be for a limited time or just once. Just think of password resets, changing email, protected rss feed urls, timed out private links
+email: gl@salesking.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- coverage/index.html
+- coverage/lib-token_code_rb.html
+- coverage/lib-tokenizer_rb.html
+- init.rb
+- lib/king_tokens.rb
+- lib/king_tokens/token_code.rb
+- lib/king_tokens/tokenizer.rb
+- tasks/tokenizer_tasks.rake
+- test/schema.rb
+- test/test_helper.rb
+- test/tokenizer_test.rb
+has_rdoc: true
+homepage: http://github.com/schorsch/king_tokens
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Access tokens for any active record object
+test_files: 
+- test/schema.rb
+- test/test_helper.rb
+- test/tokenizer_test.rb