mongoid_token 0.9.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid_token.gemspec
+gemspec
+
+group :test do
+  gem 'database_cleaner'
+  gem 'rspec'
+  gem 'autotest'
+  gem 'autotest-growl'
+  gem 'mongoid', '~> 2.0'
+  gem 'bson_ext'
+  gem 'mongoid-rspec'
+end

data/README.md

@@ -0,0 +1,81 @@
+# Mongoid::Token - Short snappy tokens for Mongoid documents
+
+This library is a quick and simple way to generate unique, random tokens
+for your mongoid documents, in the cases where you can't, or don't want
+to use slugs, or the default MongoDB IDs.
+
+Mongoid::Token can help turn this:
+
+    http://bestwebappever.com/video/4dcfbb3c6a4f1d4c4a000012/edit
+
+Into something more like this:
+
+    http://bestwebappever.com/video/83xQ3r/edit
+
+
+## Getting started
+
+In your gemfile, add:
+
+    gem 'mongoid_token', '1.0.0'
+
+Then update your bundle
+
+    $ bundle update
+
+In your Mongoid documents, just add `include Mongoid::Token` and the
+`token` method will take care of all the setup, like so:
+
+````
+class Person
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Token
+
+  field :first_name
+  field :last_name
+
+  token :length => 8
+end
+
+````
+
+Obviously, this will create tokens of 8 characters long - make them as
+short or as long as you require.
+
+
+## Options
+
+The `token` method takes two options: `length`, which determines the
+length (or maximum length, in some cases) and `contains`, which tells
+Mongoid::Token which characters to use when generating the token.
+
+The options for `contains` are as follows:
+
+* `:alphanumeric` - letters (upper and lowercase) and numbers
+* `:alpha` - letters (upper and lowercase) only
+* `:numeric` - numbers only, anything from 1 character long, up to and
+  `length`
+* `:fixed_numeric` - numbers only, but with the number of characters always the same as `length`
+
+### Examples:
+
+* `token :length => 8, :contains => :alphanumeric` generates something like `8Sdc98dQ`
+* `token :length => 5, :contains => :alpha` gereates something like
+  `ASlkj`
+* `token :length => 4, :contains => :numeric` could generate anything
+  from `0` upto `9999` - but in a random order
+* `token :length => 4, :contains => :fixed_numeric` will generate
+  anything from `0000` to `9999` in a random order
+
+## Finders
+
+The library also contains a finder method for looking up your documents
+called `find_by_token`, e.g:
+
+    Person.find_by_token('7dDn8q')
+
+# Notes
+
+If you find a problem, please [submit an issue](http://github.com/thetron/mongoid_token/issues) (and a failing test, if
+you can). Pull requests and feature requests are always welcome.

data/Rakefile

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

data/lib/mongoid_token.rb

@@ -0,0 +1,49 @@
+module Mongoid
+  module Token
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def token(*args)
+        options = args.extract_options!
+        options[:length] ||= 4
+        options[:contains] ||= :alphanumeric
+
+        self.field :token, :type => String
+
+        set_callback(:create, :before) do |document|
+          document.create_token(options[:length], options[:contains])
+        end
+      end
+
+      def find_by_token(token)
+        self.first(:conditions => {:token => token})
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        self.token
+      end
+
+      protected
+      def create_token(length, characters)
+        self.token = self.generate_token(length, characters) while self.token == nil || self.class.exists?(:conditions => {:token => self.token})
+      end
+
+      def generate_token(length, characters)
+        case characters
+        when :alphanumeric
+          ActiveSupport::SecureRandom.hex(length)[0...length]
+        when :numeric
+          rand(10**length).to_s
+        when :fixed_numeric
+          rand(10**length).to_s.rjust(length,rand(10).to_s)
+        when :alpha
+          Array.new(length).map{['A'..'Z','a'..'z'].map{|r|r.to_a}.flatten[rand(52)]}.join
+        else
+          ActiveSupport::SecureRandom.hex(length)[0...length]
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module MongoidToken
+  VERSION = "0.9.0"
+end

data/mongoid_token.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_token"
+  s.version     = MongoidToken::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nicholas Bruning"]
+  s.email       = ["nicholas@bruning.com.au"]
+  s.homepage    = "http://github.com/thetron/mongoid_token"
+  s.summary     = %q{A little random, unique token generator for Mongoid documents.}
+  s.description = %q{Mongoid token is a gem for creating random, unique tokens for mongoid documents, when you want shorter URLs.}
+
+  s.rubyforge_project = "mongoid_token"
+  s.add_dependency 'active_support', '>= 3.0.0'
+
+  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"]
+end

data/spec/mongoid/token_spec.rb

@@ -0,0 +1,103 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+class Account
+  include Mongoid::Document
+  include Mongoid::Token
+  field :name
+  token :length => 16, :contains => :fixed_numeric
+end
+
+class Person
+  include Mongoid::Document
+  include Mongoid::Token
+  field :email
+  token :length => 6, :contains => :numeric
+end
+
+class Link
+  include Mongoid::Document
+  include Mongoid::Token
+
+  field :url
+  token :length => 3, :contains => :alphanumeric
+end
+
+class Video
+  include Mongoid::Document
+  include Mongoid::Token
+
+  field :name
+  token :length => 8, :contains => :alpha
+end
+
+describe Mongoid::Token do
+  before :each do
+    @account = Account.create(:name => "Involved Pty. Ltd.")
+    @link = Link.create(:url => "http://involved.com.au")
+    @video = Video.create(:name => "Nyan nyan")
+  end
+
+  it "should have a token field" do
+    @account.attributes.include?('token').should == true
+    @link.attributes.include?('token').should == true
+    @video.attributes.include?('token').should == true
+  end
+
+  it "should have a token of correct length" do
+    @account.token.length.should == 16
+    @link.token.length.should == 3
+    @video.token.length.should == 8
+  end
+
+  it "should only generate unique tokens" do
+    1000.times do
+      @link = Link.create(:url => "http://involved.com.au")
+      Link.count(:conditions => {:token => @link.token}).should == 1
+    end
+  end
+
+  it "should have a token containing only the specified characters" do
+    50.times do
+      @account = Account.create(:name => "Smith & Co. LLC")
+      @person = Person.create(:email => "some_random_235@gmail.com")
+
+      @account.token.gsub(/[0-9]/, "").length.should == 0
+      @person.token.gsub(/[0-9]/, "").length.should == 0
+    end
+
+    50.times do
+      @link = Link.create(:url => "http://involved.com.au")
+      @link.token.gsub(/[A-Za-z0-9]/, "").length.should == 0
+    end
+
+    50.times do
+      @video = Video.create(:name => "A test video")
+      @video.token.gsub(/[A-Za-z]/, "").length.should == 0
+    end
+  end
+
+  it "should create the only after the first save" do
+    @account = Account.new(:name => "Smith & Co. LLC")
+    @account.token.should be_nil
+    @account.save!
+    @account.token.should_not be_nil
+    initial_token = @account.token
+    @account.save!
+    initial_token.should == @account.token
+  end
+
+  it "should return the token as its parameter" do
+    @account.to_param.should == @account.token
+    @link.to_param.should == @link.token
+    @video.to_param.should == @video.token
+  end
+
+
+  it "should be finable by token" do
+    50.times do |index|
+      Account.create(:name => "A random company #{index}")
+    end
+    Account.find_by_token(@account.token).id.should == @account.id
+    Account.find_by_token(Account.last.token).id.should == Account.last.id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'database_cleaner'
+require 'mongoid'
+require 'mongoid-rspec'
+require 'mongoid_token'
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_token_test")
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_token
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Nicholas Bruning
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Mongoid token is a gem for creating random, unique tokens for mongoid documents, when you want shorter URLs.
+email: 
+- nicholas@bruning.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/mongoid_token.rb
+- lib/version.rb
+- mongoid_token.gemspec
+- spec/.DS_Store
+- spec/mongoid/token_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thetron/mongoid_token
+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: mongoid_token
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: A little random, unique token generator for Mongoid documents.
+test_files: 
+- spec/mongoid/token_spec.rb
+- spec/spec_helper.rb