graphql_devise 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74d9d933b61c35ed0c51283a9455dea4cf57c9752ee80bd9622695ff07e2788f
-  data.tar.gz: 0b3bf0a42e3ace013b4709076c731a06c4e2955eec852d9d5d2d8288c634f114
+  metadata.gz: 15d08b0a23b7eff91dd05234ff0ac29499cba590a6378b2d0163642750bbb549
+  data.tar.gz: 0fc6f85822e4def4610f69f4fe2a48e81ba98446ca9969ab3479169d2888e64f
 SHA512:
-  metadata.gz: 168ab031a4a2028f06e6bc0177fa04ce2c5341aede479cb502f99cc0738246c6d90d13cb849d763110820b6a98840b2a6a0677a8b8ea7596ff58d3e545d87b1e
-  data.tar.gz: c1051fbfe8b466c5818232afafff64d17fab8880e4c9395f84e86280c0355928b59ef2c31331ae6bc78a92f0cda5bdb8dafba03eae1f50483b8fa07d4848c39f
+  metadata.gz: 62163b8e19fcd257f1740840e87f71f739ba50d498ad5403ea57da143b43230afcb75c6a708d1b326a32d62e5629bef4bb74674674edb8c7359c8bf27950fb09
+  data.tar.gz: 91c43a208b02129ecaaeaf6fc5317aeda1d8a8366ccf618130bcb883eafee540f2bb6c0208c6890b5ed7e7174bc35d0de038e0318d8971aabb736503d9d7ff7d

data/.circleci/config.yml

@@ -13,22 +13,14 @@ jobs:
       - image: 'ruby:<< parameters.ruby-version >>'
     environment:
       BUNDLE_GEMFILE: << parameters.gemfile >>
-      BUNDLE_PATH: ../vendor/bundle
       COVERALLS_PARALLEL: true
       EAGER_LOAD: 'true'
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - v2.0-<< parameters.gemfile >>-<< parameters.ruby-version >>
       - run: gem install bundler -v '1.17'
       - run:
           name: Install dependencies
           command: bundle install
-      - save_cache:
-          key: v2.0-<< parameters.gemfile >>-<< parameters.ruby-version >>
-          paths:
-            - vendor/bundle
       - run:
           name: Run Specs
           command:

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-rails
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4.4
   DisplayCopNames: true
   Exclude:
     - bin/**/*

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v1.2.0](https://github.com/graphql-devise/graphql_devise/tree/v1.2.0) (2022-11-14)
+
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v1.1.1...v1.2.0)
+
+**Implemented enhancements:**
+
+- Set base controller from route mount [\#237](https://github.com/graphql-devise/graphql_devise/pull/237) ([00dav00](https://github.com/00dav00))
+
 ## [v1.1.1](https://github.com/graphql-devise/graphql_devise/tree/v1.1.1) (2022-10-20)
 
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v1.1.0...v1.1.1)

data/README.md

@@ -157,6 +157,8 @@ Rails.application.routes.draw do
       login: Mutations::Login
     },
     skip: [:register],
+    # optional, use only if you need a specific base controller to mount the new actions
+    base_controller: ApiController,
     additional_mutations: {
       # generates mutation { adminUserSignUp }
       admin_user_sign_up: Mutations::AdminUserSignUp
@@ -264,6 +266,11 @@ our default classes and yielding your customized code after calling `super`, exa
 and an `authenticatable` type to every query. Gem will try to use `Types::<model>Type` by
 default, so in our example you could define `Types::UserType` and every query and mutation
 will use it. But, you can override this type with this option like in the example.
+1. `base_controller`: Specifying this is optional. By default the controller used to mount the route is
+`GraphqlDevise::ApplicationController` which inherits from `ActionController::API` or `ActionController::Base`
+depending on the rails version of the main project. This option allows you to set the controller used as the parent of
+the controller where the route will be mounted. This config is similar to `Devise`'s `base_controller` config but in
+this case each route can have a different parent controller. **This option only works if you are using the mount method.**
 1. `skip`: An array of the operations that should not be available in the authentication schema. All these operations are
 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

data/app/controllers/graphql_devise/graphql_controller.rb

@@ -5,48 +5,6 @@ require_dependency 'graphql_devise/application_controller'
 module GraphqlDevise
   class GraphqlController < ApplicationController
     include SetUserByToken
-
-    def auth
-      result = if params[:_json]
-        Schema.multiplex(
-          params[:_json].map do |param|
-            { query: param[:query] }.merge(execute_params(param))
-          end
-        )
-      else
-        Schema.execute(params[:query], **execute_params(params))
-      end
-
-      render json: result unless performed?
-    end
-
-    attr_accessor :client_id, :token, :resource
-
-    private
-
-    def execute_params(item)
-      {
-        operation_name: item[:operationName],
-        variables:      ensure_hash(item[:variables]),
-        context:        { controller: self }
-      }
-    end
-
-    def ensure_hash(ambiguous_param)
-      case ambiguous_param
-      when String
-        if ambiguous_param.present?
-          ensure_hash(JSON.parse(ambiguous_param))
-        else
-          {}
-        end
-      when Hash, ActionController::Parameters
-        ambiguous_param
-      when nil
-        {}
-      else
-        raise ArgumentError, "Unexpected parameter: #{ambiguous_param}"
-      end
-    end
+    include AuthControllerMethods
   end
 end

data/lib/graphql_devise/concerns/auth_controller_methods.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GraphqlDevise
+  module AuthControllerMethods
+    extend ActiveSupport::Concern
+
+    def auth
+      result = if params[:_json]
+        Schema.multiplex(
+          params[:_json].map do |param|
+            { query: param[:query] }.merge(execute_params(param))
+          end
+        )
+      else
+        Schema.execute(params[:query], **execute_params(params))
+      end
+
+      render json: result unless performed?
+    end
+
+    attr_accessor :client_id, :token, :resource
+
+    private
+
+    def execute_params(item)
+      {
+        operation_name: item[:operationName],
+        variables:      ensure_hash(item[:variables]),
+        context:        { controller: self }
+      }
+    end
+
+    def ensure_hash(ambiguous_param)
+      case ambiguous_param
+      when String
+        if ambiguous_param.present?
+          ensure_hash(JSON.parse(ambiguous_param))
+        else
+          {}
+        end
+      when Hash, ActionController::Parameters
+        ambiguous_param
+      when nil
+        {}
+      else
+        raise ArgumentError, "Unexpected parameter: #{ambiguous_param}"
+      end
+    end
+  end
+end

data/lib/graphql_devise/route_mounter.rb

@@ -1,13 +1,23 @@
 module GraphqlDevise
   module RouteMounter
     def mount_graphql_devise_for(resource, options = {})
+      routing = 'graphql_devise/graphql#auth'
+
+      if (base_controller = options.delete(:base_controller))
+        new_controller = GraphqlDevise.const_set("#{resource}AuthController", Class.new(base_controller))
+        new_controller.include(SetUserByToken)
+        new_controller.include(AuthControllerMethods)
+
+        routing = "#{new_controller.to_s.underscore.gsub('_controller','')}#auth"
+      end
+
       clean_options = ResourceLoader.new(resource, options, true).call(
         Types::QueryType,
         Types::MutationType
       )
 
-      post clean_options.at, to: 'graphql_devise/graphql#auth'
-      get  clean_options.at, to: 'graphql_devise/graphql#auth'
+      post clean_options.at, to: routing
+      get  clean_options.at, to: routing
     end
   end
 end

data/lib/graphql_devise/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlDevise
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/dummy/app/controllers/cookies_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class CookiesController < ApplicationController
+  include ActionController::Cookies
+  protect_from_forgery with: :null_session
+end
+

data/spec/dummy/config/routes.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  mount_graphql_devise_for User, at: '/api/v1/graphql_auth', operations: {
-    login:    Mutations::Login,
-    register: Mutations::Register
-  }, additional_mutations: {
-    register_confirmed_user: Mutations::RegisterConfirmedUser
-  }, additional_queries: {
-    public_user: Resolvers::PublicUser
-  }
+  mount_graphql_devise_for(
+    User,
+    at: '/api/v1/graphql_auth',
+    base_controller: CookiesController,
+    operations: { login: Mutations::Login, register: Mutations::Register },
+    additional_mutations: { register_confirmed_user: Mutations::RegisterConfirmedUser },
+    additional_queries: { public_user: Resolvers::PublicUser }
+  )
 
   mount_graphql_devise_for(
     Admin,

data/spec/requests/mutations/login_spec.rb

@@ -185,23 +185,22 @@ RSpec.describe 'Login Requests' do
     end
   end
 
-
   if DeviseTokenAuth.respond_to?(:cookie_enabled)
     context 'when using cookies for auth' do
       let!(:user) { create(:user, :confirmed, password: password, email: 'vvega@wallaceinc.com') }
       let(:email) { user.email }
       let(:query) do
         <<-GRAPHQL
-        mutation {
-          userLogin(
-            email: "#{email}",
-            password: "#{password}"
-          ) {
-            authenticatable { email }
-            credentials { accessToken uid tokenType client expiry }
+          mutation {
+            userLogin(
+              email: "#{email}",
+              password: "#{password}"
+            ) {
+              authenticatable { email }
+              credentials { accessToken uid tokenType client expiry }
+            }
           }
-        }
-      GRAPHQL
+        GRAPHQL
       end
 
       around do |example|
@@ -214,7 +213,7 @@ RSpec.describe 'Login Requests' do
 
       it 'honors DTA configuration of setting auth info in cookies' do
         cookie = cookies.get_cookie('auth_cookie')
-        expect(JSON.parse(cookie.value).keys).to include(*%w[uid access-token client])
+        expect(JSON.parse(cookie.value).keys).to include('uid', 'access-token', 'client')
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql_devise
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mario Celi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise_token_auth
@@ -333,6 +333,7 @@ files:
 - lib/graphql_devise.rb
 - lib/graphql_devise/concerns/additional_controller_methods.rb
 - lib/graphql_devise/concerns/additional_model_methods.rb
+- lib/graphql_devise/concerns/auth_controller_methods.rb
 - lib/graphql_devise/concerns/authenticatable.rb
 - lib/graphql_devise/concerns/controller_methods.rb
 - lib/graphql_devise/concerns/field_authentication.rb
@@ -389,6 +390,7 @@ files:
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/controllers/api/v1/graphql_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/cookies_controller.rb
 - spec/dummy/app/graphql/dummy_schema.rb
 - spec/dummy/app/graphql/interpreter_schema.rb
 - spec/dummy/app/graphql/mutations/base_mutation.rb
@@ -526,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: GraphQL queries and mutations on top of devise_token_auth
@@ -536,6 +538,7 @@ test_files:
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/controllers/api/v1/graphql_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/cookies_controller.rb
 - spec/dummy/app/graphql/dummy_schema.rb
 - spec/dummy/app/graphql/interpreter_schema.rb
 - spec/dummy/app/graphql/mutations/base_mutation.rb