tokenize 1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-11-30
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+init.rb
+lib/tokenize.rb
+test/test_helper.rb
+test/test_tokenize.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= Tokenize
+
+* http://github.com/yickster/tokenize
+
+== DESCRIPTION:
+
+  Quick Dirty Token generation
+  by Nick Merwin (lemurheavy.com) 11.29.2009
+
+== SYNOPSIS:
+
+  class Foo < ActiveRecord::Base
+    tokenize :api_key, :size => 32, :type => :base64
+    tokenize :public_key, :size => 64, :type => :hex, :url_safe => false
+  end
+
+== REQUIREMENTS:
+
+none
+
+== INSTALL:
+
+sudo gem i tokenize
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nick Merwin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/tokenize'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'tokenize' do
+  self.developer 'Nick Merwin', 'nick@lemurheavy.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.spec_extras[:rdoc_options] = ""
+  self.spec_extras[:homepage] = %q{http://github.com/yickster/tokenize}  
+  self.extra_deps         = [['activerecord']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/init.rb

@@ -0,0 +1 @@
+require 'tokenize'

data/lib/tokenize.rb

@@ -0,0 +1,64 @@
+# LemurTokenizer
+#   Quick Dirty Token generation
+#   by Nick Merwin 11.29.2009
+
+module LemurTokenize
+  VERSION = "1.0"
+  
+  # Usage: 
+  #   class Foo < ActiveRecord::Base
+  #     tokenize :api_key, :size => 32
+  #     tokenize :public_token, :size => 5, :type => :base64
+  #   end
+  #
+  # Options:
+  # 
+  # * column 
+  # 
+  #   The column that will store the token.
+  #   default - :token
+  # 
+  # * size
+  # 
+  #   The length of the token string
+  #   default - 32
+  # 
+  # * when
+  # 
+  #   Callback
+  #   default - :before_create
+  # 
+  # * type
+  # 
+  #   The type of random generator - :hex or :base64
+  #   default - :hex
+  # 
+  # * url_safe
+  # 
+  #   Parses out \W characters (for URL shorteners,etc)
+  #   default - true
+  #   
+  def tokenize(column=:token, opts={})
+    generate_method = "generate_#{column}".to_sym
+    define_method generate_method do
+      opts = {:column => column, :type => :hex}.merge(opts)
+      while true
+        proposed_token = ActiveSupport::SecureRandom.send(opts[:type],32)
+        proposed_token.gsub!(/\W/,'') unless opts[:url_safe] == false
+        #TODO: fill in gaps left by url safety
+        proposed_token = proposed_token.to_s[0..(opts[:size] || 32)]
+
+        break unless self.class.exists?(opts[:column] => proposed_token)
+      end
+      send "#{opts[:column]}=", proposed_token
+      raise IncompatibleTokenColumn unless send(opts[:column]) == proposed_token
+    end
+    
+    before_create generate_method
+  end
+    
+  class IncompatibleTokenColumn < StandardError; end
+end
+
+require "active_record"
+ActiveRecord::Base.extend(LemurTokenize)

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'active_record'
+require 'test/unit'
+require 'shoulda'
+require 'factory_girl'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'tokenize'
+require File.dirname(__FILE__) + "/../init"
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => 'test.db'
+)
+
+ActiveRecord::Base.connection.drop_table :dummies rescue nil
+ActiveRecord::Base.connection.drop_table :bad_dummies rescue nil
+
+ActiveRecord::Base.connection.create_table :dummies do |t|
+  t.string :token
+  t.string :api_key
+  t.string :public_token
+  
+  t.string :private_key
+end
+
+ActiveRecord::Base.connection.create_table :bad_dummies do |t|
+  t.integer :int_field
+end

data/test/test_tokenize.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+Factory.define(:dummy) {}
+Factory.define(:bad_dummy) {}
+
+class Dummy < ActiveRecord::Base
+  tokenize
+  tokenize :public_token, :size => 5
+  tokenize :api_key, :type => :hex
+  tokenize :private_key, :type => :base64, :url_safe => false
+end
+
+class BadDummy < ActiveRecord::Base
+  tokenize :int_field
+end
+
+class TokenizeTest < Test::Unit::TestCase
+  context "An instance of a class that has tokenized attributes" do
+    
+    setup do
+      @dummy = Factory(:dummy)
+    end
+    
+    should "create generate methods" do
+      assert_respond_to @dummy, :generate_token
+      assert_respond_to @dummy, :generate_public_token
+      assert_respond_to @dummy, :generate_api_key
+      assert_respond_to @dummy, :generate_private_key
+    end
+    
+    should "use defaults" do
+      assert_match /[a-g0-9]{32}/, @dummy.token
+    end
+    
+    should "size generated token correctly" do
+      assert_match /[a-g0-9]{5}/, @dummy.api_key
+    end
+    
+    should "use correct random method" do
+      assert_match /[a-zA-Z0-9\W]{32}/, @dummy.private_key
+    end
+    
+    should "ensure url-safe generation" do
+      assert_no_match /\W/, @dummy.api_key
+    end
+    
+  end
+  
+  context "An instance of a class with an incorrect field type" do
+    setup do
+      @bad_dummy = Factory.build(:bad_dummy)
+    end
+    
+    should "raise an error" do
+      assert_raise LemurTokenize::IncompatibleTokenColumn do
+        @bad_dummy.save
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: tokenize
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Nick Merwin
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNDCCAhygAwIBAgIBADANBgkqhkiG9w0BAQUFADBAMQ0wCwYDVQQDDARuaWNr
+  MRowGAYKCZImiZPyLGQBGRYKbGVtdXJoZWF2eTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTAeFw0wOTA5MjkyMzEzMDVaFw0xMDA5MjkyMzEzMDVaMEAxDTALBgNVBAMMBG5p
+  Y2sxGjAYBgoJkiaJk/IsZAEZFgpsZW11cmhlYXZ5MRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3uflg3FiN5qVj79C
+  hL+IdQJI+t1bGLrcx38cgFk9wzsBWb4OuGJdfRfUputDQ1f0q+tmRO834YuiEzq9
+  Ekhv8GMQ4KepU6E6d1mbBVSovuDljxpprGDP1Aj/ahiG4vU26gE9IjNFxwlkRPov
+  jVgUNVU2iXtd7pAM3EeEIzSFXfoTOGl1sk6UXMlMRyD6rkuIHiM08+7Q6UMdkO49
+  fMqF49DeMrlJfY4HBbegAF4dpWNY3SPhFWtOcdtCRF0AplB7HtR5laBsAdHjz3gM
+  klk+KNM5vptxWJPIqvXWS4pPudBCwz40gXRGR+BpU0UQiTqp1FiKCgL7DI4/Tm62
+  CHNMvwIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU
+  DtwNA5H16pAiznZOti8bEjba8tUwDQYJKoZIhvcNAQEFBQADggEBALYguz5G0/OJ
+  xT+pCJlgQuU5XbKPx9dibev3ixqDaXz6F3rofNyskUGuCz80pIxwuVjsf7SC/l6x
+  iSqV4RZvqrQvgMa2VIQrbIfVya59CyFl+nlENev58nSZHo/3+AOK/rCLrvyRbv+y
+  NZocOuJdRiSWjnnRga8ccYA/Hu5OQsqUi3zWcZJx9Pf1yik/TGQBB5fVCg3wc/tT
+  86mx1YMM5+6jp62bpABA/ztg5a1AwPjLztZO+kdsa5JPAe8kEORjgFUQd0bgoG1k
+  CGOLg0n36R4a1G+c6Meu9GeNGECbxY/1lzZOU9gfTqKd3DB+14BvAyvc5dTbR/RX
+  DrswbWvrKlA=
+  -----END CERTIFICATE-----
+
+date: 2009-11-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  Quick Dirty Token generation
+    by Nick Merwin (lemurheavy.com) 11.29.2009
+email: 
+- nick@lemurheavy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/tokenize.rb
+- test/test_helper.rb
+- test/test_tokenize.rb
+has_rdoc: true
+homepage: http://github.com/yickster/tokenize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tokenize
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quick Dirty Token generation by Nick Merwin (lemurheavy.com) 11.29.2009
+test_files: 
+- test/test_helper.rb
+- test/test_tokenize.rb

metadata.gz.sig

@@ -0,0 +1 @@
+0����A�6�	Ó��0�c/��=���f�e_��Т]�����NC� K�|$7tjK��=��S+�/1�ܣ�T#��������)Ԃ���F���竸�ZΈ��OC��y�|ߗ:�h�3G�����9gg3%�q��:��2�`�tYDz���|U�\s�T4�t��[�1���G���Td4T�ޛ\P3,JW��%�c#[%���3��P�Mvc��>�
F�r˴��r�^��k�Ijit���k8�����WK�