README.md in super_token-1.0.0 vs README.md in super_token-1.1.0
- old
+ new
@@ -1,67 +1,71 @@
-[](https://travis-ci.org/robertomiranda/has_secure_token)
-[](http://badge.fury.io/rb/has_secure_token)
-[](https://gemnasium.com/robertomiranda/has_secure_token)
-[](https://codeclimate.com/github/robertomiranda/has_secure_token)
+[](https://travis-ci.org/ecleel/super_token)
+[](https://badge.fury.io/rb/super_token)
+[](https://gemnasium.com/ecleel/super_token)
+[](https://codeclimate.com/github/ecleel/super_token)
+[](https://codeclimate.com/github/ecleel/super_token/coverage)
-# HasSecureToken
+# SuperToken
-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.
+SuperToken is a fork of [HasSecureToken](https://github.com/robertomiranda/has_secure_token) 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.
-**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'
+ gem 'super_token'
And then run:
$ bundle
Or install it yourself as:
- $ gem install has_secure_token
+ $ gem install super_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
+rails g migration AddTokenToAPIKey token:string secret_key:string public_key:string
=>
invoke active_record
- create db/migrate/20150424010931_add_token_to_users.rb
+ 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:
```ruby
-# Schema: User(token:string, auth_token:string)
-class User < ActiveRecord::Base
+# Schema: APIKey(token:string, secret_key:string, public_key:string)
+class APIKey < ActiveRecord::Base
has_secure_token
end
-user = User.new
-user.save
-user.token # => "pX27zsMN2ViQKta1bGfLmVJE"
-user.regenerate_token # => true
+# 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):
```ruby
-# Schema: User(token:string, auth_token:string)
-class User < ActiveRecord::Base
- has_secure_token :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
-user = User.new
-user.save
-user.auth_token # => "pX27zsMN2ViQKta1bGfLmVJE"
-user.regenerate_auth_token # => true
+
+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
@@ -71,15 +75,15 @@
```
Should return
```shell
-5 runs, 9 assertions, 0 failures, 0 errors, 0 skips
+9 runs, 17 assertions, 0 failures, 0 errors, 0 skips
```
## Contributing
-1. Fork it ( https://github.com/robertomiranda/has_secure_token/fork )
+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