rails_jwt_auth 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c7fdf2a0ecc3b2b48adc80426f802e411a7d315ad3d502d54591ba7978abd1
-  data.tar.gz: b7224f3281c49cb6c40ab28156c296a9cb74b3eefb68ac932940a931aa2886be
+  metadata.gz: 3ce38e7a38fa015a6dbf8b1504e41fd273cf3646d0b2d9053c63476d55b3c729
+  data.tar.gz: 9581d2075661754ed5d43f3a344c8d3fd0da631b9b5c8ea8e51b65fa14bb2c33
 SHA512:
-  metadata.gz: e208d2d4fc4a900a584a03d718b8539f0f53717d2bbeb15189d125d6f235e135c6e8d7de77df60cf128611cf512b8380fa747c604572495eebca32abff8d26f6
-  data.tar.gz: ab21acd7f88451742875b62f131c86243c715cc3c942ba94b7d6782c266800b68c35aef5b524c86e5bbbdbd2c9943f286d09e62d59a03562fdc667f4aae5dbd6
+  metadata.gz: f0bdc862727abcdc1db5d1a3e00bd124b7ac15e45d47e483b8487ba46854dfc68edda3a1dcef1d5cda55fb733840f7679f2bbd03996cae3ee4e775d0f12f5a5d
+  data.tar.gz: 58cd478adf9a9145fb33e7f531e8010faa6e68f86243478515333acc9aa5578531f047ca059620ae1ce867cff8fbbf7a03de5ceb81e30ede35b9d8360e5392b6

data/README.md

@@ -5,9 +5,26 @@
 
 Rails-API authentication solution based on JWT and inspired by Devise.
 
-This is documentation for version `1.x`. If you are using `0.x` version use this
+> This is documentation for version `1.x`. If you are using `0.x` version use this
 [link](https://github.com/rjurado01/rails_jwt_auth/tree/0.x)
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Modules](#modules)
+- [ORMs support](#orms-support)
+- [Controller helpers](#controller-helpers)
+- [Default Controllers API](#default-controllers-api)
+- [Customize]()
+    + [Controllers](#custom-controllers)
+    + [Payload](#custom-payload)
+    + [Responses](#custom-responses)
+    + [Strong parameters](#custom-strong-parameters)
+- [Examples](#examples)
+- [Testing](#testing-rspec)
+- [License](#license)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -65,6 +82,8 @@ You can edit configuration options into `config/initializers/auth_token_auth.rb`
 
 ## Modules
 
+It's composed of 5 modules:
+
 | Module        | Description                                                                                                     |
 | ------------- | --------------------------------------------------------------------------------------------------------------- |
 | Authenticable | Hashes and stores a password in the database to validate the authenticity of a user while signing in            |
@@ -73,7 +92,9 @@ You can edit configuration options into `config/initializers/auth_token_auth.rb`
 | Trackable     | Tracks sign in timestamps and IP address                                                                        |
 | Invitable     | Allows you to invite an user to your application sending an invitation mail                                     |
 
-### Examples
+## ORMs support
+
+RailsJwtAuth support both Mongoid and ActiveRecord.
 
 For next examples `auth_field_name` and `email_field_name` are configured to use the field `email`.
 
@@ -90,11 +111,11 @@ class User < ApplicationRecord
 
   validates :email, presence: true,
                     uniqueness: true,
-                    format: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+                    format: URI::MailTo::EMAIL_REGEXP
 end
 ```
 
-Ensure you have executed migrate task: `rails g rails_jwt_auth:migrate` and you have uncomented all modules fields.
+Ensure you have executed migrate task: `rails g rails_jwt_auth:migrate` and you have uncomented all modules fields into generated [migration file](https://github.com/rjurado01/rails_jwt_auth/blob/master/lib/generators/templates/migration.rb).
 
 **Mongoid**
 
@@ -111,7 +132,7 @@ class User
 
   validates :email, presence: true,
                     uniqueness: true,
-                    format: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+                    format: URI::MailTo::EMAIL_REGEXP
 end
 ```
 
@@ -321,7 +342,11 @@ Invitations api is provided by `RailsJwtAuth::InvitationsController`.
 
 Note: To add more fields, see "Custom strong parameters" below.
 
-## Custom controllers
+## Customize
+
+RailsJwtAuth offers an easy way to customize certain parts.
+
+### Custom controllers
 
 You can overwrite RailsJwtAuth controllers to edit actions, responses,
 permitted parameters...
@@ -351,7 +376,7 @@ And edit route resource to use it:
 resource :registration, controller: 'registrations', only: [:create, :update, :destroy]
 ```
 
-## Custom payload
+### Custom payload
 
 If you need edit default payload used to generate jwt you can overwrite the method `to_token_payload` into your User class:
 
@@ -369,15 +394,17 @@ class User < ApplicationRecord
 end
 ```
 
-## Custom responses
+### Custom responses
 
 You can overwrite `RailsJwtAuth::RenderHelper` to customize controllers responses.
 
-## Custom strong parameters
+### Custom strong parameters
 
 You can overwrite `RailsJwtAuth::ParamsHelper` to customize controllers strong parameters.
 
-## Edit user information
+## Examples
+
+### Edit user information
 
 This is a controller example that allows users to edit their `email` and `password`.
 
@@ -401,7 +428,7 @@ class CurrentUserController < ApplicationController
 end
 ```
 
-## Register users with random password
+### Register users with random password
 
 This is a controller example that allows admins to register users with random password and send email to reset it.
 If registration is sucess it will send email to `set_password_url` with reset password token.

data/lib/rails_jwt_auth/spec_helpers.rb

@@ -5,7 +5,7 @@ module RailsJwtAuth
         .to receive(:authenticate!).and_return(true)
 
       allow_any_instance_of(RailsJwtAuth::AuthenticableHelper)
-        .to receive(:current_user).and_return(user)
+        .to receive(:current_user).and_return(user.class.find(user.id))
     end
 
     def sign_out

data/lib/rails_jwt_auth/version.rb

@@ -1,3 +1,3 @@
 module RailsJwtAuth
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_jwt_auth
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - rjurado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -42,16 +42,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 description: Rails authentication solution based on Warden and JWT and inspired by
   Devise.
 email:
@@ -113,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Rails jwt authentication.