graphql_devise 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe858d6f23e94afcd3ceda214e226c481be42610c562ce2c409ce0146ba930b3
-  data.tar.gz: bb1252da47c939b6d8643975847acc57f3ae7a2abd4edf1d30717f0f0f1dce3d
+  metadata.gz: 33e021f456447d0a8d0c17ec98f365337b2d41427b5aac9cb521313317752fd4
+  data.tar.gz: 9aebe3c7d5e0c389a7e329ca6a703b56d936464a8b20c1c2003798667309a886
 SHA512:
-  metadata.gz: a26de357c7dc92c7326e1251fd920704359fe15b72841d8db4a2903cc74291023b8614e0fff99a3d6a99c65c73dbba70c805033d91967a8684108e170d46ca4a
-  data.tar.gz: 37576fd86f5921201be2b694fe83b55746949e4d79bc08e9b08dc0f753fec43709f344667c5a5ec73a0f8e07b956cb9fce968d97f211949cde4f09b18fc38d82
+  metadata.gz: c31ce514a8ab6f68e0501ed0b9435b183ced05433894ecc2214783a6027d48953a00b26234ccfbbf767d76766266329a81c3a296320cbdf3efe939b408682160
+  data.tar.gz: eff949b9be0f805b9b89da5b917863a76a27ff3cc992e2162286f1ab6162c5dc2324a19cf8df87e46ed15cb78a511fb0957a3a9aba986f0bb7cb60d14c9de316

data/.travis.yml

@@ -36,12 +36,19 @@ jobs:
       rvm: 2.5.7
     - gemfile: gemfiles/rails6.0_graphql1.10.gemfile
       rvm: 2.6.5
-    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
+    - gemfile: gemfiles/rails6.0_graphql_edge.gemfile
       rvm: 2.5.7
+      env: SKIP_COVERALLS=true
+    - gemfile: gemfiles/rails6.0_graphql_edge.gemfile
+      rvm: 2.6.5
+      env: SKIP_COVERALLS=true
     - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
       rvm: 2.6.5
+      env: SKIP_COVERALLS=true
   allow_failures:
     - rvm: 2.5.7
-      gemfile: gemfiles/rails_edge_graphql_edge.gemfile
+      gemfile: gemfiles/rails6.0_graphql_edge.gemfile
+    - rvm: 2.6.5
+      gemfile: gemfiles/rails6.0_graphql_edge.gemfile
     - rvm: 2.6.5
       gemfile: gemfiles/rails_edge_graphql_edge.gemfile

data/Appraisals

@@ -74,6 +74,14 @@ appraise 'rails6.0-graphql1.10' do
   gem 'graphql', '~> 1.10.0'
 end
 
+appraise 'rails6.0-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: '6-0-stable'
+  gem 'graphql', github: 'rmosolgo/graphql-ruby', branch: 'master'
+end
+
 appraise 'rails_edge-graphql_edge' do
   gem 'sqlite3', '~> 1.4'
   gem 'devise_token_auth', github: 'lynndylanhurley/devise_token_auth', branch: 'master'

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## [v0.9.2](https://github.com/graphql-devise/graphql_devise/tree/v0.9.2) (2020-02-03)
+## [v0.10.0](https://github.com/graphql-devise/graphql_devise/tree/v0.10.0) (2020-02-04)
+
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.9.2...v0.10.0)
+
+**Implemented enhancements:**
+
+- Add additional mutations and queries option [\#64](https://github.com/graphql-devise/graphql_devise/pull/64) ([mcelicalderon](https://github.com/mcelicalderon))
+
+## [v0.9.2](https://github.com/graphql-devise/graphql_devise/tree/v0.9.2) (2020-02-02)
 
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.9.1...v0.9.2)
 

data/README.md

@@ -46,7 +46,7 @@ Will do the following:
   - Add `devise` modules to `Admin` model
   - Other changes that you can find [here](https://devise-token-auth.gitbook.io/devise-token-auth/config)
 - Add the route to `config/routes.rb`
-  - `mount_graphql_devise_for 'Admin', at: 'api/auth'
+  - `mount_graphql_devise_for 'Admin', at: 'api/auth'`
 
 `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.
@@ -66,7 +66,15 @@ Rails.application.routes.draw do
     operations: {
       login: Mutations::Login
     },
-    skip: [:sign_up]
+    skip: [:sign_up],
+    additional_mutations: {
+      # generates mutation { adminUserSignUp }
+      admin_user_sign_up: Mutations::AdminUserSignUp
+    },
+    additional_queries: {
+      # generates query { publicUserByUuid }
+      public_user_by_uuid: Resolvers::UserByUuid
+    }
   )
 end
 ```
@@ -90,6 +98,28 @@ will use it. But, you can override this type with this option like in the exampl
 symbols and should belong to the list of available operations in the gem.
 1. `only`: An array of the operations that should be available in the authentication schema. The `skip` and `only` options are
 mutually exclusive, an error will be raised if you pass both to the mount method.
+1. `additional_mutations`: Here you can add as many mutations as you
+need, for those features that don't fully match the provided default mutations and queries.
+You need to provide a hash to this option, and
+each key will be the name of the mutation on the schema. Also, the value provided must be a valid mutation.
+This is similar to what you can accomplish with
+[devise_scope](https://www.rubydoc.info/github/heartcombo/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for).
+1. `additional_queries`: Here you can add as many queries as you need,
+for those features that don't fully match the provided default mutations and queries.
+You need to provide a hash to this option, and
+each key will be the name of the query on the schema. Also, the value provided must be a valid Resolver.
+This is also similar to what you can accomplish with
+[devise_scope](https://www.rubydoc.info/github/heartcombo/devise/master/ActionDispatch/Routing/Mapper%3Adevise_for).
+
+Additional mutations and queries will be added to the schema regardless
+of other options you might have specified like `skip` or `only`.
+Additional queries and mutations is usually a good place for other
+operations on your schema that require no authentication (like sign_up).
+Also by adding them through the mount method, your mutations and
+resolvers can inherit from our [base mutation](https://github.com/graphql-devise/graphql_devise/blob/master/app/graphql/graphql_devise/mutations/base.rb)
+or [base resover](https://github.com/graphql-devise/graphql_devise/blob/master/app/graphql/graphql_devise/resolvers/base.rb)
+respectively, to take advantage of some of the methods provided by devise
+just like with `devise_scope`
 
 #### Available Operations
 The following is a list of the symbols you can provide to the `operations`, `skip` and `only` options of the mount method:

data/app/graphql/graphql_devise/mutations/sign_up.rb

@@ -7,7 +7,7 @@ module GraphqlDevise
       argument :confirm_success_url,   String, required: false
 
       def resolve(confirm_success_url: nil, **attrs)
-        resource = resource_class.new(provider: provider, **attrs)
+        resource = build_resource(attrs.merge(provider: provider))
         raise_user_error(I18n.t('graphql_devise.resource_build_failed')) if resource.blank?
 
         redirect_url = confirm_success_url || DeviseTokenAuth.default_confirm_success_url
@@ -45,6 +45,10 @@ module GraphqlDevise
 
       private
 
+      def build_resource(attrs)
+        resource_class.new(attrs)
+      end
+
       def provider
         :email
       end

data/gemfiles/rails6.0_graphql_edge.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+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"
+
+gemspec path: "../"

data/lib/graphql_devise/rails/routes.rb

@@ -1,9 +1,11 @@
 module ActionDispatch::Routing
   class Mapper
     def mount_graphql_devise_for(resource, opts = {})
-      custom_operations  = opts[:operations] || {}
-      skipped_operations = opts.fetch(:skip, [])
-      only_operations    = opts.fetch(:only, [])
+      custom_operations    = opts.fetch(:operations, {})
+      skipped_operations   = opts.fetch(:skip, [])
+      only_operations      = opts.fetch(:only, [])
+      additional_mutations = opts.fetch(:additional_mutations, {})
+      additional_queries   = opts.fetch(:additional_queries, {})
 
       if [skipped_operations, only_operations].all?(&:any?)
         raise GraphqlDevise::Error, "Can't specify both `skip` and `only` options when mounting the route."
@@ -62,8 +64,11 @@ module ActionDispatch::Routing
 
         GraphqlDevise::Types::MutationType.field("#{mapping_name}_#{action}", mutation: used_mutation)
       end
+      additional_mutations.each do |action, mutation|
+        GraphqlDevise::Types::MutationType.field(action, mutation: mutation)
+      end
 
-      if used_mutations.present? &&
+      if (used_mutations.present? || additional_mutations.present?) &&
          (Gem::Version.new(GraphQL::VERSION) <= Gem::Version.new('1.10.0') || GraphqlDevise::Schema.mutation.nil?)
         GraphqlDevise::Schema.mutation(GraphqlDevise::Types::MutationType)
       end
@@ -87,8 +92,11 @@ module ActionDispatch::Routing
 
         GraphqlDevise::Types::QueryType.field("#{mapping_name}_#{action}", resolver: used_query)
       end
+      additional_queries.each do |action, resolver|
+        GraphqlDevise::Types::QueryType.field(action, resolver: resolver)
+      end
 
-      if used_queries.blank? && GraphqlDevise::Types::QueryType.fields.blank?
+      if (used_queries.blank? || additional_queries.present?) && GraphqlDevise::Types::QueryType.fields.blank?
         GraphqlDevise::Types::QueryType.field(:dummy, resolver: GraphqlDevise::Resolvers::Dummy)
       end
 

data/lib/graphql_devise/version.rb

@@ -1,3 +1,3 @@
 module GraphqlDevise
-  VERSION = '0.9.2'.freeze
+  VERSION = '0.10.0'.freeze
 end

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

@@ -0,0 +1,23 @@
+module Mutations
+  class RegisterConfirmedUser < GraphqlDevise::Mutations::Base
+    argument :email,                 String, required: true
+    argument :name,                  String, required: true
+    argument :password,              String, required: true
+    argument :password_confirmation, String, required: true
+
+    field :user, Types::UserType, null: true
+
+    def resolve(**attrs)
+      user = User.new(attrs.merge(confirmed_at: Time.zone.now))
+
+      if user.save
+        { user: user }
+      else
+        raise_user_error_list(
+          'Custom registration failed',
+          errors: user.errors.full_messages
+        )
+      end
+    end
+  end
+end

data/spec/dummy/app/graphql/resolvers/public_user.rb

@@ -0,0 +1,11 @@
+module Resolvers
+  class PublicUser < GraphQL::Schema::Resolver
+    type Types::UserType, null: false
+
+    argument :id, Int, required: true
+
+    def resolve(id:)
+      User.find(id)
+    end
+  end
+end

data/spec/dummy/config/routes.rb

@@ -2,6 +2,10 @@ Rails.application.routes.draw do
   mount_graphql_devise_for 'User', at: '/api/v1/graphql_auth', operations: {
     login:   Mutations::Login,
     sign_up: Mutations::SignUp
+  }, additional_mutations: {
+    register_confirmed_user: Mutations::RegisterConfirmedUser
+  }, additional_queries: {
+    public_user: Resolvers::PublicUser
   }
 
   mount_graphql_devise_for(