has_token_id 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a1c0ccaba9d98fa8f1e2018bfd79d3d6f53b33b
+  data.tar.gz: bb715b4c6c5ce510ad8f78e37d19dbb429c91de3
+SHA512:
+  metadata.gz: be8a58757749a4f5a4687310729535e3c62511f8640cec9ec582f3477d7ebc92207f8513c681fd2897ecb1d5c80080425a8cb1e794b41c9925423e275e68aa23
+  data.tar.gz: a0604087c626d0a8dcf7dd6ee69f36876baa7bd34d063de53716b9044402cc8f53b8721c57668ce6b5f994bd2e54a2470c1dc08f8bd725760febd08479b040c6

data/README.md

@@ -1,4 +1,4 @@
-# has_token_id [![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)
+# has_token_id [![Build Status](https://secure.travis-ci.org/citrus/has_token_id.png)](http://travis-ci.org/citrus/has_token_id)
 
 Identify your active records with random tokens when you don't want your users to see a sequential ID.
 
@@ -10,7 +10,7 @@ Installation
 Add has_token_id to your Gemfile like so:
 
 ```ruby
-gem 'has_token_id', '~> 0.3.1' 
+gem 'has_token_id', '~> 0.4.0'
 ```
 
 Now run `bundle install` and you're good to go!
@@ -73,7 +73,7 @@ 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 
+:prefix             => nil, # if nil use first letter of class name
 :length             => 24,
 :short_token_length => 8,
 :param_name         => 'token',
@@ -154,4 +154,4 @@ bundle exec rake
 License
 ------------------------------------------------------------------------------
 
-Copyright (c) 2011 - 2012 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.
+Copyright (c) 2011 - 2016 Spencer Steffen and Citrus, released under the New BSD License All rights reserved.

data/has_token_id.gemspec

@@ -12,19 +12,19 @@ Gem::Specification.new do |s|
   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_dependency('activerecord',  '~> 3')
+  s.add_dependency('activesupport', '~> 3')
+
+  s.add_development_dependency('rails',           '~> 3')
   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('minitest',        '~> 2.0')
+  s.add_development_dependency('minitest_should', '~> 0.3')
   s.add_development_dependency('sqlite3',         '>= 1.3.5')
 
 end

data/lib/has_token_id.rb

@@ -1,32 +1,34 @@
 require 'digest/sha1'
 require 'has_token_id/concern'
+require 'has_token_id/finder_methods'
 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
-                  
+  module ActiveRecordTie
+
+    def has_token_id(options={})
+      self.send(:include, HasTokenId::Concern)
+      @has_token_id_options = HasTokenId.default_token_options.merge(options)
+    end
+
+    def has_token_id_options
+      @has_token_id_options
     end
-        
+
   end
-  
+
   def self.default_token_options
     @default_token_options ||= {
-      :prefix             => nil, # if nil use first letter of class name 
+      :prefix             => nil, # if nil use first letter of class name
       :length             => 24,
       :short_token_length => 8,
       :param_name         => 'token',
       :case_sensitive     => false
     }
   end
-  
-end # Has Token
 
-ActiveRecord::Base.send(:include, HasTokenId)
+end
+
+ActiveRecord::Base.send(:extend, HasTokenId::ActiveRecordTie)
+ActiveRecord::Base.send(:extend, HasTokenId::FinderMethods)

data/lib/has_token_id/concern.rb

@@ -1,36 +1,17 @@
 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? }
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+      base.send(:include, InstanceMethods)
+      base.class_eval do
+        validates :token, :presence => true, :uniqueness => true
+        before_validation :generate_token, :on => :create, :if => proc{|record| record.token.nil? }
+      end
     end
 
-    # Returns the resource's token
-    def to_param
-      self.send(self.class.has_token_id_options[:param_name])
-    end
-    
-    # Returns the first N digits of the resource's token
-    # N = has_token_id_options[:short_token_length]
-    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
-        self.token = self.class.generate_unique_token
-      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
@@ -38,10 +19,10 @@ module HasTokenId
         @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
+        record, options = true, @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]
@@ -50,45 +31,32 @@ module HasTokenId
         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) rescue nil
-      end
-      
-      # Find by token and raise error if no record is found
-      def find_by_token!(token)
-        record = find_by_token(token)
-        raise ActiveRecord::RecordNotFound, "Could not find #{self.name} with token #{token.inspect}" if record.nil?
-        record
+
+    end # ClassMethods
+
+    module InstanceMethods
+
+      # Returns the resource's token
+      def to_param
+        self.send(self.class.has_token_id_options[:param_name])
       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)
+
+      # Returns the first N digits of the resource's token
+      # N = has_token_id_options[:short_token_length]
+      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 token_with_table_name
-        [ table_name, has_token_id_options[:param_name] ].join(".")
+
+      def generate_token
+        self.token = self.class.generate_unique_token
       end
-      
-    end # ClassMethods  
+
+    end # InstanceMethods
 
   end # Concern
-  
+
 end # HasTokenId

data/lib/has_token_id/finder_methods.rb

@@ -0,0 +1,41 @@
+module HasTokenId
+  module FinderMethods
+
+    # 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 and raise error if no record is found
+    def find_by_token!(token)
+      record = find_by_token(token)
+      raise ActiveRecord::RecordNotFound, "Could not find #{self.name} with token #{token.inspect}" if record.nil?
+      record
+    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]}"
+    end
+
+  end
+end

data/lib/has_token_id/version.rb

@@ -1,3 +1,3 @@
 module HasTokenId
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/test/test_helper.rb

@@ -13,13 +13,12 @@ rescue LoadError
 end
 
 env = File.expand_path("../dummy/config/environment.rb",  __FILE__)
-if File.exists?(env)
+if File.exist?(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"

data/test/unit/concern_test.rb

@@ -3,25 +3,25 @@ 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  
+
+  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?
@@ -31,105 +31,105 @@ class ConcernTest < MiniTest::Should::TestCase
     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)    
+    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, :short_token_length => 8, :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 "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
-    
+
     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)
         assert_equal @item, Item.find_by_token(@item.token)
         assert_equal @item, Item.find_by_token!(@item.token)
-      end    
-      
+      end
+
       should "find by token even if it's all uppercase" do
         assert_equal @item, Item.find(@item.token.upcase)
         assert_equal @item, Item.find_by_token(@item.token.upcase)
         assert_equal @item, Item.find_by_token!(@item.token.upcase)
       end
-      
+
       should "find by token even if it's all lowercase" do
         assert_equal @item, Item.find(@item.token.downcase)
         assert_equal @item, Item.find_by_token(@item.token.downcase)
         assert_equal @item, Item.find_by_token!(@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)
         assert_equal @item, Item.find_by_token(@item.token)
         assert_equal @item, Item.find_by_token!(@item.token)
-      end    
-      
+      end
+
       should "not find by token if it's all uppercase" do
         assert_raises ActiveRecord::RecordNotFound do
           Item.find(@item.token.upcase)
@@ -139,7 +139,7 @@ class ConcernTest < MiniTest::Should::TestCase
           Item.find_by_token!(@item.token.upcase)
         end
       end
-      
+
       should "not find by token if it's all lowercase" do
         assert_raises ActiveRecord::RecordNotFound do
           Item.find(@item.token.downcase)
@@ -149,36 +149,36 @@ class ConcernTest < MiniTest::Should::TestCase
           assert Item.find_by_token!(@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    
+
+     should "account for longer prefixes" do
        assert_equal 40, @item.token.length
-       assert_match /^item-(.*)/, @item.token
+       assert_match Regexp.new("^item-(.*)"), @item.token
      end
-    
+
   end
-        
+
 end

data/test/unit/has_token_id_test.rb

@@ -1,17 +1,13 @@
 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

metadata

@@ -1,93 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: has_token_id
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Spencer Steffen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000Z
+date: 2016-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70291048984920 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70291048984920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70291048982160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70291048982160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70291048980960 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70291048980960
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: dummier
-  requirement: &70291048979200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70291048979200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70291048977980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70291048977980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest_should
-  requirement: &70291048976940 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '0.3'
   type: :development
   prerelease: false
-  version_requirements: *70291048976940
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70291048975440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
   type: :development
   prerelease: false
-  version_requirements: *70291048975440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
 description: Identifies your active records with a random token. For more information,
   please see the documentation.
 email:
@@ -96,8 +116,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -105,6 +125,7 @@ files:
 - has_token_id.gemspec
 - lib/has_token_id.rb
 - lib/has_token_id/concern.rb
+- lib/has_token_id/finder_methods.rb
 - lib/has_token_id/table_definition.rb
 - lib/has_token_id/version.rb
 - test/dummy_hooks/after_migrate.sample
@@ -116,33 +137,26 @@ files:
 - test/unit/table_definition_test.rb
 homepage: https://github.com/citrus/has_token_id
 licenses: []
+metadata: {}
 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: -3396225044547462416
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3396225044547462416
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Identifies your active records with a random token.
 test_files:
 - test/dummy_hooks/after_migrate.sample