graphql_devise 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf545450ef87f507744e5bf493ebc30d94c20da544307ec11657f58d2e685b37
-  data.tar.gz: 7c62c31ef018325ed51516e08a3f5774d5ebe8325340ce57edbee2df9a9e29bf
+  metadata.gz: 33fca9e9e4adcd1831cfcc2a7cf47006e7f5c0b28a20651eba38916e6cd34701
+  data.tar.gz: 4cab9282ea278aa1fd077c7e5caf2164662c227a788ddac0c0224d21cf4eb679
 SHA512:
-  metadata.gz: 53dfe2bfde5d1e22f7d5d91f03c6336559abe2967208c2a237218d06fc65d4df2c5c3d0bf5d84f097c77fa2d39299defe6318999adddb68b05263c403a418654
-  data.tar.gz: dc0e2a550b3657fc13505db35042febdc32df9770cdfb00524fabb1fdaf09b1d43a0fc6a13ce71160e37aada85e3cef8ff611aaebb4d027efb81ec8013267eba
+  metadata.gz: b0311b0035cca6a5a23f38c890a96658865e9131c2a80f9f40fba91569d5951cc4662709fdc5e0ad82cef991e04d5931803c85da4e6bea8bcf4701ed92b04ef7
+  data.tar.gz: cbfa71e7947f0e7ce3ab3e23970fc313b09c9fe0198df09e440137a51e1e64b57d0f4e907d158c4c0f78e610beacfebbc61b53c5ef8d582c97091cfb8ad94772

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: bzwe3rK8KkenWfsw42Nj6JhoO77V7V3sh

data/.gitlab-ci.yml

@@ -0,0 +1,109 @@
+---
+default:
+  cache:
+    key:
+      files:
+        - Gemfile.lock
+      prefix: ${CI_COMMIT_REF_NAME}
+    paths:
+      - vendor/bundle/
+  before_script:
+    - bundle install
+
+variables:
+  EAGER_LOAD: 'true'
+  BUNDLE_PATH: 'vendor/bundle'
+
+test:2.3:
+  stage: test
+  image: ruby:2.3
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails4.2_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.10.gemfile
+
+test:2.4:
+  stage: test
+  image: ruby:2.4
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails4.2_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.10.gemfile
+
+test:2.5:
+  stage: test
+  image: ruby:2.5
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.10.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.12.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.12.gemfile
+
+test:2.6:
+  stage: test
+  image: ruby:2.6
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails5.0_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.1_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.10.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails5.2_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.12.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.12.gemfile
+
+test:2.7:
+  stage: test
+  image: ruby:2.7
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.8.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.9.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.10.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.0_graphql1.12.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.10.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.11.gemfile
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql1.12.gemfile
+
+test:edge:
+  stage: test
+  image: ruby:2.7
+  allow_failure: true
+  script:
+    - bundle exec rspec
+  parallel:
+    matrix:
+      - BUNDLE_GEMFILE: gemfiles/rails6.1_graphql_edge.gemfile

data/Appraisals

@@ -110,18 +110,38 @@ appraise 'rails6.0-graphql1.12' do
   gem 'graphql', '~> 1.12.0'
 end
 
-appraise 'rails6.0-graphql_edge' do
+appraise 'rails6.1-graphql1.9' do
   gem 'sqlite3', '~> 1.4'
-  gem 'devise_token_auth', github: 'lynndylanhurley/devise_token_auth', branch: 'master'
   gem 'devise', '>= 4.7'
-  gem 'rails', github: 'rails/rails', branch: '6-0-stable'
-  gem 'graphql', github: 'rmosolgo/graphql-ruby', branch: 'master'
+  gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+  gem 'graphql', '~> 1.9.0'
+end
+
+appraise 'rails6.1-graphql1.10' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'devise', '>= 4.7'
+  gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+  gem 'graphql', '~> 1.10.0'
+end
+
+appraise 'rails6.1-graphql1.11' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'devise', '>= 4.7'
+  gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+  gem 'graphql', '~> 1.11.0'
+end
+
+appraise 'rails6.1-graphql1.12' do
+  gem 'sqlite3', '~> 1.4'
+  gem 'devise', '>= 4.7'
+  gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+  gem 'graphql', '~> 1.12.0'
 end
 
-appraise 'rails_edge-graphql_edge' do
+appraise 'rails6.1-graphql_edge' do
   gem 'sqlite3', '~> 1.4'
   gem 'devise_token_auth', github: 'lynndylanhurley/devise_token_auth', branch: 'master'
   gem 'devise', '>= 4.7'
-  gem 'rails', github: 'rails/rails', branch: 'master'
+  gem 'rails', github: 'rails/rails', branch: '6-1-stable'
   gem 'graphql', github: 'rmosolgo/graphql-ruby', branch: 'master'
 end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.14.2](https://github.com/graphql-devise/graphql_devise/tree/v0.14.2) (2021-03-08)
+
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.14.1...v0.14.2)
+
+**Implemented enhancements:**
+
+- Add config for public introspection query on schema plugin [\#154](https://github.com/graphql-devise/graphql_devise/pull/154) ([00dav00](https://github.com/00dav00))
+
 ## [v0.14.1](https://github.com/graphql-devise/graphql_devise/tree/v0.14.1) (2021-02-11)
 
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.14.0...v0.14.1)

data/README.md

@@ -1,6 +1,6 @@
 # GraphqlDevise
-[![Build Status](https://travis-ci.com/graphql-devise/graphql_devise.svg?branch=master)](https://travis-ci.com/graphql-devise/graphql_devise)
-[![Coverage Status](https://coveralls.io/repos/github/graphql-devise/graphql_devise/badge.svg?branch=master)](https://coveralls.io/github/graphql-devise/graphql_devise?branch=master)
+[![Build Status](https://gitlab.com/graphql-devise/graphql_devise/badges/master/pipeline.svg)](https://gitlab.com/graphql-devise/graphql_devise/-/commits/master)
+[![Coverage Status](https://coveralls.io/repos/gitlab/graphql-devise/graphql_devise/badge.svg?branch=master)](https://coveralls.io/gitlab/graphql-devise/graphql_devise?branch=master)
 [![Gem Version](https://badge.fury.io/rb/graphql_devise.svg)](https://badge.fury.io/rb/graphql_devise)
 
 GraphQL interface on top of the [Devise Token Auth](https://github.com/lynndylanhurley/devise_token_auth) (DTA) gem.

data/lib/graphql_devise/schema_plugin.rb

@@ -2,13 +2,16 @@
 
 module GraphqlDevise
   class SchemaPlugin
+    # NOTE: Based on GQL-Ruby docs  https://graphql-ruby.org/schema/introspection.html
+    INTROSPECTION_FIELDS = ['__schema', '__type', '__typename']
     DEFAULT_NOT_AUTHENTICATED = ->(field) { raise GraphqlDevise::AuthenticationError, "#{field} field requires authentication" }
 
-    def initialize(query: nil, mutation: nil, authenticate_default: true, resource_loaders: [], unauthenticated_proc: DEFAULT_NOT_AUTHENTICATED)
+    def initialize(query: nil, mutation: nil, authenticate_default: true, public_introspection: !Rails.env.production?, resource_loaders: [], unauthenticated_proc: DEFAULT_NOT_AUTHENTICATED)
       @query                = query
       @mutation             = mutation
       @resource_loaders     = resource_loaders
       @authenticate_default = authenticate_default
+      @public_introspection = public_introspection
       @unauthenticated_proc = unauthenticated_proc
 
       # Must happen on initialize so operations are loaded before the types are added to the schema on GQL < 1.10
@@ -28,7 +31,7 @@ module GraphqlDevise
       auth_required = authenticate_option(field, trace_data)
       context       = context_from_data(trace_data)
 
-      if auth_required
+      if auth_required && !(public_introspection && introspection_field?(field))
         context = set_current_resource(context)
         raise_on_missing_resource(context, field)
       end
@@ -38,6 +41,8 @@ module GraphqlDevise
 
     private
 
+    attr_reader :public_introspection
+
     def set_current_resource(context)
       controller     = context[:controller]
       resource_names = Array(context[:resource_name])
@@ -109,6 +114,10 @@ module GraphqlDevise
         resource_loader.call(@query, @mutation)
       end
     end
+
+    def introspection_field?(field)
+      INTROSPECTION_FIELDS.include?(field.name)
+    end
   end
 end
 

data/lib/graphql_devise/version.rb

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

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

@@ -2,9 +2,10 @@
 
 class DummySchema < GraphQL::Schema
   use GraphqlDevise::SchemaPlugin.new(
-    query:            Types::QueryType,
-    mutation:         Types::MutationType,
-    resource_loaders: [
+    query:                Types::QueryType,
+    mutation:             Types::MutationType,
+    public_introspection: true,
+    resource_loaders:     [
       GraphqlDevise::ResourceLoader.new(
         'User',
         only: [

data/spec/requests/queries/introspection_query_spec.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Login Requests' do
+  include_context 'with graphql query request'
+
+  let(:query) do
+    <<-GRAPHQL
+      query IntrospectionQuery {
+        __schema {
+          queryType { name }
+          mutationType { name }
+          subscriptionType { name }
+          types {
+            ...FullType
+          }
+          directives {
+            name
+            description
+            args {
+              ...InputValue
+            }
+            onOperation
+            onFragment
+            onField
+          }
+        }
+      }
+
+      fragment FullType on __Type {
+        kind
+        name
+        description
+        fields(includeDeprecated: true) {
+          name
+          description
+          args {
+            ...InputValue
+          }
+          type {
+            ...TypeRef
+          }
+          isDeprecated
+          deprecationReason
+        }
+        inputFields {
+          ...InputValue
+        }
+        interfaces {
+          ...TypeRef
+        }
+        enumValues(includeDeprecated: true) {
+          name
+          description
+          isDeprecated
+          deprecationReason
+        }
+        possibleTypes {
+          ...TypeRef
+        }
+      }
+
+      fragment InputValue on __InputValue {
+        name
+        description
+        type { ...TypeRef }
+        defaultValue
+      }
+
+      fragment TypeRef on __Type {
+        kind
+        name
+        ofType {
+          kind
+          name
+          ofType {
+            kind
+            name
+            ofType {
+              kind
+              name
+            }
+          }
+        }
+      }
+
+    GRAPHQL
+  end
+
+  context 'when using a schema plugin to mount devise operations' do
+    context 'when schema plugin is set to authenticate by default' do
+      context 'when the resource is authenticated' do
+        let(:user) { create(:user, :confirmed) }
+        let(:headers) { user.create_new_auth_token }
+
+        it 'return the schema information' do
+          post_request('/api/v1/graphql')
+
+          expect(json_response[:data][:__schema].keys).to contain_exactly(
+            :queryType, :mutationType, :subscriptionType, :types, :directives
+          )
+        end
+      end
+
+      context 'when the resource is *NOT* authenticated' do
+        context 'and instrospection is set to be public' do
+          it 'return the schema information' do
+            post_request('/api/v1/graphql')
+
+            expect(json_response[:data][:__schema].keys).to contain_exactly(
+              :queryType, :mutationType, :subscriptionType, :types, :directives
+            )
+          end
+        end
+
+        context 'and introspection is set to require auth' do
+          before do
+            allow_any_instance_of(GraphqlDevise::SchemaPlugin).to(
+              receive(:public_introspection).and_return(false)
+            )
+          end
+
+          it 'return an error' do
+            post_request('/api/v1/graphql')
+
+            expect(json_response[:data]).to be_nil
+            expect(json_response[:errors]).to contain_exactly(
+              hash_including(
+                message:    '__schema field requires authentication',
+                extensions: { code: 'AUTHENTICATION_ERROR' }
+              )
+            )
+          end
+        end
+      end
+    end
+
+    context 'when schema plugin is set *NOT* to authenticate by default' do
+      it 'return the schema information' do
+        post_request('/api/v1/interpreter')
+
+        expect(json_response[:data][:__schema].keys).to contain_exactly(
+          :queryType, :mutationType, :subscriptionType, :types, :directives
+        )
+      end
+    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.14.2
 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-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise_token_auth
@@ -275,13 +275,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/enhancement.md"
 - ".github/ISSUE_TEMPLATE/question.md"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -450,6 +451,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
@@ -499,7 +501,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: GraphQL queries and mutations on top of devise_token_auth
@@ -598,6 +600,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

data/.travis.yml

@@ -1,86 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-before_install: gem install bundler -v 1.17
-before_script: RAILS_ENV=test bundle exec rake db:create db:schema:load
-
-env: EAGER_LOAD=true
-
-rvm:
-  - 2.2.10
-  - 2.3.8
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-
-gemfile:
-  - gemfiles/rails4.2_graphql1.8.gemfile
-  - gemfiles/rails5.0_graphql1.8.gemfile
-  - gemfiles/rails5.0_graphql1.9.gemfile
-  - gemfiles/rails5.1_graphql1.8.gemfile
-  - gemfiles/rails5.1_graphql1.9.gemfile
-  - gemfiles/rails5.2_graphql1.8.gemfile
-  - gemfiles/rails5.2_graphql1.9.gemfile
-  - gemfiles/rails5.2_graphql1.10.gemfile
-  - gemfiles/rails5.2_graphql1.11.gemfile
-  - gemfiles/rails5.2_graphql1.12.gemfile
-
-jobs:
-  include:
-    - gemfile: gemfiles/rails6.0_graphql1.8.gemfile
-      rvm: 2.5.8
-    - gemfile: gemfiles/rails6.0_graphql1.8.gemfile
-      rvm: 2.6.6
-    - gemfile: gemfiles/rails6.0_graphql1.8.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails6.0_graphql1.9.gemfile
-      rvm: 2.5.8
-    - gemfile: gemfiles/rails6.0_graphql1.9.gemfile
-      rvm: 2.6.6
-    - gemfile: gemfiles/rails6.0_graphql1.9.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails6.0_graphql1.10.gemfile
-      rvm: 2.5.8
-    - gemfile: gemfiles/rails6.0_graphql1.10.gemfile
-      rvm: 2.6.6
-    - gemfile: gemfiles/rails6.0_graphql1.10.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails6.0_graphql1.11.gemfile
-      rvm: 2.5.8
-    - gemfile: gemfiles/rails6.0_graphql1.11.gemfile
-      rvm: 2.6.6
-    - gemfile: gemfiles/rails6.0_graphql1.11.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails6.0_graphql1.12.gemfile
-      rvm: 2.5.8
-    - gemfile: gemfiles/rails6.0_graphql1.12.gemfile
-      rvm: 2.6.6
-    - gemfile: gemfiles/rails6.0_graphql1.12.gemfile
-      rvm: 2.7.1
-    - gemfile: gemfiles/rails6.0_graphql_edge.gemfile
-      rvm: 2.6.6
-      env:
-        - SKIP_COVERALLS=true
-        - EAGER_LOAD=true
-    - gemfile: gemfiles/rails6.0_graphql_edge.gemfile
-      rvm: 2.7.1
-      env:
-        - SKIP_COVERALLS=true
-        - EAGER_LOAD=true
-    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
-      rvm: 2.7.1
-      env:
-        - SKIP_COVERALLS=true
-        - EAGER_LOAD=true
-  exclude:
-    - gemfile: gemfiles/rails4.2_graphql1.8.gemfile
-      rvm: 2.7.1
-  allow_failures:
-    - rvm: 2.6.6
-      gemfile: gemfiles/rails6.0_graphql_edge.gemfile
-    - rvm: 2.7.1
-      gemfile: gemfiles/rails6.0_graphql_edge.gemfile
-    - rvm: 2.7.1
-      gemfile: gemfiles/rails_edge_graphql_edge.gemfile