graphql_devise 0.4.1 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/CHANGELOG.md +12 -1
- data/README.md +36 -14
- data/graphql_devise.gemspec +1 -0
- data/lib/generators/graphql_devise/install_generator.rb +66 -0
- data/lib/graphql_devise/version.rb +1 -1
- data/spec/dummy/config/locales/devise.en.yml +65 -0
- data/spec/generators/graphql_devise/install_generator_spec.rb +52 -0
- data/spec/rails_helper.rb +2 -0
- data/spec/support/generators/file_helpers.rb +12 -0
- metadata +23 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 30163bf2c26f42fe410f8adb68b491336677d5ff182819c1445e9e0be3ac4fad
|
4
|
+
data.tar.gz: 857c649c6edc130f9c8b09d91f03c6e5a1788ee332da77446d3783332a5ebac3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d2c07b7c32c22fafa9e18f767f99355100eb57c89ba377dbe49353c67f27a092ca4949ba2db627c1a58840350aae36163eae0b355964f721d3d955aa5e26dd7
|
7
|
+
data.tar.gz: 12e63d7d8aa0bd621bea3b01e7cc2398cc001709a1aa9c1faa711552f7699b5a3bbcc2fed356d949b127f9a9cdc49f8d6871ca86ab167307c11d643dcbe0ce49
|
data/.gitignore
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,17 @@
|
|
1
1
|
# Change Log
|
2
2
|
|
3
|
-
## [v0.
|
3
|
+
## [v0.5.0](https://github.com/graphql-devise/graphql_devise/tree/v0.5.0) (2019-10-24)
|
4
|
+
[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.4.1...v0.5.0)
|
5
|
+
|
6
|
+
**Closed issues:**
|
7
|
+
|
8
|
+
- Add fields when user Sign Up [\#28](https://github.com/graphql-devise/graphql_devise/issues/28)
|
9
|
+
|
10
|
+
**Merged pull requests:**
|
11
|
+
|
12
|
+
- Add routes generator [\#22](https://github.com/graphql-devise/graphql_devise/pull/22) ([00dav00](https://github.com/00dav00))
|
13
|
+
|
14
|
+
## [v0.4.1](https://github.com/graphql-devise/graphql_devise/tree/v0.4.1) (2019-10-18)
|
4
15
|
[Full Changelog](https://github.com/graphql-devise/graphql_devise/compare/v0.4.0...v0.4.1)
|
5
16
|
|
6
17
|
**Fixed bugs:**
|
data/README.md
CHANGED
@@ -20,21 +20,40 @@ Or install it yourself as:
|
|
20
20
|
|
21
21
|
$ gem install graphql_devise
|
22
22
|
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
23
|
+
Next, you need to run the generator:
|
24
|
+
|
25
|
+
$ rails generate graphql_devise:install
|
26
|
+
|
27
|
+
Graphql Devise generator will execute `Devise` and `Devise Token Auth`
|
28
|
+
generators for you. These will make the required changes for the gems to
|
29
|
+
work correctly. All configurations for [Devise](https://github.com/plataformatec/devise) and
|
30
|
+
[Devise Token Auth](https://github.com/lynndylanhurley/devise_token_auth) are available,
|
31
|
+
so you can read the docs there to customize your options.
|
27
32
|
Configurations are done via initializer files as usual, one per gem.
|
28
|
-
|
29
|
-
|
33
|
+
|
34
|
+
The generator accepts 2 params: `user_class` and `mount_path`. The params
|
35
|
+
will be used to mount the route in `config/routes.rb`. For instance the executing:
|
36
|
+
|
30
37
|
```bash
|
31
|
-
$ rails g
|
38
|
+
$ rails g graphql_devise:install Admin api/auth
|
32
39
|
```
|
33
|
-
`User` could be any model name you are going to be using for authentication,
|
34
|
-
and `auth` could be anything as we will be removing that from the routes file.
|
35
40
|
|
36
|
-
|
37
|
-
|
41
|
+
Will do the following:
|
42
|
+
- Execute `Devise` install generator
|
43
|
+
- Execute `Devise Token Auth` install generator with `Admin` and `api/auth` as params
|
44
|
+
- Find or create `Admin` model
|
45
|
+
- Add `devise` modules to `Admin` model
|
46
|
+
- Other changes that you can find [here](https://devise-token-auth.gitbook.io/devise-token-auth/config)
|
47
|
+
- Add the route to `config/routes.rb`
|
48
|
+
- `mount_graphql_devise_for 'Admin', at: 'api/auth'
|
49
|
+
|
50
|
+
`Admin` could be any model name you are going to be using for authentication,
|
51
|
+
and `api/auth` could be any mount path you would like to use for auth.
|
52
|
+
|
53
|
+
### Mounting Routes manually
|
54
|
+
Routes can be added using the initializer or manually.
|
55
|
+
You can add a route like this:
|
56
|
+
|
38
57
|
```ruby
|
39
58
|
# config/routes.rb
|
40
59
|
|
@@ -50,8 +69,6 @@ Rails.application.routes.draw do
|
|
50
69
|
)
|
51
70
|
end
|
52
71
|
```
|
53
|
-
If you used DTA's installer you will have to remove the `mount_devise_token_auth_for`
|
54
|
-
line.
|
55
72
|
|
56
73
|
Here are the options for the mount method:
|
57
74
|
|
@@ -107,6 +124,9 @@ class User < ApplicationRecord
|
|
107
124
|
end
|
108
125
|
```
|
109
126
|
|
127
|
+
The install generator can do this for you if you specify the `user_class` option.
|
128
|
+
See [Installation](#Installation) for details.
|
129
|
+
|
110
130
|
### Customizing Email Templates
|
111
131
|
The approach of this gem is a bit different from DeviseTokenAuth. We have placed our templates in `app/views/graphql_devise/mailer`,
|
112
132
|
so if you want to change them, place yours on the same dir structure on your Rails project. You can customize these two templates:
|
@@ -132,6 +152,9 @@ class MyController < ApplicationController
|
|
132
152
|
end
|
133
153
|
```
|
134
154
|
|
155
|
+
The install generator can do this for you because it executes DTA installer.
|
156
|
+
See [Installation](#Installation) for details.
|
157
|
+
|
135
158
|
### Making Requests
|
136
159
|
Here is a list of the available mutations and queries assuming your mounted model
|
137
160
|
is `User`.
|
@@ -167,7 +190,6 @@ templates.
|
|
167
190
|
## Future Work
|
168
191
|
We will continue to improve the gem and add better docs.
|
169
192
|
|
170
|
-
1. Add install generator.
|
171
193
|
1. Add mount option that will create a separate schema for the mounted resource.
|
172
194
|
1. Make sure this gem can correctly work alongside DTA and the original Devise gem.
|
173
195
|
1. Improve DOCS.
|
data/graphql_devise.gemspec
CHANGED
@@ -0,0 +1,66 @@
|
|
1
|
+
module GraphqlDevise
|
2
|
+
class InstallGenerator < ::Rails::Generators::Base
|
3
|
+
source_root File.expand_path('templates', __dir__)
|
4
|
+
|
5
|
+
argument :user_class, type: :string, default: 'User'
|
6
|
+
argument :mount_path, type: :string, default: 'auth'
|
7
|
+
|
8
|
+
def execute_devise_installer
|
9
|
+
generate 'devise:install'
|
10
|
+
end
|
11
|
+
|
12
|
+
def execute_dta_installer
|
13
|
+
generate 'devise_token_auth:install', "#{user_class} #{mount_path}"
|
14
|
+
end
|
15
|
+
|
16
|
+
def mount_resource_route
|
17
|
+
routes_file = 'config/routes.rb'
|
18
|
+
routes_path = File.join(destination_root, routes_file)
|
19
|
+
gem_helper = 'mount_graphql_devise_for'
|
20
|
+
gem_route = "#{gem_helper} '#{user_class}', at: '#{mount_path}'"
|
21
|
+
dta_route = "mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'"
|
22
|
+
file_start = 'Rails.application.routes.draw do'
|
23
|
+
|
24
|
+
if File.exist?(routes_path)
|
25
|
+
current_route = parse_file_for_line(routes_path, gem_route)
|
26
|
+
|
27
|
+
if current_route.present?
|
28
|
+
say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
|
29
|
+
else
|
30
|
+
current_dta_route = parse_file_for_line(routes_path, dta_route)
|
31
|
+
|
32
|
+
if current_dta_route.present?
|
33
|
+
replace_line(routes_path, dta_route, gem_route)
|
34
|
+
else
|
35
|
+
insert_text_after_line(routes_path, file_start, gem_route)
|
36
|
+
end
|
37
|
+
end
|
38
|
+
else
|
39
|
+
say_status('skipped', "#{routes_file} not found. Add \"#{gem_route}\" to your routes file.")
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
private
|
44
|
+
|
45
|
+
def insert_text_after_line(filename, line, str)
|
46
|
+
gsub_file(filename, /(#{Regexp.escape(line)})/mi) do |match|
|
47
|
+
"#{match}\n #{str}"
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def replace_line(filename, old_line, new_line)
|
52
|
+
gsub_file(filename, /(#{Regexp.escape(old_line)})/mi, " #{new_line}")
|
53
|
+
end
|
54
|
+
|
55
|
+
def parse_file_for_line(filename, str)
|
56
|
+
match = false
|
57
|
+
|
58
|
+
File.open(filename) do |f|
|
59
|
+
f.each_line do |line|
|
60
|
+
match = line if line =~ /(#{Regexp.escape(str)})/mi
|
61
|
+
end
|
62
|
+
end
|
63
|
+
match
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
# Additional translations at https://github.com/plataformatec/devise/wiki/I18n
|
2
|
+
|
3
|
+
en:
|
4
|
+
devise:
|
5
|
+
confirmations:
|
6
|
+
confirmed: "Your email address has been successfully confirmed."
|
7
|
+
send_instructions: "You will receive an email with instructions for how to confirm your email address in a few minutes."
|
8
|
+
send_paranoid_instructions: "If your email address exists in our database, you will receive an email with instructions for how to confirm your email address in a few minutes."
|
9
|
+
failure:
|
10
|
+
already_authenticated: "You are already signed in."
|
11
|
+
inactive: "Your account is not activated yet."
|
12
|
+
invalid: "Invalid %{authentication_keys} or password."
|
13
|
+
locked: "Your account is locked."
|
14
|
+
last_attempt: "You have one more attempt before your account is locked."
|
15
|
+
not_found_in_database: "Invalid %{authentication_keys} or password."
|
16
|
+
timeout: "Your session expired. Please sign in again to continue."
|
17
|
+
unauthenticated: "You need to sign in or sign up before continuing."
|
18
|
+
unconfirmed: "You have to confirm your email address before continuing."
|
19
|
+
mailer:
|
20
|
+
confirmation_instructions:
|
21
|
+
subject: "Confirmation instructions"
|
22
|
+
reset_password_instructions:
|
23
|
+
subject: "Reset password instructions"
|
24
|
+
unlock_instructions:
|
25
|
+
subject: "Unlock instructions"
|
26
|
+
email_changed:
|
27
|
+
subject: "Email Changed"
|
28
|
+
password_change:
|
29
|
+
subject: "Password Changed"
|
30
|
+
omniauth_callbacks:
|
31
|
+
failure: "Could not authenticate you from %{kind} because \"%{reason}\"."
|
32
|
+
success: "Successfully authenticated from %{kind} account."
|
33
|
+
passwords:
|
34
|
+
no_token: "You can't access this page without coming from a password reset email. If you do come from a password reset email, please make sure you used the full URL provided."
|
35
|
+
send_instructions: "You will receive an email with instructions on how to reset your password in a few minutes."
|
36
|
+
send_paranoid_instructions: "If your email address exists in our database, you will receive a password recovery link at your email address in a few minutes."
|
37
|
+
updated: "Your password has been changed successfully. You are now signed in."
|
38
|
+
updated_not_active: "Your password has been changed successfully."
|
39
|
+
registrations:
|
40
|
+
destroyed: "Bye! Your account has been successfully cancelled. We hope to see you again soon."
|
41
|
+
signed_up: "Welcome! You have signed up successfully."
|
42
|
+
signed_up_but_inactive: "You have signed up successfully. However, we could not sign you in because your account is not yet activated."
|
43
|
+
signed_up_but_locked: "You have signed up successfully. However, we could not sign you in because your account is locked."
|
44
|
+
signed_up_but_unconfirmed: "A message with a confirmation link has been sent to your email address. Please follow the link to activate your account."
|
45
|
+
update_needs_confirmation: "You updated your account successfully, but we need to verify your new email address. Please check your email and follow the confirmation link to confirm your new email address."
|
46
|
+
updated: "Your account has been updated successfully."
|
47
|
+
updated_but_not_signed_in: "Your account has been updated successfully, but since your password was changed, you need to sign in again"
|
48
|
+
sessions:
|
49
|
+
signed_in: "Signed in successfully."
|
50
|
+
signed_out: "Signed out successfully."
|
51
|
+
already_signed_out: "Signed out successfully."
|
52
|
+
unlocks:
|
53
|
+
send_instructions: "You will receive an email with instructions for how to unlock your account in a few minutes."
|
54
|
+
send_paranoid_instructions: "If your account exists, you will receive an email with instructions for how to unlock it in a few minutes."
|
55
|
+
unlocked: "Your account has been unlocked successfully. Please sign in to continue."
|
56
|
+
errors:
|
57
|
+
messages:
|
58
|
+
already_confirmed: "was already confirmed, please try signing in"
|
59
|
+
confirmation_period_expired: "needs to be confirmed within %{period}, please request a new one"
|
60
|
+
expired: "has expired, please request a new one"
|
61
|
+
not_found: "not found"
|
62
|
+
not_locked: "was not locked"
|
63
|
+
not_saved:
|
64
|
+
one: "1 error prohibited this %{resource} from being saved:"
|
65
|
+
other: "%{count} errors prohibited this %{resource} from being saved:"
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# Generators are not automatically loaded by Rails
|
2
|
+
require 'rails_helper'
|
3
|
+
require 'generators/graphql_devise/install_generator'
|
4
|
+
|
5
|
+
RSpec.describe GraphqlDevise::InstallGenerator, type: :generator do
|
6
|
+
destination File.expand_path('../../../tmp', __FILE__)
|
7
|
+
|
8
|
+
before do
|
9
|
+
prepare_destination
|
10
|
+
end
|
11
|
+
|
12
|
+
let(:routes_path) { "#{destination_root}/config/routes.rb" }
|
13
|
+
let(:routes_content) { File.read(routes_path) }
|
14
|
+
let(:dta_route) { "mount_devise_token_auth_for 'User', at: 'auth'" }
|
15
|
+
|
16
|
+
xcontext 'when the file exists' do
|
17
|
+
before do
|
18
|
+
create_file_with_content(
|
19
|
+
routes_path,
|
20
|
+
"Rails.application.routes.draw do\n#{dta_route}\nend"
|
21
|
+
)
|
22
|
+
end
|
23
|
+
|
24
|
+
context 'when passing no params to the generator' do
|
25
|
+
before { run_generator }
|
26
|
+
|
27
|
+
it 'replaces dta route using the default values for class and path' do
|
28
|
+
generator_added_route = / mount_graphql_devise_for 'User', at: 'auth'/
|
29
|
+
expect(routes_content).to match(generator_added_route)
|
30
|
+
expect(routes_content).not_to match(dta_route)
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
context 'when passing custom params to the generator' do
|
35
|
+
before { run_generator %w[Admin api] }
|
36
|
+
|
37
|
+
it 'add the routes using the provided values for class and path and keeps dta route' do
|
38
|
+
generator_added_route = / mount_graphql_devise_for 'Admin', at: 'api'/
|
39
|
+
expect(routes_content).to match(generator_added_route)
|
40
|
+
expect(routes_content).to match(dta_route)
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
xcontext 'when file does *NOT* exist' do
|
46
|
+
before { run_generator }
|
47
|
+
|
48
|
+
it 'does *NOT* create the file and throw no exception' do
|
49
|
+
expect(File.exist?(routes_path)).to be_falsey
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
data/spec/rails_helper.rb
CHANGED
@@ -10,6 +10,7 @@ require 'rspec/rails'
|
|
10
10
|
# Add additional requires below this line. Rails is not loaded until this point!
|
11
11
|
require 'factory_bot'
|
12
12
|
require 'faker'
|
13
|
+
require 'generator_spec'
|
13
14
|
|
14
15
|
# Load RSpec helpers.
|
15
16
|
Dir[File.join(ENGINE_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
|
@@ -36,4 +37,5 @@ RSpec.configure do |config|
|
|
36
37
|
config.include(Requests::JsonHelpers, type: :request)
|
37
38
|
config.include(Requests::AuthHelpers, type: :request)
|
38
39
|
config.include(ActiveSupport::Testing::TimeHelpers)
|
40
|
+
config.include(Generators::FileHelpers, type: :generator)
|
39
41
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: graphql_devise
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mario Celi
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: exe
|
11
11
|
cert_chain: []
|
12
|
-
date: 2019-10-
|
12
|
+
date: 2019-10-24 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: devise_token_auth
|
@@ -221,6 +221,20 @@ dependencies:
|
|
221
221
|
- - ">="
|
222
222
|
- !ruby/object:Gem::Version
|
223
223
|
version: '0'
|
224
|
+
- !ruby/object:Gem::Dependency
|
225
|
+
name: generator_spec
|
226
|
+
requirement: !ruby/object:Gem::Requirement
|
227
|
+
requirements:
|
228
|
+
- - ">="
|
229
|
+
- !ruby/object:Gem::Version
|
230
|
+
version: '0'
|
231
|
+
type: :development
|
232
|
+
prerelease: false
|
233
|
+
version_requirements: !ruby/object:Gem::Requirement
|
234
|
+
requirements:
|
235
|
+
- - ">="
|
236
|
+
- !ruby/object:Gem::Version
|
237
|
+
version: '0'
|
224
238
|
description: GraphQL queries and mutations on top of devise_token_auth
|
225
239
|
email:
|
226
240
|
- mcelicalderon@gmail.com
|
@@ -279,6 +293,7 @@ files:
|
|
279
293
|
- gemfiles/rails6.0_graphql1.9.gemfile
|
280
294
|
- gemfiles/rails_edge_graphql_edge.gemfile
|
281
295
|
- graphql_devise.gemspec
|
296
|
+
- lib/generators/graphql_devise/install_generator.rb
|
282
297
|
- lib/graphql_devise.rb
|
283
298
|
- lib/graphql_devise/concerns/controller_methods.rb
|
284
299
|
- lib/graphql_devise/detailed_user_error.rb
|
@@ -331,6 +346,7 @@ files:
|
|
331
346
|
- spec/dummy/config/initializers/inflections.rb
|
332
347
|
- spec/dummy/config/initializers/mime_types.rb
|
333
348
|
- spec/dummy/config/initializers/wrap_parameters.rb
|
349
|
+
- spec/dummy/config/locales/devise.en.yml
|
334
350
|
- spec/dummy/config/locales/en.yml
|
335
351
|
- spec/dummy/config/master.key
|
336
352
|
- spec/dummy/config/puma.rb
|
@@ -352,6 +368,7 @@ files:
|
|
352
368
|
- spec/factories/admins.rb
|
353
369
|
- spec/factories/guests.rb
|
354
370
|
- spec/factories/users.rb
|
371
|
+
- spec/generators/graphql_devise/install_generator_spec.rb
|
355
372
|
- spec/graphql_devise_spec.rb
|
356
373
|
- spec/models/user_spec.rb
|
357
374
|
- spec/rails_helper.rb
|
@@ -366,6 +383,7 @@ files:
|
|
366
383
|
- spec/spec_helper.rb
|
367
384
|
- spec/support/contexts/graphql_request.rb
|
368
385
|
- spec/support/factory_bot.rb
|
386
|
+
- spec/support/generators/file_helpers.rb
|
369
387
|
- spec/support/matchers/auth_headers_matcher.rb
|
370
388
|
- spec/support/matchers/not_change_matcher.rb
|
371
389
|
- spec/support/requests/auth_helpers.rb
|
@@ -425,6 +443,7 @@ test_files:
|
|
425
443
|
- spec/dummy/config/secrets.yml
|
426
444
|
- spec/dummy/config/routes.rb
|
427
445
|
- spec/dummy/config/locales/en.yml
|
446
|
+
- spec/dummy/config/locales/devise.en.yml
|
428
447
|
- spec/dummy/config/environments/production.rb
|
429
448
|
- spec/dummy/config/environments/development.rb
|
430
449
|
- spec/dummy/config/environments/test.rb
|
@@ -473,9 +492,11 @@ test_files:
|
|
473
492
|
- spec/support/contexts/graphql_request.rb
|
474
493
|
- spec/support/requests/auth_helpers.rb
|
475
494
|
- spec/support/requests/json_helpers.rb
|
495
|
+
- spec/support/generators/file_helpers.rb
|
476
496
|
- spec/support/matchers/not_change_matcher.rb
|
477
497
|
- spec/support/matchers/auth_headers_matcher.rb
|
478
498
|
- spec/factories/admins.rb
|
479
499
|
- spec/factories/users.rb
|
480
500
|
- spec/factories/guests.rb
|
501
|
+
- spec/generators/graphql_devise/install_generator_spec.rb
|
481
502
|
- spec/rails_helper.rb
|