graphql_devise 0.14.1 → 0.17.0

data/spec/requests/user_controller_spec.rb

@@ -5,6 +5,14 @@ require 'rails_helper'
 RSpec.describe "Integrations with the user's controller" do
   include_context 'with graphql query request'
 
+  shared_examples 'returns a must authenticate error' do |field|
+    it 'returns a must sign in error' do
+      expect(json_response[:errors]).to contain_exactly(
+        hash_including(message: "#{field} field requires authentication", extensions: { code: 'AUTHENTICATION_ERROR' })
+      )
+    end
+  end
+
   let(:user) { create(:user, :confirmed) }
 
   describe 'publicField' do
@@ -42,6 +50,22 @@ 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') }
 
@@ -62,11 +86,7 @@ RSpec.describe "Integrations with the user's controller" do
       end
 
       context 'when user is not authenticated' do
-        it 'returns a must sign in error' do
-          expect(json_response[:errors]).to contain_exactly(
-            hash_including(message: 'privateField field requires authentication', extensions: { code: 'AUTHENTICATION_ERROR' })
-          )
-        end
+        it_behaves_like 'returns a must authenticate error', 'privateField'
       end
 
       context 'when using the failing route' do
@@ -91,11 +111,7 @@ RSpec.describe "Integrations with the user's controller" do
       end
 
       context 'when user is not authenticated' do
-        it 'returns a must sign in error' do
-          expect(json_response[:errors]).to contain_exactly(
-            hash_including(message: 'privateField field requires authentication', extensions: { code: 'AUTHENTICATION_ERROR' })
-          )
-        end
+        it_behaves_like 'returns a must authenticate error', 'privateField'
       end
     end
   end
@@ -121,11 +137,7 @@ RSpec.describe "Integrations with the user's controller" do
       end
 
       context 'when user is not authenticated' do
-        it 'returns a must sign in error' do
-          expect(json_response[:errors]).to contain_exactly(
-            hash_including(message: 'dummyMutation field requires authentication', extensions: { code: 'AUTHENTICATION_ERROR' })
-          )
-        end
+        it_behaves_like 'returns a must authenticate error', 'dummyMutation'
       end
     end
 
@@ -141,11 +153,7 @@ RSpec.describe "Integrations with the user's controller" do
       end
 
       context 'when user is not authenticated' do
-        it 'returns a must sign in error' do
-          expect(json_response[:errors]).to contain_exactly(
-            hash_including(message: 'dummyMutation field requires authentication', extensions: { code: 'AUTHENTICATION_ERROR' })
-          )
-        end
+        it_behaves_like 'returns a must authenticate error', 'dummyMutation'
       end
     end
   end
@@ -179,11 +187,7 @@ RSpec.describe "Integrations with the user's controller" do
       end
 
       context 'when user is not authenticated' do
-        it 'returns a must sign in error' do
-          expect(json_response[:errors]).to contain_exactly(
-            hash_including(message: 'user field requires authentication', extensions: { code: 'AUTHENTICATION_ERROR' })
-          )
-        end
+        it_behaves_like 'returns a must authenticate error', 'user'
       end
     end
 
@@ -251,4 +255,61 @@ RSpec.describe "Integrations with the user's controller" do
       )
     end
   end
+
+  describe 'vipField' do
+    let(:error_message) { 'Field available only for VIP Users' }
+    let(:query) do
+      <<-GRAPHQL
+        query { vipField }
+      GRAPHQL
+    end
+
+    context 'when using a regular schema' do
+      before { post_request('/api/v1/graphql') }
+
+      context 'when user is authenticated' do
+        let(:headers) { user.create_new_auth_token }
+
+        context 'when schema user is VIP' do
+          let(:user) { create(:user, :confirmed, vip: true) }
+
+          it 'allows to perform the query' do
+            expect(json_response[:data][:vipField]).to eq(error_message)
+          end
+        end
+
+        context 'when schema user is not VIP' do
+          it_behaves_like 'returns a must authenticate error', 'vipField'
+        end
+      end
+
+      context 'when user is not authenticated' do
+        it_behaves_like 'returns a must authenticate error', 'vipField'
+      end
+    end
+
+    context 'when using the interpreter schema' do
+      before { post_request('/api/v1/interpreter') }
+
+      context 'when user is authenticated' do
+        let(:headers) { user.create_new_auth_token }
+
+        context 'when schema user is VIP' do
+          let(:user) { create(:user, :confirmed, vip: true) }
+
+          it 'allows to perform the query' do
+            expect(json_response[:data][:vipField]).to eq(error_message)
+          end
+        end
+
+        context 'when schema user is not VIP' do
+          it_behaves_like 'returns a must authenticate error', 'vipField'
+        end
+      end
+
+      context 'when user is not authenticated' do
+        it_behaves_like 'returns a must authenticate error', 'vipField'
+      end
+    end
+  end
 end

data/spec/services/mount_method/operation_preparer_spec.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe GraphqlDevise::MountMethod::OperationPreparer do
   describe '#call' do
     subject(:prepared_operations) do
       described_class.new(
-        mapping_name:          mapping,
+        model:                 model,
         selected_operations:   selected,
         preparer:              preparer,
         custom:                custom,
@@ -15,14 +15,14 @@ RSpec.describe GraphqlDevise::MountMethod::OperationPreparer do
     end
 
     let(:logout_class) { Class.new(GraphQL::Schema::Resolver) }
-    let(:mapping)      { :user }
+    let(:model)        { User }
     let(:preparer)     { double(:preparer, call: logout_class) }
     let(:custom)       { { login: double(:custom_login, graphql_name: nil) } }
     let(:additional)   { { user_additional: double(:user_additional) } }
     let(:selected) do
       {
-        login: { klass: double(:login_default) },
-        logout:{ klass: logout_class }
+        login:  { klass: double(:login_default) },
+        logout: { klass: logout_class }
       }
     end
 

data/spec/services/mount_method/operation_preparers/custom_operation_preparer_spec.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::CustomOperationPreparer do
   describe '#call' do
-    subject(:prepared) { described_class.new(selected_keys: selected_keys, custom_operations: operations, mapping_name: mapping_name).call }
+    subject(:prepared) { described_class.new(selected_keys: selected_keys, custom_operations: operations, model: model).call }
 
     let(:login_operation)  { double(:confirm_operation, graphql_name: nil) }
     let(:logout_operation) { double(:sign_up_operation, graphql_name: nil) }
-    let(:mapping_name)     { :user }
+    let(:model)            { User }
     let(:operations)       { { login: login_operation, logout: logout_operation, invalid: double(:invalid) } }
     let(:selected_keys)    { [:login, :logout, :sign_up, :confirm] }
 
@@ -22,8 +22,8 @@ RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::CustomOperationPr
 
       prepared
 
-      expect(login_operation.instance_variable_get(:@resource_name)).to eq(:user)
-      expect(logout_operation.instance_variable_get(:@resource_name)).to eq(:user)
+      expect(login_operation.instance_variable_get(:@resource_klass)).to eq(User)
+      expect(logout_operation.instance_variable_get(:@resource_klass)).to eq(User)
     end
 
     context 'when no selected keys are provided' do

data/spec/services/mount_method/operation_preparers/default_operation_preparer_spec.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::DefaultOperationPreparer do
   describe '#call' do
     subject(:prepared) { default_preparer.call }
 
-    let(:default_preparer)  { described_class.new(selected_operations: operations, custom_keys: custom_keys, mapping_name: mapping_name, preparer: preparer) }
+    let(:default_preparer)  { described_class.new(selected_operations: operations, custom_keys: custom_keys, model: model, preparer: preparer) }
     let(:confirm_operation) { double(:confirm_operation, graphql_name: nil) }
     let(:sign_up_operation) { double(:sign_up_operation, graphql_name: nil) }
     let(:login_operation)   { double(:confirm_operation, graphql_name: nil) }
     let(:logout_operation)  { double(:sign_up_operation, graphql_name: nil) }
-    let(:mapping_name)      { :user }
+    let(:model)             { User }
     let(:preparer)          { double(:preparer) }
     let(:custom_keys)       { [:login, :logout] }
     let(:operations) do
@@ -46,8 +46,8 @@ RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::DefaultOperationP
 
       prepared
 
-      expect(confirm_operation.instance_variable_get(:@resource_name)).to eq(:user)
-      expect(sign_up_operation.instance_variable_get(:@resource_name)).to eq(:user)
+      expect(confirm_operation.instance_variable_get(:@resource_klass)).to eq(User)
+      expect(sign_up_operation.instance_variable_get(:@resource_klass)).to eq(User)
     end
 
     context 'when no custom keys are provided' do

data/spec/services/mount_method/operation_preparers/{resource_name_setter_spec.rb → resource_klass_setter_spec.rb}

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require 'rails_helper'
 
-RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::ResourceNameSetter do
+RSpec.describe GraphqlDevise::MountMethod::OperationPreparers::ResourceKlassSetter do
   describe '#call' do
-    subject(:prepared_operation) { described_class.new(mapping_name).call(operation) }
+    subject(:prepared_operation) { described_class.new(model).call(operation) }
 
-    let(:operation)    { double(:operation) }
-    let(:mapping_name) { :user }
+    let(:operation) { double(:operation) }
+    let(:model) { User }
 
     it 'sets a gql name to the operation' do
-      expect(prepared_operation.instance_variable_get(:@resource_name)).to eq(:user)
+      expect(prepared_operation.instance_variable_get(:@resource_klass)).to eq(model)
     end
   end
 end

data/spec/services/mount_method/operation_sanitizer_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe GraphqlDevise::MountMethod::OperationSanitizer do
     context 'when the operations passed are mutations' do
       let(:skipped)  { [] }
       let(:only)     { [] }
-      let(:default)  { { operation1: op_class1, operation2: op_class2 } }
+      let(:default)  { { operation1: { klass: op_class1 }, operation2: { klass: op_class2 } } }
 
       context 'when no other option besides default is passed' do
         it { is_expected.to eq(default) }
@@ -22,13 +22,13 @@ RSpec.describe GraphqlDevise::MountMethod::OperationSanitizer do
       context 'when there are only operations' do
         let(:only) { [:operation1] }
 
-        it { is_expected.to eq(operation1: op_class1) }
+        it { is_expected.to eq(operation1: { klass: op_class1 }) }
       end
 
       context 'when there are skipped operations' do
         let(:skipped) { [:operation2] }
 
-        it { is_expected.to eq(operation1: op_class1) }
+        it { is_expected.to eq(operation1: { klass: op_class1 }) }
       end
     end
   end

data/spec/services/resource_loader_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require 'rails_helper'
 
 RSpec.describe GraphqlDevise::ResourceLoader do
   describe '#call' do
@@ -15,8 +15,8 @@ RSpec.describe GraphqlDevise::ResourceLoader do
 
     before do
       allow(GraphqlDevise).to receive(:add_mapping).with(:user, resource)
-      allow(GraphqlDevise).to receive(:resource_mounted?).with(:user).and_return(mounted)
-      allow(GraphqlDevise).to receive(:mount_resource).with(:user)
+      allow(GraphqlDevise).to receive(:resource_mounted?).with(User).and_return(mounted)
+      allow(GraphqlDevise).to receive(:mount_resource).with(User)
     end
 
     it 'loads operations into the provided types' do
@@ -64,13 +64,13 @@ RSpec.describe GraphqlDevise::ResourceLoader do
 
       it 'adds mappings' do
         expect(GraphqlDevise).to receive(:add_mapping).with(:user, resource)
-        expect(GraphqlDevise).to receive(:mount_resource).with(:user)
+        expect(GraphqlDevise).to receive(:mount_resource).with(User)
 
         loader
       end
 
       context 'when resource was already mounted' do
-        before { allow(GraphqlDevise).to receive(:resource_mounted?).with(:user).and_return(true) }
+        before { allow(GraphqlDevise).to receive(:resource_mounted?).with(User).and_return(true) }
 
         it 'skips schema loading' do
           expect(query).not_to         receive(:field)

data/spec/support/contexts/graphql_request.rb

@@ -5,17 +5,25 @@ RSpec.shared_context 'with graphql query request' do
   let(:variables) { {} }
   let(:graphql_params) do
     if Rails::VERSION::MAJOR >= 5
-      [{ params: { query: query, variables: variables }, headers: headers }]
+      { params: { query: query, variables: variables }, headers: headers }
     else
       [{ query: query, variables: variables }, headers]
     end
   end
 
   def post_request(path = '/api/v1/graphql_auth')
-    post path, *graphql_params
+    send_request(path, :post)
   end
 
   def get_request(path = '/api/v1/graphql_auth')
-    get path, *graphql_params
+    send_request(path, :get)
+  end
+
+  def send_request(path, method)
+    if Rails::VERSION::MAJOR >= 5
+      public_send(method, path, **graphql_params)
+    else
+      public_send(method, path, *graphql_params)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql_devise
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.17.0
 platform: ruby
 authors:
 - Mario Celi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise_token_auth
@@ -86,19 +86,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -275,13 +275,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/enhancement.md"
 - ".github/ISSUE_TEMPLATE/question.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -289,10 +289,12 @@ files:
 - README.md
 - Rakefile
 - app/controllers/graphql_devise/application_controller.rb
+- app/controllers/graphql_devise/concerns/additional_controller_methods.rb
 - app/controllers/graphql_devise/concerns/set_user_by_token.rb
 - app/controllers/graphql_devise/graphql_controller.rb
 - app/helpers/graphql_devise/application_helper.rb
 - app/helpers/graphql_devise/mailer_helper.rb
+- app/models/graphql_devise/concerns/additional_model_methods.rb
 - app/models/graphql_devise/concerns/model.rb
 - app/views/.keep
 - app/views/graphql_devise/mailer/confirmation_instructions.html.erb
@@ -322,7 +324,7 @@ files:
 - lib/graphql_devise/mount_method/operation_preparers/gql_name_setter.rb
 - lib/graphql_devise/mount_method/operation_preparers/mutation_field_setter.rb
 - lib/graphql_devise/mount_method/operation_preparers/resolver_type_setter.rb
-- lib/graphql_devise/mount_method/operation_preparers/resource_name_setter.rb
+- lib/graphql_devise/mount_method/operation_preparers/resource_klass_setter.rb
 - lib/graphql_devise/mount_method/operation_sanitizer.rb
 - lib/graphql_devise/mount_method/option_sanitizer.rb
 - lib/graphql_devise/mount_method/option_sanitizers/array_checker.rb
@@ -335,9 +337,12 @@ files:
 - lib/graphql_devise/mount_method/options_validator.rb
 - lib/graphql_devise/mount_method/supported_options.rb
 - lib/graphql_devise/mutations/base.rb
+- lib/graphql_devise/mutations/confirm_registration_with_token.rb
 - lib/graphql_devise/mutations/login.rb
 - lib/graphql_devise/mutations/logout.rb
+- lib/graphql_devise/mutations/register.rb
 - lib/graphql_devise/mutations/resend_confirmation.rb
+- lib/graphql_devise/mutations/resend_confirmation_with_token.rb
 - lib/graphql_devise/mutations/send_password_reset.rb
 - lib/graphql_devise/mutations/send_password_reset_with_token.rb
 - lib/graphql_devise/mutations/sign_up.rb
@@ -364,6 +369,7 @@ files:
 - spec/dummy/app/graphql/dummy_schema.rb
 - spec/dummy/app/graphql/interpreter_schema.rb
 - spec/dummy/app/graphql/mutations/login.rb
+- spec/dummy/app/graphql/mutations/register.rb
 - spec/dummy/app/graphql/mutations/register_confirmed_user.rb
 - spec/dummy/app/graphql/mutations/reset_admin_password_with_token.rb
 - spec/dummy/app/graphql/mutations/sign_up.rb
@@ -423,6 +429,7 @@ files:
 - spec/dummy/db/migrate/20200321121807_create_users_customers.rb
 - spec/dummy/db/migrate/20200621182414_remove_uncofirmed_email_from_admins.rb
 - spec/dummy/db/migrate/20200623003142_create_schema_users.rb
+- spec/dummy/db/migrate/20210516211417_add_vip_to_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/public/robots.txt
@@ -440,9 +447,12 @@ files:
 - spec/requests/graphql_controller_spec.rb
 - spec/requests/mutations/additional_mutations_spec.rb
 - spec/requests/mutations/additional_queries_spec.rb
+- spec/requests/mutations/confirm_registration_with_token_spec.rb
 - spec/requests/mutations/login_spec.rb
 - spec/requests/mutations/logout_spec.rb
+- spec/requests/mutations/register_spec.rb
 - spec/requests/mutations/resend_confirmation_spec.rb
+- spec/requests/mutations/resend_confirmation_with_token_spec.rb
 - spec/requests/mutations/send_password_reset_spec.rb
 - spec/requests/mutations/send_password_reset_with_token_spec.rb
 - spec/requests/mutations/sign_up_spec.rb
@@ -450,6 +460,7 @@ files:
 - spec/requests/mutations/update_password_with_token_spec.rb
 - spec/requests/queries/check_password_token_spec.rb
 - spec/requests/queries/confirm_account_spec.rb
+- spec/requests/queries/introspection_query_spec.rb
 - spec/requests/user_controller_spec.rb
 - spec/services/mount_method/operation_preparer_spec.rb
 - spec/services/mount_method/operation_preparers/custom_operation_preparer_spec.rb
@@ -457,7 +468,7 @@ files:
 - spec/services/mount_method/operation_preparers/gql_name_setter_spec.rb
 - spec/services/mount_method/operation_preparers/mutation_field_setter_spec.rb
 - spec/services/mount_method/operation_preparers/resolver_type_setter_spec.rb
-- spec/services/mount_method/operation_preparers/resource_name_setter_spec.rb
+- spec/services/mount_method/operation_preparers/resource_klass_setter_spec.rb
 - spec/services/mount_method/operation_sanitizer_spec.rb
 - spec/services/mount_method/option_sanitizer_spec.rb
 - spec/services/mount_method/option_sanitizers/array_checker_spec.rb
@@ -499,7 +510,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: GraphQL queries and mutations on top of devise_token_auth
@@ -512,6 +523,7 @@ test_files:
 - spec/dummy/app/graphql/dummy_schema.rb
 - spec/dummy/app/graphql/interpreter_schema.rb
 - spec/dummy/app/graphql/mutations/login.rb
+- spec/dummy/app/graphql/mutations/register.rb
 - spec/dummy/app/graphql/mutations/register_confirmed_user.rb
 - spec/dummy/app/graphql/mutations/reset_admin_password_with_token.rb
 - spec/dummy/app/graphql/mutations/sign_up.rb
@@ -571,6 +583,7 @@ test_files:
 - spec/dummy/db/migrate/20200321121807_create_users_customers.rb
 - spec/dummy/db/migrate/20200621182414_remove_uncofirmed_email_from_admins.rb
 - spec/dummy/db/migrate/20200623003142_create_schema_users.rb
+- spec/dummy/db/migrate/20210516211417_add_vip_to_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/seeds.rb
 - spec/dummy/public/robots.txt
@@ -588,9 +601,12 @@ test_files:
 - spec/requests/graphql_controller_spec.rb
 - spec/requests/mutations/additional_mutations_spec.rb
 - spec/requests/mutations/additional_queries_spec.rb
+- spec/requests/mutations/confirm_registration_with_token_spec.rb
 - spec/requests/mutations/login_spec.rb
 - spec/requests/mutations/logout_spec.rb
+- spec/requests/mutations/register_spec.rb
 - spec/requests/mutations/resend_confirmation_spec.rb
+- spec/requests/mutations/resend_confirmation_with_token_spec.rb
 - spec/requests/mutations/send_password_reset_spec.rb
 - spec/requests/mutations/send_password_reset_with_token_spec.rb
 - spec/requests/mutations/sign_up_spec.rb
@@ -598,6 +614,7 @@ test_files:
 - spec/requests/mutations/update_password_with_token_spec.rb
 - spec/requests/queries/check_password_token_spec.rb
 - spec/requests/queries/confirm_account_spec.rb
+- spec/requests/queries/introspection_query_spec.rb
 - spec/requests/user_controller_spec.rb
 - spec/services/mount_method/operation_preparer_spec.rb
 - spec/services/mount_method/operation_preparers/custom_operation_preparer_spec.rb
@@ -605,7 +622,7 @@ test_files:
 - spec/services/mount_method/operation_preparers/gql_name_setter_spec.rb
 - spec/services/mount_method/operation_preparers/mutation_field_setter_spec.rb
 - spec/services/mount_method/operation_preparers/resolver_type_setter_spec.rb
-- spec/services/mount_method/operation_preparers/resource_name_setter_spec.rb
+- spec/services/mount_method/operation_preparers/resource_klass_setter_spec.rb
 - spec/services/mount_method/operation_sanitizer_spec.rb
 - spec/services/mount_method/option_sanitizer_spec.rb
 - spec/services/mount_method/option_sanitizers/array_checker_spec.rb