ar-tokens 0.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tokens.gemspec
+gemspec
+gem 'rspec'
+gem 'sqlite3'

data/README.markdown

@@ -0,0 +1,39 @@
+For generating a token on an active record column you can use `generate_token`
+
+Parameters
+----------
+
+  * column: the column of the active record
+  * options: some options for generating the token
+    * :length: the token length (default: 8)
+    * :uniq: whether the token must be uniq or not (default: true)
+    * :scope: the column for the scope to check the uniqueness (default: nil)
+
+Example
+-------
+
+```ruby
+  class User < ActiveRecord::Base
+    tokenize :email_confirmation_token, length: 16
+  end
+```
+
+this is equal to
+
+```ruby
+  class User < ActiveRecord::Base
+    before_validation on: :create do |obj|
+      obj.generate_token :email_confirmation_token, length: 16
+    end
+  end
+```
+
+Installation
+------------
+
+Currently the gem is not available on rubyforge, so you have to install it with git:
+
+```
+  gem 'ar-tokens'
+```
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ar-tokens.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tokens/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ar-tokens"
+  s.version     = Tokens::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Spieker"]
+  s.email       = ["p.spieker@duenos.de"]
+  s.homepage    = "https://github.com/spieker/tokens"
+  s.summary     = %q{Generating tokens on ruby objects and active record columns}
+  s.description = %q{This gem lets you easily generate tokens on ruby objects and provides additional methods on ActiveRecord::Base to generate tokens on records}
+
+  s.rubyforge_project = "tokens"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activerecord'
+end

data/lib/active_record/mixin/token_generator.rb

@@ -0,0 +1,84 @@
+# This mixin provides methods on ActiveRecord::Base to generate a token for
+# a given column. The token for the column can have a specific length, can
+# be uniq and the uniqueness can be scoped on a given column.
+#
+module ActiveRecord
+  module Mixin
+    module TokenGenerator
+      module InstanceMethods
+        # Generates a token for the given active record column
+        #
+        # == Parameters
+        # * columns: the column of the active record as symbol or an array of columns
+        # * options: some options for generating the token
+        # ** :length: the token length (default: 8)
+        # ** :uniq: whether the token must be uniq or not (default: true)
+        # ** :scope: the column for the scope to check the uniqueness (default: nil)
+        # ** :same_token: if an array of columns is given and this option is true, all columns will get the same token (default: false)
+        #
+        # == Example
+        #   class User < ActiveRecord::Base
+        #     before_validation do |obj|
+        #       obj.generate_token :email_confirmation_token, :length => 16
+        #     end
+        #   end
+        #
+        def generate_token(columns, *args)
+          options = {
+            :length     => 8,
+            :uniq       => true,
+            :scope      => nil,
+            :same_token => false,
+            :max_try    => 8
+          }.merge(args.extract_options!)
+          
+          columns = [columns] unless columns.is_a?(Array)
+          
+          result = {}
+          token = nil
+          columns.each do |column|
+            counter = 0
+            begin
+              raise NoFreeToken.new(column) if counter >= options[:max_try]
+              counter += 1
+
+              token = new_token(options[:length]) if(token.blank? or not options[:same_token])
+              self.send("#{column}=".to_sym, token)
+              result[column.to_sym]      = token
+              condition                  = { column => token }
+              condition[options[:scope]] = self[options[:scope]] if options[:scope].is_a?(Symbol) or options[:scope].is_a?(String)
+            end while options[:uniq] and self.class.exists?(condition)
+          end
+          result
+        end
+
+      end
+
+      module ClassMethods
+        # this method generates a token for the given columns before there get validated. Beside the
+        # options described at the +generate_token+ method, you can use the following options.
+        #
+        # :on: (default: :create)
+        #
+        def tokenize(column, *args)
+          options = {
+            :on => :create
+          }.merge(args.extract_options!)
+          before_validation_options = options.reject { |k,v| [:length, :uniq, :scope, :same_token].include?(k) }
+          options.select! { |k,v| [:length, :uniq, :scope, :same_token].include?(k) }
+
+          before_validation before_validation_options do |obj|
+            obj.generate_token column, options
+          end  
+        end
+      end
+  
+      def self.included(receiver)
+        receiver.send :include, InstanceMethods
+        receiver.extend ClassMethods
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Mixin::TokenGenerator

data/lib/ar-tokens.rb

@@ -0,0 +1,5 @@
+require 'object'
+require 'no_free_token'
+require 'securerandom'
+require 'active_record'
+require 'active_record/mixin/token_generator'

data/lib/no_free_token.rb

@@ -0,0 +1,5 @@
+class NoFreeToken < Exception
+  def initialize(column)
+    super("No free token for column '#{column}' found")
+  end
+end

data/lib/object.rb

@@ -0,0 +1,22 @@
+# This provides a method for generating a random token of the given length.
+# The generated token is base58 encoded, so the token just contains numbers,
+# up- and down case characters.
+# 
+# Example:
+#   Object.new_token(10) # => "S2Mq4mJBv6" (i.e.)
+# or
+#   Object.new.new_token(10) # => "S2Mq4mJBv6" (i.e.)
+#
+class Object
+  def self.new_token(length=8, characters = ('a'..'z').to_a+('A'..'Z').to_a+(0..9).to_a)
+    result = ''
+    length.times do
+      result += characters[SecureRandom.random_number(characters.length)].to_s
+    end
+    result
+  end
+  
+  def new_token(length=8, characters = ('a'..'z').to_a+('A'..'Z').to_a+(0..9).to_a)
+    self.class.new_token(length, characters)
+  end
+end

data/lib/tokens/version.rb

@@ -0,0 +1,3 @@
+module Tokens
+  VERSION = "0.0.4"
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ActiveRecord::Mixin::TokenGenerator do
+  before :each do
+    @klass = TokenTest.dup    
+  end
+
+  it "geneates a token" do
+    SecureRandom.stub(:random_number).and_return(0)
+    @klass.tokenize :token
+    @klass.create.token.should == 'aaaaaaaa'
+  end
+  
+  it "raises an exception if no free token is available" do
+    SecureRandom.stub(:random_number).and_return(0)
+    @klass.tokenize :token
+    @klass.create.token.should == 'aaaaaaaa'
+    expect {
+      @klass.create
+    }.to raise_error(NoFreeToken)
+  end
+
+  it "generates duplicate tokens if allowed" do
+    SecureRandom.stub(:random_number).and_return(0)
+    @klass.tokenize :token, :uniq => false
+    @klass.create.token.should == 'aaaaaaaa'
+    @klass.create.token.should == 'aaaaaaaa'
+  end
+  
+  it "generates duplicate tokens in different scopes if allowed" do
+    SecureRandom.stub(:random_number).and_return(0)
+    @klass.tokenize :token, :scope => 'scope'
+    @klass.create(:scope => 'a').token.should == 'aaaaaaaa'
+    @klass.create(:scope => 'b').token.should == 'aaaaaaaa'
+  end
+
+  it "generates tokens with the specified length" do
+    (6..32).each do |i|
+      @klass = TokenTest.dup
+      @klass.tokenize :token, :length => i
+      10.times do
+        @klass.create.token.length.should == i
+      end
+    end
+  end
+
+  it "generates different tokens for different columns" do
+    @klass.tokenize [:token, :token_two]
+    r = @klass.create!
+    r.token.should_not == r.token_two
+  end
+
+  it "generates the same token for two columns if specified" do
+    @klass.tokenize [:token, :token_two], :same_token => true
+    r = @klass.create!
+    r.token.should == r.token_two
+  end
+end

data/spec/object_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Object do
+  it "returns 8 a's if only a is given as character list" do
+    new_token(8, ['a']).should == 'aaaaaaaa'
+  end
+
+  it "returns 'bbbbbbbb' if random_number retruns 1" do
+    SecureRandom.stub(:random_number).and_return(1)
+    new_token.should == 'bbbbbbbb'
+  end
+
+  it "returns a random string with the given length" do
+    32.times do |i|
+      100.times do
+        new_token(i).length.should == i
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ar-tokens'
+require 'support/active_record'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :token_tests do |t|
+  t.string :scope
+  t.string :token
+  t.string :token_two
+  t.timestamps
+end
+
+class TokenTest < ActiveRecord::Base
+  set_table_name 'token_tests'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ar-tokens
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Paul Spieker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem lets you easily generate tokens on ruby objects and provides
+  additional methods on ActiveRecord::Base to generate tokens on records
+email:
+- p.spieker@duenos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- ar-tokens.gemspec
+- lib/active_record/mixin/token_generator.rb
+- lib/ar-tokens.rb
+- lib/no_free_token.rb
+- lib/object.rb
+- lib/tokens/version.rb
+- spec/active_record_spec.rb
+- spec/object_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: https://github.com/spieker/tokens
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tokens
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Generating tokens on ruby objects and active record columns
+test_files:
+- spec/active_record_spec.rb
+- spec/object_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+has_rdoc: