has_token_id 0.2.0 → 0.3.0

data/README.md

@@ -10,7 +10,7 @@ Installation
 Add has_token_id to your Gemfile like so:
 
 ```ruby
-gem 'has_token_id', '~> 0.2.0' 
+gem 'has_token_id', '~> 0.3.0' 
 ```
 
 Now run `bundle install` and you're good to go!
@@ -61,6 +61,8 @@ Try it out in your `rails console`
 # Iccfa4bb1613e80097ba9495
 @item == Item.find("Iccfa4bb1613e80097ba9495")
 # true
+@item.short_token
+# Iccfa4bb
 ```
 
 
@@ -71,10 +73,11 @@ 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
+:prefix             => nil, # if nil use first letter of class name 
+:length             => 24,
+:short_token_length => 8,
+:param_name         => 'token',
+:case_sensitive     => false
 ```
 
 

data/lib/has_token_id/concern.rb

@@ -71,10 +71,16 @@ module HasTokenId
     
     module InstanceMethods
   
-      def to_param 
+      def to_param
         self.send(self.class.has_token_id_options[:param_name])
       end
     
+      def short_token
+        max = self.class.has_token_id_options[:length]
+        len = self.class.has_token_id_options[:short_token_length]
+        to_param[0, len < max ? len : max]
+      end
+    
       private      
         
         def generate_token

data/lib/has_token_id/version.rb

@@ -1,3 +1,3 @@
 module HasTokenId
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/has_token_id.rb

@@ -19,10 +19,11 @@ module HasTokenId
   
   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
+      :prefix             => nil, # if nil use first letter of class name 
+      :length             => 24,
+      :short_token_length => 8,
+      :param_name         => 'token',
+      :case_sensitive     => false
     }
   end
   

data/test/unit/concern_test.rb

@@ -47,7 +47,7 @@ class ConcernTest < MiniTest::Should::TestCase
     end
     
     should "have default options" do
-      opts = { :prefix => "I", :length => 24, :param_name => "token", :case_sensitive => false }
+      opts = { :prefix => "I", :length => 24, :short_token_length => 8, :param_name => "token", :case_sensitive => false }
       assert_equal opts, Item.has_token_id_options
     end
     
@@ -59,6 +59,17 @@ class ConcernTest < MiniTest::Should::TestCase
       assert_equal @item.to_param, @item.token
     end
     
+    should "have short token" do
+      assert_equal @item.token[0, 8], @item.short_token
+      assert_equal 8, @item.short_token.length
+    end
+    
+    should "return max token size when short token length is set longer than token length" do
+      Item.has_token_id_options.merge!(:short_token_length => 99)
+      assert_equal @item.token[0..24], @item.short_token
+      assert_equal 24, @item.short_token.length
+    end
+    
     should "find by token" do
       assert_equal @item, Item.find(@item.token)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_token_id
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000Z
+date: 2012-01-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70283871501780 !ruby/object:Gem::Requirement
+  requirement: &70314473800600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70283871501780
+  version_requirements: *70314473800600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70283871501060 !ruby/object:Gem::Requirement
+  requirement: &70314473799680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70283871501060
+  version_requirements: *70314473799680
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70283871500300 !ruby/object:Gem::Requirement
+  requirement: &70314473798880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70283871500300
+  version_requirements: *70314473798880
 - !ruby/object:Gem::Dependency
   name: dummier
-  requirement: &70283871499760 !ruby/object:Gem::Requirement
+  requirement: &70314473798140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70283871499760
+  version_requirements: *70314473798140
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70283871499140 !ruby/object:Gem::Requirement
+  requirement: &70314473797440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70283871499140
+  version_requirements: *70314473797440
 - !ruby/object:Gem::Dependency
   name: minitest_should
-  requirement: &70283871497700 !ruby/object:Gem::Requirement
+  requirement: &70314473796720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *70283871497700
+  version_requirements: *70314473796720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70283871496720 !ruby/object:Gem::Requirement
+  requirement: &70314473796060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 1.3.5
   type: :development
   prerelease: false
-  version_requirements: *70283871496720
+  version_requirements: *70314473796060
 description: Identifies your active records with a random token. For more information,
   please see the documentation.
 email:
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2547320390415965778
+      hash: -2635183054273131293
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2547320390415965778
+      hash: -2635183054273131293
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10