graphql_devise 0.18.2 → 1.0.0

data/lib/graphql_devise/types/query_type.rb

@@ -3,6 +3,7 @@
 module GraphqlDevise
   module Types
     class QueryType < GraphQL::Schema::Object
+      field_class GraphqlDevise::Types::BaseField if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('2.0')
     end
   end
 end

data/lib/graphql_devise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlDevise
-  VERSION = '0.18.2'.freeze
+  VERSION = '1.0.0'
 end

data/lib/graphql_devise.rb

@@ -1,13 +1,31 @@
 # frozen_string_literal: true
 
 require 'rails'
+require 'rails/generators'
 require 'graphql'
 require 'devise_token_auth'
+require 'zeitwerk'
+
+if Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.0')
+  GraphQL::Field.accepts_definitions(authenticate: GraphQL::Define.assign_metadata_key(:authenticate))
+  GraphQL::Schema::Field.accepts_definition(:authenticate)
+end
+
+loader = Zeitwerk::Loader.for_gem
+
+loader.collapse("#{__dir__}/graphql_devise/concerns")
+loader.collapse("#{__dir__}/graphql_devise/errors")
+loader.collapse("#{__dir__}/generators")
+
+loader.inflector.inflect('error_codes' => 'ERROR_CODES')
+loader.inflector.inflect('supported_options' => 'SUPPORTED_OPTIONS')
+
+loader.setup
 
 module GraphqlDevise
   class Error < StandardError; end
 
-  class InvalidMountOptionsError < GraphqlDevise::Error; end
+  class InvalidMountOptionsError < ::GraphqlDevise::Error; end
 
   @schema_loaded     = false
   @mounted_resources = []
@@ -52,32 +70,6 @@ module GraphqlDevise
   end
 end
 
+ActionDispatch::Routing::Mapper.include(GraphqlDevise::RouteMounter)
+
 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'
-
-# TODO: Remove when merged into master
-require 'graphql_devise/concerns/authenticatable'
-require 'graphql_devise/concerns/set_user_by_token.rb'
-
-require 'graphql_devise/concerns/controller_methods'
-require 'graphql_devise/schema'
-require 'graphql_devise/types/authenticatable_type'
-require 'graphql_devise/types/credential_type'
-require 'graphql_devise/types/mutation_type'
-require 'graphql_devise/types/query_type'
-require 'graphql_devise/default_operations/mutations'
-require 'graphql_devise/default_operations/resolvers'
-require 'graphql_devise/resolvers/dummy'
-
-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/spec/dummy/app/controllers/api/v1/graphql_controller.rb

@@ -15,28 +15,13 @@ module Api
         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
 

data/spec/dummy/app/graphql/dummy_schema.rb

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

data/spec/dummy/app/graphql/interpreter_schema.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 class InterpreterSchema < GraphQL::Schema
-  use GraphQL::Execution::Interpreter if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.9.0')
-  use GraphQL::Analysis::AST          if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0')
+  if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.9.0') && Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.0')
+    use GraphQL::Execution::Interpreter
+  end
+  if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('1.10.0') && Gem::Version.new(GraphQL::VERSION) < Gem::Version.new('2.0')
+    use GraphQL::Analysis::AST
+  end
 
   use GraphqlDevise::SchemaPlugin.new(query: Types::QueryType, authenticate_default: false)
 

data/spec/dummy/app/graphql/mutations/base_mutation.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Mutations
+  class BaseMutation < GraphQL::Schema::Mutation
+  end
+end

data/spec/dummy/app/graphql/mutations/update_user.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Mutations
-  class UpdateUser < GraphQL::Schema::Mutation
+  class UpdateUser < BaseMutation
     field :user, Types::UserType, null: false
 
     argument :email, String, required: false
@@ -10,10 +10,8 @@ module Mutations
     def resolve(**attrs)
       user = context[:current_resource]
 
-      schema_url = context[:controller].full_url_without_params
-
       user.update_with_email(
-        attrs.merge(schema_url: schema_url, confirmation_success_url: 'https://google.com')
+        attrs.merge(confirmation_url: 'https://google.com')
       )
 
       { user: user }

data/spec/dummy/app/graphql/types/admin_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Types
-  class AdminType < GraphQL::Schema::Object
+  class AdminType < BaseObject
     field :id,    Int,    null: false
     field :email, String, null: false
   end

data/spec/dummy/app/graphql/types/custom_admin_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Types
-  class CustomAdminType < GraphQL::Schema::Object
+  class CustomAdminType < BaseObject
     field :email,        String, null: false
     field :custom_field, String, null: false
 

data/spec/dummy/app/graphql/types/mutation_type.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Types
-  class MutationType < Types::BaseObject
+  class MutationType < BaseObject
+    field_class GraphqlDevise::Types::BaseField if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('2.0')
+
     field :dummy_mutation, String, null: false, authenticate: true
     field :update_user, mutation: Mutations::UpdateUser
 

data/spec/dummy/app/graphql/types/query_type.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Types
-  class QueryType < Types::BaseObject
+  class QueryType < BaseObject
+    field_class GraphqlDevise::Types::BaseField if Gem::Version.new(GraphQL::VERSION) >= Gem::Version.new('2.0')
+
     field :user, resolver: Resolvers::UserShow
     field :public_field, String, null: false, authenticate: false
     field :private_field, String, null: false, authenticate: true

data/spec/dummy/app/graphql/types/user_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Types
-  class UserType < GraphQL::Schema::Object
+  class UserType < BaseObject
     field :id,            Int,    null: false
     field :email,         String, null: false
     field :name,          String, null: false

data/spec/dummy/config/environments/test.rb

@@ -43,5 +43,5 @@ Rails.application.configure do
   config.active_support.deprecation = :stderr
 
   # Raises error for missing translations
-  config.action_view.raise_on_missing_translations = true
+  config.action_view.raise_on_missing_translations = true if Rails::VERSION::MAJOR < 7
 end

data/spec/dummy/config/routes.rb

@@ -1,9 +1,8 @@
 # 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,
-    sign_up:  Mutations::SignUp,
     register: Mutations::Register
   }, additional_mutations: {
     register_confirmed_user: Mutations::RegisterConfirmedUser
@@ -14,22 +13,21 @@ Rails.application.routes.draw do
   mount_graphql_devise_for(
     Admin,
     authenticatable_type: Types::CustomAdminType,
-    skip:                 [:sign_up, :register, :check_password_token],
+    skip:                 [:register],
     operations:           {
-      confirm_account:            Resolvers::ConfirmAdminAccount,
       update_password_with_token: Mutations::ResetAdminPasswordWithToken
     },
     at:                   '/api/v1/admin/graphql_auth'
   )
 
   mount_graphql_devise_for(
-    'Guest',
-    only: [:login, :logout, :sign_up, :register],
+    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'
   )
@@ -37,6 +35,4 @@ Rails.application.routes.draw do
   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

data/spec/graphql_devise/model/with_email_updater_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe GraphqlDevise::Model::WithEmailUpdater do
       let(:resource) { create(:admin, :confirmed) }
 
       context 'when attributes contain email' do
-        let(:attributes) { { email: 'new@gmail.com', schema_url: 'http://localhost/test', confirmation_success_url: 'https://google.com' } }
+        let(:attributes) { { email: 'new@gmail.com', confirmation_url: 'https://google.com' } }
 
         it 'does not postpone email update' do
           expect do
@@ -78,7 +78,7 @@ RSpec.describe GraphqlDevise::Model::WithEmailUpdater do
       let(:resource) { create(:user, :confirmed) }
 
       context 'when attributes do not contain email' do
-        let(:attributes) { { name: 'Updated Name', schema_url: 'http://localhost/test', confirmation_success_url: 'https://google.com' } }
+        let(:attributes) { { name: 'Updated Name', confirmation_url: 'https://google.com' } }
 
         it 'updates resource, ignores url params' do
           expect do
@@ -89,11 +89,15 @@ RSpec.describe GraphqlDevise::Model::WithEmailUpdater do
       end
 
       context 'when attributes contain email' do
-        context 'when confirmation_success_url is used' do
-          it_behaves_like 'all required arguments are provided', schema_url: 'http://localhost/test', confirmation_success_url: 'https://google.com'
+        context 'when confirmation_url is used' do
+          it_behaves_like 'all required arguments are provided', confirmation_url: 'https://google.com'
+
+          context 'when arguments hash has strings as keys' do
+            it_behaves_like 'all required arguments are provided', 'confirmation_url' => 'https://google.com'
+          end
 
-          context 'when confirmation_success_url is missing and no default is set' do
-            let(:attributes) { { email: 'new@gmail.com', name: 'Updated Name', schema_url: 'http://localhost/test' } }
+          context 'when confirmation_url is missing and no default is set' do
+            let(:attributes) { { email: 'new@gmail.com', name: 'Updated Name' } }
 
             before { allow(DeviseTokenAuth).to receive(:default_confirm_success_url).and_return(nil) }
 
@@ -105,7 +109,7 @@ RSpec.describe GraphqlDevise::Model::WithEmailUpdater do
             end
 
             context 'when email will not change' do
-              let(:attributes) { { email: resource.email, name: 'changed', confirmation_success_url: 'https://google.com' } }
+              let(:attributes) { { email: resource.email, name: 'changed' } }
 
               it 'updates name and does not raise an error' do
                 expect do
@@ -121,37 +125,15 @@ RSpec.describe GraphqlDevise::Model::WithEmailUpdater do
           end
         end
 
-        context 'when confirm_url is used' do
-          it_behaves_like 'all required arguments are provided', confirmation_url: 'https://google.com'
-
-          context 'when arguments hash has strings as keys' do
-            it_behaves_like 'all required arguments are provided', 'confirmation_url' => 'https://google.com'
-          end
-        end
-
         context 'when no confirmation url is provided is provided' do
-          context 'when schema_url is provided' do
-            let(:attributes) { { email: 'new@gmail.com', name: 'Updated Name', schema_url: 'http://localhost/test' } }
-
-            it 'uses DTA default_confirm_success_url on the email with redirect flow' do
-              expect { updater }.to change(ActionMailer::Base.deliveries, :count).by(1)
-
-              email = ActionMailer::Base.deliveries.first
-              expect(email.body.decoded).to include(CGI.escape('https://google.com'))
-              expect(email.body.decoded).to include(CGI.escape('ConfirmAccount('))
-            end
-          end
+          let(:attributes) { { email: 'new@gmail.com', name: 'Updated Name' } }
 
-          context 'when schema_url is not provided' do
-            let(:attributes) { { email: 'new@gmail.com', name: 'Updated Name' } }
+          it 'uses DTA default_confirm_success_url on the email and new confirmation flow' do
+            expect { updater }.to change(ActionMailer::Base.deliveries, :count).by(1)
 
-            it 'uses DTA default_confirm_success_url on the email and new confirmation flow' do
-              expect { updater }.to change(ActionMailer::Base.deliveries, :count).by(1)
-
-              email = ActionMailer::Base.deliveries.first
-              expect(email.body.decoded).to include(CGI.escape('https://google.com'))
-              expect(email.body.decoded).to include('?confirmationToken=')
-            end
+            email = ActionMailer::Base.deliveries.first
+            expect(email.body.decoded).to include('https://google.com')
+            expect(email.body.decoded).to include('?confirmationToken=')
           end
         end
       end

data/spec/rails_helper.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 ENV['RAILS_ENV'] ||= 'test'
-ENGINE_ROOT = File.join(File.dirname(__FILE__), '../')
+GQL_DEVISE_ROOT = File.join(File.dirname(__FILE__), '../')
 
 require File.expand_path('dummy/config/environment.rb', __dir__)
 
@@ -16,12 +16,12 @@ require 'faker'
 require 'generator_spec'
 
 # Load RSpec helpers.
-Dir[File.join(ENGINE_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
+Dir[File.join(GQL_DEVISE_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
 
 begin
   ActiveRecord::Migrator.migrations_paths = [
-    File.join(ENGINE_ROOT, 'spec/dummy/db/migrate'),
-    File.join(ENGINE_ROOT, 'spec/db/migrate')
+    File.join(GQL_DEVISE_ROOT, 'spec/dummy/db/migrate'),
+    File.join(GQL_DEVISE_ROOT, 'spec/db/migrate')
   ]
   ActiveRecord::Migration.maintain_test_schema!
 rescue ActiveRecord::PendingMigrationError => e
@@ -29,7 +29,7 @@ rescue ActiveRecord::PendingMigrationError => e
   exit 1
 end
 RSpec.configure do |config|
-  config.fixture_path = "#{ENGINE_ROOT}/spec/fixtures"
+  config.fixture_path = "#{GQL_DEVISE_ROOT}/spec/fixtures"
 
   config.use_transactional_fixtures = true
 

data/spec/requests/mutations/resend_confirmation_with_token_spec.rb

@@ -105,9 +105,8 @@ RSpec.describe 'Resend confirmation with token' do
 
     before do
       user.update_with_email(
-        email:                    new_email,
-        schema_url:               'http://localhost/test',
-        confirmation_success_url: 'https://google.com'
+        email:            new_email,
+        confirmation_url: 'https://google.com'
       )
     end
 

data/spec/requests/user_controller_spec.rb

@@ -50,22 +50,6 @@ RSpec.describe "Integrations with the user's controller" do
       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 @@ RSpec.describe "Integrations with the user's controller" do
       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
@@ -245,14 +220,7 @@ RSpec.describe "Integrations with the user's controller" do
 
       email = Nokogiri::HTML(ActionMailer::Base.deliveries.last.body.encoded)
       link  = email.css('a').first
-      expect(link['href']).to include('/api/v1/graphql')
-
-      expect do
-        get link['href']
-        user.reload
-      end.to change(user, :email).from(original_email).to('updated@gmail.com').and(
-        change(user, :uid).from(original_email).to('updated@gmail.com')
-      )
+      expect(link['href']).to include('https://google.com')
     end
   end
 

data/spec/services/resource_loader_spec.rb

@@ -10,8 +10,8 @@ RSpec.describe GraphqlDevise::ResourceLoader do
     let(:mutation) { class_double(GraphQL::Schema::Object) }
     let(:routing)  { false }
     let(:mounted)  { false }
-    let(:resource) { 'User' }
-    let(:options)  { { only: [:login, :confirm_account] } }
+    let(:resource) { User }
+    let(:options)  { { only: [:login], additional_queries: { public_user: Class.new(GraphQL::Schema::Resolver) } } }
 
     before do
       allow(GraphqlDevise).to receive(:add_mapping).with(:user, resource)
@@ -20,7 +20,7 @@ RSpec.describe GraphqlDevise::ResourceLoader do
     end
 
     it 'loads operations into the provided types' do
-      expect(query).to             receive(:field).with(:user_confirm_account, resolver: instance_of(Class), authenticate: false)
+      expect(query).to             receive(:field).with(:public_user, resolver: instance_of(Class), authenticate: false)
       expect(mutation).to          receive(:field).with(:user_login, mutation: instance_of(Class), authenticate: false)
       expect(GraphqlDevise).to     receive(:add_mapping).with(:user, resource)
       expect(GraphqlDevise).not_to receive(:mount_resource)
@@ -30,6 +30,17 @@ RSpec.describe GraphqlDevise::ResourceLoader do
       expect(returned).to be_a(Struct)
     end
 
+    context 'when resource is not class' do
+      let(:resource) { 'User' }
+
+      it 'raises an error' do
+        expect { loader }.to raise_error(
+          GraphqlDevise::Error,
+          'A class must be provided when mounting a model. String values are no longer supported.'
+        )
+      end
+    end
+
     context 'when mutation is nil' do
       let(:mutation) { nil }