graphql_devise 0.11.3 → 0.12.3

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/app/views/graphql_devise/mailer/confirmation_instructions.html.erb

@@ -2,4 +2,4 @@
 
 <p><%= t('.confirm_link_msg') %></p>
 
-<p><%= link_to t('.confirm_account_link'), url_for(controller: 'graphql_devise/graphql', action: :auth, **confirmation_query(resource_name: @resource.class.to_s, redirect_url: message['redirect-url'], token: @token)) %></p>
+<p><%= link_to t('.confirm_account_link'), url_for(controller: message['controller'], action: message['action'], **confirmation_query(resource_name: @resource.class.to_s, redirect_url: message['redirect-url'], token: @token)) %></p>

data/app/views/graphql_devise/mailer/reset_password_instructions.html.erb

@@ -2,7 +2,7 @@
 
 <p><%= t('.request_reset_link_msg') %></p>
 
-<p><%= link_to t('.password_change_link'), url_for(controller: 'graphql_devise/graphql', action: :auth, **password_reset_query(token: @token, redirect_url: message['redirect-url'], resource_name: @resource.class.to_s)) %></p>
+<p><%= link_to t('.password_change_link'), url_for(controller: message['controller'], action: message['action'], **password_reset_query(token: @token, redirect_url: message['redirect-url'], resource_name: @resource.class.to_s)) %></p>
 
 <p><%= t('.ignore_mail_msg') %></p>
 <p><%= t('.no_changes_msg') %></p>

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

@@ -12,5 +12,7 @@ GraphqlDevise::Engine.routes.draw do
     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.12.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,6 +5,8 @@ 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
@@ -29,15 +31,20 @@ module GraphqlDevise
 
     def mount_resource_route
       routes_file = 'config/routes.rb'
-      gem_route   = "mount_graphql_devise_for '#{user_class}', at: '#{mount_path}'"
       dta_route   = "mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'"
 
-      if file_contains_str?(routes_file, gem_route)
+      if options['mount'] != 'separate_route'
         gsub_file(routes_file, /^\s+#{Regexp.escape(dta_route + "\n")}/i, '')
-
-        say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
       else
-        gsub_file(routes_file, /#{Regexp.escape(dta_route)}/i, gem_route)
+        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, '')
+
+          say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
+        else
+          gsub_file(routes_file, /#{Regexp.escape(dta_route)}/i, gem_route)
+        end
       end
     end
 
@@ -65,6 +72,22 @@ module GraphqlDevise
       )
     end
 
+    def mount_in_schema
+      return if options['mount'] == 'separate_route'
+
+      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
+    end
+
     private
 
     def file_contains_str?(filename, regex_str)

data/lib/graphql_devise.rb

@@ -18,15 +18,32 @@ module GraphqlDevise
     @schema_loaded = true
   end
 
-  def self.mount_resource(resource)
-    @mounted_resources << resource
+  def self.resource_mounted?(mapping_name)
+    @mounted_resources.include?(mapping_name)
   end
 
-  def self.resource_mounted?(resource)
-    @mounted_resources.include?(resource)
+  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'
@@ -37,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

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

@@ -6,8 +6,8 @@ module GraphqlDevise
           @name = name
         end
 
-        def call(operation)
-          operation.instance_variable_set(:@resource_name, @name.to_sym)
+        def call(operation, **)
+          operation.instance_variable_set(:@resource_name, @name)
 
           operation
         end

data/lib/graphql_devise/mutations/resend_confirmation.rb

@@ -19,13 +19,11 @@ module GraphqlDevise
 
           resource.send_confirmation_instructions(
             redirect_url:  redirect_url,
-            template_path: ['graphql_devise/mailer']
+            template_path: ['graphql_devise/mailer'],
+            **controller.params.permit('controller', 'action').to_h.symbolize_keys
           )
 
-          {
-            authenticatable: resource,
-            message:       I18n.t('graphql_devise.confirmations.send_instructions', email: email)
-          }
+          { message: I18n.t('graphql_devise.confirmations.send_instructions', email: email) }
         else
           raise_user_error(I18n.t('graphql_devise.confirmations.user_not_found', email: email))
         end

data/lib/graphql_devise/mutations/send_password_reset.rb

@@ -4,6 +4,8 @@ module GraphqlDevise
       argument :email,        String, required: true
       argument :redirect_url, String, required: true
 
+      field :message, String, null: false
+
       def resolve(email:, redirect_url:)
         resource = find_resource(:email, get_case_insensitive_field(:email, email))
 
@@ -14,11 +16,12 @@ module GraphqlDevise
             email:         email,
             provider:      'email',
             redirect_url:  redirect_url,
-            template_path: ['graphql_devise/mailer']
+            template_path: ['graphql_devise/mailer'],
+            **controller.params.permit('controller', 'action').to_h.symbolize_keys
           )
 
           if resource.errors.empty?
-            { authenticatable: resource }
+            { message: I18n.t('graphql_devise.passwords.send_instructions') }
           else
             raise_user_error_list(I18n.t('graphql_devise.invalid_resource'), errors: resource.errors.full_messages)
           end

data/lib/graphql_devise/mutations/sign_up.rb

@@ -27,7 +27,8 @@ module GraphqlDevise
           unless resource.confirmed?
             resource.send_confirmation_instructions(
               redirect_url:  confirm_success_url,
-              template_path: ['graphql_devise/mailer']
+              template_path: ['graphql_devise/mailer'],
+              **controller.params.permit('controller', 'action').to_h.symbolize_keys
             )
           end
 
@@ -35,7 +36,7 @@ module GraphqlDevise
 
           { authenticatable: resource }
         else
-          clean_up_passwords(resource)
+          resource.try(:clean_up_passwords)
           raise_user_error_list(
             I18n.t('graphql_devise.registration_failed'),
             errors: resource.errors.full_messages
@@ -48,10 +49,6 @@ module GraphqlDevise
       def build_resource(attrs)
         resource_class.new(attrs)
       end
-
-      def clean_up_passwords(resource)
-        controller.send(:clean_up_passwords, resource)
-      end
     end
   end
 end

data/lib/graphql_devise/rails/routes.rb

@@ -1,80 +1,13 @@
 module ActionDispatch::Routing
   class Mapper
-    DEVISE_OPERATIONS = [
-      :sessions,
-      :registrations,
-      :passwords,
-      :confirmations,
-      :omniauth_callbacks,
-      :unlocks,
-      :invitations
-    ].freeze
-
     def mount_graphql_devise_for(resource, options = {})
-      default_operations = GraphqlDevise::DefaultOperations::MUTATIONS.merge(GraphqlDevise::DefaultOperations::QUERIES)
-
-      # clean_options responds to all keys defined in GraphqlDevise::MountMethod::SUPPORTED_OPTIONS
-      clean_options = GraphqlDevise::MountMethod::OptionSanitizer.new(options).call!
-
-      GraphqlDevise::MountMethod::OptionsValidator.new(
-        [
-          GraphqlDevise::MountMethod::OptionValidators::SkipOnlyValidator.new(options: clean_options),
-          GraphqlDevise::MountMethod::OptionValidators::ProvidedOperationsValidator.new(
-            options: clean_options, supported_operations: default_operations
-          )
-        ]
-      ).validate!
-
-      devise_for(
-        resource.pluralize.underscore.tr('/', '_').to_sym,
-        module:     :devise,
-        class_name: resource,
-        skip:       DEVISE_OPERATIONS
+      clean_options = GraphqlDevise::ResourceLoader.new(resource, options, true).call(
+        GraphqlDevise::Types::QueryType,
+        GraphqlDevise::Types::MutationType
       )
 
-      devise_scope resource.underscore.tr('/', '_').to_sym do
-        post clean_options.at, to: 'graphql_devise/graphql#auth'
-        get  clean_options.at, to: 'graphql_devise/graphql#auth'
-      end
-
-      # Avoid routes reload done by Devise
-      return if GraphqlDevise.resource_mounted?(resource)
-
-      authenticatable_type = clean_options.authenticatable_type.presence ||
-                             "Types::#{resource}Type".safe_constantize ||
-                             GraphqlDevise::Types::AuthenticatableType
-
-      prepared_mutations = GraphqlDevise::MountMethod::OperationPreparer.new(
-        resource:              resource,
-        custom:                clean_options.operations,
-        additional_operations: clean_options.additional_mutations,
-        preparer:              GraphqlDevise::MountMethod::OperationPreparers::MutationFieldSetter.new(authenticatable_type),
-        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
-          default: GraphqlDevise::DefaultOperations::MUTATIONS, only: clean_options.only, skipped: clean_options.skip
-        )
-      ).call
-
-      prepared_mutations.each do |action, mutation|
-        GraphqlDevise::Types::MutationType.field(action, mutation: mutation)
-      end
-
-      prepared_queries = GraphqlDevise::MountMethod::OperationPreparer.new(
-        resource:              resource,
-        custom:                clean_options.operations,
-        additional_operations: clean_options.additional_queries,
-        preparer:              GraphqlDevise::MountMethod::OperationPreparers::ResolverTypeSetter.new(authenticatable_type),
-        selected_operations:   GraphqlDevise::MountMethod::OperationSanitizer.call(
-          default: GraphqlDevise::DefaultOperations::QUERIES, only: clean_options.only, skipped: clean_options.skip
-        )
-      ).call
-
-      prepared_queries.each do |action, resolver|
-        GraphqlDevise::Types::QueryType.field(action, resolver: resolver)
-      end
-
-      Devise.mailer.helper(GraphqlDevise::MailerHelper)
-
-      GraphqlDevise.mount_resource(resource)
+      post clean_options.at, to: 'graphql_devise/graphql#auth'
+      get  clean_options.at, to: 'graphql_devise/graphql#auth'
     end
   end
 end