graphql_devise 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ddce4ffb15dd4eac50fd0756808ce5fdef81a2f5fcc3405e8c00e5a7c51b689
-  data.tar.gz: b47284dc35df29df8a9bd2ef17cb68dde81e4a183cae904220167a37efbd6a05
+  metadata.gz: 34880444c63dfec84dd91addc76574355469fdab6b3e0a00100ab4edde7da869
+  data.tar.gz: 3e3cbc8dd402f3d2e7450f301b1f0506bd804a1a62ddc7acc5b0c6c07bd892c2
 SHA512:
-  metadata.gz: 7dfb908c7284d5aac400dac4424ab7b053cd9c2f8da6b684028d19fa651eb0bd9b76ac911063676bb923c71a882930aefb65c66f2081d441b0461fc226dddf7b
-  data.tar.gz: 5f49d0b6b687b32de66836f9617eeb344b6c7dd77045b7a3e936f570799f9076c88f6d1abf152ba5ae54d034b5a31a0f106b0593359b742da5b7898578675633
+  metadata.gz: 953635cd445812d68d15e20367712b3118abb4bcea774859a80ce7265bc710c9c5917804ddb80f26868e2455591c2a96d14d10d4b5c6ff36315e18680e2d1534
+  data.tar.gz: 8b4bbba71c257d2be8fbc73e3c07817bc013a755fde9d13c6226f748e2ceebde975888d6f4e411584c3bb45ae4e6777cd1c8023c20a7f4fb35eb51655f44bb16

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [v0.13.0](https://github.com/graphql-devise/graphql_devise/tree/v0.13.0) (2020-06-22)
+
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.12.3...v0.13.0)
+
+**Breaking changes:**
+
+- Fix email reconfirmation feature [\#111](https://github.com/graphql-devise/graphql_devise/pull/111) ([mcelicalderon](https://github.com/mcelicalderon))
+
+**Implemented enhancements:**
+
+- Add frozen string literal to all relevant files [\#114](https://github.com/graphql-devise/graphql_devise/pull/114) ([mcelicalderon](https://github.com/mcelicalderon))
+
+**Fixed bugs:**
+
+- CookieOverflow for Own Schema Mount [\#112](https://github.com/graphql-devise/graphql_devise/issues/112)
+- Reconfirmable not setting unconfirmed\_email [\#102](https://github.com/graphql-devise/graphql_devise/issues/102)
+
 ## [v0.12.3](https://github.com/graphql-devise/graphql_devise/tree/v0.12.3) (2020-06-19)
 
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.12.2...v0.12.3)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -301,6 +301,44 @@ end
 The install generator can do this for you if you specify the `user_class` option.
 See [Installation](#installation) for details.
 
+### Email Reconfirmation
+DTA and Devise support email reconfirmation. When the `confirmable` module is added to your
+resource, an email is sent to the provided email address when the `signUp` mutation is used.
+You can also use this gem so every time a user updates the `email` field, a new email gets sent
+for the user to confirm the new email address. Only after clicking on the confirmation link,
+the email will be updated on the database to use the new value.
+
+In order to use this feature there are a couple of things to setup first:
+1. Make user your model includes the `:confirmable` module.
+1. Add an `unconfirmed_email` String column to your resource's table.
+
+After that is done, you simply need to call a different update method on your resource,
+`update_with_email`. This method behaves exactly the same as ActiveRecord's `update` method
+if the previous steps are not performed, or if you are not updating the `email` attribute.
+It is also mandatory to provide two additional attributes when email will change or an error
+will be raised:
+
+1. `schema_url`: The full url where your GQL schema is mounted. You can get this value from the
+controller available in the context of your mutations and queries like this:
+```ruby
+  context[:controller].full_url_without_params
+```
+1. `confirmation_success_url`: This the full url where you want users to be redirected after
+the email has changed successfully (usually a front-end url). This value is mandatory
+unless you have set `default_confirm_success_url` in your devise_token_auth initializer.
+
+So, it's up to you where you require confirmation of changing emails.
+[Here's an example](https://github.com/graphql-devise/graphql_devise/blob/c4dcb17e98f8d84cc5ac002c66ed98a797d3bc82/spec/dummy/app/graphql/mutations/update_user.rb#L13)
+on how you might do this. And also a demonstration on the method usage:
+```ruby
+user.update_with_email(
+  name:                     'New Name',
+  email:                    'new@domain.com',
+  schema_url:               'http://localhost:3000/graphql',
+  confirmation_success_url: 'https://google.com'
+)
+```
+
 ### Customizing Email Templates
 The approach of this gem is a bit different from DeviseTokenAuth. We have placed our templates in `app/views/graphql_devise/mailer`,
 so if you want to change them, place yours on the same dir structure on your Rails project. You can customize these two templates:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/controllers/graphql_devise/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   ApplicationController = if Rails::VERSION::MAJOR >= 5
     Class.new(ActionController::API)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module Concerns
     SetUserByToken = DeviseTokenAuth::Concerns::SetUserByToken
@@ -5,6 +7,10 @@ module GraphqlDevise
     SetUserByToken.module_eval do
       attr_accessor :client_id, :token, :resource
 
+      def full_url_without_params
+        request.base_url + request.path
+      end
+
       def set_resource_by_token(resource)
         set_user_by_token(resource)
       end

data/app/controllers/graphql_devise/graphql_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'graphql_devise/application_controller'
 
 module GraphqlDevise

data/app/helpers/graphql_devise/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module ApplicationHelper
   end

data/app/helpers/graphql_devise/mailer_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MailerHelper
     def confirmation_query(resource_name:, token:, redirect_url:)

data/app/models/graphql_devise/concerns/model.rb

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
+require 'graphql_devise/model/with_email_updater'
+
 module GraphqlDevise
   module Concerns
     Model = DeviseTokenAuth::Concerns::User
+
+    Model.module_eval do
+      def update_with_email(attributes = {})
+        GraphqlDevise::Model::WithEmailUpdater.new(self, attributes).call
+      end
+    end
   end
 end

data/app/views/graphql_devise/mailer/confirmation_instructions.html.erb

@@ -2,4 +2,4 @@
 
 <p><%= t('.confirm_link_msg') %></p>
 
-<p><%= link_to t('.confirm_account_link'), url_for(controller: message['controller'], action: message['action'], **confirmation_query(resource_name: @resource.class.to_s, redirect_url: message['redirect-url'], token: @token)) %></p>
+<p><%= link_to t('.confirm_account_link'), "#{message['schema_url']}?#{confirmation_query(resource_name: @resource.class.to_s, redirect_url: message['redirect-url'], token: @token).to_query}" %></p>

data/app/views/graphql_devise/mailer/reset_password_instructions.html.erb

@@ -2,7 +2,7 @@
 
 <p><%= t('.request_reset_link_msg') %></p>
 
-<p><%= link_to t('.password_change_link'), url_for(controller: message['controller'], action: message['action'], **password_reset_query(token: @token, redirect_url: message['redirect-url'], resource_name: @resource.class.to_s)) %></p>
+<p><%= link_to t('.password_change_link'), "#{message['schema_url']}?#{password_reset_query(token: @token, redirect_url: message['redirect-url'], resource_name: @resource.class.to_s).to_query}" %></p>
 
 <p><%= t('.ignore_mail_msg') %></p>
 <p><%= t('.no_changes_msg') %></p>

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 GraphqlDevise::Engine.routes.draw do
   # Required as Devise forces routes to reload on eager_load
   unless GraphqlDevise.schema_loaded?

data/lib/generators/graphql_devise/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)

data/lib/graphql_devise.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'graphql'
 require 'devise_token_auth'

data/lib/graphql_devise/concerns/controller_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module Concerns
     module ControllerMethods

data/lib/graphql_devise/default_operations/mutations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'graphql_devise/mutations/base'
 require 'graphql_devise/mutations/login'
 require 'graphql_devise/mutations/logout'

data/lib/graphql_devise/default_operations/resolvers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'graphql_devise/resolvers/base'
 require 'graphql_devise/resolvers/check_password_token'
 require 'graphql_devise/resolvers/confirm_account'

data/lib/graphql_devise/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'graphql_devise/rails/routes'
 
 module GraphqlDevise

data/lib/graphql_devise/errors/authentication_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   class AuthenticationError < ExecutionError
     def to_h

data/lib/graphql_devise/errors/detailed_user_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   class DetailedUserError < ExecutionError
     def initialize(message, errors:)

data/lib/graphql_devise/errors/error_codes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   ERROR_CODES = {
     user_error:           'USER_ERROR',

data/lib/graphql_devise/errors/execution_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   class ExecutionError < GraphQL::ExecutionError
   end

data/lib/graphql_devise/errors/user_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   class UserError < ExecutionError
     def to_h

data/lib/graphql_devise/model/with_email_updater.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module GraphqlDevise
+  module Model
+    class WithEmailUpdater
+      def initialize(resource, attributes)
+        @attributes = attributes
+        @resource   = resource
+      end
+
+      def call
+        resource_attributes = @attributes.except(:schema_url, :confirmation_success_url)
+        return @resource.update(resource_attributes) unless requires_reconfirmation?(resource_attributes)
+
+        @resource.assign_attributes(resource_attributes)
+
+        if @resource.email == email_in_database
+          return @resource.save
+        elsif required_reconfirm_attributes?
+          return false unless @resource.valid?
+
+          store_unconfirmed_email
+          saved = @resource.save
+          send_confirmation_instructions(saved)
+
+          saved
+        else
+          raise(
+            GraphqlDevise::Error,
+            'Method `update_with_email` requires attributes `confirmation_success_url` and `schema_url` for email reconfirmation to work'
+          )
+        end
+      end
+
+      private
+
+      def required_reconfirm_attributes?
+        @attributes[:schema_url].present? &&
+          (@attributes[:confirmation_success_url].present? || DeviseTokenAuth.default_confirm_success_url.present?)
+      end
+
+      def requires_reconfirmation?(resource_attributes)
+        resource_attributes.key?(:email) &&
+          @resource.devise_modules.include?(:confirmable) &&
+          @resource.respond_to?(:unconfirmed_email=)
+      end
+
+      def store_unconfirmed_email
+        @resource.unconfirmed_email  = @resource.email
+        @resource.confirmation_token = nil
+        @resource.email              = email_in_database
+        @resource.send(:generate_confirmation_token)
+      end
+
+      def email_in_database
+        if Devise.activerecord51?
+          @resource.email_in_database
+        else
+          @resource.email_was
+        end
+      end
+
+      def send_confirmation_instructions(saved)
+        return unless saved
+
+        @resource.send_confirmation_instructions(
+          redirect_url:  @attributes[:confirmation_success_url] || DeviseTokenAuth.default_confirm_success_url,
+          template_path: ['graphql_devise/mailer'],
+          schema_url:    @attributes[:schema_url]
+        )
+      end
+    end
+  end
+end

data/lib/graphql_devise/mount_method/operation_preparer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'operation_preparers/gql_name_setter'
 require_relative 'operation_preparers/mutation_field_setter'
 require_relative 'operation_preparers/resolver_type_setter'

data/lib/graphql_devise/mount_method/operation_preparers/custom_operation_preparer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_preparers/default_operation_preparer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_preparers/gql_name_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_preparers/mutation_field_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_preparers/resolver_type_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_preparers/resource_name_setter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OperationPreparers

data/lib/graphql_devise/mount_method/operation_sanitizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     class OperationSanitizer

data/lib/graphql_devise/mount_method/option_sanitizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'supported_options'
 
 module GraphqlDevise

data/lib/graphql_devise/mount_method/option_sanitizers/array_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionSanitizers

data/lib/graphql_devise/mount_method/option_sanitizers/class_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionSanitizers

data/lib/graphql_devise/mount_method/option_sanitizers/hash_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionSanitizers

data/lib/graphql_devise/mount_method/option_sanitizers/string_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionSanitizers

data/lib/graphql_devise/mount_method/option_validators/provided_operations_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'supported_operations_validator'
 
 module GraphqlDevise

data/lib/graphql_devise/mount_method/option_validators/skip_only_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionValidators

data/lib/graphql_devise/mount_method/option_validators/supported_operations_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GraphqlDevise
   module MountMethod
     module OptionValidators

data/lib/graphql_devise/mount_method/options_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'option_validators/skip_only_validator'
 require_relative 'option_validators/provided_operations_validator'