graphql_devise 0.11.4 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77e78a89405d9294b587abd9684c4448a4c08f89386d332dd73386ffe4a6f60b
-  data.tar.gz: d9451d952032587e3ea983ffa6edd34347f3227bb4ea038d0c5da4e8c35ffaa1
+  metadata.gz: 6929ccf18a8a9f8e7cd9b3f4f5e8388cf2b6d19617ed163f8b1c769820c14e57
+  data.tar.gz: fb23c4d077deb50757905b0d28ed92764e8442b696273035d8a925c917e69fb4
 SHA512:
-  metadata.gz: f963bf770985c5ce4f4d533efb9a15b468ba4c6827dca1ad7b64eecc9afb4cd3944ab383452cc897367d156f950d0f19f84d501e3ae6d6b34d3a528fe4d2473f
-  data.tar.gz: 4d49b3cbb3050db885d18265394e7e6acbc5c2208c4913dcc988aae13865dbc6b6f57e3f079cbb8edb943c4de025ca2816d6b18562ce9b625972aae82cdc4c3a
+  metadata.gz: 7f76369100a4ad9f5e1814a759e5a358dd9a38548a105ee685baf38cd5b5a42f18c58f28f320fe2d607e1061c2cc12ed64bd82085b616179004e93720b4e3baa
+  data.tar.gz: cce3f1d55751b40d6089e3a0f0b77563dbecf0298004eec3a9d40df2890ebf80b28fc8e8c95aeefb46878e7c71296c1444bff8145885f1aec014ba030253b1da

data/.gitignore

@@ -15,7 +15,8 @@ README.md.*
 /spec/dummy/tmp/
 /Gemfile.lock
 *.gemfile.lock
-/*.sqlite3
+*.sqlite3
+*.sqlite3-journal
 /spec/dummy/db/development.sqlite3
 /spec/dummy/db/test.sqlite3
 /*.gem

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.12.0](https://github.com/graphql-devise/graphql_devise/tree/v0.12.0) (2020-06-11)
+
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.11.4...v0.12.0)
+
+**Implemented enhancements:**
+
+- Mount auth operations in main GQL schema [\#96](https://github.com/graphql-devise/graphql_devise/pull/96) ([mcelicalderon](https://github.com/mcelicalderon))
+
 ## [v0.11.4](https://github.com/graphql-devise/graphql_devise/tree/v0.11.4) (2020-05-23)
 
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.11.3...v0.11.4)

data/README.md

@@ -12,25 +12,34 @@ GraphQL interface on top of the [Devise Token Auth](https://github.com/lynndylan
       * [Table of Contents](#table-of-contents)
       * [Introduction](#introduction)
       * [Installation](#installation)
+         * [Running the Generator](#running-the-generator)
+            * [Mounting the Schema in a Separate Route](#mounting-the-schema-in-a-separate-route)
+            * [Mounting Operations in Your Own Schema](#mounting-operations-in-your-own-schema)
+         * [Important](#important)
       * [Usage](#usage)
-         * [Mounting Routes manually](#mounting-routes-manually)
-            * [Available Operations](#available-operations)
+         * [Mounting Auth Schema on a Separate Route](#mounting-auth-schema-on-a-separate-route)
+         * [Mounting Operations Into Your Own Schema](#mounting-operations-into-your-own-schema)
+         * [Available Mount Options](#available-mount-options)
+         * [Available Operations](#available-operations)
          * [Configuring Model](#configuring-model)
          * [Customizing Email Templates](#customizing-email-templates)
          * [I18n](#i18n)
          * [Authenticating Controller Actions](#authenticating-controller-actions)
+            * [Authenticate Before Reaching Your GQL Schema](#authenticate-before-reaching-your-gql-schema)
+            * [Authenticate in Your GQL Schema](#authenticate-in-your-gql-schema)
          * [Making Requests](#making-requests)
             * [Mutations](#mutations)
             * [Queries](#queries)
          * [More Configuration Options](#more-configuration-options)
             * [Devise Token Auth Initializer](#devise-token-auth-initializer)
             * [Devise Initializer](#devise-initializer)
+         * [GraphQL Interpreter](#graphql-interpreter)
          * [Using Alongside Standard Devise](#using-alongside-standard-devise)
       * [Future Work](#future-work)
       * [Contributing](#contributing)
       * [License](#license)
 
-<!-- Added by: mcelicalderon, at: Tue Apr 28 21:43:30 -05 2020 -->
+<!-- Added by: mcelicalderon, at: Wed Jun 10 22:10:26 -05 2020 -->
 
 <!--te-->
 
@@ -54,13 +63,11 @@ gem 'graphql_devise'
 ```
 
 And then execute:
+```bash
+$ bundle
+```
 
-    $ bundle
-
-Next, you need to run the generator:
-
-    $ bundle exec rails generate graphql_devise:install
-
+### Running the Generator
 Graphql Devise generator will execute `Devise` and `Devise Token Auth`
 generators for you. These will make the required changes for the gems to
 work correctly. All configurations for [Devise](https://github.com/plataformatec/devise) and
@@ -68,6 +75,11 @@ work correctly. All configurations for [Devise](https://github.com/plataformatec
 so you can read the docs there to customize your options.
 Configurations are done via initializer files as usual, one per gem.
 
+#### Mounting the Schema in a Separate Route
+```bash
+$ bundle exec rails generate graphql_devise:install
+```
+
 The generator accepts 2 params: `user_class` and `mount_path`. The params
 will be used to mount the route in `config/routes.rb`. For instance the executing:
 
@@ -87,14 +99,32 @@ Will do the following:
 `Admin` could be any model name you are going to be using for authentication,
 and `api/auth` could be any mount path you would like to use for auth.
 
-**Important:** Remember this gem mounts a completely separate GraphQL schema on a separate controller in the route
+#### Mounting Operations in Your Own Schema
+Now you can provide to the generator an option specifying
+the name of your GQL schema. Doing this will skip the insertion of the mount method in the
+routes file and will also add our `SchemaPlugin` to the specified schema. `user_class` param is still optional (`Admin`) in the following example.
+
+```bash
+$ bundle exec rails g graphql_devise:install Admin --mount MySchema
+```
+
+### Important
+Remember that by default this gem mounts a completely separate GraphQL schema on a separate controller in the route
 provided by the `at` option in the `mount_graphql_devise_for` method in the `config/routes.rb` file. If no `at`
-option is provided, the route will be `/graphql_auth`. This has no effect on your own application schema.
-More on this in the next section.
+option is provided, the route will be `/graphql_auth`.
+
+**Starting with `v0.12.0`** you can opt-in to load this gem's queries and mutations into your
+own application's schema. You can actually mount a resource's auth schema in a separate route
+and in your app's schema at the same time, but that's probably not a common scenario. More on
+this in the next section.
 
 ## Usage
-### Mounting Routes manually
-Routes can be added using the initializer or manually.
+### Mounting Auth Schema on a Separate Route
+The generator can do this step for you by default. Remember now you can mount this gem's
+auth operations into your own schema as described in [this section](#mounting-operations-into-your-own-schema).
+
+
+Routes can be added using the generator or manually.
 You can mount this gem's GraphQL auth schema in your routes file like this:
 
 ```ruby
@@ -120,11 +150,83 @@ Rails.application.routes.draw do
   )
 end
 ```
+The second argument of the `mount_graphql_devise` method is a hash of options where you can
+customize how the queries and mutations are mounted into the schema. For a list of available
+options go [here](#available-mount-options)
+
+### Mounting Operations Into Your Own Schema
+Starting with `v0.12.0` you can now mount the GQL operations provided by this gem into your
+app's main schema.
+
+```ruby
+# app/graphql/dummy_schema.rb
+
+class DummySchema < GraphQL::Schema
+  # It's important that this line goes before setting the query and mutation type on your
+  # schema in graphql versions < 1.10.0
+  use GraphqlDevise::SchemaPlugin.new(
+    query:            Types::QueryType,
+    mutation:         Types::MutationType,
+    resource_loaders: [
+      GraphqlDevise::ResourceLoader.new('User', only: [:login, :confirm_account])
+    ]
+  )
+
+  mutation(Types::MutationType)
+  query(Types::QueryType)
+end
+```
+The example above describes just one of the possible scenarios you might need.
+The second argument of the `GraphqlDevise::ResourceLoader` initializer is a hash of
+options where you can customize how the queries and mutations are mounted into the schema.
+For a list of available options go [here](#available-mount-options).
+
+It's important to use the plugin in your schema before assigning the mutation and query type to
+it in graphql versions `< 1.10.0`. Otherwise the auth operations won't be available.
+
+You can provide as many resource loaders as you need to the `resource_loaders` option, and each
+of those will be loaded into your schema. These are the options you can initialize the
+`SchemaPlugin` with:
+
+1. `query`: This param is mandatory unless you skip all queries via the resource loader
+options. This should be the same `QueryType` you provide to the `query` method
+in your schema.
+1. `mutation`: This param mandatory unless you skip all mutations via the resource loader
+options. This should be the same `MutationType` you provide to the `mutation` method
+in your schema.
+1. `resource_loaders`: This is an optional array of `GraphqlDevise::ResourceLoader` instances.
+Here is where you specify the operations that you want to load into your app's schema.
+If no loader is provided, no operations will be added to your schema, but you will still be
+able to authenticate queries and mutations selectively. More on this in the controller
+authentication [section](#authenticating-controller-actions).
+1. `authenticate_default`: This is a boolean value which is `true` by default. This value
+defines what is the default behavior for authentication in your schema fields. `true` means
+every root level field requires authentication unless specified otherwise using the
+`authenticate: false` option on the field. `false` means your root level fields won't require
+authentication unless specified otherwise using the `authenticate: true` option on the field.
+1. `unauthenticated_proc`: This param is optional. Here you can provide a proc that receives
+one argument (field name) and is called whenever a field that requires authentication
+is called without an authenticated resource. By default a `GraphQL::ExecutionError` will be
+raised if authentication fails. This will provide a GQL like error message on the response.
+
+### Available Mount Options
+Both the `mount_graphql_devise_for` method and the `GraphqlDevise::ResourceLoader` class
+take the same options. So, wether you decide to mount this gem in a separate route
+from your main application's schema or you use our `GraphqlDevise::SchemaPlugin` to load
+this gem's auth operation into your schema, these are the options you can provide as a hash.
 
-Here are the options for the mount method:
+```ruby
+# Using the mount method in your config/routes.rb file
+mount_graphql_devise_for('User', {})
+
+# Providing options to a GraphqlDevise::ResourceLoader
+GraphqlDevise::ResourceLoader.new('User', {})
+```
 
-1. `at`: Route where the GraphQL schema will be mounted on the Rails server. In this example your API will have these two routes: `POST /api/v1/graphql_auth` and `GET /api/v1/graphql_auth`.
-If this option is not specified, the schema will be mounted at `/graphql_auth`.
+1. `at`: Route where the GraphQL schema will be mounted on the Rails server.
+In [this example](#mounting-auth-schema-on-a-separate-route) your API will have
+these two routes: `POST /api/v1/graphql_auth` and `GET /api/v1/graphql_auth`.
+If this option is not specified, the schema will be mounted at `/graphql_auth`. **This option only works if you are using the mount method.**
 1. `operations`: Specifying this is optional. Here you can override default
 behavior by specifying your own mutations and queries for every GraphQL operation.
 Check available operations in this file [mutations](https://github.com/graphql-devise/graphql_devise/blob/b5985036e01ea064e43e457b4f0c8516f172471c/lib/graphql_devise/rails/routes.rb#L19)
@@ -163,7 +265,7 @@ or [base resolver](https://github.com/graphql-devise/graphql_devise/blob/master/
 respectively, to take advantage of some of the methods provided by devise
 just like with `devise_scope`
 
-#### Available Operations
+### Available Operations
 The following is a list of the symbols you can provide to the `operations`, `skip` and `only` options of the mount method:
 ```ruby
 :login
@@ -175,7 +277,6 @@ The following is a list of the symbols you can provide to the `operations`, `ski
 :check_password_token
 ```
 
-
 ### Configuring Model
 Just like with Devise and DTA, you need to include a module in your authenticatable model,
 so with our example, your user model will have to look like this:
@@ -216,6 +317,9 @@ Keep in mind that if your app uses multiple locales, you should set the `I18n.lo
 
 ### Authenticating Controller Actions
 Just like with Devise or DTA, you will need to authenticate users in your controllers.
+For this you have two alternatives.
+
+#### Authenticate Before Reaching Your GQL Schema
 For this you need to call `authenticate_<model>!` in a before_action hook of your controller.
 In our example our model is `User`, so it would look like this:
 ```ruby
@@ -234,6 +338,62 @@ end
 
 The install generator can do this for you because it executes DTA installer.
 See [Installation](#Installation) for details.
+If authentication fails for the request for whatever reason, execution of the request is halted
+and an error is returned in a REST format as the request never reaches your GQL schema.
+
+#### Authenticate in Your GQL Schema
+For this you will need to add the `GraphqlDevise::SchemaPlugin` to your schema as described
+[here](#mounting-operations-into-your-own-schema) and also set the authenticated resource
+in a `before_action` hook.
+
+```ruby
+# app/controllers/my_controller.rb
+
+class MyController < ApplicationController
+  include GraphqlDevise::Concerns::SetUserByToken
+
+  before_action -> { set_resource_by_token(:user) }
+
+  def my_action
+    render json: DummySchema.execute(params[:query], context: graphql_context)
+  end
+end
+
+# @resource.to_s.underscore.tr('/', '_').to_sym
+```
+The `set_resource_by_token` method receives a symbol identifying the resource you are trying
+to authenticate. So if you mounted the `'User'` resource, the symbol is `:user`. You can use
+this snippet to find the symbol for more complex scenarios
+`resource_klass.to_s.underscore.tr('/', '_').to_sym`.
+
+The `graphql_context` method is simply a helper method that returns a hash like this
+```ruby
+{ current_resource: @resource, controller: self }
+```
+These are the two values the gem needs to check if a user is authenticated and to perform
+other auth operations. All `set_resource_by_token` does is set the `@resource` variable if
+the provided authentication headers are valid. If authentication fails, resource will be `nil`
+and this is how `GraphqlDevise::SchemaPlugin` knows if a user is authenticated or not in
+each query.
+
+Please note that by using this mechanism your GQL schema will be in control of what queries are
+restricted to authenticated users and you can only do this at the root level fields of your GQL
+schema. Configure the plugin as explained [here](#mounting-operations-into-your-own-schema)
+so this can work.
+
+In you main app's schema this is how you might specify if a field needs to be authenticated or not:
+```ruby
+module Types
+  class QueryType < Types::BaseObject
+    # user field used the default set in the Plugin's initializer
+    field :user, resolver: Resolvers::UserShow
+    # this field will never require authentication
+    field :public_field, String, null: false, authenticate: false
+    # this field requires authentication
+    field :private_field, String, null: false, authenticate: true
+  end
+end
+```
 
 ### Making Requests
 Here is a list of the available mutations and queries assuming your mounted model is `User`.
@@ -308,6 +468,14 @@ In this section the most important configurations will be highlighted.
 
 **Note:** Remember this gem adds a layer on top of Devise, so some configurations might not apply.
 
+### GraphQL Interpreter
+GraphQL-Ruby `>= 1.9.0` includes a new runtime module which you may use for your schema.
+Eventually, it will become the default. You can read more about it
+[here](https://graphql-ruby.org/queries/interpreter).
+
+This gem supports schemas using the interpreter and it is recommended as it introduces several
+improvements which focus mainly on performance.
+
 ### Using Alongside Standard Devise
 The DeviseTokenAuth gem allows experimental use of the standard Devise gem to be configured at the same time, for more
 information you can check [this answer here](https://github.com/lynndylanhurley/devise_token_auth/blob/2a32f18ccce15638a74e72f6cfde5cf15a808d3f/docs/faq.md#can-i-use-this-gem-alongside-standard-devise).
@@ -318,7 +486,6 @@ standard Devise templates.
 ## Future Work
 We will continue to improve the gem and add better docs.
 
-1. Add mount option that will create a separate schema for the mounted resource.
 1. Make sure this gem can correctly work alongside DTA and the original Devise gem.
 1. Improve DOCS.
 1. Add support for unlockable and other Devise modules.

data/app/controllers/graphql_devise/application_controller.rb

@@ -1,8 +1,7 @@
 module GraphqlDevise
-  class ApplicationController < DeviseTokenAuth::ApplicationController
-    private
-
-    def verify_authenticity_token
-    end
+  ApplicationController = if Rails::VERSION::MAJOR >= 5
+    Class.new(ActionController::API)
+  else
+    Class.new(ActionController::Base)
   end
 end

data/app/controllers/graphql_devise/concerns/set_user_by_token.rb

@@ -1,5 +1,28 @@
 module GraphqlDevise
   module Concerns
     SetUserByToken = DeviseTokenAuth::Concerns::SetUserByToken
+
+    SetUserByToken.module_eval do
+      attr_accessor :client_id, :token, :resource
+
+      alias_method :set_resource_by_token, :set_user_by_token
+
+      def graphql_context
+        {
+          current_resource: @resource,
+          controller:       self
+        }
+      end
+
+      def build_redirect_headers(access_token, client, redirect_header_options = {})
+        {
+          DeviseTokenAuth.headers_names[:"access-token"] => access_token,
+          DeviseTokenAuth.headers_names[:client] => client,
+          :config => params[:config],
+          :client_id => client,
+          :token => access_token
+        }.merge(redirect_header_options)
+      end
+    end
   end
 end

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/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

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
 
   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.11.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)