0.0
Low commit activity in last 3 years
A long-lived project that still receives updates
SuperToken provides you an easily way to geneatre uniques random tokens for any model in ruby on rails and gives you ability to add prefix of token and change length.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 0
~> 2.2

Runtime

 Project Readme

Build Status Gem Version Dependency Status Code Climate Test Coverage

SuperToken

SuperToken is a fork of HasSecureToken module which is provides an easy way to generate uniques random tokens for any model in ruby on rails. SuperToken gives you a way to prefix token with string and change token length.

Installation

Add this line to your application's Gemfile:

gem 'super_token'

And then run:

$ bundle

Or install it yourself as:

$ gem install super_token

Setting your Model

The first step is to generate a migration in order to add the token key field.

rails g migration AddTokenToAPIKey token:string secret_key:string public_key:string
=>
   invoke  active_record
   create    db/migrate/20150424010931_add_token_to_api_key_.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:

# Schema: APIKey(token:string, secret_key:string, public_key:string)
class APIKey < ActiveRecord::Base
  has_secure_token
end

# test regular has_secure_token features
api_key = APIKey.new
api_key.save
api_key.token # => "pX27zsMN2ViQKta1bGfLmVJE"
api_key.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):

# Schema: APIKey(token:string, secret_key:string, public_key:string)
class APIKey < ActiveRecord::Base
  # super_token add two options for has_secure_token (prefix and length)
  has_secure_token :secret_key, prefix: 'sk_', length: 48
  has_secure_token :public_key, prefix: 'pk_', length: 48
end


api_key = APIKey.new
api_key.save
api_key.secret_key # => "sk_pX27zsMN2ViQKta1bGfLmVJEiQKta1bGfLmVJE"
api_key.public_key # => "pk_pX27zsMN2ViQKta1bGfLmVJEiQKta1bGfLmVJE"
api_key.regenerate_secret_key # => true

Running tests

Running

$ rake test

Should return

9 runs, 17 assertions, 0 failures, 0 errors, 0 skips

Contributing

  1. Fork it ( https://github.com/ecleel/super_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