tokens 0.2.0 → 0.2.1

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+gem "rspec-rails", "2.0.0.rc"
+gem "rails", "3.0.0"
+gem "sqlite3-ruby"
+
+platforms :mri_19 do
+  gem "ruby-debug19", :require => "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.6.1)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    rspec-rails (2.0.0.rc)
+      rspec (= 2.0.0.rc)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.0)
+  rspec-rails (= 2.0.0.rc)
+  ruby-debug19
+  sqlite3-ruby

data/README.rdoc

@@ -4,52 +4,24 @@
 
 === Installation
 
-You can use I18n-JS as plugin and gem. Choose what's best for you!
-
-  script/plugin install git://github.com/fnando/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
+Add Tokens to your Gemfile and run <tt>rails generate tokens:install</tt>.
+This will create a new migration file. Execute it by running <tt>rake db:migrate</tt>.
 
-Run migrations with <tt>rake db:migrate</tt>. Add the method call
-<tt>tokens</tt> to your model and be happy!
+Finally, add the macro <tt>tokenizable</tt> to your model and be happy!
 
   class User < ActiveRecord::Base
     tokenizable
   end
 
-  # create a new token; remember that the object need to be saved before creating
+  # create a new user; 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)
+  # create token that never expires
   user.add_token(:activate)
 
   # uses custom expires_at
@@ -61,9 +33,8 @@ Run migrations with <tt>rake db:migrate</tt>. Add the method call
   # 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)
+  # create token with arbitrary data.
+  user.add_token(:activate, :data => {:action => 'do something'})
 
   # find token by name
   user.find_token_by_name(:reset_account)
@@ -86,9 +57,6 @@ Run migrations with <tt>rake db:migrate</tt>. Add the method call
   # 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')
 

data/Rakefile

@@ -9,9 +9,9 @@ begin
     gem.email = "fnando.vieira@gmail.com"
     gem.homepage = "http://github.com/fnando/tokens"
     gem.authors = ["Nando Vieira"]
-    gem.version = SimplesIdeias::Tokens::Version::STRING
+    gem.version = Tokens::Version::STRING
     gem.summary = "Generate named tokens on your ActiveRecord models."
-    gem.files =  FileList["README.rdoc", "init.rb", "{lib,spec,source}/**/*", "Rakefile"]
+    gem.files =  FileList["{Rakefile,README.rdoc,Gemfile,Gemfile.lock,tokens.gemspec}", "{lib,spec,templates}/**/*"]
   end
 
   Jeweler::GemcutterTasks.new
@@ -20,5 +20,5 @@ rescue LoadError => e
 end
 
 RSpec::Core::RakeTask.new do |t|
-  t.ruby_opts = %[ -rubygems -Ilib -Ispec ]
+  t.ruby_opts = %[ -Ilib -Ispec ]
 end

data/lib/tokens.rb

@@ -1,140 +1,7 @@
-module Tokens
-  require "tokens/token"
-  require "tokens/version"
+require "rails/railtie"
+require "active_record"
 
-  def self.included(base)
-    base.class_eval { extend  ClassMethods }
-  end
-
-  module ClassMethods
-    # Set up model for using tokens.
-    #
-    #   class User < ActiveRecord::Base
-    #     tokenizable
-    #   end
-    #
-    def tokenizable
-      has_many :tokens, :as => :tokenizable, :dependent => :destroy
-      include InstanceMethods
-    end
-
-    alias_method :has_tokens, :tokenizable
-
-    # Generate token with specified length.
-    #
-    #   User.generate_token(10)
-    #
-    def generate_token(size)
-      validity = Proc.new {|token| Token.where(:token => token).first.nil?}
-
-      begin
-        seed = "--#{rand}--#{Time.now}--#{rand}--"
-        token = Digest::SHA1.hexdigest(seed)[0, size]
-      end while validity[token] == false
-
-      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)
-      if args.first.kind_of?(Hash)
-        options = args.first
-      else
-        options = {
-          :name => args.first,
-          :token => args.last
-        }
-      end
-
-      options.merge!(:name => options[:name].to_s, :tokenizable_type => self.name)
-      Token.where(options).includes(:tokenizable).first
-    end
-
-    # 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
-
-    # 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 || token.expired?
-      token.tokenizable
-    end
-  end
-
-  module InstanceMethods
-    # Verify if given token is valid.
-    #
-    #   @user.valid_token?(:active, "abcdefg")
-    #
-    def valid_token?(name, hash)
-      self.tokens.where(:name => name.to_s, :token => hash.to_s).first != nil
-    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
-
-    # Find token by its name.
-    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
-
-    # 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)
-      attrs = {
-        :name       => name.to_s,
-        :token      => self.class.generate_token(options[:size]),
-        :expires_at => options[:expires_at],
-        :data       => options[:data]
-      }
-
-      self.tokens.create!(attrs)
-    end
-  end
-end
-
-ActiveRecord::Base.send :include, Tokens
+require "tokens/active_record"
+require "tokens/token"
+require "tokens/version"
+require "tokens/railtie"

data/lib/tokens/active_record.rb

@@ -0,0 +1,135 @@
+module Tokens
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval { extend  ClassMethods }
+    end
+
+    module ClassMethods
+      # Set up model for using tokens.
+      #
+      #   class User < ActiveRecord::Base
+      #     tokenizable
+      #   end
+      #
+      def tokenizable
+        has_many :tokens, :as => :tokenizable, :dependent => :destroy
+        include InstanceMethods
+      end
+
+      # Generate token with specified length.
+      #
+      #   User.generate_token(10)
+      #
+      def generate_token(size)
+        validity = Proc.new {|token| Token.where(:token => token).first.nil?}
+
+        begin
+          seed = "--#{rand}--#{Time.now}--#{rand}--"
+          token = Digest::SHA1.hexdigest(seed)[0, size]
+        end while validity[token] == false
+
+        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)
+        if args.first.kind_of?(Hash)
+          options = args.first
+        else
+          options = {
+            :name => args.first,
+            :token => args.last
+          }
+        end
+
+        options.merge!(:name => options[:name].to_s, :tokenizable_type => self.name)
+        Token.where(options).includes(:tokenizable).first
+      end
+
+      # 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
+
+      # 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 || token.expired?
+        token.tokenizable
+      end
+    end
+
+    module InstanceMethods
+      # Verify if given token is valid.
+      #
+      #   @user.valid_token?(:active, "abcdefg")
+      #
+      def valid_token?(name, hash)
+        self.tokens.where(:name => name.to_s, :token => hash.to_s).first != nil
+      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
+
+      # Find token by its name.
+      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
+
+      # 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)
+        attrs = {
+          :name       => name.to_s,
+          :token      => self.class.generate_token(options[:size]),
+          :expires_at => options[:expires_at],
+          :data       => options[:data]
+        }
+
+        self.tokens.create!(attrs)
+      end
+    end
+  end
+end