tokens 0.1.0

data/README.rdoc

@@ -0,0 +1,122 @@
+= Tokens
+
+== Usage
+
+=== Installation
+
+You can use I18n-JS as plugin and gem. Choose what's best for you!
+
+  script/plugin install git://github.com/fnando/has_tokens.git
+
+or
+
+  gem install tokens
+
+=== Setting up
+
+Create a migration file with <tt>script/generate migration create_tokens</tt> or <tt>rails generate migration tokens</tt>.
+
+  class CreateTokens < ActiveRecord::Migration
+    def self.up
+      create_table :tokens do |t|
+        t.integer :tokenizable_id, :null => false
+        t.string :tokenizable_type, :name, :null => false
+        t.string :token, :limit => 40, :null => false
+        t.text :data, :null => true
+        t.datetime :expires_at, :null => true
+        t.datetime :created_at
+      end
+
+      add_index :tokens, :tokenizable_type
+      add_index :tokens, :tokenizable_id
+      add_index :tokens, :token
+      add_index :tokens, :expires_at
+    end
+
+    def self.down
+      drop_table :tokens
+    end
+  end
+
+Run migrations with <tt>rake db:migrate</tt>. Add the method call
+<tt>has_tokens</tt> to your model and be happy!
+
+  class User < ActiveRecord::Base
+    has_tokens
+  end
+
+  # create a new token; remember that the object need to be saved before creating
+  # the token because it depends on the id
+  user = User.create(:login => "fnando")
+
+  # uses the default expires_at (2 days from now)
+  user.add_token(:activate)
+
+  # uses custom expires_at
+  user.add_token(:activate, :expires_at => 10.days.from_now)
+
+  # uses the default size (12 characters)
+  user.add_token(:activate)
+
+  # uses custom size (up to 32)
+  user.add_token(:activate, :size => 20)
+
+  # create token with arbitrary data
+  data = {:action => 'do something'}
+  user.add_token(:activate, :data => data.to_json)
+
+  # find token by name
+  user.find_token_by_name(:reset_account)
+
+  # find token by hash
+  user.find_token("ea2f14aeac40")
+
+  # check if a token has expired
+  user.tokens.first.expired?
+
+  # find user by token
+  User.find_by_token(:activate, "ea2f14aeac40")
+
+  # remove all expired tokens except those with NULL values
+  Token.delete_expired
+
+  # generate a token as string, without saving it
+  User.generate_token
+
+  # remove a token by its name
+  user.remove_token(:activate)
+
+  # find user by token
+  User.find_by_token(:activate, 'ea2f14aeac40')
+
+  # find user by valid token (same name, same hash, not expired)
+  User.find_by_valid_token(:activate, 'ea2f14aeac40')
+
+  # find a token using class scope
+  User.find_token(:activate, 'ea2f14aeac40')
+
+  # Token hash
+  token.to_s #=> ea2f14aeac40
+
+== License
+
+Copyright (c) 2008 Nando Vieira, released under the MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+require "lib/tokens/version"
+
+begin
+  require 'jeweler'
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "tokens"
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/has_tokens"
+    gem.authors = ["Nando Vieira"]
+    gem.version = SimplesIdeias::Tokens::Version::STRING
+    gem.summary = "Generate named tokens on your ActiveRecord models."
+    gem.files =  FileList["README.rdoc", "init.rb", "{lib,spec,source}/**/*", "Rakefile"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "[JEWELER] You can't build a gem until you install jeweler with `gem install jeweler`"
+end

data/init.rb

@@ -0,0 +1 @@
+require 'tokens'

data/lib/tokens/string_ext.rb

@@ -0,0 +1,7 @@
+require "digest/sha1"
+
+class String
+  def to_sha1
+    Digest::SHA1.hexdigest(self.dup)
+  end
+end

data/lib/tokens/token.rb

@@ -0,0 +1,19 @@
+class Token < ActiveRecord::Base
+  belongs_to :tokenizable, :polymorphic => true
+  
+  def hash
+    token
+  end
+  
+  def to_s
+    hash
+  end
+  
+  def expired?
+    expires_at && expires_at < Time.now
+  end
+  
+  def self.delete_expired
+    delete_all ["expires_at < ? AND expires_at IS NOT NULL", Time.now] 
+  end
+end

data/lib/tokens/version.rb

@@ -0,0 +1,10 @@
+module SimplesIdeias
+  module Tokens
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/lib/tokens.rb

@@ -0,0 +1,115 @@
+require "active_record"
+require "digest/sha1"
+require "tokens/string_ext"
+require "tokens/token"
+
+module SimplesIdeias
+  module Tokens #:nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_tokens
+        write_inheritable_attribute(:has_tokens_options, {
+          :token_type => ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+        })
+
+        class_inheritable_reader :has_tokens_options
+
+        has_many :tokens, :as => :tokenizable, :dependent => :destroy
+        include SimplesIdeias::Tokens::InstanceMethods
+      end
+
+      def generate_token(seed, size)
+        validity = Proc.new { |token| Token.find(:first, :conditions => {:token => token}).nil? }
+
+        begin
+          seed = Digest::SHA1.hexdigest(seed)
+          token = Digest::SHA1.hexdigest(seed)[0, size]
+        end while !validity.call(token)
+
+        token
+      end
+
+      # Find a token
+      # User.find_token(:activation, 'abcdefg')
+      # User.find_token(:name => activation, :token => 'abcdefg')
+      # User.find_token(:name => activation, :token => 'abcdefg', :tokenizable_id => 1)
+      def find_token(*args)
+        unless (options = args.first).is_a?(Hash)
+          options = {:name => args.first, :token => args.last.to_s}
+        end
+
+        options[:name] = options[:name].to_s
+        options.merge!({:tokenizable_type => has_tokens_options[:token_type]})
+        Token.find(:first, :conditions => options)
+      end
+
+      # Find object by token
+      # User.find_by_token(:activation, 'abcdefg')
+      def find_by_token(name, token)
+        t = find_token(:name => name.to_s, :token => token)
+        return nil unless t
+        t.tokenizable
+      end
+
+      # Find object by valid token (same name, same hash, not expired)
+      # User.find_by_valid_token(:activation, 'abcdefg')
+      def find_by_valid_token(name, token)
+        t = find_token(:name => name.to_s, :token => token)
+        return nil unless t && !t.expired? && t.hash == token
+        t.tokenizable
+      end
+    end
+
+    module InstanceMethods
+      # Object has a valid token (same name, same hash, not expired)
+      # @user.valid_token?(:activation, 'abcdefg')
+      def valid_token?(name, token)
+        t = find_token_by_name(name)
+        !!(t && !t.expired? && t.hash == token)
+      end
+
+      def remove_token(name)
+        Token.delete_all([
+          "tokenizable_id = ? AND tokenizable_type = ? AND name = ?",
+          self.id,
+          self.class.has_tokens_options[:token_type],
+          name.to_s
+        ])
+      end
+
+      def add_token(name, options={})
+        options = {
+          :expires_at => 2.days.from_now,
+          :size => 12,
+          :data => nil
+        }.merge(options)
+
+        remove_token(name)
+
+        seed = "--#{self.id}--#{self.object_id}--#{Time.now}--"
+
+        self.tokens.create(
+          :name => name.to_s,
+          :token => self.class.generate_token(seed, options[:size]),
+          :expires_at => options[:expires_at],
+          :data => options[:data]
+        )
+      end
+
+      def find_token_by_name(name)
+        self.tokens.find_by_name(name.to_s)
+      end
+
+      # Find a token
+      # @user.find_token(:activation, 'abcdefg')
+      def find_token(name, token)
+        self.class.find_token(:tokenizable_id => self.id, :name => name.to_s, :token => token)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, SimplesIdeias::Tokens)

data/spec/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users do |t|
+    t.string :name
+  end
+  
+  create_table :posts do |t|
+    t.string :title
+  end
+  
+  create_table :tokens do |t|
+    t.integer :tokenizable_id, :null => false
+    t.string :tokenizable_type, :name, :null => false
+    t.string :token, :limit => 40, :null => false
+    t.text :data, :null => true
+    t.datetime :expires_at, :null => true
+    t.datetime :created_at
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+
+require "spec"
+require "ruby-debug"
+require "active_record"
+require "tokens"
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+
+load('schema.rb')
+
+class Object
+  def self.unset_class(*args)
+    class_eval do
+      args.each do |klass|
+        eval(klass) rescue nil
+        remove_const(klass) if const_defined?(klass)
+      end
+    end
+  end
+end
+
+alias :doing :lambda

data/spec/tokens_spec.rb

@@ -0,0 +1,164 @@
+require "spec_helper"
+
+class User < ActiveRecord::Base
+  has_tokens
+end
+
+class Post < ActiveRecord::Base
+  has_tokens
+end
+
+describe "has_tokens" do
+  before(:each) do
+    User.delete_all
+    Post.delete_all
+    
+    @user = User.create(:name => "Homer")
+    @another_user = User.create(:name => "Bart")
+    @post = Post.create(:title => "How to make donuts")
+    @expire = 3.days.from_now
+  end
+  
+  describe "- token" do
+    it "should be created" do
+      doing { @user.add_token(:uid) }.should change(Token, :count)
+    end
+    
+    it "should be created for different users" do
+      @user.add_token(:uid).should be_valid
+      @another_user.add_token(:uid).should be_valid
+    end
+    
+    it "should be created with expiration date" do
+      @user.add_token(:uid, :expires_at => @expire).expires_at.should == @expire
+    end
+    
+    it "should be created with additional data" do
+      @user.add_token(:uid, :data => 'some value').data.should == 'some value'
+    end
+    
+    it "should be created with custom size" do
+      @user.add_token(:uid, :size => 6).hash.size.should == 6
+    end
+    
+    it "should find token by its name" do
+      token = @user.add_token(:uid)
+      @user.find_token_by_name(:uid).should == token
+    end
+    
+    it "should be nil when no token is found" do
+      @user.find_token(:uid, 'abcdef').should be_nil
+      @user.find_token_by_name(:uid).should be_nil
+    end
+    
+    it "should be a valid token" do
+      token = @user.add_token(:uid)
+      @user.valid_token?(:uid, token.hash).should be_true
+    end
+    
+    it "should not be a valid token" do
+      @user.valid_token?(:uid, 'invalid').should be_false
+    end
+    
+    it "should find token by its name and hash" do
+      token = @user.add_token(:uid)
+      @user.find_token(:uid, token.hash).should == token
+    end
+    
+    it "should not be expired when have no expiration date" do
+      @user.add_token(:uid).should_not be_expired
+    end
+    
+    it "should not be expired when have a future expiration date" do
+      @user.add_token(:uid, :expires_at => 3.days.from_now).should_not be_expired
+    end
+    
+    it "should be expired" do
+      @user.add_token(:uid, :expires_at => 3.days.ago).should be_expired
+    end
+    
+    it "should remove token" do
+      @user.add_token(:uid)
+      @user.remove_token(:uid).should > 0
+    end
+    
+    it "should not remove other users tokens" do
+      @user.add_token(:uid)
+      @another_user.add_token(:uid)
+      
+      @user.remove_token(:uid)
+      
+      @user.find_token_by_name(:uid).should be_nil
+      @another_user.find_token_by_name(:uid).should be_an_instance_of(Token)
+    end
+    
+    it "should not be duplicated" do
+      @user.add_token(:uid)
+      @user.add_token(:uid)
+      
+      @user.tokens.find_all_by_name('uid').size.should == 1
+    end
+  end
+  
+  it "should have tokens association" do
+    doing { @user.tokens }.should_not raise_error
+  end
+  
+  it "should remove all expired tokens" do
+    doing {
+      %w(uid activation_code reset_password_code).each do |name|
+        @user.add_token(name, :expires_at => 3.days.ago)
+      end
+    }.should change(Token, :count).by(3)
+    
+    Token.delete_expired.should == 3
+  end
+  
+  it "should generate token without saving it" do
+    doing {
+      User.generate_token(Time.now.to_s, 32)
+    }.should_not change(Token, :count)
+  end
+  
+  it "should generate token with custom size" do
+    User.generate_token(Time.now.to_s, 8).size.should == 8
+  end
+  
+  it "should alias token method" do
+    token = @user.add_token(:uid)
+    token.hash.should == token.token
+  end
+  
+  it "should find user by token" do
+    token = @user.add_token(:uid)
+    User.find_by_token(:uid, token.hash).should == @user
+  end
+  
+  it "should return user by its valid token without expiration time" do
+    token = @user.add_token(:uid)
+    User.find_by_valid_token(:uid, token.hash).should == @user
+  end
+  
+  it "should return user by its valid token with expiration time" do
+    token = @user.add_token(:uid, :expires_at => @expire)
+    User.find_by_valid_token(:uid, token.hash).should == @user
+  end
+  
+  it "should find token using class method with one argument (hash only)" do
+    token = @user.add_token(:uid)
+    User.find_token(:name => :uid, :token => token.hash).should == token
+  end
+  
+  it "should not conflict with other models" do
+    user_token = @user.add_token(:uid)
+    post_token = @post.add_token(:uid)
+    
+    User.find_token(post_token.to_s).should == nil
+    User.find_token(:name => :uid)
+  end
+  
+  it "to_s should return hash" do
+    token = @user.add_token(:uid)
+    token.to_s.should == token.hash
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: tokens
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nando Vieira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-09 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: fnando.vieira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/tokens.rb
+- lib/tokens/string_ext.rb
+- lib/tokens/token.rb
+- lib/tokens/version.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/tokens_spec.rb
+has_rdoc: true
+homepage: http://github.com/fnando/has_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: Generate named tokens on your ActiveRecord models.
+test_files: 
+- spec/schema.rb
+- spec/spec_helper.rb
+- spec/tokens_spec.rb