Make user API client return JSON, not a model

The data flow of other bits of our application looks like this:
```
                         API (returns JSON)
                                  ⬇
          API client (returns a built in type, usually `dict`)
                                  ⬇
          Model (returns an instance, eg of type `Service`)
                                  ⬇
                         View (returns HTML)
```
The user API client was architected weirdly, in that it returned a model
directly, like this:

```
                         API (returns JSON)
                                  ⬇
    API client (returns a model, of type `User`, `InvitedUser`, etc)
                                  ⬇
                         View (returns HTML)
```

This mixing of different layers of the application is bad because it
makes it hard to write model code that doesn’t have circular
dependencies. As our application gets more complicated we will be
relying more on models to manage this complexity, so we should make it
easy, not hard to write them.

It also means that most of our mocking was of the User model, not just
the underlying JSON. So it would have been easy to introduce subtle bugs
to the user model, because it wasn’t being comprehensively tested. A lot
of the changed lines of code in this commit mean changing the tests to
mock only the JSON, which means that the model layer gets implicitly
tested.

For those reasons this commit changes the user API client to return
JSON, not an instance of `User` or other models.

app/main/views/code_not_received.py

@@ -3,21 +3,22 @@ from flask import redirect, render_template, session, url_for
 from app import user_api_client
 from app.main import main
 from app.main.forms import TextNotReceivedForm
+from app.models.user import User
 from app.utils import redirect_to_sign_in
 
 
 @main.route('/resend-email-verification')
 @redirect_to_sign_in
 def resend_email_verification():
-    user = user_api_client.get_user_by_email(session['user_details']['email'])
-    user_api_client.send_verify_email(user.id, user.email_address)
+    user = User.from_email_address(session['user_details']['email'])
+    user.send_verify_email()
     return render_template('views/resend-email-verification.html', email=user.email_address)
 
 
 @main.route('/text-not-received', methods=['GET', 'POST'])
 @redirect_to_sign_in
 def check_and_resend_text_code():
-    user = user_api_client.get_user_by_email(session['user_details']['email'])
+    user = User.from_email_address(session['user_details']['email'])
 
     if user.state == 'active':
         # this is a verified user and therefore redirect to page to request resend without edit mobile
@@ -25,8 +26,8 @@ def check_and_resend_text_code():
 
     form = TextNotReceivedForm(mobile_number=user.mobile_number)
     if form.validate_on_submit():
-        user_api_client.send_verify_code(user.id, 'sms', to=form.mobile_number.data)
-        user = user_api_client.update_user_attribute(user.id, mobile_number=form.mobile_number.data)
+        user.send_verify_code(to=form.mobile_number.data)
+        user.update(mobile_number=form.mobile_number.data)
         return redirect(url_for('.verify'))
 
     return render_template('views/text-not-received.html', form=form)
@@ -35,8 +36,8 @@ def check_and_resend_text_code():
 @main.route('/send-new-code', methods=['GET'])
 @redirect_to_sign_in
 def check_and_resend_verification_code():
-    user = user_api_client.get_user_by_email(session['user_details']['email'])
-    user_api_client.send_verify_code(user.id, 'sms', user.mobile_number)
+    user = User.from_email_address(session['user_details']['email'])
+    user.send_verify_code()
     if user.state == 'pending':
         return redirect(url_for('main.verify'))
     else:

app/main/views/find_users.py

@@ -4,6 +4,7 @@ from flask_login import login_required
 from app import user_api_client
 from app.main import main
 from app.main.forms import SearchUsersByEmailForm
+from app.models.user import User
 from app.utils import user_is_platform_admin
 
 
@@ -29,7 +30,7 @@ def find_users_by_email():
 @login_required
 @user_is_platform_admin
 def user_information(user_id):
-    user = user_api_client.get_user(user_id)
+    user = User.from_id(user_id)
     services = user_api_client.get_services_for_user(user)
     return render_template(
         'views/find-users/user-information.html',

app/main/views/invites.py

@@ -1,28 +1,27 @@
 from flask import abort, flash, redirect, render_template, session, url_for
 from flask_login import current_user
 from markupsafe import Markup
-from notifications_python_client.errors import HTTPError
 
-from app import (
-    invite_api_client,
-    org_invite_api_client,
-    organisations_client,
-    service_api_client,
-    user_api_client,
-)
 from app.main import main
+from app.models.organisation import Organisation
+from app.models.service import Service
+from app.models.user import (
+    InvitedOrgUser,
+    InvitedUser,
+    OrganisationUsers,
+    User,
+    Users,
+)
+from app.notify_client import InviteTokenError
 
 
 @main.route("/invitation/<token>")
 def accept_invite(token):
     try:
-        invited_user = invite_api_client.check_token(token)
-    except HTTPError as e:
-        if e.status_code == 400 and 'invitation' in e.message:
-            flash(e.message['invitation'])
-            return redirect(url_for('main.sign_in'))
-        else:
-            raise e
+        invited_user = InvitedUser.from_token(token)
+    except InviteTokenError as exception:
+        flash(str(exception))
+        return redirect(url_for('main.sign_in'))
 
     if not current_user.is_anonymous and current_user.email_address.lower() != invited_user.email_address.lower():
         message = Markup("""
@@ -38,11 +37,10 @@ def accept_invite(token):
         abort(403)
 
     if invited_user.status == 'cancelled':
-        from_user = user_api_client.get_user(invited_user.from_user)
-        service = service_api_client.get_service(invited_user.service)['data']
+        service = Service.from_id(invited_user.service)
         return render_template('views/cancelled-invitation.html',
-                               from_user=from_user.name,
-                               service_name=service['name'])
+                               from_user=invited_user.from_user.name,
+                               service_name=service.name)
 
     if invited_user.status == 'accepted':
         session.pop('invited_user', None)
@@ -50,36 +48,32 @@ def accept_invite(token):
 
     session['invited_user'] = invited_user.serialize()
 
-    existing_user = user_api_client.get_user_by_email_or_none(invited_user.email_address)
-    service_users = user_api_client.get_users_for_service(invited_user.service)
+    existing_user = User.from_email_address_or_none(invited_user.email_address)
 
     if existing_user:
-        invite_api_client.accept_invite(invited_user.service, invited_user.id)
-        if existing_user in service_users:
+        invited_user.accept_invite()
+        if existing_user in Users(invited_user.service):
             return redirect(url_for('main.service_dashboard', service_id=invited_user.service))
         else:
-            service = service_api_client.get_service(invited_user.service)['data']
+            service = Service.from_id(invited_user.service)
             # if the service you're being added to can modify auth type, then check if this is relevant
-            if 'email_auth' in service['permissions'] and (
-                    # they have a phone number, we want them to start using it. if they dont have a mobile we just
-                    # ignore that option of the invite
-                    (existing_user.mobile_number and invited_user.auth_type == 'sms_auth') or
-                    # we want them to start sending emails. it's always valid, so lets always update
-                    invited_user.auth_type == 'email_auth'
+            if service.has_permission('email_auth') and (
+                # they have a phone number, we want them to start using it. if they dont have a mobile we just
+                # ignore that option of the invite
+                (existing_user.mobile_number and invited_user.auth_type == 'sms_auth') or
+                # we want them to start sending emails. it's always valid, so lets always update
+                invited_user.auth_type == 'email_auth'
             ):
-                user_api_client.update_user_attribute(existing_user.id, auth_type=invited_user.auth_type)
-            user_api_client.add_user_to_service(invited_user.service,
-                                                existing_user.id,
-                                                invited_user.permissions,
-                                                invited_user.folder_permissions)
-            return redirect(url_for('main.service_dashboard', service_id=invited_user.service))
+                existing_user.update(auth_type=invited_user.auth_type)
+            invited_user.add_to_service()
+            return redirect(url_for('main.service_dashboard', service_id=service.id))
     else:
         return redirect(url_for('main.register_from_invite'))
 
 
 @main.route("/organisation-invitation/<token>")
 def accept_org_invite(token):
-    invited_org_user = org_invite_api_client.check_token(token)
+    invited_org_user = InvitedOrgUser.from_token(token)
     if not current_user.is_anonymous and current_user.email_address.lower() != invited_org_user.email_address.lower():
         message = Markup("""
             You’re signed in as {}.
@@ -94,11 +88,10 @@ def accept_org_invite(token):
         abort(403)
 
     if invited_org_user.status == 'cancelled':
-        invited_by = user_api_client.get_user(invited_org_user.invited_by)
-        organisation = organisations_client.get_organisation(invited_org_user.organisation)
+        organisation = Organisation.from_id(invited_org_user.organisation)
         return render_template('views/cancelled-invitation.html',
-                               from_user=invited_by.name,
-                               organisation_name=organisation['name'])
+                               from_user=invited_org_user.invited_by.name,
+                               organisation_name=organisation.name)
 
     if invited_org_user.status == 'accepted':
         session.pop('invited_org_user', None)
@@ -106,13 +99,13 @@ def accept_org_invite(token):
 
     session['invited_org_user'] = invited_org_user.serialize()
 
-    existing_user = user_api_client.get_user_by_email_or_none(invited_org_user.email_address)
-    organisation_users = user_api_client.get_users_for_organisation(invited_org_user.organisation)
+    existing_user = User.from_email_address_or_none(invited_org_user.email_address)
+    organisation_users = OrganisationUsers(invited_org_user.organisation)
 
     if existing_user:
-        org_invite_api_client.accept_invite(invited_org_user.organisation, invited_org_user.id)
+        invited_org_user.accept_invite()
         if existing_user not in organisation_users:
-            user_api_client.add_user_to_organisation(invited_org_user.organisation, existing_user.id)
+            invited_org_user.add_to_organisation()
         return redirect(url_for('main.organisation_dashboard', org_id=invited_org_user.organisation))
     else:
         return redirect(url_for('main.register_from_org_invite'))

app/main/views/manage_users.py

@@ -10,12 +10,7 @@ from flask import (
 from flask_login import current_user, login_required
 from notifications_python_client.errors import HTTPError
 
-from app import (
-    current_service,
-    invite_api_client,
-    service_api_client,
-    user_api_client,
-)
+from app import current_service, service_api_client
 from app.event_handlers import (
     create_email_change_event,
     create_mobile_number_change_event,
@@ -29,7 +24,8 @@ from app.main.forms import (
     PermissionsForm,
     SearchUsersForm,
 )
-from app.models.user import permissions
+from app.models.roles_and_permissions import permissions
+from app.models.user import InvitedUser, User
 from app.utils import is_gov_user, redact_mobile_number, user_has_permissions
 
 
@@ -64,7 +60,7 @@ def invite_user(service_id):
 
     if form.validate_on_submit():
         email_address = form.email_address.data
-        invited_user = invite_api_client.create_invite(
+        invited_user = InvitedUser.create(
             current_user.id,
             service_id,
             email_address,
@@ -106,13 +102,13 @@ def edit_user_permissions(service_id, user_id):
     )
 
     if form.validate_on_submit():
-        user_api_client.set_user_permissions(
-            user_id, service_id,
+        user.set_permissions(
+            service_id,
             permissions=form.permissions,
             folder_permissions=form.folder_permissions.data,
         )
         if service_has_email_auth:
-            user_api_client.update_user_attribute(user_id, auth_type=form.login_authentication.data)
+            user.update(auth_type=form.login_authentication.data)
         return redirect(url_for('.manage_users', service_id=service_id))
 
     return render_template(
@@ -154,13 +150,10 @@ def edit_user_email(service_id, user_id):
     user = current_service.get_team_member(user_id)
     user_email = user.email_address
 
-    def _is_email_already_in_use(email):
-        return user_api_client.is_email_already_in_use(email)
-
     if is_gov_user(user_email):
-        form = ChangeEmailForm(_is_email_already_in_use, email_address=user_email)
+        form = ChangeEmailForm(User.already_registered, email_address=user_email)
     else:
-        form = ChangeNonGovEmailForm(_is_email_already_in_use, email_address=user_email)
+        form = ChangeNonGovEmailForm(User.already_registered, email_address=user_email)
 
     if request.form.get('email_address', '').strip() == user_email:
         return redirect(url_for('.manage_users', service_id=current_service.id))
@@ -193,7 +186,7 @@ def confirm_edit_user_email(service_id, user_id):
         ))
     if request.method == 'POST':
         try:
-            user_api_client.update_user_attribute(str(user_id), email_address=new_email, updated_by=current_user.id)
+            user.update(email_address=new_email, updated_by=current_user.id)
         except HTTPError as e:
             abort(500, e)
         else:
@@ -253,7 +246,7 @@ def confirm_edit_user_mobile_number(service_id, user_id):
         ))
     if request.method == 'POST':
         try:
-            user_api_client.update_user_attribute(str(user_id), mobile_number=new_number, updated_by=current_user.id)
+            user.update(mobile_number=new_number, updated_by=current_user.id)
         except HTTPError as e:
             abort(500, e)
         else:

app/main/views/new_password.py

@@ -12,10 +12,10 @@ from flask import (
 from itsdangerous import SignatureExpired
 from notifications_utils.url_safe_token import check_token
 
-from app import user_api_client
 from app.main import main
 from app.main.forms import NewPasswordForm
 from app.main.views.two_factor import log_in_user
+from app.models.user import User
 
 
 @main.route('/new-password/<path:token>', methods=['GET', 'POST'])
@@ -28,7 +28,7 @@ def new_password(token):
         return redirect(url_for('.forgot_password'))
 
     email_address = json.loads(token_data)['email']
-    user = user_api_client.get_user_by_email(email_address)
+    user = User.from_email_address(email_address)
     if user.password_changed_at and datetime.strptime(user.password_changed_at, '%Y-%m-%d %H:%M:%S.%f') > \
             datetime.strptime(json.loads(token_data)['created_at'], '%Y-%m-%d %H:%M:%S.%f'):
         flash('The link in the email has already been used')
@@ -37,7 +37,7 @@ def new_password(token):
     form = NewPasswordForm()
 
     if form.validate_on_submit():
-        user_api_client.reset_failed_login_count(user.id)
+        user.reset_failed_login_count()
         session['user_details'] = {
             'id': user.id,
             'email': user.email_address,
@@ -47,7 +47,7 @@ def new_password(token):
             return log_in_user(user.id)
         else:
             # send user a 2fa sms code
-            user_api_client.send_verify_code(user.id, 'sms', user.mobile_number)
+            user.send_verify_code()
             return redirect(url_for('main.two_factor'))
     else:
         return render_template('views/new-password.html', token=token, form=form, user=user)

app/main/views/organisations.py

@@ -31,6 +31,7 @@ from app.main.forms import (
     SetLetterBranding,
 )
 from app.main.views.service_settings import get_branding_as_value_and_label
+from app.models.user import InvitedOrgUser, User
 from app.utils import user_has_permissions, user_is_platform_admin
 
 
@@ -112,7 +113,7 @@ def invite_org_user(org_id):
     )
     if form.validate_on_submit():
         email_address = form.email_address.data
-        invited_org_user = org_invite_api_client.create_invite(
+        invited_org_user = InvitedOrgUser.create(
             current_user.id,
             org_id,
             email_address
@@ -131,11 +132,9 @@ def invite_org_user(org_id):
 @login_required
 @user_has_permissions()
 def edit_user_org_permissions(org_id, user_id):
-    user = user_api_client.get_user(user_id)
-
     return render_template(
         'views/organisations/organisation/users/user/index.html',
-        user=user
+        user=User.from_id(user_id)
     )
 
 
@@ -143,7 +142,7 @@ def edit_user_org_permissions(org_id, user_id):
 @login_required
 @user_has_permissions()
 def remove_user_from_organisation(org_id, user_id):
-    user = user_api_client.get_user(user_id)
+    user = User.from_id(user_id)
     if request.method == 'POST':
         try:
             organisations_client.remove_user_from_organisation(org_id, user_id)

app/main/views/register.py

@@ -3,7 +3,6 @@ from datetime import datetime, timedelta
 from flask import abort, redirect, render_template, session, url_for
 from flask_login import current_user
 
-from app import invite_api_client, org_invite_api_client, user_api_client
 from app.main import main
 from app.main.forms import (
     RegisterUserForm,
@@ -11,6 +10,7 @@ from app.main.forms import (
     RegisterUserFromOrgInviteForm,
 )
 from app.main.views.verify import activate_user
+from app.models.user import InvitedOrgUser, InvitedUser, User
 
 
 @main.route('/register', methods=['GET', 'POST'])
@@ -28,20 +28,18 @@ def register():
 
 @main.route('/register-from-invite', methods=['GET', 'POST'])
 def register_from_invite():
-    invited_user = session.get('invited_user')
+    invited_user = InvitedUser.from_session()
     if not invited_user:
         abort(404)
 
-    is_sms_auth = invited_user['auth_type'] == 'sms_auth'
-
     form = RegisterUserFromInviteForm(invited_user)
 
     if form.validate_on_submit():
-        if form.service.data != invited_user['service'] or form.email_address.data != invited_user['email_address']:
+        if form.service.data != invited_user.service or form.email_address.data != invited_user.email_address:
             abort(400)
-        _do_registration(form, send_email=False, send_sms=is_sms_auth)
-        invite_api_client.accept_invite(invited_user['service'], invited_user['id'])
-        if is_sms_auth:
+        _do_registration(form, send_email=False, send_sms=invited_user.sms_auth)
+        invited_user.accept_invite()
+        if invited_user.sms_auth:
             return redirect(url_for('main.verify'))
         else:
             # we've already proven this user has email because they clicked the invite link,
@@ -53,7 +51,7 @@ def register_from_invite():
 
 @main.route('/register-from-org-invite', methods=['GET', 'POST'])
 def register_from_org_invite():
-    invited_org_user = session.get('invited_org_user')
+    invited_org_user = InvitedOrgUser.from_session()
     if not invited_org_user:
         abort(404)
 
@@ -63,34 +61,37 @@ def register_from_org_invite():
     form.auth_type.data = 'sms_auth'
 
     if form.validate_on_submit():
-        if (form.organisation.data != invited_org_user['organisation'] or
-                form.email_address.data != invited_org_user['email_address']):
+        if (form.organisation.data != invited_org_user.organisation or
+                form.email_address.data != invited_org_user.email_address):
             abort(400)
-        _do_registration(form, send_email=False, send_sms=True, organisation_id=invited_org_user['organisation'])
-        org_invite_api_client.accept_invite(invited_org_user['organisation'], invited_org_user['id'])
+        _do_registration(form, send_email=False, send_sms=True, organisation_id=invited_org_user.organisation)
+        invited_org_user.accept_invite()
 
         return redirect(url_for('main.verify'))
     return render_template('views/register-from-org-invite.html', invited_org_user=invited_org_user, form=form)
 
 
 def _do_registration(form, send_sms=True, send_email=True, organisation_id=None):
-    if user_api_client.is_email_already_in_use(form.email_address.data):
-        user = user_api_client.get_user_by_email(form.email_address.data)
+    user = User.from_email_address_or_none(form.email_address.data)
+    if user:
         if send_email:
-            user_api_client.send_already_registered_email(user.id, user.email_address)
+            user.send_already_registered_email()
         session['expiry_date'] = str(datetime.utcnow() + timedelta(hours=1))
         session['user_details'] = {"email": user.email_address, "id": user.id}
     else:
-        user = user_api_client.register_user(form.name.data,
-                                             form.email_address.data,
-                                             form.mobile_number.data or None,
-                                             form.password.data,
-                                             form.auth_type.data)
+        user = User.register(
+            name=form.name.data,
+            email_address=form.email_address.data,
+            mobile_number=form.mobile_number.data,
+            password=form.password.data,
+            auth_type=form.auth_type.data,
+        )
+
         if send_email:
-            user_api_client.send_verify_email(user.id, user.email_address)
+            user.send_verify_email()
 
         if send_sms:
-            user_api_client.send_verify_code(user.id, 'sms', user.mobile_number)
+            user.send_verify_code()
         session['expiry_date'] = str(datetime.utcnow() + timedelta(hours=1))
         session['user_details'] = {"email": user.email_address, "id": user.id}
     if organisation_id:

app/main/views/send.py

@@ -32,7 +32,6 @@ from app import (
     job_api_client,
     notification_api_client,
     service_api_client,
-    user_api_client,
 )
 from app.main import main
 from app.main.forms import (
@@ -41,6 +40,7 @@ from app.main.forms import (
     SetSenderForm,
     get_placeholder_form_instance,
 )
+from app.models.user import Users
 from app.s3_client.s3_csv_client import (
     s3download,
     s3upload,
@@ -520,8 +520,6 @@ def _check_messages(service_id, template_id, upload_id, preview_row, letters_as_
         if e.status_code != 404:
             raise
 
-    users = user_api_client.get_users_for_service(service_id=service_id)
-
     statistics = service_api_client.get_service_statistics(service_id, today_only=True)
     remaining_messages = (current_service.message_limit - sum(stat['requested'] for stat in statistics.values()))
 
@@ -559,7 +557,7 @@ def _check_messages(service_id, template_id, upload_id, preview_row, letters_as_
         max_initial_rows_shown=50,
         max_errors_shown=50,
         whitelist=itertools.chain.from_iterable(
-            [user.name, user.mobile_number, user.email_address] for user in users
+            [user.name, user.mobile_number, user.email_address] for user in Users(service_id)
         ) if current_service.trial_mode else None,
         remaining_messages=remaining_messages,
         international_sms=current_service.has_permission('international_sms'),

app/main/views/sign_in.py

@@ -10,9 +10,10 @@ from flask import (
 )
 from flask_login import current_user
 
-from app import invite_api_client, login_manager, user_api_client
+from app import login_manager
 from app.main import main
 from app.main.forms import LoginForm
+from app.models.user import InvitedUser, User
 
 
 @main.route('/sign-in', methods=(['GET', 'POST']))
@@ -24,26 +25,26 @@ def sign_in():
 
     if form.validate_on_submit():
 
-        user = user_api_client.get_user_by_email_or_none(form.email_address.data)
-        user = _get_and_verify_user(user, form.password.data)
+        user = User.from_email_address_and_password_or_none(
+            form.email_address.data, form.password.data
+        )
+
         if user and user.state == 'pending':
             return redirect(url_for('main.resend_email_verification'))
 
         if user and session.get('invited_user'):
-            invited_user = session.get('invited_user')
-            if user.email_address.lower() != invited_user['email_address'].lower():
+            invited_user = InvitedUser.from_session()
+            if user.email_address.lower() != invited_user.email_address.lower():
                 flash("You can't accept an invite for another person.")
                 session.pop('invited_user', None)
                 abort(403)
             else:
-                invite_api_client.accept_invite(invited_user['service'], invited_user['id'])
-        if user:
-            session['user_details'] = {"email": user.email_address, "id": user.id}
-            if user.is_active:
-                if user.auth_type == "email_auth":
-                    return sign_in_email(user.id, user.email_address)
-                else:
-                    return sign_in_sms(user.id, user.mobile_number)
+                invited_user.accept_invite()
+        if user and user.sign_in():
+            if user.sms_auth:
+                return redirect(url_for('.two_factor', next=request.args.get('next')))
+            if user.email_auth:
+                return redirect(url_for('.two_factor_email_sent'))
 
         # Vague error message for login in case of user not known, locked, inactive or password not verified
         flash(Markup(
@@ -62,35 +63,8 @@ def sign_in():
     )
 
 
-def sign_in_email(user_id, to):
-    if request.args.get('next'):
-        user_api_client.send_verify_code(user_id, 'email', None, request.args.get('next'))
-    else:
-        user_api_client.send_verify_code(user_id, 'email', None)
-    return redirect(url_for('.two_factor_email_sent'))
-
-
-def sign_in_sms(user_id, to):
-    user_api_client.send_verify_code(user_id, 'sms', to)
-    if request.args.get('next'):
-        return redirect(url_for('.two_factor', next=request.args.get('next')))
-    else:
-        return redirect(url_for('.two_factor'))
-
-
 @login_manager.unauthorized_handler
 def sign_in_again():
     return redirect(
         url_for('main.sign_in', next=request.path)
     )
-
-
-def _get_and_verify_user(user, password):
-    if not user:
-        return None
-    elif user.is_locked():
-        return None
-    elif not user_api_client.verify_password(user.id, password):
-        return None
-    else:
-        return user

app/main/views/two_factor.py

@@ -8,13 +8,14 @@ from flask import (
     session,
     url_for,
 )
-from flask_login import current_user, login_user
+from flask_login import current_user
 from itsdangerous import SignatureExpired
 from notifications_utils.url_safe_token import check_token
 
 from app import user_api_client
 from app.main import main
 from app.main.forms import TwoFactorForm
+from app.models.user import User
 from app.utils import redirect_to_sign_in
 
 
@@ -30,7 +31,7 @@ def two_factor_email_sent():
 @main.route('/email-auth/<token>', methods=['GET'])
 def two_factor_email(token):
     if current_user.is_authenticated:
-        return redirect_when_logged_in(current_user.id)
+        return redirect_when_logged_in(platform_admin=current_user.platform_admin)
 
     # checks url is valid, and hasn't timed out
     try:
@@ -79,27 +80,27 @@ def _is_safe_redirect_url(target):
 
 def log_in_user(user_id):
     try:
-        user = user_api_client.get_user(user_id)
+        user = User.from_id(user_id)
         # the user will have a new current_session_id set by the API - store it in the cookie for future requests
         session['current_session_id'] = user.current_session_id
         # Check if coming from new password page
         if 'password' in session.get('user_details', {}):
-            user = user_api_client.update_password(user.id, password=session['user_details']['password'])
-        activated_user = user_api_client.activate_user(user)
-        login_user(activated_user)
+            user.update_password(session['user_details']['password'])
+        user.activate()
+        user.login()
     finally:
         # get rid of anything in the session that we don't expect to have been set during register/sign in flow
         session.pop("user_details", None)
         session.pop("file_uploads", None)
 
-    return redirect_when_logged_in(user_id)
+    return redirect_when_logged_in(platform_admin=user.platform_admin)
 
 
-def redirect_when_logged_in(user_id):
+def redirect_when_logged_in(platform_admin):
     next_url = request.args.get('next')
     if next_url and _is_safe_redirect_url(next_url):
         return redirect(next_url)
-    if current_user.platform_admin:
+    if platform_admin:
         return redirect(url_for('main.platform_admin'))
 
     return redirect(url_for('main.show_accounts_or_dashboard'))

app/main/views/user_profile.py

@@ -14,6 +14,7 @@ from app.main.forms import (
     ConfirmPasswordForm,
     TwoFactorForm,
 )
+from app.models.user import User
 from app.utils import user_is_gov_user
 
 NEW_EMAIL = 'new-email'
@@ -37,7 +38,7 @@ def user_profile_name():
     form = ChangeNameForm(new_name=current_user.name)
 
     if form.validate_on_submit():
-        user_api_client.update_user_attribute(current_user.id, name=form.new_name.data)
+        current_user.update(name=form.new_name.data)
         return redirect(url_for('.user_profile'))
 
     return render_template(
@@ -52,9 +53,7 @@ def user_profile_name():
 @user_is_gov_user
 def user_profile_email():
 
-    def _is_email_already_in_use(email):
-        return user_api_client.is_email_already_in_use(email)
-    form = ChangeEmailForm(_is_email_already_in_use,
+    form = ChangeEmailForm(User.already_registered,
                            email_address=current_user.email_address)
 
     if form.validate_on_submit():
@@ -99,9 +98,8 @@ def user_profile_email_confirm(token):
                              current_app.config['DANGEROUS_SALT'],
                              current_app.config['EMAIL_EXPIRY_SECONDS'])
     token_data = json.loads(token_data)
-    user_id = token_data['user_id']
-    new_email = token_data['email']
-    user_api_client.update_user_attribute(user_id, email_address=new_email)
+    user = User.from_id(token_data['user_id'])
+    user.update(email_address=token_data['email'])
     session.pop(NEW_EMAIL, None)
 
     return redirect(url_for('.user_profile'))
@@ -138,7 +136,7 @@ def user_profile_mobile_number_authenticate():
 
     if form.validate_on_submit():
         session[NEW_MOBILE_PASSWORD_CONFIRMED] = True
-        user_api_client.send_verify_code(current_user.id, 'sms', session[NEW_MOBILE])
+        current_user.send_verify_code(to=session[NEW_MOBILE])
         return redirect(url_for('.user_profile_mobile_number_confirm'))
 
     return render_template(
@@ -163,13 +161,11 @@ def user_profile_mobile_number_confirm():
     form = TwoFactorForm(_check_code)
 
     if form.validate_on_submit():
-        user = user_api_client.get_user(current_user.id)
-        # the user will have a new current_session_id set by the API - store it in the cookie for future requests
-        session['current_session_id'] = user.current_session_id
+        current_user.refresh_session_id()
         mobile_number = session[NEW_MOBILE]
         del session[NEW_MOBILE]
         del session[NEW_MOBILE_PASSWORD_CONFIRMED]
-        user_api_client.update_user_attribute(current_user.id, mobile_number=mobile_number)
+        current_user.update(mobile_number=mobile_number)
         return redirect(url_for('.user_profile'))
 
     return render_template(

app/main/views/verify.py

@@ -9,14 +9,13 @@ from flask import (
     session,
     url_for,
 )
-from flask_login import login_user
 from itsdangerous import SignatureExpired
 from notifications_utils.url_safe_token import check_token
 
 from app import user_api_client
 from app.main import main
 from app.main.forms import TwoFactorForm
-from app.models.user import InvitedUser
+from app.models.user import InvitedUser, User
 from app.utils import redirect_to_sign_in
 
 
@@ -54,7 +53,7 @@ def verify_email(token):
 
     # token contains json blob of format: {'user_id': '...', 'secret_code': '...'} (secret_code is unused)
     token_data = json.loads(token_data)
-    user = user_api_client.get_user(token_data['user_id'])
+    user = User.from_id(token_data['user_id'])
     if not user:
         abort(404)
 
@@ -63,17 +62,17 @@ def verify_email(token):
         return redirect(url_for('main.sign_in'))
 
     session['user_details'] = {"email": user.email_address, "id": user.id}
-    user_api_client.send_verify_code(user.id, 'sms', user.mobile_number)
+    user.send_verify_code()
     return redirect(url_for('main.verify'))
 
 
 def activate_user(user_id):
-    user = user_api_client.get_user(user_id)
+    user = User.from_id(user_id)
     # the user will have a new current_session_id set by the API - store it in the cookie for future requests
     session['current_session_id'] = user.current_session_id
     organisation_id = session.get('organisation_id')
-    activated_user = user_api_client.activate_user(user)
-    login_user(activated_user)
+    activated_user = user.activate()
+    activated_user.login()
 
     invited_user = session.get('invited_user')
     if invited_user:
@@ -92,7 +91,7 @@ def activate_user(user_id):
 
 def _add_invited_user_to_service(invited_user):
     invitation = InvitedUser(**invited_user)
-    user = user_api_client.get_user(session['user_id'])
+    user = User.from_id(session['user_id'])
     service_id = invited_user['service']
     user_api_client.add_user_to_service(service_id, user.id, invitation.permissions, invitation.folder_permissions)
     return service_id