[#69] Add approval flow for new customers #90

rhian-cs · 2022-03-23T17:27:01Z

Closes: #69

What?

Add a new attribute to the users table: self_registered
Add a way for unauthenticated users to register themselves in the platform
When a user registers themselves, an email is sent to all admins notifying about the new user and their email address
Self registered users have, by default, self_registered: true and active: false and need to be enabled manually by an admin

Why?

With these changes, admins no longer need to manually add each user to the platform, they only need to approve their entry.

How to test it?

Open up the application and create a new user via the JSON request POST /signup with the body:

{
  "user": {
    "full_name": "John Doe",
    "email": "[email protected]",
    "password": "12345678",
    "address": "Test Street, 123",
    "cpf": "12345670088",
    "cellphone": "123456789012345"
  }
}

Example cURL request:

curl -v -X POST http://localhost:3000/signup.json \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "full_name": "John Doe",
      "email": "[email protected]",
      "password": "12345678",
      "address": "Test Street, 123",
      "cpf": "12345670088",
      "cellphone": "123456789012345"
    }
  }'

It should return status 201 Created and a body containing the created user:

{
  "id": 5,
  "full_name": "John Doe",
  "email": "[email protected]",
  "cpf": "12345670088",
  "address": "Test Street, 123",
  "cellphone": "123456789012345",
  "picture_url": null,
  "admin": false,
  "active": false,
  "self_registered": true,
  "created_at": "2022-03-23T17:10:05.768Z",
  "updated_at": "2022-03-23T17:10:05.768Z",
  "companies": []
}

If something is wrong, it will return 422 Unprocessable Entity with the errors inside the body:

{
  "errors": {
    "email": [
      "já está em uso"
    ],
    "cpf": [
      "já está em uso"
    ]
  }
}

Mailer Preview Screenshot

spec/requests/registrations_spec.rb

RodrigoVitiello · 2022-03-25T17:48:00Z

spec/mailers/previews/admin_mailer_preview.rb

@@ -0,0 +1,9 @@
+# Preview all emails at http://localhost:3000/rails/mailers/admin_mailer


Is this comment here needed?

This was autogenerated by rails generate, I thought it would be nice to keep it.

But thinking about it now, it may be better to include this information in the README.md or in the setup docs instead.

RodrigoVitiello · 2022-03-25T17:50:22Z

app/controllers/registrations_controller.rb

+  def send_user_self_registration_notification_email
+    return unless resource.persisted?
+
+    AdminMailer.user_self_registration_notification(admins: User.admins.to_a, user: resource).deliver_later


Here you don't need to call .to_a on User.admins

Unfortunately, for this case it is necessary to specify the to_a option for the admins. If this option is omitted, ActiveJob raises an exception:

ActiveJob::SerializationError: Unsupported argument type: ActiveRecord::Relation

What do you think about sending only the emails themselves? It seems to me you don't need the entire admin and by doing that you'll simplify the serialization and make the mailer know only what it needs to know to complete its job.

RodrigoVitiello

🚀

mauricio-prl

It looks awesome, thanks for this pr! 🥇
Just left a comment telling you about our request helpers, but it will be merged very soon! 🚀
Also, it has a few rubocop offenses, can you please take a look?

mauricio-prl · 2022-04-01T12:17:38Z

spec/requests/registrations_spec.rb

+  describe 'POST /signup' do
+    subject(:request) { post signup_path, params: params, as: :json }
+
+    let(:response_body) { JSON.parse(response.body).deep_symbolize_keys }


We have a helper for this :D
https://github.com/comarev/comarev/blob/master/spec/support/request_helpers.rb#L19

rhian-cs · 2022-04-01T14:37:50Z

app/controllers/registrations_controller.rb

+  PERMITTED_PARAMS = %i[email full_name cellphone cpf address].freeze
+
+  before_action :configure_permitted_parameters
+  after_action :send_user_self_registration_notification_email, only: %i[create] # rubocop:disable Rails/LexicallyScopedActionFilter


@m-pereira I disabled this Rubocop rule for this case, is this ok?

The reason is that, at first Rubocop pointed out that create is not defined in the class, but if I explicitly add the method, like so:

def create super end

Rubocop complains about an useless method:

app/controllers/registrations_controller.rb:10:3: W: [Correctable] Lint/UselessMethodDefinition: Useless method definition detected.

I think that's ok commenting as you did, in this case, the method is inherited from the Devise gem. And it's easy to find why, on the rubocop docs

mauricio-prl

Nice! Thanks @rhian-cs 🚀

mauricio-prl · 2022-04-01T16:35:16Z

@allcontributors add @rhian-cs for code

allcontributors · 2022-04-01T16:35:25Z

@m-pereira

I've put up a pull request to add @rhian-cs! 🎉

mauricio-prl · 2022-04-01T16:42:25Z

@allcontributors add @wenderjean and @RodrigoVitiello for review

allcontributors · 2022-04-01T16:42:33Z

@m-pereira

I've put up a pull request to add @wenderjean! 🎉

mauricio-prl · 2022-04-01T16:43:37Z

@allcontributors add @RodrigoVitiello for review

allcontributors · 2022-04-01T16:43:45Z

@m-pereira

I've put up a pull request to add @RodrigoVitiello! 🎉

Add self_registered flag to users table

671c937

RodrigoVitiello reviewed Mar 25, 2022

View reviewed changes

rhian-cs force-pushed the 69-add-approval-flow-for-customers branch from 6a0a7e9 to 7cae99d Compare March 28, 2022 13:07

RodrigoVitiello approved these changes Mar 28, 2022

View reviewed changes

mauricio-prl reviewed Apr 1, 2022

View reviewed changes

rhian-cs commented Apr 1, 2022

View reviewed changes

rhian-cs added 2 commits April 1, 2022 13:28

Add Devise registration for users

edbc01a

Add AdminMailer with user_self_registration_notification

b17de60

rhian-cs force-pushed the 69-add-approval-flow-for-customers branch from 7ee29f9 to b17de60 Compare April 1, 2022 16:28

mauricio-prl approved these changes Apr 1, 2022

View reviewed changes

mauricio-prl merged commit b4dc209 into comarev:master Apr 1, 2022

allcontributors bot mentioned this pull request Apr 1, 2022

docs: add rhian-cs as a contributor for code #92

Merged

allcontributors bot mentioned this pull request Apr 1, 2022

docs: add wenderjean as a contributor for review #93

Merged

allcontributors bot mentioned this pull request Apr 1, 2022

docs: add RodrigoVitiello as a contributor for review #94

Merged

belgamo mentioned this pull request May 16, 2022

Public sign up with approval comarev/comarev-dashboard#86

Open

apolimax mentioned this pull request Jun 9, 2022

86 public signup approval comarev/comarev-dashboard#94

Closed

		@@ -0,0 +1,9 @@
		# Preview all emails at http://localhost:3000/rails/mailers/admin_mailer

[#69] Add approval flow for new customers #90

[#69] Add approval flow for new customers #90

Uh oh!

Conversation

rhian-cs commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How to test it?

Mailer Preview Screenshot

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RodrigoVitiello Mar 25, 2022

Choose a reason for hiding this comment

Uh oh!

rhian-cs Mar 25, 2022

Choose a reason for hiding this comment

Uh oh!

RodrigoVitiello Mar 25, 2022

Choose a reason for hiding this comment

Uh oh!

rhian-cs Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

wenderjean Mar 28, 2022

Choose a reason for hiding this comment

Uh oh!

RodrigoVitiello left a comment

Choose a reason for hiding this comment

Uh oh!

mauricio-prl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mauricio-prl Apr 1, 2022

Choose a reason for hiding this comment

Uh oh!

rhian-cs Apr 1, 2022

Choose a reason for hiding this comment

Uh oh!

mauricio-prl Apr 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mauricio-prl left a comment

Choose a reason for hiding this comment

Uh oh!

mauricio-prl commented Apr 1, 2022

Uh oh!

allcontributors bot commented Apr 1, 2022

Uh oh!

mauricio-prl commented Apr 1, 2022

Uh oh!

allcontributors bot commented Apr 1, 2022

Uh oh!

mauricio-prl commented Apr 1, 2022

Uh oh!

allcontributors bot commented Apr 1, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rhian-cs commented Mar 23, 2022 •

edited

Loading

mauricio-prl left a comment •

edited

Loading

mauricio-prl Apr 1, 2022 •

edited

Loading