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_.rbThen 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 # => trueTo 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 # => trueRunning tests
Running
$ rake testShould return
9 runs, 17 assertions, 0 failures, 0 errors, 0 skipsContributing
- Fork it ( https://github.com/ecleel/super_token/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request