graphql_devise 0.11.1 → 0.12.1

data/app/controllers/graphql_devise/application_controller.rb

@@ -1,4 +1,7 @@
 module GraphqlDevise
-  class ApplicationController < DeviseTokenAuth::ApplicationController
+  ApplicationController = if Rails::VERSION::MAJOR >= 5
+    Class.new(ActionController::API)
+  else
+    Class.new(ActionController::Base)
   end
 end

data/app/controllers/graphql_devise/concerns/set_user_by_token.rb

@@ -1,5 +1,28 @@
 module GraphqlDevise
   module Concerns
     SetUserByToken = DeviseTokenAuth::Concerns::SetUserByToken
+
+    SetUserByToken.module_eval do
+      attr_accessor :client_id, :token, :resource
+
+      alias_method :set_resource_by_token, :set_user_by_token
+
+      def graphql_context
+        {
+          current_resource: @resource,
+          controller:       self
+        }
+      end
+
+      def build_redirect_headers(access_token, client, redirect_header_options = {})
+        {
+          DeviseTokenAuth.headers_names[:"access-token"] => access_token,
+          DeviseTokenAuth.headers_names[:client] => client,
+          :config => params[:config],
+          :client_id => client,
+          :token => access_token
+        }.merge(redirect_header_options)
+      end
+    end
   end
 end

data/app/controllers/graphql_devise/graphql_controller.rb

@@ -2,6 +2,8 @@ require_dependency 'graphql_devise/application_controller'
 
 module GraphqlDevise
   class GraphqlController < ApplicationController
+    include GraphqlDevise::Concerns::SetUserByToken
+
     def auth
       result = if params[:_json]
         GraphqlDevise::Schema.multiplex(

data/app/helpers/graphql_devise/mailer_helper.rb

@@ -1,7 +1,7 @@
 module GraphqlDevise
   module MailerHelper
     def confirmation_query(resource_name:, token:, redirect_url:)
-      name = "#{resource_name.camelize(:lower)}ConfirmAccount"
+      name = "#{resource_name.underscore.tr('/', '_').camelize(:lower)}ConfirmAccount"
       raw = <<-GRAPHQL
         query($token:String!,$redirectUrl:String!){
           #{name}(confirmationToken:$token,redirectUrl:$redirectUrl){
@@ -17,7 +17,7 @@ module GraphqlDevise
     end
 
     def password_reset_query(token:, redirect_url:, resource_name:)
-      name = "#{resource_name.camelize(:lower)}CheckPasswordToken"
+      name = "#{resource_name.underscore.tr('/', '_').camelize(:lower)}CheckPasswordToken"
       raw = <<-GRAPHQL
         query($token:String!,$redirectUrl:String!){
           #{name}(resetPasswordToken:$token,redirectUrl:$redirectUrl){

data/config/locales/en.yml

@@ -14,6 +14,7 @@ en:
       password_not_required: "This account does not require a password. Sign in using your '%{provider}' account instead."
       reset_token_not_found: "No user found for the specified reset token."
       reset_token_expired: "Reset password token is no longer valid."
+      send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes."
     sessions:
       bad_credentials: "Invalid login credentials. Please try again."
       not_confirmed: "A confirmation email was sent to your account at '%{email}'. You must follow the instructions in the email before your account can be activated"

data/config/routes.rb

@@ -1,11 +1,18 @@
 GraphqlDevise::Engine.routes.draw do
-  if GraphqlDevise::Types::QueryType.fields.blank?
-    GraphqlDevise::Types::QueryType.field(:dummy, resolver: GraphqlDevise::Resolvers::Dummy)
-  end
+  # Required as Devise forces routes to reload on eager_load
+  unless GraphqlDevise.schema_loaded?
+    if GraphqlDevise::Types::QueryType.fields.blank?
+      GraphqlDevise::Types::QueryType.field(:dummy, resolver: GraphqlDevise::Resolvers::Dummy)
+    end
 
-  if GraphqlDevise::Types::MutationType.fields.present?
-    GraphqlDevise::Schema.mutation(GraphqlDevise::Types::MutationType)
-  end
+    if GraphqlDevise::Types::MutationType.fields.present?
+      GraphqlDevise::Schema.mutation(GraphqlDevise::Types::MutationType)
+    end
+
+    GraphqlDevise::Schema.query(GraphqlDevise::Types::QueryType)
 
-  GraphqlDevise::Schema.query(GraphqlDevise::Types::QueryType)
+    GraphqlDevise.load_schema
+
+    Devise.mailer.helper(GraphqlDevise::MailerHelper)
+  end
 end

data/graphql_devise.gemspec

@@ -21,13 +21,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.test_files    = Dir['spec/**/*']
+  spec.test_files    = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").select { |f| f.match(%r{^spec/}) }
+  end
 
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_dependency 'devise_token_auth', '>= 0.1.43'
-  spec.add_dependency 'graphql', '>= 1.8'
-  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'devise_token_auth', '>= 0.1.43', '< 2.0'
+  spec.add_dependency 'graphql', '>= 1.8', '< 1.11.0'
+  spec.add_dependency 'rails', '>= 4.2', '< 6.2'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'coveralls'

data/lib/generators/graphql_devise/install_generator.rb

@@ -5,62 +5,95 @@ module GraphqlDevise
     argument :user_class, type: :string, default: 'User'
     argument :mount_path, type: :string, default: 'auth'
 
+    class_option :mount, type: :string, default: 'separate_route'
+
     def execute_devise_installer
       generate 'devise:install'
     end
 
     def execute_dta_installer
+      # Necessary in case of a re-run of the generator, for DTA to detect concerns already included
+      if File.exist?(File.expand_path("app/models/#{user_class.underscore}.rb", destination_root))
+        gsub_file(
+          "app/models/#{user_class.underscore}.rb",
+          'GraphqlDevise::Concerns::Model',
+          'DeviseTokenAuth::Concerns::User'
+        )
+      end
+      gsub_file(
+        'app/controllers/application_controller.rb',
+        'GraphqlDevise::Concerns::SetUserByToken',
+        'DeviseTokenAuth::Concerns::SetUserByToken'
+      )
+
       generate 'devise_token_auth:install', "#{user_class} #{mount_path}"
     end
 
     def mount_resource_route
       routes_file = 'config/routes.rb'
-      routes_path = File.join(destination_root, routes_file)
-      gem_helper  = 'mount_graphql_devise_for'
-      gem_route   = "#{gem_helper} '#{user_class}', at: '#{mount_path}'"
       dta_route   = "mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'"
-      file_start  = 'Rails.application.routes.draw do'
 
-      if File.exist?(routes_path)
-        current_route = parse_file_for_line(routes_path, gem_route)
+      if options['mount'] != 'separate_route'
+        gsub_file(routes_file, /^\s+#{Regexp.escape(dta_route + "\n")}/i, '')
+      else
+        gem_route = "mount_graphql_devise_for '#{user_class}', at: '#{mount_path}'"
+
+        if file_contains_str?(routes_file, gem_route)
+          gsub_file(routes_file, /^\s+#{Regexp.escape(dta_route + "\n")}/i, '')
 
-        if current_route.present?
           say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
         else
-          current_dta_route = parse_file_for_line(routes_path, dta_route)
-
-          if current_dta_route.present?
-            replace_line(routes_path, dta_route, gem_route)
-          else
-            insert_text_after_line(routes_path, file_start, gem_route)
-          end
+          gsub_file(routes_file, /#{Regexp.escape(dta_route)}/i, gem_route)
         end
-      else
-        say_status('skipped', "#{routes_file} not found. Add \"#{gem_route}\" to your routes file.")
       end
     end
 
-    private
+    def replace_model_concern
+      gsub_file(
+        "app/models/#{user_class.underscore}.rb",
+        /^\s+include DeviseTokenAuth::Concerns::User/,
+        '  include GraphqlDevise::Concerns::Model'
+      )
+    end
 
-    def insert_text_after_line(filename, line, str)
-      gsub_file(filename, /(#{Regexp.escape(line)})/mi) do |match|
-        "#{match}\n  #{str}"
-      end
+    def replace_controller_concern
+      gsub_file(
+        'app/controllers/application_controller.rb',
+        /^\s+include DeviseTokenAuth::Concerns::SetUserByToken/,
+        '  include GraphqlDevise::Concerns::SetUserByToken'
+      )
     end
 
-    def replace_line(filename, old_line, new_line)
-      gsub_file(filename, /(#{Regexp.escape(old_line)})/mi, "  #{new_line}")
+    def set_change_headers_on_each_request_false
+      gsub_file(
+        'config/initializers/devise_token_auth.rb',
+        '# config.change_headers_on_each_request = true',
+        'config.change_headers_on_each_request = false'
+      )
     end
 
-    def parse_file_for_line(filename, str)
-      match = false
+    def mount_in_schema
+      return if options['mount'] == 'separate_route'
 
-      File.open(filename) do |f|
-        f.each_line do |line|
-          match = line if line =~ /(#{Regexp.escape(str)})/mi
-        end
+      inject_into_file "app/graphql/#{options['mount'].underscore}.rb", after: "< GraphQL::Schema\n" do
+<<-RUBY
+  use GraphqlDevise::SchemaPlugin.new(
+    query:            Types::QueryType,
+    mutation:         Types::MutationType,
+    resource_loaders: [
+      GraphqlDevise::ResourceLoader.new('#{user_class}'),
+    ]
+  )
+RUBY
       end
-      match
+    end
+
+    private
+
+    def file_contains_str?(filename, regex_str)
+      path = File.join(destination_root, filename)
+
+      File.read(path) =~ /(#{Regexp.escape(regex_str)})/i
     end
   end
 end

data/lib/graphql_devise.rb

@@ -6,8 +6,44 @@ module GraphqlDevise
   class Error < StandardError; end
 
   class InvalidMountOptionsError < GraphqlDevise::Error; end
+
+  @schema_loaded     = false
+  @mounted_resources = []
+
+  def self.schema_loaded?
+    @schema_loaded
+  end
+
+  def self.load_schema
+    @schema_loaded = true
+  end
+
+  def self.resource_mounted?(mapping_name)
+    @mounted_resources.include?(mapping_name)
+  end
+
+  def self.mount_resource(mapping_name)
+    @mounted_resources << mapping_name
+  end
+
+  def self.add_mapping(mapping_name, resource)
+    return if Devise.mappings.key?(mapping_name)
+
+    Devise.add_mapping(
+      mapping_name.to_s.pluralize.to_sym,
+      module: :devise, class_name: resource
+    )
+  end
 end
 
+require 'graphql_devise/engine'
+require 'graphql_devise/version'
+require 'graphql_devise/errors/error_codes'
+require 'graphql_devise/errors/execution_error'
+require 'graphql_devise/errors/user_error'
+require 'graphql_devise/errors/authentication_error'
+require 'graphql_devise/errors/detailed_user_error'
+
 require 'graphql_devise/concerns/controller_methods'
 require 'graphql_devise/schema'
 require 'graphql_devise/types/authenticatable_type'
@@ -18,13 +54,10 @@ require 'graphql_devise/default_operations/mutations'
 require 'graphql_devise/default_operations/resolvers'
 require 'graphql_devise/resolvers/dummy'
 
-require 'graphql_devise/engine'
-require 'graphql_devise/version'
-require 'graphql_devise/error_codes'
-require 'graphql_devise/user_error'
-require 'graphql_devise/detailed_user_error'
-
 require 'graphql_devise/mount_method/option_sanitizer'
 require 'graphql_devise/mount_method/options_validator'
 require 'graphql_devise/mount_method/operation_preparer'
 require 'graphql_devise/mount_method/operation_sanitizer'
+
+require 'graphql_devise/resource_loader'
+require 'graphql_devise/schema_plugin'

data/lib/graphql_devise/default_operations/mutations.rb

@@ -9,12 +9,12 @@ require 'graphql_devise/mutations/update_password'
 module GraphqlDevise
   module DefaultOperations
     MUTATIONS = {
-      login:               GraphqlDevise::Mutations::Login,
-      logout:              GraphqlDevise::Mutations::Logout,
-      sign_up:             GraphqlDevise::Mutations::SignUp,
-      update_password:     GraphqlDevise::Mutations::UpdatePassword,
-      send_password_reset: GraphqlDevise::Mutations::SendPasswordReset,
-      resend_confirmation: GraphqlDevise::Mutations::ResendConfirmation
+      login:               { klass: GraphqlDevise::Mutations::Login, authenticatable: true },
+      logout:              { klass: GraphqlDevise::Mutations::Logout, authenticatable: true },
+      sign_up:             { klass: GraphqlDevise::Mutations::SignUp, authenticatable: true },
+      update_password:     { klass: GraphqlDevise::Mutations::UpdatePassword, authenticatable: true },
+      send_password_reset: { klass: GraphqlDevise::Mutations::SendPasswordReset, authenticatable: false },
+      resend_confirmation: { klass: GraphqlDevise::Mutations::ResendConfirmation, authenticatable: false }
     }.freeze
   end
 end

data/lib/graphql_devise/default_operations/resolvers.rb

@@ -5,8 +5,8 @@ require 'graphql_devise/resolvers/confirm_account'
 module GraphqlDevise
   module DefaultOperations
     QUERIES = {
-      confirm_account:      GraphqlDevise::Resolvers::ConfirmAccount,
-      check_password_token: GraphqlDevise::Resolvers::CheckPasswordToken
+      confirm_account:      { klass: GraphqlDevise::Resolvers::ConfirmAccount },
+      check_password_token: { klass: GraphqlDevise::Resolvers::CheckPasswordToken }
     }.freeze
   end
 end

data/lib/graphql_devise/errors/authentication_error.rb

@@ -0,0 +1,7 @@
+module GraphqlDevise
+  class AuthenticationError < ExecutionError
+    def to_h
+      super.merge(extensions: { code: ERROR_CODES.fetch(:authentication_error) })
+    end
+  end
+end

data/lib/graphql_devise/{detailed_user_error.rb → errors/detailed_user_error.rb}

@@ -1,5 +1,5 @@
 module GraphqlDevise
-  class DetailedUserError < GraphQL::ExecutionError
+  class DetailedUserError < ExecutionError
     def initialize(message, errors:)
       @message = message
       @errors  = errors

data/lib/graphql_devise/errors/error_codes.rb

@@ -0,0 +1,6 @@
+module GraphqlDevise
+  ERROR_CODES = {
+    user_error:           'USER_ERROR',
+    authentication_error: 'AUTHENTICATION_ERROR'
+  }.freeze
+end

data/lib/graphql_devise/errors/execution_error.rb

@@ -0,0 +1,4 @@
+module GraphqlDevise
+  class ExecutionError < GraphQL::ExecutionError
+  end
+end

data/lib/graphql_devise/{user_error.rb → errors/user_error.rb}

@@ -1,5 +1,5 @@
 module GraphqlDevise
-  class UserError < GraphQL::ExecutionError
+  class UserError < ExecutionError
     def to_h
       super.merge(extensions: { code: ERROR_CODES.fetch(:user_error) })
     end

data/lib/graphql_devise/mount_method/operation_preparer.rb

@@ -8,10 +8,10 @@ require_relative 'operation_preparers/custom_operation_preparer'
 module GraphqlDevise
   module MountMethod
     class OperationPreparer
-      def initialize(resource:, selected_operations:, preparer:, custom:, additional_operations:)
+      def initialize(mapping_name:, selected_operations:, preparer:, custom:, additional_operations:)
         @selected_operations   = selected_operations
         @preparer              = preparer
-        @mapping_name          = resource.underscore.tr('/', '_')
+        @mapping_name          = mapping_name
         @custom                = custom
         @additional_operations = additional_operations
       end

data/lib/graphql_devise/mount_method/operation_preparers/default_operation_preparer.rb

@@ -10,14 +10,18 @@ module GraphqlDevise
         end
 
         def call
-          @selected_operations.except(*@custom_keys).each_with_object({}) do |(action, operation), result|
+          @selected_operations.except(*@custom_keys).each_with_object({}) do |(action, operation_info), result|
             mapped_action = "#{@mapping_name}_#{action}"
+            operation     = operation_info[:klass]
+            options       = operation_info.except(:klass)
 
             result[mapped_action.to_sym] = [
               OperationPreparers::GqlNameSetter.new(mapped_action),
               @preparer,
               OperationPreparers::ResourceNameSetter.new(@mapping_name)
-            ].reduce(child_class(operation)) { |prepared_operation, preparer| preparer.call(prepared_operation) }
+            ].reduce(child_class(operation)) do |prepared_operation, preparer|
+              preparer.call(prepared_operation, **options)
+            end
           end
         end
 

data/lib/graphql_devise/mount_method/operation_preparers/gql_name_setter.rb

@@ -6,7 +6,7 @@ module GraphqlDevise
           @mapping_name = mapping_name
         end
 
-        def call(operation)
+        def call(operation, **)
           operation.graphql_name(graphql_name)
 
           operation

data/lib/graphql_devise/mount_method/operation_preparers/mutation_field_setter.rb

@@ -6,9 +6,10 @@ module GraphqlDevise
           @authenticatable_type = authenticatable_type
         end
 
-        def call(mutation)
-          mutation.field(:authenticatable, @authenticatable_type, null: false)
+        def call(mutation, authenticatable: true)
+          return mutation unless authenticatable
 
+          mutation.field(:authenticatable, @authenticatable_type, null: false)
           mutation
         end
       end

data/lib/graphql_devise/mount_method/operation_preparers/resolver_type_setter.rb

@@ -6,7 +6,7 @@ module GraphqlDevise
           @authenticatable_type = authenticatable_type
         end
 
-        def call(resolver)
+        def call(resolver, **)
           resolver.type(@authenticatable_type, null: false)
 
           resolver