token_attribute 0.0.4 → 0.1.0

data/RELEASE_NOTE.md

@@ -0,0 +1,8 @@
+Release notes
+=====
+
+## 0.1.0
+
+### `#token_attribute`
+
+Add option `length` to specify token length.

data/lib/token_attribute/version.rb

@@ -1,3 +1,3 @@
 module TokenAttribute
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/token_attribute.rb

@@ -6,6 +6,7 @@ module TokenAttribute
   extend ActiveSupport::Concern
 
   module ClassMethods
+    DEFAULT_TOKEN_LENGTH = 10
 
     # Macro-ish method to define token-setter.
     # #set_#{attribute_name} will be defined to set unique token.
@@ -18,30 +19,36 @@ module TokenAttribute
         attr_protected *attribute_names
       end
 
+      # `/ 2` because "The length of the result string is twice of n".
+      # see: http://www.ruby-doc.org/stdlib-1.9.3/libdoc/securerandom/rdoc/SecureRandom.html#method-c-hex
+      raise "Can't set odd number to token length" if options[:length] && (options[:length] % 2) == 1
+      length = (options[:length] || DEFAULT_TOKEN_LENGTH) / 2
+
       attribute_names.each do |attribute|
 
         generator_method_name = "generate_#{attribute}"
+        setter_method_name    = "set_#{attribute}"
+        attribute_to_scope    = Array.wrap(options[:scope])
 
         define_method generator_method_name do
-          key = SecureRandom.hex(10)
+          key = SecureRandom.hex(length)
         end
-        scope_items = Array.wrap(options[:scope])
-
-        setter_method_name = "set_#{attribute}"
 
         define_method setter_method_name do
 
-          key = send generator_method_name
+          candidate = send generator_method_name
 
-          cond = {}
-          scope_items.each do |scope_item|
-            cond[scope_item] = self.send(scope_item)
+          # Gererate scope condition
+          condition = {}
+          attribute_to_scope.each do |name|
+            condition[name] = self.attributes[name]
           end
-          cond.merge!(attribute => key)
+          condition.merge!(attribute => candidate)
 
-          unless self.class.where(cond).exists?
-            self[attribute] = key
+          unless self.class.where(condition).exists?
+            self[attribute] = candidate
           else
+            # Recur if the token is already used
             send setter_method_name
           end
         end

data/test/lib/token_attribute_test.rb

@@ -22,6 +22,7 @@ class TokenAttributeTest < Test::Unit::TestCase
         assert klass.new.methods.map(&:to_sym).include? method_name
       end
     end
+
     test 'can make attr_protected with option' do
       klass = User.dup
       klass.class_eval do
@@ -30,7 +31,8 @@ class TokenAttributeTest < Test::Unit::TestCase
       end
       assert klass.protected_attributes.include? :download_ticket
     end
-    test 'can be scoped' do
+
+    test 'can scope' do
       klass = User.dup
       klass.class_eval do
         include TokenAttribute
@@ -43,13 +45,39 @@ class TokenAttributeTest < Test::Unit::TestCase
       [one, two].each {|u| u.save }
       assert one.download_ticket == two.download_ticket
     end
+
+    describe 'Token length' do
+      test '10 by default' do
+        klass = User.dup
+        klass.class_eval do
+          include TokenAttribute
+          token_attribute :download_ticket
+          before_save :set_download_ticket
+        end
+        one = klass.new :name => 'fujimura'
+        one.save
+        assert_equal one.download_ticket.length, 10
+      end
+
+      test 'can be configured' do
+        klass = User.dup
+        klass.class_eval do
+          include TokenAttribute
+          token_attribute :download_ticket, :length => 8
+          before_save :set_download_ticket
+        end
+        one = klass.new :name => 'fujimura'
+        one.save
+        assert_equal one.download_ticket.length, 8
+      end
+    end
   end
 
   context 'class with access_token as token_attribute' do
 
     describe '#generate_access_token' do
       test 'returns random string' do
-        stub(SecureRandom).hex(10) { 'abcde' }
+        stub(SecureRandom).hex { 'abcde' }
         assert_equal @user.generate_access_token, 'abcde'
       end
     end
@@ -59,6 +87,7 @@ class TokenAttributeTest < Test::Unit::TestCase
         @user.set_access_token
         assert @user.access_token != nil
       end
+
       test 'set again if it duplicates' do
         dup = 'duplicating'
         User.create :access_token => dup
@@ -78,5 +107,4 @@ class TokenAttributeTest < Test::Unit::TestCase
       assert coupon.code == 'my code'
     end
   end
-
 end

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require File.expand_path('../../lib/token_attribute', __FILE__)
 require 'minitest/unit'
 require 'contest'
 require 'rr'
-require 'ruby-debug'
+require 'pry'
 require 'turn'
 Test::Unit::TestCase.send :include, RR::Adapters::TestUnit
 

data/token_attribute.gemspec

@@ -27,9 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "contest"
   s.add_development_dependency "turn", '>= 0.8.3'
   s.add_development_dependency "rr"
-  if RUBY_VERSION.to_f == 1.9
-    s.add_development_dependency "ruby-debug19"
-  else
-    s.add_development_dependency "ruby-debug"
-  end
+  s.add_development_dependency "pry"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_attribute
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-25 00:00:00.000000000Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70158298353140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158298353140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70158298352680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70158298352680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70158298352300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298352300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70158298351880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298351880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70158298351460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298351460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: contest
-  requirement: &70158298351040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298351040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70158298350540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: 0.8.3
   type: :development
   prerelease: false
-  version_requirements: *70158298350540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70158298350160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298350160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70158298349720 !ruby/object:Gem::Requirement
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158298349720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Small macro to generate unique random token attribute for ActiveRecord
 email:
 - me@fujimuradaisuke.com
@@ -121,6 +166,7 @@ files:
 - .travis.yml
 - Gemfile
 - README.md
+- RELEASE_NOTE.md
 - Rakefile
 - TODO.md
 - lib/token_attribute.rb
@@ -148,10 +194,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: token_attribute
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Small macro to generate unique random token attribute for ActiveRecord
 test_files:
 - test/lib/token_attribute_test.rb
 - test/test_helper.rb
+has_rdoc: