has_token_id 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.DS_Store
+coverage
+Gemfile.lock
+pkg/*
+test/dummy_hooks/after_migrate.rb
+test/dummy

data/.travis.yml

@@ -0,0 +1,8 @@
+before_script: "bundle exec dummier"
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - ree

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2011 Spencer Steffen and Citrus Media Group.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of Citrus Media Group nor the names of its
+      contributors may be used to endorse or promote products derived from this
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,154 @@
+# HasTokenId [![Build Status](https://secure.travis-ci.org/citrus/has_token_id.png)](http://travis-ci.org/citrus/has_token_id) [![Dependency Status](https://gemnasium.com/citrus/has_token_id.png)](https://gemnasium.com/citrus/has_token_id)
+
+Identify your active records with random tokens when you don't want your users to see a sequential ID.
+
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+Add has_token_id to your Gemfile like so:
+
+```ruby
+gem 'has_token_id', '~> 0.1.0' 
+```
+
+Now run `bundle install` and you're good to go!
+
+
+------------------------------------------------------------------------------
+Usage
+------------------------------------------------------------------------------
+
+First, add a token to your model's table with a migration:
+
+```ruby
+# Upgrade and existing table
+class AddTokenToItems < ActiveRecord::Migration
+  add_column :items, :token, :string
+end
+
+# Add to a new table
+class CreateItems < ActiveRecord::Migration
+  def change
+    create_table :items do |t|
+      t.token
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end
+```
+
+
+Now make sure your model knows to use it's token by calling `has_token_id`
+
+```ruby
+class Item < ActiveRecord::Base
+  has_token_id  
+end
+```
+
+That's basically it! Your Items will now know to use their token as their identifier.
+
+Try it out in your `rails console`
+
+```ruby
+@item = Item.create(:name => "Tokenz!")
+#<Item id: 1, token: "Iccfa4bb1613e80097ba9495", name: "Tokenz!", created_at: "2012-01-26 20:17:13", updated_at: "2012-01-26 20:17:13">
+@item.to_param
+# Iccfa4bb1613e80097ba9495
+@item == Item.find("Iccfa4bb1613e80097ba9495")
+# true
+```
+
+
+------------------------------------------------------------------------------
+Options
+------------------------------------------------------------------------------
+
+You can customize has_token_id by setting a few options. Here's the defaults:
+
+```ruby
+:prefix         => nil, # if nil use first letter of class name 
+:length         => 24,
+:param_name     => 'token',
+:case_sensitive => false
+```
+
+
+Options can be set globally by overwriting the `HasTokenId.default_token_options`
+
+```ruby
+# config/initializers/has_token_id.rb
+
+# for one option
+HasTokenId.default_token_options[:prefix] = "OMG"
+
+# for multiple options
+HasTokenId.default_token_options.merge!(
+  :case_sensitive => true,
+  :length         => 8
+)
+```
+
+
+Options can also be set on a per-class level:
+
+```ruby
+class List < ActiveRecord::Base
+  has_token_id :prefix => "LI", :length => 10
+end
+
+class Item < ActiveRecord::Base
+  has_token_id :prefix => "ITM"
+end
+```
+
+
+------------------------------------------------------------------------------
+Demo
+------------------------------------------------------------------------------
+
+Try out the demo to get a real clear idea of what has_token_id does.
+
+```bash
+git clone git://github.com/citrus/has_token_id.git
+cd has_token_id
+bundle install
+bundle exec dummier
+cd test/dummy
+rails s
+```
+
+Now open your browser to [http://localhost:3000](http://localhost:3000)
+
+
+------------------------------------------------------------------------------
+Testing
+------------------------------------------------------------------------------
+
+Testing is done with [minitest](https://github.com/seattlerb/minitest), [minitest_should](https://github.com/citrus/minitest_should) and [dummier](https://github.com/citrus/dummier).
+
+To get setup, run the following commands:
+
+```bash
+git clone git://github.com/citrus/has_token_id.git
+cd has_token_id
+bundle install
+bundle exec dummier
+```
+
+Now run the tests with:
+
+```bash
+bundle exec rake
+```
+
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Copyright (c) 2011 - 2012 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test' << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/has_token_id.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_token_id/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = "has_token_id"
+  s.version     = HasTokenId::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Steffen"]
+  s.email       = ["spencer@citrusme.com"]
+  s.homepage    = "https://github.com/citrus/has_token_id"
+  s.summary     = %q{Identifies your active records with a random token.}
+  s.description = %q{Identifies your active records with a random token. For more information, please see the documentation.}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features,lib/dummy_hooks}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('activerecord',  '>= 3.0.0')
+  s.add_dependency('activesupport', '>= 3.0.0')
+  
+  s.add_development_dependency('rails',           '>= 3.0.0')
+  s.add_development_dependency('dummier',         '>= 0.3.0')
+  s.add_development_dependency('minitest',        '>= 2.0.0')
+  s.add_development_dependency('minitest_should', '>= 0.3.1')
+  s.add_development_dependency('sqlite3',         '>= 1.3.5')
+
+end

data/lib/has_token_id/concern.rb

@@ -0,0 +1,81 @@
+module HasTokenId
+  module Concern
+  
+    extend ActiveSupport::Concern
+
+    included do
+      validates :token, :presence => true, :uniqueness => true
+      before_validation :generate_token, :on => :create, :if => proc{|record| record.token.nil? }
+    end
+
+    module ClassMethods
+      attr_accessor :has_token_id_options
+      
+      # Default options as well as an overwrite point so you can assign different defaults to different models
+      def default_token_options
+        return @default_token_options if @default_token_options
+        @default_token_options = HasTokenId.default_token_options
+        @default_token_options[:prefix] ||= self.name[0, 1]
+        @default_token_options
+      end
+      
+      # Generates a unique token based on the options
+      def generate_unique_token
+        record, options = true, self.has_token_id_options
+        conditions = {}
+        while record
+          token = [ options[:prefix], Digest::SHA1.hexdigest((Time.now.to_i * rand()).to_s)].compact.join[0...options[:length].to_i]
+          conditions[options[:param_name].to_sym] = token
+          record = self.where(conditions).first
+        end
+        token
+      end
+      
+      # Find by token ensuring case sensitivity
+      def find_by_case_sensitive_token(token)
+        where("#{token_with_table_name} = ?", token).first
+      end
+      
+      # Find by token regardless of case
+      def find_by_case_insensitive_token(token)
+        where("lower(#{token_with_table_name}) = ?", token.downcase).first
+      end
+      
+      # Find by token
+      def find_by_token(token)
+        send(has_token_id_options[:case_sensitive] ? :find_by_case_sensitive_token : :find_by_case_insensitive_token, token)
+      end
+      
+      # Find by token if the first param looks like a token, otherwise use super 
+      def find(*args)
+        if args[0].is_a?(String) && args[0].length == has_token_id_options[:length]
+          record = find_by_token(args[0])
+        end
+        record || super(*args)
+      end
+      
+      private
+      
+        def token_with_table_name
+          [ table_name, has_token_id_options[:param_name] ].join(".")
+        end
+      
+    end # ClassMethods
+    
+    module InstanceMethods
+  
+      def to_param 
+        self.send(self.class.has_token_id_options[:param_name])
+      end
+    
+      private      
+        
+        def generate_token
+          self.token = self.class.generate_unique_token
+        end
+        
+    end # InstanceMethods    
+
+  end # Concern
+  
+end # HasTokenId

data/lib/has_token_id/table_definition.rb

@@ -0,0 +1,14 @@
+require 'active_record/connection_adapters/abstract/schema_definitions'
+
+module HasTokenId
+  module TableDefinition
+    
+    def token(*args)
+      options = { :length => HasTokenId.default_token_options[:length] }.merge(args.extract_options!)
+      column(:token, :string, options.merge(:nil => false))
+    end
+  
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, HasTokenId::TableDefinition)

data/lib/has_token_id/version.rb

@@ -0,0 +1,3 @@
+module HasTokenId
+  VERSION = "0.1.0"
+end

data/lib/has_token_id.rb

@@ -0,0 +1,31 @@
+require 'digest/sha1'
+require 'has_token_id/concern'
+require 'has_token_id/table_definition'
+
+module HasTokenId
+
+  def self.included(base)
+    
+    base.instance_eval do
+            
+      def has_token_id(options={})
+        self.send(:include, HasTokenId::Concern)
+        self.has_token_id_options = self.default_token_options.merge(options)
+      end
+                  
+    end
+        
+  end
+  
+  def self.default_token_options
+    @default_token_options ||= {
+      :prefix         => nil, # if nil use first letter of class name 
+      :length         => 24,
+      :param_name     => 'token',
+      :case_sensitive => false
+    }
+  end
+  
+end # Has Token
+
+ActiveRecord::Base.send(:include, HasTokenId)

data/test/dummy_hooks/after_migrate.sample

@@ -0,0 +1 @@
+rake "db:migrate", :env => "development"

data/test/dummy_hooks/before_migrate.rb

@@ -0,0 +1,20 @@
+# Generate an Item model
+run "rails g scaffold item name:string"
+
+# Add has_token_id to our Item model
+gsub_file "app/models/item.rb", "end", %(
+  has_token_id
+  
+end)
+
+# Replace the delete link with a button since we won't have js in the demo
+gsub_file "app/views/items/index.html.erb", %(link_to 'Destroy'), %(button_to 'Destroy')
+
+# Ensure our migration is using our `token` TableDefinition
+@migration = File.basename(Dir[File.expand_path("db/migrate/*.rb", destination_path)].last)
+gsub_file File.join("db/migrate/", @migration), "t.string :name", "t.token\n      t.string :name"
+
+# Route items#index as the root path
+gsub_file "config/routes.rb", "resources :items", %(
+  resources :items
+  root :to => "items#index")

data/test/support/test_case.rb

@@ -0,0 +1,17 @@
+class MiniTest::Should::TestCase
+
+  # Borrowed from thor .. thanks wycats! :)
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+        
+    result
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+ENV["RAILS_ENV"] = "test"
+
+gem "minitest"
+
+begin
+  require "simplecov"
+  SimpleCov.start do
+    add_filter do |source_file|
+      source_file.filename =~ /dummy/
+    end
+  end
+rescue LoadError
+end
+
+env = File.expand_path("../dummy/config/environment.rb",  __FILE__)
+if File.exists?(env)
+  require env
+else
+  raise LoadError, "Please create the dummy app before running tests. Try running `bundle exec dummier`"
+end
+
+require "rails/test_help"
+require "minitest/autorun"
+require "minitest/should"
+require "support/test_case"
+
+Rails.backtrace_cleaner.remove_silencers!

data/test/unit/concern_test.rb

@@ -0,0 +1,157 @@
+require "test_helper"
+
+# We'll test the test/dummy/app/item.rb model
+
+class ConcernTest < MiniTest::Should::TestCase
+  
+  setup do
+    # remove all items
+    Item.destroy_all
+    # reset to defaults
+    Item.has_token_id_options.merge!(Item.default_token_options)
+  end
+  
+  should "respond to has_token_id" do
+    assert Item.respond_to?(:has_token_id)
+  end
+  
+  should "set it's token" do  
+    @item = Item.new(:name => "Something")
+    assert @item.valid?
+    assert !@item.token.nil?
+    assert @item.save
+  end
+  
+  should "only set it's token once" do
+    @item = Item.new(:name => "Something")
+    assert @item.valid?
+    token = @item.token
+    assert !token.nil?
+    @item.name = "Something else"
+    assert @item.valid?
+    assert_equal token, @item.token
+  end
+  
+  should "join token with table name when searching for record" do
+    assert_equal "items.token", Item.send(:token_with_table_name)    
+  end
+  
+  context "with an existing item" do
+    
+    setup do
+      @item = Item.create(:name => "Blue Cheese Burger")
+    end
+    
+    should "assume token prefix" do
+      assert_equal "I", @item.token[0, 1]
+    end
+    
+    should "have default options" do
+      opts = { :prefix => "I", :length => 24, :param_name => "token", :case_sensitive => false }
+      assert_equal opts, Item.has_token_id_options
+    end
+    
+    should "have proper token length" do
+      assert_equal Item.has_token_id_options[:length], @item.token.length
+    end
+    
+    should "have token as to_param" do
+      assert_equal @item.to_param, @item.token
+    end
+    
+    should "find by token" do
+      assert_equal @item, Item.find(@item.token)
+    end
+    
+    should "work with token finder method" do
+      assert Item.find_by_token(@item.token)
+    end
+    
+    should "work with !bang token finder method" do
+      assert Item.find_by_token!(@item.token)
+    end
+    
+    should "return nil from token finder method when record is not found" do
+      assert_equal nil, Item.find_by_token("invalid")
+    end
+    
+    should "raise activerecord not found from !bang token finder method when record is not found" do
+      assert_raises ActiveRecord::RecordNotFound do
+        Item.find_by_token!("invalid")
+      end
+    end
+    
+    context "when case sensitivity is disabled" do
+    
+      setup do
+        Item.has_token_id_options[:case_sensitive] = false
+      end
+    
+      should "find by token" do
+        assert_equal @item, Item.find(@item.token)
+      end    
+      
+      should "find by token even if it's all uppercase" do
+        assert_equal @item, Item.find(@item.token.upcase)
+      end
+      
+      should "find by token even if it's all lowercase" do
+        assert_equal @item, Item.find(@item.token.downcase)
+      end
+      
+    end
+    
+    context "when case sensitivity is enabled" do
+    
+      setup do
+        Item.has_token_id_options[:case_sensitive] = true
+      end
+    
+      should "find by token" do
+        assert_equal @item, Item.find(@item.token)
+      end    
+      
+      should "not find by token if it's all uppercase" do
+        assert_raises ActiveRecord::RecordNotFound do
+          Item.find(@item.token.upcase)
+        end
+      end
+      
+      should "find by token even if it's all lowercase" do
+        assert_raises ActiveRecord::RecordNotFound do
+          assert Item.find(@item.token.downcase)
+        end
+      end
+            
+    end
+    
+  end
+
+  context "with a long token" do
+     
+     setup do
+       Item.has_token_id_options[:length] = 40
+       @item = Item.create(:name => "Bacon Cheese Burger")
+     end
+     
+     should "have long token" do
+       assert_equal 40, @item.token.length
+     end
+    
+  end
+  
+  context "with long prefix" do
+  
+     setup do
+       Item.has_token_id_options.update(:prefix => "item-", :length => 40)
+       @item = Item.create(:name => "Bacon Cheese Burger")
+     end
+  
+     should "account for longer prefixes" do    
+       assert_equal 40, @item.token.length
+       assert_match /^item-(.*)/, @item.token
+     end
+    
+  end
+        
+end

data/test/unit/has_token_id_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class HasTokenIdIdTest < MiniTest::Should::TestCase
+  
+  should "have version" do
+    assert_equal String, HasTokenId::VERSION.class
+  end
+  
+  should "include HasTokenId" do
+    assert ActiveRecord::Base.included_modules.include?(HasTokenId)
+  end
+  
+  should "have has_token_id method" do
+    assert ActiveRecord::Base.respond_to?(:has_token_id)
+  end
+    
+end

data/test/unit/table_definition_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class TableDefinitionTest < MiniTest::Should::TestCase
+  
+  setup do
+    @migration = ActiveRecord::Migration.new
+    @definition = ActiveRecord::ConnectionAdapters::TableDefinition.new(@migration)  
+  end
+  
+  should "include token as a migration table definition" do
+    assert @definition.respond_to?(:token)
+  end
+  
+  should "token definition should be the same as a string column named token" do
+    capture(:stdout) {
+      assert_equal @definition.column(:token, :string), @definition.token
+    }
+  end
+  
+  should "token definition should include custom options" do
+    capture(:stdout) {
+      assert_equal @definition.column(:token, :string, :length => 8), @definition.token(:length => 8)
+    }
+  end
+  
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: has_token_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Spencer Steffen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70098471332260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70098471332260
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70098471329600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70098471329600
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70098471329120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70098471329120
+- !ruby/object:Gem::Dependency
+  name: dummier
+  requirement: &70098471328580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70098471328580
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70098471327820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70098471327820
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  requirement: &70098471327140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *70098471327140
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70098471326400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70098471326400
+description: Identifies your active records with a random token. For more information,
+  please see the documentation.
+email:
+- spencer@citrusme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_token_id.gemspec
+- lib/has_token_id.rb
+- lib/has_token_id/concern.rb
+- lib/has_token_id/table_definition.rb
+- lib/has_token_id/version.rb
+- test/dummy_hooks/after_migrate.sample
+- test/dummy_hooks/before_migrate.rb
+- test/support/test_case.rb
+- test/test_helper.rb
+- test/unit/concern_test.rb
+- test/unit/has_token_id_test.rb
+- test/unit/table_definition_test.rb
+homepage: https://github.com/citrus/has_token_id
+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'
+      segments:
+      - 0
+      hash: -556802150054861821
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -556802150054861821
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Identifies your active records with a random token.
+test_files:
+- test/dummy_hooks/after_migrate.sample
+- test/dummy_hooks/before_migrate.rb
+- test/support/test_case.rb
+- test/test_helper.rb
+- test/unit/concern_test.rb
+- test/unit/has_token_id_test.rb
+- test/unit/table_definition_test.rb