king_tokens 2.0.0 → 2.0.1

data/{README.rdoc → README.md}

@@ -1,16 +1,16 @@
-= KingTokens
+# KingTokens
 
 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, .. KingTokens are your easy way out in such cases 
+Just think of password resets, changing email, protected rss feed urls, timed out private links, .. KingTokens are your easy way out in such cases
 
 This plugin consists of two parts:
 
-* an ActiveRecord model class TokenCode, which maps to the token table in the db 
+* an ActiveRecord model class TokenCode, which maps to the token table in the db
 * a module Tokenizer mixed into ActiveRecord::Base, providing your models with the possibility to define tokens
 
 KingTokens map polymorphic to other objects, through the can_has_tokens :a_tokens_name call
 
-== Install
+## Install
 
 Get it as gem (hosted on gemcutter.org)
   gem install king_tokens
@@ -19,17 +19,21 @@ Or download it from github and use it as rails plugin
 
 setup your token db like defined in the test schema => test/schema.rb
 
-== Example
+## Example
 
 Define a token on a model
+```ruby
   class User
     can_has_tokens :forgot_password
   end
+```
 
 Set and get a user by token in a controller
+
+```ruby
   class UsersController
     # form with email so user can send himself a password reset link
-    def lost_password      
+    def lost_password
       if request.post?
           #create users forgot_password_token
           @user.set_forgot_password_token
@@ -47,41 +51,58 @@ Set and get a user by token in a controller
       ...
     end
   end
-
-== Docs
+```
+## Docs
 
 To get a full understanding of the usage also read the tests. For QM you might check the coverage report in coverage/index.html
 
-=== Token definition inside an ActiveRecord object:
+### Token definition inside an ActiveRecord object:
+
+```ruby
+  class User
   
-Add a token with the name forgot_pasword to an object.  
-  can_has_tokens :forgot_password 
-A token with the name change email valid for 3 days
-  can_has_tokens :change_email, {:days_valid => 3}
+    # Adds token named forgot_pasword to an object.
+    can_has_tokens :forgot_password
+    
+    # Token named change email valid for 3 days
+    can_has_tokens :change_email, {:days_valid => 3}
+  end
+```
 
-=== Instance methods added to the ActiveRecord object:
-Set a new token and removing any existing one
+### Instance methods added to the ActiveRecord object:
+
+```ruby
+  user = User.new
+  # Set a new token and removing any existing one
   user.set_forgot_password_token
-Get the token string  
+
+  #Get the token string
   user.forgot_password_token
-Check if the user has such a token, returns boolean true
+
+  # Check if the user has such a token, returns boolean true
   user.forgot_password_token?
-Get the token object  
+
+  # Get the token object
   user.get_forgot_password_token
-Get the token object by name  
-  user.token(:forgot_password)  
-Low level function to create a token with special options, overriding the ones set in the class definition
-  user.create_token(:token_name, :valid => 2.days.from_now)
 
+  # Get the token object by name
+  user.token(:forgot_password)
+
+  # Low level function to create a token with special options, 
+  # overriding the ones set in the class definition
+  user.create_token(:token_name, :valid => 2.days.from_now)
+```
 
-=== Class methods
+### Class methods
 
-Find a user by a specific token which must be valid
+```ruby
+  # Find user by specific token which must be valid
   User.find_by_valid_token(:token_name, 'a token string')
-Find a user by specific token, without valid check  
+ 
+  # Find user by specific token, without validation check
   User.find_by_token(:forgot_password, 'a token string')
-  
-  User.find_token
 
+  User.find_token
+```
 
-Copyright (c) 2008-2010 Michael Bumann, Georg Leciejewski released under the MIT license
+Copyright (c) 2008-2013 Michael Bumann, Georg Leciejewski released under the MIT license

data/king_tokens.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |s|
   s.description = %q{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}
   s.version = KingTokens::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Georg Leciejewski", "Michael Bumann"]
-  s.date = %q{2010-05-04}
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Georg Leciejewski', 'Michael Bumann']
+  s.date = %q{2013-03-05}
   s.email = %q{gl@salesking.eu}
   s.homepage = %q{http://github.com/schorsch/king_tokens}
 
-  s.extra_rdoc_files = ["README.rdoc"]
-  s.require_paths = ["lib"]
+  s.extra_rdoc_files = %w(README.md)
+  s.require_paths = %w(lib)
 
   s.rubygems_version = %q{1.6.2}
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.require_paths = ["lib"]
+  s.require_paths = %w(lib)
 
   s.add_development_dependency 'test-unit'
   s.add_development_dependency 'activerecord'

data/lib/king_tokens/token_code.rb

@@ -4,6 +4,8 @@ require "digest/sha1"
 # Class to handle polymorphic tokens
 class TokenCode < ActiveRecord::Base
 
+  attr_accessible :name, :valid_until
+
   belongs_to :object, :polymorphic => true
   before_create :set_token
 
@@ -76,4 +78,4 @@ class TokenCode < ActiveRecord::Base
     self.token = generate_token { |token| TokenCode.find_by_token(token).nil? }
   end
 
-end
+end

data/lib/king_tokens/version.rb

@@ -1,3 +1,3 @@
 module KingTokens
-  VERSION= '2.0.0'
+  VERSION= '2.0.1'
 end

metadata

@@ -1,120 +1,126 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: king_tokens
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 2.0.1
   prerelease: 
-  segments: 
-  - 2
-  - 0
-  - 0
-  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Georg Leciejewski
 - Michael Bumann
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-04 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: test-unit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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: 
+extra_rdoc_files:
+- README.md
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - king_tokens.gemspec
 - lib/king_tokens.rb
@@ -127,36 +133,29 @@ files:
 - test/tokenizer_test.rb
 homepage: http://github.com/schorsch/king_tokens
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2455597393221619131
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Access tokens for any active record object
 test_files: []
-