graphql_devise 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e824468f5810cc5fd611ac85056683a6208a5d4cfb6f92a5a28943cce6710ad
-  data.tar.gz: 750e8bc45f2c674269866b20af1e04c472ef3d1c86c00ff3899963d76915caf1
+  metadata.gz: 45c54ce5ffe8440cbcd6c371ee99acb6b904e21179f7d7f818e92473a74fcb2e
+  data.tar.gz: 41b388054e3e4cb4dc92ca2266fe13a9e953874eb717152eb2d163a25e365fb4
 SHA512:
-  metadata.gz: ad0971ec1bb0bfc16c01f3016388acdaeb82f6c58fb2108dd94ca8ba0712b570e629b5fe807c720b46bcd9ff8c24d72fc18d6acd17563247723066b9954a9422
-  data.tar.gz: 0da1bc5e775cb80e6f34012244b0985d83929a2b6011e17789508d9a9f0866158eb81f50c090959f0dd4f6f5a0f3c198b95733dfcba2f38a06c27bd8af4bee4e
+  metadata.gz: '088ee44829e747b80fbf089325b4f66afbd872c446f002fa9ddf453c43a264cb0a43853e4d35a29865700466ee8c4fa98fa2dad17b75459a09c9aa9708ea8c12'
+  data.tar.gz: eec7dd4a4ccefde800b347c87c0c7adb53f2c12c1318d476aae2b717b355c9be98508db22324ca9ec2bf26d11c3a4bead8ac9e64e529c10d92111cb7ab7ac4b3

data/.travis.yml

@@ -8,9 +8,9 @@ before_script: RAILS_ENV=test bundle exec rake db:create db:schema:load
 rvm:
   - 2.2.10
   - 2.3.8
-  - 2.4.7
-  - 2.5.6
-  - 2.6.4
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 gemfile:
   - gemfiles/rails4.2_graphql1.8.gemfile
@@ -23,11 +23,11 @@ gemfile:
 
 matrix:
   include:
-    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
-      rvm: 2.5.6
-    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
-      rvm: 2.6.4
     - gemfile: gemfiles/rails6.0_graphql1.8.gemfile
-      rvm: 2.5.6
+      rvm: 2.5.7
     - gemfile: gemfiles/rails6.0_graphql1.9.gemfile
-      rvm: 2.6.4
+      rvm: 2.6.5
+    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
+      rvm: 2.5.7
+    - gemfile: gemfiles/rails_edge_graphql_edge.gemfile
+      rvm: 2.6.5

data/CHANGELOG.md

@@ -1,16 +1,24 @@
 # Change Log
 
-## [v0.3.0](https://github.com/graphql-devise/graphql_devise/tree/v0.3.0) (2019-10-04)
-[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.2.0...v0.3.0)
+## [v0.4.0](https://github.com/graphql-devise/graphql_devise/tree/v0.4.0) (2019-10-13)
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.3.0...v0.4.0)
 
-**Implemented enhancements:**
+**Merged pull requests:**
 
-- Use new dir for email templates [\#17](https://github.com/graphql-devise/graphql_devise/pull/17) ([mcelicalderon](https://github.com/mcelicalderon))
+- Support `skip` and `only` when mounting routes [\#19](https://github.com/graphql-devise/graphql_devise/pull/19) ([mcelicalderon](https://github.com/mcelicalderon))
+- Test with latest ruby versions [\#18](https://github.com/graphql-devise/graphql_devise/pull/18) ([mcelicalderon](https://github.com/mcelicalderon))
+
+## [v0.3.0](https://github.com/graphql-devise/graphql_devise/tree/v0.3.0) (2019-10-04)
+[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.2.0...v0.3.0)
 
 **Fixed bugs:**
 
 - Fix separate resource mounts [\#16](https://github.com/graphql-devise/graphql_devise/pull/16) ([mcelicalderon](https://github.com/mcelicalderon))
 
+**Merged pull requests:**
+
+- Use new dir for email templates [\#17](https://github.com/graphql-devise/graphql_devise/pull/17) ([mcelicalderon](https://github.com/mcelicalderon))
+
 ## [v0.2.0](https://github.com/graphql-devise/graphql_devise/tree/v0.2.0) (2019-09-16)
 [Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.1.1...v0.2.0)
 

data/README.md

@@ -41,7 +41,8 @@ First, you need to mount the gem in the routes file like this
 Rails.application.routes.draw do
   mount_graphql_devise_for 'User', at: 'api/v1', authenticable_type: Types::CustomUserType, operations: {
     login: Mutations::Login
-  }
+  }, skip: [:sign_up]
+end
 ```
 If you used DTA's installer you will have to remove the `mount_devise_token_auth_for`
 line.
@@ -49,7 +50,7 @@ line.
 Here are the option for the mount method:
 
 1. `at`: Route where the GraphQL schema will be mounted on the Rails server. In the
-example your API will have this two routes `POST /api/v1//graphql_auth` `GET /api/v1//graphql_auth`.
+example your API will have this two routes `POST /api/v1/graphql_auth` and `GET /api/v1/graphql_auth`.
 If no this option is not specified, the schema will be mounted at `/graphql_auth`.
 1. `operations`: Specifying this one is optional. Here you can override default
 behavior by specifying your own mutations and queries for every GraphQL operation.
@@ -62,6 +63,23 @@ our default classes and yielding your customized code after calling `super`, exa
 and an `authenticable` 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. `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
+mutually exclusive, an error will be raised if you pass both to the mount method.
+
+#### 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
+:logout
+:sign_up
+:update_password
+:send_reset_password
+:confirm_account
+:check_password_token
+```
+
 
 ### Configuring Model
 Just like with Devise and DTA, you need to include a module in your authenticable model,
@@ -145,8 +163,7 @@ templates.
 We will continue to improve the gem and add better docs.
 
 1. Add install generator.
-1. Support more options on the mount method.
-1. Better support for multiple mounted models (it already works by mounting in different routes).
+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/lib/graphql_devise/rails/routes.rb

@@ -1,7 +1,33 @@
 module ActionDispatch::Routing
   class Mapper
     def mount_graphql_devise_for(resource, opts = {})
-      custom_operations = opts[:operations] || {}
+      custom_operations  = opts[:operations] || {}
+      skipped_operations = opts.fetch(:skip, [])
+      only_operations    = opts.fetch(:only, [])
+
+      if [skipped_operations, only_operations].all?(&:any?)
+        raise GraphqlDevise::Error, "Can't specify both `skip` and `only` options when mounting the route."
+      end
+
+      default_mutations = {
+        login:               GraphqlDevise::Mutations::Login,
+        logout:              GraphqlDevise::Mutations::Logout,
+        sign_up:             GraphqlDevise::Mutations::SignUp,
+        update_password:     GraphqlDevise::Mutations::UpdatePassword,
+        send_reset_password: GraphqlDevise::Mutations::SendPasswordReset
+      }.freeze
+      default_queries = {
+        confirm_account:      GraphqlDevise::Resolvers::ConfirmAccount,
+        check_password_token: GraphqlDevise::Resolvers::CheckPasswordToken
+      }
+      supported_operations = default_mutations.keys + default_queries.keys
+
+      unless skipped_operations.all? { |skipped| supported_operations.include?(skipped) }
+        raise GraphqlDevise::Error, 'Trying to skip a non supported operation. Check for typos.'
+      end
+      unless only_operations.all? { |only| supported_operations.include?(only) }
+        raise GraphqlDevise::Error, 'One of the `only` operations is not supported. Check for typos.'
+      end
 
       path         = opts.fetch(:at, '/graphql_auth')
       mapping_name = resource.underscore.tr('/', '_').to_sym
@@ -16,15 +42,12 @@ module ActionDispatch::Routing
                            "Types::#{resource}Type".safe_constantize ||
                            GraphqlDevise::Types::AuthenticableType
 
-      default_mutations = {
-        login:               GraphqlDevise::Mutations::Login,
-        logout:              GraphqlDevise::Mutations::Logout,
-        sign_up:             GraphqlDevise::Mutations::SignUp,
-        update_password:     GraphqlDevise::Mutations::UpdatePassword,
-        send_reset_password: GraphqlDevise::Mutations::SendPasswordReset
-      }.freeze
-
-      default_mutations.each do |action, mutation|
+      used_mutations = if only_operations.present?
+        default_mutations.slice(*only_operations)
+      else
+        default_mutations.except(*skipped_operations)
+      end
+      used_mutations.each do |action, mutation|
         used_mutation = if custom_operations[action].present?
           custom_operations[action]
         else
@@ -39,12 +62,12 @@ module ActionDispatch::Routing
         GraphqlDevise::Types::MutationType.field("#{mapping_name}_#{action}", mutation: used_mutation)
       end
 
-      default_queries = {
-        confirm_account:      GraphqlDevise::Resolvers::ConfirmAccount,
-        check_password_token: GraphqlDevise::Resolvers::CheckPasswordToken
-      }
-
-      default_queries.each do |action, query|
+      used_queries = if only_operations.present?
+        default_queries.slice(*only_operations)
+      else
+        default_queries.except(*skipped_operations)
+      end
+      used_queries.each do |action, query|
         used_query = if custom_operations[action].present?
           custom_operations[action]
         else

data/lib/graphql_devise/version.rb

@@ -1,3 +1,3 @@
 module GraphqlDevise
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/spec/dummy/app/graphql/types/mutation_type.rb

@@ -1,4 +1,9 @@
 module Types
   class MutationType < Types::BaseObject
+    field :dummy_mutation, String, null: false
+
+    def dummy_mutation
+      'Necessary so GraphQL gem does not complain about empty mutation type'
+    end
   end
 end

data/spec/dummy/app/models/guest.rb

@@ -0,0 +1,9 @@
+class Guest < ApplicationRecord
+  devise :database_authenticatable,
+         :registerable,
+         :recoverable,
+         :validatable,
+         :confirmable
+
+  include GraphqlDevise::Concerns::Model
+end

data/spec/dummy/config/routes.rb

@@ -7,8 +7,15 @@ Rails.application.routes.draw do
   mount_graphql_devise_for(
     'Admin',
     authenticable_type: Types::CustomAdminType,
+    skip:               [:sign_up, :check_password_token],
     at:                 '/api/v1/admin/graphql_auth'
   )
 
+  mount_graphql_devise_for(
+    'Guest',
+    only: [:login, :logout],
+    at:   '/api/v1/guest/graphql_auth'
+  )
+
   post '/api/v1/graphql', to: 'api/v1/graphql#graphql'
 end

data/spec/dummy/db/migrate/20191013213045_create_guests.rb

@@ -0,0 +1,36 @@
+class CreateGuests < ActiveRecord::Migration[6.0]
+  def change
+    create_table :guests do |t|
+      ## Required
+      t.string :provider, null: false, default: 'email'
+      t.string :uid, null: false, default: ''
+
+      ## Database authenticatable
+      t.string :encrypted_password, null: false, default: ''
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+      t.boolean  :allow_password_change, default: false
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## User Info
+      t.string :email
+
+      ## Tokens
+      t.text :tokens
+
+      t.timestamps
+    end
+
+    add_index :guests, :email,                unique: true
+    add_index :guests, [:uid, :provider],     unique: true
+    add_index :guests, :reset_password_token, unique: true
+    add_index :guests, :confirmation_token,   unique: true
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2019_09_16_012505) do
+ActiveRecord::Schema.define(version: 2019_10_13_213045) do
 
   create_table "admins", force: :cascade do |t|
     t.string "provider", default: "email", null: false
@@ -33,6 +33,27 @@ ActiveRecord::Schema.define(version: 2019_09_16_012505) do
     t.index ["uid", "provider"], name: "index_admins_on_uid_and_provider", unique: true
   end
 
+  create_table "guests", force: :cascade do |t|
+    t.string "provider", default: "email", null: false
+    t.string "uid", default: "", null: false
+    t.string "encrypted_password", default: "", null: false
+    t.string "reset_password_token"
+    t.datetime "reset_password_sent_at"
+    t.boolean "allow_password_change", default: false
+    t.string "confirmation_token"
+    t.datetime "confirmed_at"
+    t.datetime "confirmation_sent_at"
+    t.string "unconfirmed_email"
+    t.string "email"
+    t.text "tokens"
+    t.datetime "created_at", precision: 6, null: false
+    t.datetime "updated_at", precision: 6, null: false
+    t.index ["confirmation_token"], name: "index_guests_on_confirmation_token", unique: true
+    t.index ["email"], name: "index_guests_on_email", unique: true
+    t.index ["reset_password_token"], name: "index_guests_on_reset_password_token", unique: true
+    t.index ["uid", "provider"], name: "index_guests_on_uid_and_provider", unique: true
+  end
+
   create_table "users", force: :cascade do |t|
     t.string "provider", default: "email", null: false
     t.string "uid", default: "", null: false

data/spec/dummy/log/development.log

@@ -276,19 +276,37 @@ Migrating to AddAuthAvailableToUsers (20190824215150)
    (0.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
    (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
    (0.3ms)  SELECT COUNT(*) FROM "users"
-   (0.7ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.8ms)  SELECT sqlite_version(*)
+   (0.5ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
 Migrating to CreateAdmins (20190916012505)
    (0.1ms)  begin transaction
-   (0.1ms)  SELECT sqlite_version(*)
-   (0.6ms)  CREATE TABLE "admins" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "provider" varchar DEFAULT 'email' NOT NULL, "uid" varchar DEFAULT '' NOT NULL, "encrypted_password" varchar DEFAULT '' NOT NULL, "reset_password_token" varchar, "reset_password_sent_at" datetime, "allow_password_change" boolean DEFAULT 0, "confirmation_token" varchar, "confirmed_at" datetime, "confirmation_sent_at" datetime, "unconfirmed_email" varchar, "email" varchar, "tokens" text, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL)
+   (0.5ms)  CREATE TABLE "admins" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "provider" varchar DEFAULT 'email' NOT NULL, "uid" varchar DEFAULT '' NOT NULL, "encrypted_password" varchar DEFAULT '' NOT NULL, "reset_password_token" varchar, "reset_password_sent_at" datetime, "allow_password_change" boolean DEFAULT 0, "confirmation_token" varchar, "confirmed_at" datetime, "confirmation_sent_at" datetime, "unconfirmed_email" varchar, "email" varchar, "tokens" text, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL)
    (0.1ms)  CREATE UNIQUE INDEX "index_admins_on_email" ON "admins" ("email")
    (0.1ms)  CREATE UNIQUE INDEX "index_admins_on_uid_and_provider" ON "admins" ("uid", "provider")
    (0.1ms)  CREATE UNIQUE INDEX "index_admins_on_reset_password_token" ON "admins" ("reset_password_token")
    (0.1ms)  CREATE UNIQUE INDEX "index_admins_on_confirmation_token" ON "admins" ("confirmation_token")
-  ActiveRecord::SchemaMigration Create (0.3ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20190916012505"]]
-   (0.6ms)  commit transaction
-  ActiveRecord::InternalMetadata Load (0.5ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
-   (0.0ms)  begin transaction
-   (0.0ms)  commit transaction
+  primary::SchemaMigration Create (0.4ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20190916012505"]]
+   (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.5ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.9ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+Migrating to CreateGuests (20191013213045)
+   (0.1ms)  begin transaction
+   (0.5ms)  CREATE TABLE "guests" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "provider" varchar DEFAULT 'email' NOT NULL, "uid" varchar DEFAULT '' NOT NULL, "encrypted_password" varchar DEFAULT '' NOT NULL, "reset_password_token" varchar, "reset_password_sent_at" datetime, "allow_password_change" boolean DEFAULT 0, "confirmation_token" varchar, "confirmed_at" datetime, "confirmation_sent_at" datetime, "unconfirmed_email" varchar, "email" varchar, "tokens" text, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL)
+   (0.4ms)  rollback transaction
+   (0.7ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+Migrating to CreateGuests (20191013213045)
+   (0.1ms)  begin transaction
+   (1.0ms)  CREATE TABLE "guests" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "provider" varchar DEFAULT 'email' NOT NULL, "uid" varchar DEFAULT '' NOT NULL, "encrypted_password" varchar DEFAULT '' NOT NULL, "reset_password_token" varchar, "reset_password_sent_at" datetime, "allow_password_change" boolean DEFAULT 0, "confirmation_token" varchar, "confirmed_at" datetime, "confirmation_sent_at" datetime, "unconfirmed_email" varchar, "email" varchar, "tokens" text, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL)
+   (0.3ms)  CREATE UNIQUE INDEX "index_guests_on_email" ON "guests" ("email")
+   (0.1ms)  CREATE UNIQUE INDEX "index_guests_on_uid_and_provider" ON "guests" ("uid", "provider")
+   (0.1ms)  CREATE UNIQUE INDEX "index_guests_on_reset_password_token" ON "guests" ("reset_password_token")
+   (0.1ms)  CREATE UNIQUE INDEX "index_guests_on_confirmation_token" ON "guests" ("confirmation_token")
+  primary::SchemaMigration Create (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20191013213045"]]
+   (1.1ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+   (0.0ms)  SELECT sqlite_version(*)
    (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC