simple_token 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script:
+  - "bundle exec rake spec"
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'sqlite3'
+gem 'rspec',              :group => [ :test, :development ]
+gem 'nyan-cat-formatter', :group => [ :test, :development ]
+
+group :test do
+  gem 'simplecov', :require => false
+  gem 'factory_girl'
+end
+
+# Specify your gem's dependencies in simple_token.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Enrique Vidal
+
+MIT License
+
+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/README.md

@@ -0,0 +1,57 @@
+# SimpleToken
+
+[![Build Status](https://secure.travis-ci.org/cloverinteractive/simple_token.png?branch=master)](http://travis-ci.org/cloverinteractive/simple_token)
+
+Add an unique 64 chars sha2 or secure random token to your active record models.
+
+**Note:** You should definately try `postgresql` native `UUID` support, if that's not a possibility then `simple_token` has your back.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_token'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_token
+
+## Usage
+
+SimpleToken only has two dependencies, `activerecord` and `activesupport` and it's usage is the same as every `acts_as_` rails plugin out there.
+
+By default SimpleToken expects you to have a `token` field in your table, but I'll show you how to customize this in a bit.
+
+### Default settings
+
+Just a simple call inside your model like this:
+
+```ruby
+class Post < ActiveRecord::Base
+  has_simple_token
+end
+```
+
+### Custom settings
+
+By default SimpleToken, uses sha2 as it's digest algorithm and expects a token field to exist in your table but we can change this:
+
+```ruby
+class User < ActiveRecord::Base
+  has_simple_token :token_field => :secret_hash, :digest_type => :secure_random
+end
+```
+
+This model will now use `secure_random` to generate the secret token and it will write it to the `secret_hash` field on the users table.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+desc 'Default: run all specs.'
+task :default => :spec
+
+require 'rspec/core/rake_task'
+desc 'Run the test suite.'
+RSpec::Core::RakeTask.new :spec

data/lib/simple_token/rails.rb

@@ -0,0 +1,57 @@
+module SimpleToken
+  module Rails
+    def has_simple_token( options={} )
+      cattr_accessor :token_field, :digest_type
+
+      return if included_modules.include? InstanceMethods
+
+      self.token_field  = options[:token_field]  || :token
+      self.digest_type  = options[:digest_type]  || :sha2
+
+      include InstanceMethods
+
+      define_token_getter
+    end
+
+    def define_token_getter
+      define_method( token_field ) do
+        return self[ token_field ] unless self[ token_field ].blank?
+
+        new_token = case digest_type
+          when :sha2          then create_sha2_token
+          when :secure_random then create_secure_random_token
+        end
+
+        self[ token_field ] = new_token
+      end
+    end
+
+    module InstanceMethods
+      extend ActiveSupport::Concern
+
+      included do
+        private
+
+        def create_sha2_token
+          token_lookup do
+            salt = rand( 36**12 ).to_s 36
+            seed_content = "#{ salt }#{ Time.now.to_i }#{ self.hash }".scan( /./ ).shuffle.join
+            new_token = Digest::SHA2.hexdigest seed_content
+          end
+        end
+
+        def create_secure_random_token
+          token_lookup { SecureRandom.hex 32 }
+        end
+
+        def token_lookup( &block )
+          begin
+            new_token = block.call
+          end while self.class.exists? token_field => new_token
+
+          new_token
+        end
+      end
+    end
+  end
+end

data/lib/simple_token/version.rb

@@ -0,0 +1,3 @@
+module SimpleToken
+  VERSION = "0.0.1"
+end

data/lib/simple_token.rb

@@ -0,0 +1,10 @@
+require "simple_token/version"
+require "simple_token/rails"
+
+module SimpleToken
+  def self.included( base )
+    base.extend Rails
+  end
+end
+
+ActiveRecord::Base.send( :include, SimpleToken ) if defined?( ActiveRecord::Base ) and defined?( ActiveSupport::Concern )

data/simple_token.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_token/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "simple_token"
+  gem.version       = SimpleToken::VERSION
+  gem.authors       = ["Enrique Vidal"]
+  gem.email         = ["enrique@cloverinteractive.com"]
+  gem.description   = %q{Easily create unique tokens in active record models}
+  gem.summary       = %q{Simple token creation gem}
+  gem.homepage      = "http://cloverinteractive.github.com/simple_token/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'activesupport'
+end

data/spec/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_simple_token
+end

data/spec/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_simple_token :token_field => :secret_hash, :digest_type => :secure_random
+end

data/spec/config/database.yml

@@ -0,0 +1,4 @@
+test:
+  sqlite:
+    adapter: sqlite3
+    database: ":memory:"

data/spec/db/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.string   "token"
+
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string "username"
+    t.string "secret_hash"
+
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  sequence :name do |n|
+    "dummy#{ n }"
+  end
+
+  factory :post do
+    title { generate :name }
+  end
+
+  factory :user do
+    username { generate :name }
+  end
+end

data/spec/simple_token_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+module SimpleToken
+  describe Rails do
+    context 'Default settings' do
+      let( :post ) { build :post }
+
+      it 'should respond to token' do
+        post.should respond_to( :token )
+      end
+
+      it 'should generate an unique 64 chars long SHA2 digest' do
+        token = post.token
+
+        token.should_not be_blank
+        token.length.should eql( 64 )
+      end
+
+      it 'should generate token before being persisted' do
+        post.token.should_not be_blank
+        post.should_not be_persisted
+      end
+
+      it 'should generate new tokens each time' do
+        persisted_post = create :post
+        persisted_post.token.should_not eql( post.token )
+      end
+
+      it 'should have a create_sha2_token private method' do
+        post.private_methods.should be_include( :create_sha2_token )
+      end
+
+      it 'should have a create_secure_random_token private method' do
+        post.private_methods.should be_include( :create_secure_random_token )
+      end
+
+      it 'should have a token_lookup private method' do
+        post.private_methods.should be_include( :token_lookup )
+      end
+
+      context :create_secure_random_token do
+        it 'should generate a 64 chars string' do
+          secure_random = post.send( :create_secure_random_token )
+          secure_random.should_not be_blank
+          secure_random.length.should eql( 64 )
+        end
+      end
+
+      context :create_sha2_token do
+        it 'should generate a 64 chars string' do
+          sha2 = post.send( :create_sha2_token )
+          sha2.should_not be_blank
+          sha2.length.should eql( 64 )
+        end
+      end
+
+      context :token_lookup do
+        it 'works by receiving a block of code to generate a string and returning such string if unique' do
+          lookup = post.send( :token_lookup ) do
+            'foo'
+          end
+
+          lookup.should eql( 'foo' )
+        end
+      end
+    end
+
+    context 'Custom settings' do
+      let( :user ) { build :user }
+
+      it 'should have a getter named secret_hash' do
+        user.should respond_to( :secret_hash )
+      end
+
+      it 'should have a 64 chars secret_hash' do
+        user.secret_hash.length.should eql( 64 )
+      end
+
+      it 'should generate a new token in secret_hash even if not persisted' do
+        user.secret_hash.should be_present
+        user.should_not be_persisted
+      end
+
+      it 'should generate a unique token each time' do
+        persisted_user = create :user
+        persisted_user.secret_hash.should_not eql( user.secret_hash )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+require 'rspec'
+require 'factory_girl'
+require 'active_record'
+require 'active_support'
+require 'simple_token'
+require 'sqlite3'
+require 'factories'
+
+SPEC_PATH = File.expand_path File.join( File.dirname __FILE__ )
+config    = YAML::load( IO.read( File.join SPEC_PATH, 'config', 'database.yml' ) )['test']['sqlite']
+
+# Connect to sqlite3 and load models
+ActiveRecord::Base.establish_connection config
+ActiveSupport::Dependencies.autoload_paths.unshift File.join( SPEC_PATH, 'app', 'models' )
+
+# Load schema.rb into sqlite3
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load File.join( SPEC_PATH, 'db', 'schema.rb' )
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.include FactoryGirl::Syntax::Methods
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: simple_token
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Enrique Vidal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily create unique tokens in active record models
+email:
+- enrique@cloverinteractive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_token.rb
+- lib/simple_token/rails.rb
+- lib/simple_token/version.rb
+- simple_token.gemspec
+- spec/app/models/post.rb
+- spec/app/models/user.rb
+- spec/config/database.yml
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/simple_token_spec.rb
+- spec/spec_helper.rb
+homepage: http://cloverinteractive.github.com/simple_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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple token creation gem
+test_files:
+- spec/app/models/post.rb
+- spec/app/models/user.rb
+- spec/config/database.yml
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/simple_token_spec.rb
+- spec/spec_helper.rb