tokens 0.1.0 → 0.2.0.beta.1

data/README.rdoc

@@ -78,7 +78,7 @@ Run migrations with <tt>rake db:migrate</tt>. Add the method call
   User.find_by_token(:activate, "ea2f14aeac40")
 
   # remove all expired tokens except those with NULL values
-  Token.delete_expired
+  Token.clean
 
   # generate a token as string, without saving it
   User.generate_token

data/Rakefile

@@ -8,7 +8,7 @@ begin
     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.version = SimplesIdeias::Tokens::Version::STRING + ".beta.1"
     gem.summary = "Generate named tokens on your ActiveRecord models."
     gem.files =  FileList["README.rdoc", "init.rb", "{lib,spec,source}/**/*", "Rakefile"]
   end

data/lib/tokens/token.rb

@@ -1,19 +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] 
+
+  def self.clean
+    delete_all ["expires_at < ? AND expires_at IS NOT NULL", Time.now]
   end
-end
+end

data/lib/tokens/version.rb

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

data/lib/tokens.rb

@@ -1,115 +1,131 @@
-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
-        })
+module Tokens
+  require "tokens/token"
+  require "tokens/version"
 
-        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)
+  def self.included(base)
+    base.class_eval { extend  ClassMethods }
+  end
 
-        token
-      end
+  module ClassMethods
+    # Set up model for using tokens.
+    #
+    #   class User < ActiveRecord::Base
+    #     has_tokens
+    #   end
+    #
+    def has_tokens
+      has_many :tokens, :as => :tokenizable, :dependent => :destroy
+      include InstanceMethods
+    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
+    # Generate token using seed and size.
+    #
+    #   User.generate_token("abc", 10)
+    #
+    def generate_token(seed, size)
+      validity = Proc.new {|token| Token.where(:token => token).first.nil?}
 
-      # 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
+      begin
+        seed = Digest::SHA1.hexdigest(seed)
+        token = Digest::SHA1.hexdigest(seed)[0, size]
+      end while validity[token] == false
 
-      # 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
+      token
     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)
+    # 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)
+      if args.first.kind_of?(Hash)
+        args.first
+      else
+        options = {
+          :name => args.first,
+          :token => args.last
+        }
       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
+      options.merge!(:name => options[:name].to_s, :tokenizable_type => self.name)
+      Token.where(options).include(:tokenizable).first
+    end
 
-      def add_token(name, options={})
-        options = {
-          :expires_at => 2.days.from_now,
-          :size => 12,
-          :data => nil
-        }.merge(options)
+    # Find object by token.
+    #
+    #   User.find_by_token(:activation, 'abcdefg')
+    #
+    def find_by_token(name, hash)
+      token = find_token(:name => name.to_s, :token => hash)
+      return nil unless token
+      token.tokenizable
+    end
 
-        remove_token(name)
+    # Find object by valid token (same name, same hash, not expired).
+    #
+    #   User.find_by_valid_token(:activation, 'abcdefg')
+    #
+    def find_by_valid_token(name, hash)
+      token = find_token(:name => name.to_s, :token => hash)
+      return nil if !token || t.expired?
+      t.tokenizable
+    end
+  end
 
-        seed = "--#{self.id}--#{self.object_id}--#{Time.now}--"
+  module InstanceMethods
+    # 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
 
-        self.tokens.create(
-          :name => name.to_s,
-          :token => self.class.generate_token(seed, options[:size]),
-          :expires_at => options[:expires_at],
-          :data => options[:data]
-        )
-      end
+    # Find token by its name.
+    def find_token_by_name(name)
+      self.tokens.find_by_name(name.to_s)
+    end
 
-      def find_token_by_name(name)
-        self.tokens.find_by_name(name.to_s)
-      end
+    # Remove token.
+    #
+    #   @user.remove_token(:activate)
+    #
+    def remove_token(name)
+      return if new_record?
+      token = find_token_by_name(name)
+      token && token.destroy
+    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
+    # Add a new token.
+    #
+    #   @user.add_token(:api_key, :expires_at => nil)
+    #   @user.add_token(:api_key, :size => 20)
+    #   @user.add_token(:api_key, :data => data.to_yaml)
+    #
+    def add_token(name, options={})
+      options.reverse_merge!({
+        :expires_at => 2.days.from_now,
+        :size => 12,
+        :data => nil
+      })
+
+      remove_token(name)
+
+      seed = "--#{rand}--#{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
   end
 end
 
-ActiveRecord::Base.send(:include, SimplesIdeias::Tokens)
+ActiveRecord::Base.send :include, Tokens

data/spec/schema.rb

@@ -2,17 +2,19 @@ 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
+    t.integer   :tokenizable_id,            :null => false
+    t.string    :tokenizable_type, :name,   :null => false
+    t.string    :token,                     :null => false, :limit => 40
+    t.text      :data,                      :null => true
+    t.datetime  :expires_at,                :null => true
+    t.datetime  :created_at
   end
-end
+
+  add_index :tokens, :token, :unique => true
+end

data/spec/spec_helper.rb

@@ -1,23 +1,9 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
 
-require "spec"
-require "ruby-debug"
+require "rspec"
 require "active_record"
 require "tokens"
 
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+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
+load("schema.rb")

data/spec/tokens_spec.rb

@@ -21,7 +21,7 @@ describe "has_tokens" do
   
   describe "- token" do
     it "should be created" do
-      doing { @user.add_token(:uid) }.should change(Token, :count)
+      expect { @user.add_token(:uid) }.to change(Token, :count)
     end
     
     it "should be created for different users" do
@@ -101,23 +101,23 @@ describe "has_tokens" do
   end
   
   it "should have tokens association" do
-    doing { @user.tokens }.should_not raise_error
+    expect { @user.tokens }.to_not raise_error
   end
   
   it "should remove all expired tokens" do
-    doing {
+    expect {
       %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)
+    }.to change(Token, :count).by(3)
     
     Token.delete_expired.should == 3
   end
   
   it "should generate token without saving it" do
-    doing {
+    expect {
       User.generate_token(Time.now.to_s, 32)
-    }.should_not change(Token, :count)
+    }.to_not change(Token, :count)
   end
   
   it "should generate token with custom size" do

metadata

@@ -1,12 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: tokens
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 62196353
+  prerelease: true
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  - beta
+  - 1
+  version: 0.2.0.beta.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-09 00:00:00 -03:00
+date: 2010-07-27 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -29,9 +32,7 @@ extra_rdoc_files:
 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
@@ -47,23 +48,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Generate named tokens on your ActiveRecord models.

data/init.rb

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

data/lib/tokens/string_ext.rb

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