super_token 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ecc5d2fae093eb6123d5b016b48d1e63977f1f0f
-  data.tar.gz: 1192d3a13440aff01cbbf43316447db20e5e6f9a
+SHA256:
+  metadata.gz: 4ea30d63401a1aeaa7271ac99dfa66e459a76fe645357b2aaabddb3479c77b6e
+  data.tar.gz: 30915900f03d12d13ffdd437d2469dd5e038752a252be07c046e6b4128217b25
 SHA512:
-  metadata.gz: 4e5d89fc1795b0f6d3350f87ff2ecd22a8b5036b5409d0849cce5123129cdf2cb98f3f27bef37a6190411c52ccf40d11bd906e64fbd4bf15c3af039e2c7ad4b3
-  data.tar.gz: 9bc9b3e09da2cb9b0b480260dc1028a6b9904366b8fcb4dec8b9881e98f1c2c50e2b3f0e974a796a60f758b6ba0382987093af54a653dc1a851ec01f22ec17cd
+  metadata.gz: 9d13341247f9f789251bf40e9d6bca654b5de31d9a4de554afd1e833fe0c8a2dc397c10dffaeb5bb17d7558fbf8eb5539e4a7afe8d16d2025759f76fd85e97be
+  data.tar.gz: 9793540bff0d1dee733933da994696d05e5def533d880fe2da4b3958fd8c7dd1f59c79a3c764c8763b64458a0b0da63a6d4467683a2f34dc294f2ff02933967a

data/.travis.yml

@@ -4,11 +4,23 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.0
 gemfile:
   - gemfiles/rails3.gemfile
   - gemfiles/rails4_0.gemfile
   - gemfiles/rails4_1.gemfile
   - gemfiles/rails4_2.gemfile
+  - gemfiles/rails5_0.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails5_0.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails5_0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails5_0.gemfile
+    - rvm: 2.2
+      gemfile: gemfiles/rails5_0.gemfile
 before_install:
 - gem update --system
 - gem install bundler

data/README.md

@@ -1,19 +1,18 @@
-[![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)
+[![Build Status](https://travis-ci.org/ecleel/super_token.svg?branch=master)](https://travis-ci.org/ecleel/super_token)
+[![Gem Version](https://badge.fury.io/rb/super_token.svg)](https://badge.fury.io/rb/super_token)
+[![Dependency Status](https://gemnasium.com/ecleel/super_token.svg)](https://gemnasium.com/ecleel/super_token)
+[![Code Climate](https://codeclimate.com/github/ecleel/super_token/badges/gpa.svg)](https://codeclimate.com/github/ecleel/super_token)
+[![Test Coverage](https://codeclimate.com/github/ecleel/super_token/badges/coverage.svg)](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.
-
-**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.
+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. 
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'has_secure_token'
+    gem 'super_token'
 
 And then run:
 
@@ -21,45 +20,50 @@ And then run:
 
 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
@@ -73,12 +77,12 @@ $ rake test
 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`)

data/gemfiles/rails5_0.gemfile

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

data/lib/active_support/core_ext/securerandom.rb

@@ -1,4 +1,4 @@
-require 'securerandom'
+# frozen_string_literal: true
 
 module SecureRandom
   BASE58_ALPHABET = ('0'..'9').to_a  + ('A'..'Z').to_a + ('a'..'z').to_a - ['0', 'O', 'I', 'l']

data/lib/super_token/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SuperToken
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/super_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 module ActiveRecord
   module SecureToken
@@ -28,12 +30,12 @@ module ActiveRecord
       # 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}?")}
+        require 'active_support/core_ext/securerandom' unless SecureRandom.respond_to?(:base58)
+        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_secure_token_with_prefix(length, prefix) }
+        before_create { self.send("#{attribute}=", self.class.generate_unique_secure_token_with_prefix(length, prefix)) unless self.send("#{attribute}?")}
       end
 
-      def generate_unique_secure_token(length, prefix)
+      def generate_unique_secure_token_with_prefix(length, prefix)
         token_length = length - prefix.length
         prefix + SecureRandom.base58(token_length)
       end

data/super_token.gemspec

@@ -6,10 +6,10 @@ 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.authors       = ["Abdulaziz Alshetwi", "Roberto Miranda Altamar"]
+  spec.email         = ["e@ecleel.com", "rjmaltamar@gmail.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.description   = %q{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.}
   spec.homepage      = "https://github.com/ecleel/super_token"
   spec.license       = "MIT"
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord", ">= 3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency 'sqlite3'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: super_token
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
-- Roberto Miranda Altamar
 - Abdulaziz Alshetwi
+- Roberto Miranda Altamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-07 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,12 +81,12 @@ dependencies:
     - - ">="
       - !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.
+description: 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.
 email:
-- rjmaltamar@gmail.com
 - e@ecleel.com
+- rjmaltamar@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -101,6 +101,7 @@ files:
 - gemfiles/rails4_0.gemfile
 - gemfiles/rails4_1.gemfile
 - gemfiles/rails4_2.gemfile
+- gemfiles/rails5_0.gemfile
 - lib/active_support/core_ext/securerandom.rb
 - lib/super_token.rb
 - lib/super_token/version.rb
@@ -129,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: HasSecureToken with more options