jwt_keeper 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d622a17d010fc9b106c161c42b90a4b3f8f1c05
-  data.tar.gz: 45467b7f357ad75e985b1b74297b5948cb2964d2
+  metadata.gz: 28d115e2b0772731d3b5fefce241da3f8be40c4a
+  data.tar.gz: 0507622c05cf4a5b93be4035b77a15424b89e4b1
 SHA512:
-  metadata.gz: c87fbde489f9aace5c0bf65ae997b65d80b984bcd860986ed04bac9cece93b955b66bfa3bbca70dea29f1fb08dfb099cfdb1061f573e74cd63e66bf065eeaf7b
-  data.tar.gz: c5c28a26779d3c539c8dc63f6e5ba4636b5d82c2016cd1c2d7aa81526a498fec23aac300d4157e7c79ff5da724fd548dfd731bf43739fd695d75e24c095d092f
+  metadata.gz: fd49463a7660666d28507b5b6ae9345cea21c7baec56fdc904d6f683ec8bbcafa354c29113b658798c1531129e34b12e419ff6b1324af9f83b60484341b30c9c
+  data.tar.gz: 61fcefd218432ca6e2de3e6b6bfde1a0bdda28a8414baefe63ce0ef6a03a1c20e444c9d79b3ad5e95d5e841530d2d1e701a33157d08c468e2dd6f94a6fce2caf

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3.0
+  - 2.2.5
+  - 2.3.1
   - ruby-head
 matrix:
   allow_failures:

data/README.md

@@ -1,4 +1,5 @@
 # JWT Keeper
+[![Gem Version](https://img.shields.io/gem/v/jwt_keeper.svg?maxAge=2592000)](https://rubygems.org/gems/jwt_keeper)
 [![Build Status](https://img.shields.io/travis/sirwolfgang/jwt_keeper/master.svg)](https://travis-ci.org/sirwolfgang/jwt_keeper)
 [![Dependency Status](https://img.shields.io/gemnasium/sirwolfgang/jwt_keeper.svg)](https://gemnasium.com/sirwolfgang/jwt_keeper)
 [![Code Climate](https://img.shields.io/codeclimate/github/sirwolfgang/jwt_keeper.svg)](https://codeclimate.com/github/sirwolfgang/jwt_keeper)

data/jwt_keeper.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_dependency 'redis', '~> 3.3'
-  spec.add_dependency 'rails', '~> 4.2'
-  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'rails', '~> 5.0'
+  spec.add_dependency 'activesupport', '~> 5.0'
   spec.add_dependency 'jwt', '~> 1.5'
 end

data/lib/jwt_keeper/controller.rb

@@ -2,11 +2,9 @@ module JWTKeeper
   module Controller
     extend ActiveSupport::Concern
 
-    module ClassMethods
-    end
-
     # Available to be used as a before_action by the application's controllers. This is
     # the main logical section for decoding, and automatically rotating tokens
+    # @return [void]
     def require_authentication
       token = read_authentication_token
 
@@ -25,6 +23,7 @@ module JWTKeeper
     end
 
     # Decodes and returns the token
+    # @return [Token] the token read from request
     def read_authentication_token
       return nil unless request.headers['Authorization']
       @authentication_token ||=
@@ -35,6 +34,8 @@ module JWTKeeper
     end
 
     # Encodes and writes the token
+    # @param token [Token] The token to be written
+    # @return [Token] the token written to response
     def write_authentication_token(token)
       return clear_authentication_token if token.nil?
       response.headers['Authorization'] = "Bearer #{token.to_jwt}"
@@ -43,6 +44,7 @@ module JWTKeeper
     end
 
     # delets the authentication token
+    # @return [void]
     def clear_authentication_token
       response.headers['Authorization'] = nil
       cookies.delete('jwt_keeper')
@@ -51,18 +53,21 @@ module JWTKeeper
 
     # The default action for denying non-authenticated connections.
     # You can override this method in your controllers
+    # @return [void]
     def not_authenticated
       redirect_to root_path
     end
 
     # The default action for accepting authenticated connections.
     # You can override this method in your controllers
+    # @return [void]
     def authenticated(token)
     end
 
     # Invoked by the require_authentication method as part of the automatic rotation
     # process. The application should override this method to include the necessary
     # claims.
+    # @return [void]
     def regenerate_claims(old_token)
     end
   end

data/lib/jwt_keeper/engine.rb

@@ -2,8 +2,7 @@ require 'jwt_keeper'
 require 'rails'
 
 module JWTKeeper
-  # The Sorcery engine takes care of extending ActiveRecord (if used) and ActionController,
-  # With the plugin logic.
+  # Includes JWTKeeper into ActionController
   class Engine < ::Rails::Engine
     initializer 'extend Controller with jwt_keeper' do |_app|
       ActionController::Base.send(:include, JWTKeeper::Controller)

data/lib/jwt_keeper/token.rb

@@ -1,9 +1,13 @@
 module JWTKeeper
+  # This class acts as the main interface to wrap the concerns of JWTs. Handling everything from
+  # encoding to invalidation.
   class Token
     attr_accessor :claims, :cookie_secret
 
     # Initalizes a new web token
     # @param private_claims [Hash] the custom claims to encode
+    # @param cookie_secret [String] the cookie secret to use during encoding
+    # @return [void]
     def initialize(private_claims = {}, cookie_secret = nil)
       @cookie_secret = cookie_secret
       @claims = {
@@ -25,6 +29,7 @@ module JWTKeeper
 
     # Decodes and validates an existing token
     # @param raw_token [String] the raw token
+    # @param cookie_secret [String] the cookie secret
     # @return [Token] token object
     def self.find(raw_token, cookie_secret = nil)
       claims = decode(raw_token, cookie_secret)
@@ -39,12 +44,14 @@ module JWTKeeper
     # is inherently ignored by the token's exp check and then rewritten with the revokation on
     # rotate.
     # @param token_jti [String] the token unique id
+    # @return [void]
     def self.rotate(token_jti)
       Datastore.rotate(token_jti, JWTKeeper.configuration.expiry.from_now.to_i)
     end
 
     # Revokes a web token
     # @param token_jti [String] the token unique id
+    # @return [void]
     def self.revoke(token_jti)
       Datastore.revoke(token_jti, JWTKeeper.configuration.expiry.from_now.to_i)
     end
@@ -57,7 +64,7 @@ module JWTKeeper
 
     # Revokes and creates a new web token
     # @param new_claims [Hash] Used to override and update claims during rotation
-    # @return [String] new token
+    # @return [Token]
     def rotate(new_claims = nil)
       revoke
 
@@ -70,6 +77,7 @@ module JWTKeeper
     end
 
     # Revokes a web token
+    # @return [void]
     def revoke
       return if invalid?
       Datastore.revoke(id, claims[:exp] - DateTime.now.to_i)
@@ -106,14 +114,14 @@ module JWTKeeper
     end
 
     # Encodes the jwt
-    # @return [String]
+    # @return [String] the encoded jwt
     def to_jwt
       encode
     end
     alias to_s to_jwt
 
     # Encodes the cookie
-    # @return [Hash]
+    # @return [Hash] the cookie options
     def to_cookie
       {
         value: cookie_secret,

data/lib/jwt_keeper/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module JWTKeeper
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/spec/lib/jwt_keeper/token_spec.rb

@@ -17,6 +17,13 @@ module JWTKeeper
         before { JWTKeeper.configure(JWTKeeper::Configuration.new(config.merge(cookie_lock: true))) }
         it { expect(subject.cookie_secret).not_to be_empty }
       end
+
+      context 'when overiding default claims' do
+        let(:private_claims) { { exp: 1.minute.from_now.to_i } }
+
+        it { is_expected.to be_instance_of described_class }
+        it { expect(subject.claims[:exp]).to eql private_claims[:exp] }
+      end
     end
 
     describe '.find' do

data/spec/spec_helper.rb

@@ -9,7 +9,9 @@ SimpleCov.formatter =
                                              SimpleCov::Formatter::HTMLFormatter,
                                              CodeClimate::TestReporter::Formatter
                                            ])
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/spec/'
+end
 
 require 'rails'
 require 'jwt_keeper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jwt_keeper
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - David Rivera
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-27 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,28 +157,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement