graphql-auth 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ffa56e33c28af702f87bb776c192921f83086b070fb05d5abf98eefb73c9787
-  data.tar.gz: 8ad60b751d4c1c3438d780a145692f557b3d6624698fe8d20f0ab8917d2e57c1
+  metadata.gz: b217f15c97c13f82c9a46e990b43d3330d188c1e581858eebf950cb002d4a4fd
+  data.tar.gz: 16c2e73bb8afd958b1c1ea1c13976d5c3feca2af34a58ae2cbed4545bbc67b82
 SHA512:
-  metadata.gz: 5bd40850c4273a5b071e9e9b7b46afcaa7ec5bf9a9bc8d1774f76767832e33a5fdb6d90f4438c3c543be50a344fefbde4e0c5d4b49951912e3708dcdb6372275
-  data.tar.gz: 2c1be37cece9f12dfa1fd57812ba7c66a0d893f1fe1d570e404a2eea5c510f128e09a7df7a9be8ef949de0a964d8fb70a379b4a134915e3196a74ebd47ef9744
+  metadata.gz: 4e80d69d1268094b93c0bab8e0f4c8330b36e11cb3deefedef20dc03a1593960de962a74de2f5cdbec006c6f0ea561297fc5b31e41e86befdff5619ddff8313c
+  data.tar.gz: 4ef5135a028e31897b0a446197135e97a1f31ef73e51d160fcab572932c3f0d3e207a981bdf39a60a7efa5aa44dc1711040b040a321a4025a816b83cf61d1969

data/README.md

@@ -26,6 +26,16 @@ rails g graphql_auth:install
 
 Make sure to read all configurations present inside the file and fill them with your own configs.
 
+## Devise gem
+
+Use Devise with a User model and skip all route
+
+```
+Rails.application.routes.draw do
+  devise_for :users, skip: :all
+end
+```
+
 ## Usage
 
 Make 'JWT_SECRET_KEY' and 'APP_URL' available to ENV

data/app/graphql/mutations/auth/forgot_password.rb

@@ -3,6 +3,7 @@
 # mutation {
 #  forgotPassword(email: "email@example.com") {
 #     valid
+#     success
 #   }
 # }
 
@@ -11,12 +12,17 @@ class Mutations::Auth::ForgotPassword < GraphQL::Schema::Mutation
     description 'The email with forgotten password'
   end
 
-  field :valid, Boolean, null: false
-  
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+
   def resolve(email:)
     user = User.find_by email: email
     user.send_reset_password_instructions if user.present?
 
-    { valid: true }
+    {
+      errors: [],
+      success: true,
+      valid: true
+    }
   end
 end

data/app/graphql/mutations/auth/reset_password.rb

@@ -2,7 +2,7 @@
 
 # mutation {
 #   resetPassword(resetPasswordToken: "token", password: "password", passwordConfirmation: "password") {
-#     valid
+#     success
 #     errors {
 #       field
 #       message
@@ -18,20 +18,20 @@ class Mutations::Auth::ResetPassword < GraphQL::Schema::Mutation
   argument :password, String, required: true do
     description "New user's new password"
   end
-  
+
   argument :password_confirmation, String, required: true do
     description "New user's new password confirmation"
   end
 
-  field :valid, Boolean, null: false
-  field :errors, [Types::Auth::Error], null: true
-  
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+
   def resolve(args)
     user = User.reset_password_by_token args
-    
+
     if user.errors.any?
       {
-        valid: false,
+        success: true,
         errors: user.errors.messages.map do |field, messages|
           field = field == :reset_password_token ? :_error : field.to_s.camelize(:lower)
           {
@@ -40,7 +40,10 @@ class Mutations::Auth::ResetPassword < GraphQL::Schema::Mutation
         end
       }
     else
-      { valid: true }
+      {
+        errors: [],
+        success: true
+      }
     end
   end
 end

data/app/graphql/mutations/auth/sign_in.rb

@@ -2,6 +2,7 @@
 
 # mutation {
 #   signIn(email: "email@example.com", password: "password") {
+#     success
 #     user {
 #       email
 #     }
@@ -13,6 +14,8 @@
 # }
 
 class Mutations::Auth::SignIn < GraphQL::Schema::Mutation
+  include ::Graphql::TokenHelper
+
   argument :email, String, required: true do
     description "The user's email"
   end
@@ -21,17 +24,27 @@ class Mutations::Auth::SignIn < GraphQL::Schema::Mutation
     description "The user's password"
   end
 
-  field :user, Types::Auth::User, null: true
-  field :errors, [Types::Auth::Error], null: true
-  
-  def resolve(email:, password:)
+  argument :remember_me, Boolean, required: true do
+    description "User's checkbox to be remembered after connection timeout"
+  end
+
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+  field :user, ::Types::Auth::User, null: true
+
+  def resolve(email:, password:, remember_me:)
     response = context[:response]
+
     user = User.find_by email: email
     valid_sign_in = user.present? && user.valid_password?(password)
-    
+
     if valid_sign_in
-      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) # TODO use uuid
+      generate_access_token(user, response)
+      remember_me ? set_refresh_token(user, response) : delete_refresh_token(user)
+
       {
+        errors: [],
+        success: true,
         user: user
       }
     else
@@ -42,7 +55,9 @@ class Mutations::Auth::SignIn < GraphQL::Schema::Mutation
             message: I18n.t('devise.failure.invalid',
                             authentication_keys: I18n.t('activerecord.attributes.user.email'))
           }
-        ]
+        ],
+        success: false,
+        user: nil,
       }
     end
   end

data/app/graphql/mutations/auth/sign_up.rb

@@ -2,6 +2,7 @@
 
 # mutation {
 #   signUp(email: "email@example.com", password: "password", passwordConfirmation: "password") {
+#     success
 #     user {
 #       email
 #     }
@@ -13,6 +14,8 @@
 # }
 
 class Mutations::Auth::SignUp < GraphQL::Schema::Mutation
+  include ::Graphql::TokenHelper
+
   argument :email, String, required: true do
     description "New user's email"
   end
@@ -25,21 +28,29 @@ class Mutations::Auth::SignUp < GraphQL::Schema::Mutation
     description "New user's password confirmation"
   end
 
-  field :user, Types::Auth::User, null: true
-  field :errors, [Types::Auth::Error], null: true
-  
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+  field :user, ::Types::Auth::User, null: true
+
   def resolve(args)
     response = context[:response]
     user = User.new args
-    
+
     if user.save
-      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) # TODO use uuid
-      { user: user }
+      generate_access_token(user, response)
+
+      {
+        errors: [],
+        success: true,
+        user: user
+      }
     else
       {
         errors: user.errors.messages.map do |field, messages|
           { field: field.to_s.camelize(:lower), message: messages.first.capitalize }
-        end
+        end,
+        success: false,
+        user: nil,
       }
     end
   end

data/app/graphql/mutations/auth/update_account.rb

@@ -2,6 +2,7 @@
 
 # mutation {
 #   updateAccount(current_password: "currentPassword", password: "newPassword", password_confirmation: "newPassword") {
+#     success
 #     user {
 #       email
 #     }
@@ -16,30 +17,37 @@ class Mutations::Auth::UpdateAccount < GraphQL::Schema::Mutation
   argument :current_password, String, required: true do
     description "User's current password"
   end
-  
+
   argument :password, String, required: true do
     description "User's new password"
   end
-  
+
   argument :password_confirmation, String, required: true do
     description "User's new password confirmation"
   end
-  
-  field :user, Types::Auth::User, null: true
-  field :errors, [Types::Auth::Error], null: true
-  
+
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+  field :user, ::Types::Auth::User, null: true
+
   def resolve(args)
     user = context[:current_user]
     user.update_with_password args
-    
+
     if user.errors.any?
       {
         errors: user.errors.messages.map do |field, messages|
           { field: field.to_s.camelize(:lower), message: messages.first.capitalize }
-        end
+        end,
+        success: false,
+        user: nil
       }
     else
-      { user: user }
+      {
+        errors: [],
+        success: true,
+        user: user
+      }
     end
   end
 end

data/app/graphql/mutations/auth/validate_token.rb

@@ -2,6 +2,7 @@
 
 # mutation {
 #   validateToken {
+#     success
 #     valid
 #     user {
 #       email
@@ -10,15 +11,19 @@
 # }
 
 class Mutations::Auth::ValidateToken < GraphQL::Schema::Mutation
+  field :errors, [::Types::Auth::Error], null: false
+  field :success, Boolean, null: false
+  field :user, ::Types::Auth::User, null: true
   field :valid, Boolean, null: false
-  field :user, Types::Auth::User, null: true
-  
+
   def resolve
     user = context[:current_user]
-    
+
     {
-      valid: user.present?,
+      errors: [],
+      success: user.present?,
       user: user,
+      valid: user.present?,
     }
   end
 end

data/app/helpers/graphql/auth_helper.rb

@@ -4,27 +4,45 @@
 
 module Graphql
   module AuthHelper
+    include ::Graphql::TokenHelper
+
     def context
       {
         current_user: current_user,
         response: response,
       }
     end
-  
+
+    # set current user from Authorization header
     def current_user
       return if request.headers['Authorization'].nil?
-      
+
       decrypted_token = GraphQL::Auth::JwtManager.decode(request.headers['Authorization'])
-    
+
       user_id = decrypted_token['user']
-      user = User.find_by id: user_id  # TODO use uuid
+      user = User.find_by id: user_id
 
       # update token if user is found with token
-      response.set_header 'Authorization', GraphQL::Auth::JwtManager.issue({ user: user.id }) if user.present?
+      if user.present?
+        generate_access_token(user, response)
+      end
 
       user
+
+    # rescue expired Authorization header with RefreshToken header
     rescue JWT::ExpiredSignature
-      nil
+      return nil if request.headers['RefreshToken'].nil?
+
+      user = User.find_by refresh_token: request.headers['RefreshToken']
+
+      if user.present?
+        generate_access_token(user, response)
+        set_refresh_token(user, response)
+      end
+
+      user
     end
+
+
   end
 end

data/app/helpers/graphql/token_helper.rb

@@ -0,0 +1,23 @@
+# include this helper in GraphqlController to use context method so that current_user will be available
+#
+# ::GraphqlSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
+
+module Graphql
+  module TokenHelper
+    def generate_access_token(user, response)
+      token = GraphQL::Auth::JwtManager.issue_with_expiration({ user: user.id }) # TODO use uuid
+      response.set_header 'Authorization', token
+      response.set_header 'Expires', GraphQL::Auth::JwtManager.token_expiration(token)
+    end
+
+    def set_refresh_token(user, response)
+      refresh_token = user.refresh_token.presence || GraphQL::Auth::JwtManager.issue_without_expiration({ user: user.id })
+      user.update_column :refresh_token, refresh_token
+      response.set_header 'RefreshToken', refresh_token
+    end
+
+    def delete_refresh_token(user)
+      user.update_column :refresh_token, nil if user.refresh_token.present?
+    end
+  end
+end

data/lib/generators/graphql_auth/install_generator.rb

@@ -5,6 +5,7 @@ module GraphqlAuth
 
       def copy_configuration
         template 'initializer.rb', 'config/initializers/graphql_auth.rb'
+        template 'add_refresh_token_to_user.rb', "db/migrate/#{Time.now.strftime('%Y%m%d%H%M%S')}_add_refresh_token_to_user.rb"
       end
     end
   end

data/lib/generators/graphql_auth/templates/add_refresh_token_to_user.rb

@@ -0,0 +1,5 @@
+class AddRefreshTokenToUser < ActiveRecord::Migration[5.2]
+  def change
+    add_column :users, :refresh_token, :string, default: nil
+  end
+end

data/lib/graphql-auth/jwt_manager.rb

@@ -8,19 +8,28 @@ module GraphQL
       TYPE = 'Bearer'
 
       class << self
-        def issue(payload, custom_expiration = nil)
+        def issue_with_expiration(payload, custom_expiration = nil)
           if custom_expiration.present? && custom_expiration.is_a?(ActiveSupport::Duration)
             payload[:exp] = custom_expiration
           else
             payload.merge!(expiration)
           end
 
+          issue payload
+        end
+
+        def issue(payload)
           token = JWT.encode payload,
                              auth_secret,
                              ALGORITHM
           set_type token
         end
 
+        def token_expiration(token)
+          decrypted_token = decode(token)
+          decrypted_token.try(:[], 'exp')
+        end
+
         def decode(token)
           token = extract_token token
           decrypted_token = JWT.decode token,
@@ -48,6 +57,8 @@ module GraphQL
           exp = Time.now.to_i + GraphQL::Auth.configuration.token_lifespan
           { exp: exp }
         end
+
+        alias_method :issue_without_expiration, :issue
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillaume Ferland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,8 +99,10 @@ files:
 - app/graphql/types/auth/user.rb
 - app/graphql/types/graphql_auth.rb
 - app/helpers/graphql/auth_helper.rb
+- app/helpers/graphql/token_helper.rb
 - app/views/devise/mailer/reset_password_instructions.html.erb
 - lib/generators/graphql_auth/install_generator.rb
+- lib/generators/graphql_auth/templates/add_refresh_token_to_user.rb
 - lib/generators/graphql_auth/templates/initializer.rb
 - lib/graphql-auth.rb
 - lib/graphql-auth/configuration.rb
@@ -127,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: GraphQL + JWT + Devise