Merge pull request #199 from graphql-devise/remove-deprecated-authentication-methods

Remove deprecated authentication methods

Author: mcelicalderon

app/controllers/graphql_devise/concerns/additional_controller_methods.rb

@@ -40,24 +40,6 @@ def set_resource_by_token(resource)
         set_user_by_token(resource)
       end
 
-      def graphql_context(resource_name)
-        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
-          `graphql_context` is deprecated and will be removed in a future version of this gem.
-           Use `gql_devise_context(model)` instead.
-
-           EXAMPLE
-           include GraphqlDevise::Concerns::SetUserByToken
-
-           DummySchema.execute(params[:query], context: gql_devise_context(User))
-           DummySchema.execute(params[:query], context: gql_devise_context(User, Admin))
-        DEPRECATION
-
-        {
-          resource_name: resource_name,
-          controller:    self
-        }
-      end
-
       def build_redirect_headers(access_token, client, redirect_header_options = {})
         {
           DeviseTokenAuth.headers_names[:"access-token"] => access_token,

app/models/graphql_devise/concerns/model.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'graphql_devise/model/with_email_updater'
-
 module GraphqlDevise
   module Concerns
     module Model

lib/graphql_devise/resource_loader.rb

@@ -13,32 +13,23 @@ def call(query, mutation)
       # clean_options responds to all keys defined in GraphqlDevise::MountMethod::SUPPORTED_OPTIONS
       clean_options = GraphqlDevise::MountMethod::OptionSanitizer.new(@options).call!
 
-      model = if @resource.is_a?(String)
-        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
-          Providing a String as the model you want to mount is deprecated and will be removed in a future version of
-          this gem. Please use the actual model constant instead.
-
-          EXAMPLE
-
-          GraphqlDevise::ResourceLoader.new(User) # instead of GraphqlDevise::ResourceLoader.new('User')
-
-          mount_graphql_devise_for User # instead of mount_graphql_devise_for 'User'
-        DEPRECATION
-        @resource.constantize
-      else
-        @resource
+      unless @resource.is_a?(Class)
+        raise(
+          GraphqlDevise::InvalidMountOptionsError,
+          'A class must be provided when mounting a model. String values are no longer supported.'
+        )
       end
 
       # Necesary when mounting a resource via route file as Devise forces the reloading of routes
-      return clean_options if GraphqlDevise.resource_mounted?(model) && @routing
+      return clean_options if GraphqlDevise.resource_mounted?(@resource) && @routing
 
       validate_options!(clean_options)
 
       authenticatable_type = clean_options.authenticatable_type.presence ||
                              "Types::#{@resource}Type".safe_constantize ||
                              GraphqlDevise::Types::AuthenticatableType
 
-      prepared_mutations = prepare_mutations(model, clean_options, authenticatable_type)
+      prepared_mutations = prepare_mutations(@resource, clean_options, authenticatable_type)
 
       if prepared_mutations.any? && mutation.blank?
         raise GraphqlDevise::Error, 'You need to provide a mutation type unless all mutations are skipped'
@@ -48,7 +39,7 @@ def call(query, mutation)
         mutation.field(action, mutation: prepared_mutation, authenticate: false)
       end
 
-      prepared_resolvers = prepare_resolvers(model, clean_options, authenticatable_type)
+      prepared_resolvers = prepare_resolvers(@resource, clean_options, authenticatable_type)
 
       if prepared_resolvers.any? && query.blank?
         raise GraphqlDevise::Error, 'You need to provide a query type unless all queries are skipped'
@@ -59,7 +50,7 @@ def call(query, mutation)
       end
 
       GraphqlDevise.add_mapping(GraphqlDevise.to_mapping_name(@resource).to_sym, @resource)
-      GraphqlDevise.mount_resource(model) if @routing
+      GraphqlDevise.mount_resource(@resource) if @routing
 
       clean_options
     end

lib/graphql_devise/schema_plugin.rb

@@ -30,22 +30,7 @@ def trace(event, trace_data)
       auth_required = authenticate_option(field, trace_data)
       context       = context_from_data(trace_data)
 
-      if context.key?(:resource_name)
-        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
-          Providing `resource_name` as part of the GQL context, or doing so by using the `graphql_context(resource_name)`
-          method on your controller is deprecated and will be removed in a future version of this gem.
-          Please use `gql_devise_context` in you controller instead.
-
-          EXAMPLE
-          include GraphqlDevise::Concerns::SetUserByToken
-
-          DummySchema.execute(params[:query], context: gql_devise_context(User))
-          DummySchema.execute(params[:query], context: gql_devise_context(User, Admin))
-        DEPRECATION
-      end
-
       if auth_required && !(public_introspection && introspection_field?(field))
-        context = set_current_resource(context)
         raise_on_missing_resource(context, field, auth_required)
       end
 
@@ -56,25 +41,6 @@ def trace(event, trace_data)
 
     attr_reader :public_introspection
 
-    def set_current_resource(context)
-      controller     = context[:controller]
-      resource_names = Array(context[:resource_name])
-
-      context[:current_resource] ||= resource_names.find do |resource_name|
-        unless Devise.mappings.key?(resource_name)
-          raise(
-            GraphqlDevise::Error,
-            "Invalid resource_name `#{resource_name}` provided to `graphql_context`. Possible values are: #{Devise.mappings.keys}."
-          )
-        end
-
-        found = controller.set_resource_by_token(resource_name)
-        break found if found
-      end
-
-      context
-    end
-
     def raise_on_missing_resource(context, field, auth_required)
       @unauthenticated_proc.call(field.name) if context[:current_resource].blank?
 

spec/dummy/app/controllers/api/v1/graphql_controller.rb

@@ -15,28 +15,13 @@ def interpreter
         render json: InterpreterSchema.execute(params[:query], **execute_params(params))
       end
 
-      def failing_resource_name
-        render json: DummySchema.execute(params[:query], context: graphql_context([:user, :fail]))
-      end
-
-      def controller_auth
-        result = DummySchema.execute(
-          params[:query],
-          operation_name: params[:operationName],
-          variables:      ensure_hash(params[:variables]),
-          context:        gql_devise_context(SchemaUser, User)
-        )
-
-        render json: result unless performed?
-      end
-
       private
 
       def execute_params(item)
         {
           operation_name: item[:operationName],
           variables:      ensure_hash(item[:variables]),
-          context:        graphql_context([:user, :schema_user])
+          context:        gql_devise_context(SchemaUser, User)
         }
       end
 

spec/dummy/app/graphql/dummy_schema.rb

@@ -10,7 +10,7 @@ class DummySchema < GraphQL::Schema
         User,
         only: [
           :login,
-          :resend_confirmation_with_token,
+          :resend_confirmation_with_token
         ]
       ),
       GraphqlDevise::ResourceLoader.new(Guest, only: [:logout]),

spec/dummy/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  mount_graphql_devise_for 'User', at: '/api/v1/graphql_auth', operations: {
+  mount_graphql_devise_for User, at: '/api/v1/graphql_auth', operations: {
     login:    Mutations::Login,
     register: Mutations::Register
   }, additional_mutations: {
@@ -21,20 +21,18 @@
   )
 
   mount_graphql_devise_for(
-    'Guest',
+    Guest,
     only: [:login, :logout, :register],
     at:   '/api/v1/guest/graphql_auth'
   )
 
   mount_graphql_devise_for(
-    'Users::Customer',
+    Users::Customer,
     only: [:login],
     at:   '/api/v1/user_customer/graphql_auth'
   )
 
   get '/api/v1/graphql', to: 'api/v1/graphql#graphql'
   post '/api/v1/graphql', to: 'api/v1/graphql#graphql'
   post '/api/v1/interpreter', to: 'api/v1/graphql#interpreter'
-  post '/api/v1/failing', to: 'api/v1/graphql#failing_resource_name'
-  post '/api/v1/controller_auth', to: 'api/v1/graphql#controller_auth'
 end

spec/requests/user_controller_spec.rb

@@ -50,22 +50,6 @@
       GRAPHQL
     end
 
-    context 'when authenticating before using the GQL schema' do
-      before { post_request('/api/v1/controller_auth') }
-
-      context 'when user is authenticated' do
-        let(:headers) { create(:schema_user).create_new_auth_token }
-
-        it 'allows authentication at the controller level' do
-          expect(json_response[:data][:privateField]).to eq('Field will always require authentication')
-        end
-      end
-
-      context 'when user is not authenticated' do
-        it_behaves_like 'returns a must authenticate error', 'privateField'
-      end
-    end
-
     context 'when using a regular schema' do
       before { post_request('/api/v1/graphql') }
 
@@ -88,15 +72,6 @@
       context 'when user is not authenticated' do
         it_behaves_like 'returns a must authenticate error', 'privateField'
       end
-
-      context 'when using the failing route' do
-        it 'raises an invalid resource_name error' do
-          expect { post_request('/api/v1/failing') }.to raise_error(
-            GraphqlDevise::Error,
-            'Invalid resource_name `fail` provided to `graphql_context`. Possible values are: [:user, :admin, :guest, :users_customer, :schema_user].'
-          )
-        end
-      end
     end
 
     context 'when using an interpreter schema' do

spec/services/resource_loader_spec.rb

@@ -10,7 +10,7 @@
     let(:mutation) { class_double(GraphQL::Schema::Object) }
     let(:routing)  { false }
     let(:mounted)  { false }
-    let(:resource) { 'User' }
+    let(:resource) { User }
     let(:options)  { { only: [:login], additional_queries: { public_user: Class.new(GraphQL::Schema::Resolver) } } }
 
     before do