super_token 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecc5d2fae093eb6123d5b016b48d1e63977f1f0f
+  data.tar.gz: 1192d3a13440aff01cbbf43316447db20e5e6f9a
+SHA512:
+  metadata.gz: 4e5d89fc1795b0f6d3350f87ff2ecd22a8b5036b5409d0849cce5123129cdf2cb98f3f27bef37a6190411c52ccf40d11bd906e64fbd4bf15c3af039e2c7ad4b3
+  data.tar.gz: 9bc9b3e09da2cb9b0b480260dc1028a6b9904366b8fcb4dec8b9881e98f1c2c50e2b3f0e974a796a60f758b6ba0382987093af54a653dc1a851ec01f22ec17cd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+gemfile:
+  - gemfiles/rails3.gemfile
+  - gemfiles/rails4_0.gemfile
+  - gemfiles/rails4_1.gemfile
+  - gemfiles/rails4_2.gemfile
+before_install:
+- gem update --system
+- gem install bundler
+install: bundle install
+script: bundle exec rake build
+env:
+  global:
+    secure: 0dc92adb26454f7a8fcf0639f9f85150fd82b08cabfe8a66e0c5dc85a9cdddbc83b38468f863048af3e7dec3dd3e354e0a50c1b327a1a9f556357897e13e8bc6
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in has_secure_password.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 robertomiranda
+
+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,85 @@
+[![Build Status](https://travis-ci.org/robertomiranda/has_secure_token.png)](https://travis-ci.org/robertomiranda/has_secure_token)
+[![Gem Version](https://badge.fury.io/rb/has_secure_token.svg)](http://badge.fury.io/rb/has_secure_token)
+[![Dependency Status](https://gemnasium.com/robertomiranda/has_secure_token.svg)](https://gemnasium.com/robertomiranda/has_secure_token)
+[![Code Climate](https://codeclimate.com/github/robertomiranda/has_secure_token/badges/gpa.svg)](https://codeclimate.com/github/robertomiranda/has_secure_token)
+
+# HasSecureToken
+
+HasSecureToken provides an easy way to generate uniques random tokens for any model in ruby on rails. **SecureRandom::base58** is used to generate the 24-character unique tokens, so collisions are highly unlikely.
+
+**Note** If you're worried about possible collissions, there's a way to generate a race condition in the database in the same way that [validates_uniqueness_of](http://api.rubyonrails.org/classes/ActiveRecord/Validations/ClassMethods.html) can. You're encouraged to add an unique index in the database to deal with this even more unlikely scenario.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_secure_token'
+
+And then run:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_secure_token
+
+## Setting your Model
+
+The first step is to generate a migration in order to add the token key field.
+
+```ruby
+rails g migration AddTokenToUsers token:string
+=>
+   invoke  active_record
+   create    db/migrate/20150424010931_add_token_to_users.rb
+```
+
+Then run `rake db:migrate` in order to update users table in the database. The next step is to add `has_secure_token`
+ to the model:
+```ruby
+# Schema: User(token:string, auth_token:string)
+class User < ActiveRecord::Base
+  has_secure_token
+end
+
+user = User.new
+user.save
+user.token # => "pX27zsMN2ViQKta1bGfLmVJE"
+user.regenerate_token # => true
+```
+
+To use a custom column to store the token key field you can specify the column_name option. See example above (e.g: auth_token):
+
+```ruby
+# Schema: User(token:string, auth_token:string)
+class User < ActiveRecord::Base
+  has_secure_token :auth_token
+end
+
+user = User.new
+user.save
+user.auth_token # => "pX27zsMN2ViQKta1bGfLmVJE"
+user.regenerate_auth_token # => true
+```
+
+## Running tests
+
+Running
+
+```shell
+$ rake test
+```
+
+Should return
+
+```shell
+5 runs, 9 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/robertomiranda/has_secure_token/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :help do
+  puts "Available rake tasks: "
+  puts "rake console - Run a IRB console with all enviroment loaded"
+  puts "rake test - Run tests"
+end
+
+task :test do
+  Dir.chdir('test')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '../lib'
+  t.libs << '../test'
+  t.test_files = FileList['*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/gemfiles/rails3.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 3.2.0'
+end

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.0.0'
+  gem 'minitest', '~> 4.2'
+end

data/gemfiles/rails4_1.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.1.0'
+end

data/gemfiles/rails4_2.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec :path => '../'
+
+group :development, :test do
+  gem 'activerecord', '~> 4.2.0'
+end

data/lib/active_support/core_ext/securerandom.rb

@@ -0,0 +1,23 @@
+require 'securerandom'
+
+module SecureRandom
+  BASE58_ALPHABET = ('0'..'9').to_a  + ('A'..'Z').to_a + ('a'..'z').to_a - ['0', 'O', 'I', 'l']
+  # SecureRandom.base58 generates a random base58 string.
+  #
+  # The argument _n_ specifies the length, of the random string to be generated.
+  #
+  # If _n_ is not specified or is nil, 16 is assumed. It may be larger in the future.
+  #
+  # The result may contain alphanumeric characters except 0, O, I and l
+  #
+  #   p SecureRandom.base58 #=> "4kUgL2pdQMSCQtjE"
+  #   p SecureRandom.base58(24) #=> "77TMHrHJFvFDwodq8w7Ev2m7"
+  #
+  def self.base58(n = 16)
+    SecureRandom.random_bytes(n).unpack("C*").map do |byte|
+      idx = byte % 64
+      idx = SecureRandom.random_number(58) if idx >= 58
+      BASE58_ALPHABET[idx]
+    end.join
+  end
+end

data/lib/super_token.rb

@@ -0,0 +1,43 @@
+require 'active_record'
+module ActiveRecord
+  module SecureToken
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Example using #has_secure_token
+      #
+      #   # Schema: User(token:string, auth_token:string, api_key:string)
+      #   class User < ActiveRecord::Base
+      #     has_secure_token
+      #     has_secure_token :auth_token, prefix: 'ut_'
+      #     has_secure_token :api_key,    prefix: 'ak_', length: 42
+      #   end
+      #
+      #   user = User.new
+      #   user.save
+      #   user.token # => "pX27zsMN2ViQKta1bGfLmVJE"
+      #   user.auth_token # => "77TMHrHJFvFDwodq8w7Ev2m7"
+      #   user.api_key # => "ak_1wkenr7vcAb9tH1jyQzvBdxBg8jC2bSv8ySM335"
+      #   user.regenerate_token # => true
+      #   user.regenerate_auth_token # => true
+      #
+      # <tt>SecureRandom::base58</tt> is used to generate the 24-character unique token, so collisions are highly unlikely.
+      #
+      # Note that it's still possible to generate a race condition in the database in the same way that
+      # {validates_uniqueness_of}[rdoc-ref:Validations::ClassMethods#validates_uniqueness_of] can.
+      # You're encouraged to add a unique index in the database to deal with this even more unlikely scenario.
+      def has_secure_token(attribute = :token, length: 24, prefix: '')
+        # Load securerandom only when has_secure_token is used.
+        require 'active_support/core_ext/securerandom'
+        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_secure_token(length, prefix) }
+        before_create { self.send("#{attribute}=", self.class.generate_unique_secure_token(length, prefix)) unless self.send("#{attribute}?")}
+      end
+
+      def generate_unique_secure_token(length, prefix)
+        token_length = length - prefix.length
+        prefix + SecureRandom.base58(token_length)
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, ActiveRecord::SecureToken)

data/lib/super_token/version.rb

@@ -0,0 +1,3 @@
+module SuperToken
+  VERSION = "1.0.0"
+end

data/super_token.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'super_token/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "super_token"
+  spec.version       = SuperToken::VERSION
+  spec.authors       = ["Roberto Miranda Altamar", "Abdulaziz Alshetwi"]
+  spec.email         = ["rjmaltamar@gmail.com", "e@ecleel.com"]
+  spec.summary       = %q{HasSecureToken with more options}
+  spec.description   = %q{SecureToken provides you an easily way to geneatre uniques random tokens for any model in ruby on rails. **SecureRandom::base58** is used to generate the 24-character unique token, so collisions are highly unlikely.}
+  spec.homepage      = "https://github.com/ecleel/super_token"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'sqlite3'
+end

data/test/has_secure_token_test.rb

@@ -0,0 +1,61 @@
+require "test_helper"
+
+class SecureTokenTest < MiniTest::Unit::TestCase
+  def setup
+    @user = User.new
+  end
+
+  def test_token_values_are_generated_for_specified_attributes_and_persisted_on_save
+    @user.save
+    refute_nil @user.token
+    refute_nil @user.auth_token
+  end
+
+  def test_regenerating_the_secure_token
+    @user.save
+    old_token = @user.token
+    old_auth_token = @user.auth_token
+    @user.regenerate_token
+    @user.regenerate_auth_token
+
+    refute_equal @user.token, old_token
+    refute_equal @user.auth_token, old_auth_token
+  end
+
+  def test_token_value_not_overwritten_when_present
+    @user.token = "custom-secure-token"
+    @user.save
+
+    assert_equal @user.token, "custom-secure-token"
+  end
+
+  def test_token_value_default_length_is_24
+    default_length = 24
+    @user.save
+    
+    assert_equal default_length, @user.token.length
+    assert_equal default_length, @user.auth_token.length
+    refute_equal default_length, @user.api_key.length
+  end
+
+  def test_token_length_option_change_token_length
+    @user.save
+    
+    assert_equal 42, @user.api_key.length
+  end
+  
+  def test_regenerating_token_with_same_length
+    @user.save
+    @user.regenerate_api_key
+    
+    assert_equal 24, @user.token.length
+    assert_equal 24, @user.auth_token.length
+    assert_equal 42, @user.api_key.length
+  end
+  
+  def test_prefix_prepend_in_token
+    @user.save
+    
+    assert @user.api_key.start_with?("ak_")
+  end
+end

data/test/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  has_secure_token
+  has_secure_token :auth_token, prefix: 'ut_'
+  has_secure_token :api_key,    prefix: 'ak_', length: 42
+end

data/test/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :token
+    t.string :auth_token
+    t.string :api_key
+  end
+end

data/test/securerandom_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+
+class SecureRandomTest < MiniTest::Unit::TestCase
+  def test_base58
+    s1 = SecureRandom.base58
+    s2 = SecureRandom.base58
+
+    refute_equal s1, s2
+    assert_equal 16, s1.length
+  end
+
+  def test_base58_with_length
+    s1 = SecureRandom.base58(24)
+    s2 = SecureRandom.base58(24)
+
+    refute_equal s1, s2
+    assert_equal 24, s1.length
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+require "super_token"
+require "minitest/autorun"
+require "minitest/unit"
+
+Dir["models/*.rb"].each {|file| require file }
+
+def assert_not_nil(exp, msg=nil)
+  msg = message(msg) { "<#{mu_pp(exp)}> expected to not be nil" }
+  assert(!exp.nil?, msg)
+end
+
+DB_FILE = 'tmp/test_db'
+FileUtils.mkdir_p File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => DB_FILE
+
+load 'schema.rb'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: super_token
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roberto Miranda Altamar
+- Abdulaziz Alshetwi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SecureToken provides you an easily way to geneatre uniques random tokens
+  for any model in ruby on rails. **SecureRandom::base58** is used to generate the
+  24-character unique token, so collisions are highly unlikely.
+email:
+- rjmaltamar@gmail.com
+- e@ecleel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails3.gemfile
+- gemfiles/rails4_0.gemfile
+- gemfiles/rails4_1.gemfile
+- gemfiles/rails4_2.gemfile
+- lib/active_support/core_ext/securerandom.rb
+- lib/super_token.rb
+- lib/super_token/version.rb
+- super_token.gemspec
+- test/has_secure_token_test.rb
+- test/models/user.rb
+- test/schema.rb
+- test/securerandom_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ecleel/super_token
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: HasSecureToken with more options
+test_files:
+- test/has_secure_token_test.rb
+- test/models/user.rb
+- test/schema.rb
+- test/securerandom_test.rb
+- test/test_helper.rb