1069: Add immediate onboarding

Author: danhalson

.env.example

@@ -51,3 +51,6 @@ EDITOR_ENCRYPTION_KEY=a1b2c3d4e5f67890123456789abcdef0123456789abcdef0123456789a
 # The sandbox creds can be found in 1password under "Google Cloud Console: CEfE Sandbox"
 GOOGLE_CLIENT_ID=changeme.apps.googleusercontent.com
 GOOGLE_CLIENT_SECRET=changeme
+
+# Enable immediate onboarding for schools
+ENABLE_IMMEDIATE_SCHOOL_ONBOARDING=true

app/controllers/api/schools_controller.rb

@@ -16,7 +16,7 @@ def show
     end
 
     def create
-      result = School::Create.call(school_params:, creator_id: current_user.id)
+      result = School::Create.call(school_params:, creator_id: current_user.id, token: current_user.token)
 
       if result.success?
         @school = result[:school]

app/jobs/school_import_job.rb

@@ -71,7 +71,8 @@ def import_school(school_data)
     School.transaction do
       result = School::Create.call(
         school_params: school_params,
-        creator_id: proposed_owner[:id]
+        creator_id: proposed_owner[:id],
+        token: @token
       )
 
       if result.success?

app/models/school.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class School < ApplicationRecord
+  class DuplicateSchoolError < StandardError; end
+
   has_many :classes, class_name: :SchoolClass, inverse_of: :school, dependent: :destroy
   has_many :lessons, dependent: :nullify
   has_many :projects, dependent: :nullify
@@ -15,6 +17,8 @@ class School < ApplicationRecord
   validates :website, presence: true, format: { with: VALID_URL_REGEX, message: I18n.t('validations.school.website') }
   validates :address_line_1, presence: true
   validates :municipality, presence: true
+  validates :administrative_area, presence: true
+  validates :postal_code, presence: true
   validates :country_code, presence: true, inclusion: { in: ISO3166::Country.codes }
   validates :reference, uniqueness: { case_sensitive: false, allow_nil: true }, presence: false
   validates :district_nces_id, uniqueness: { case_sensitive: false, allow_nil: true }, presence: false
@@ -30,8 +34,6 @@ class School < ApplicationRecord
   validates :verified_at, absence: { if: proc { |school| school.rejected? } }
   validates :code,
             uniqueness: { allow_nil: true },
-            presence: { if: proc { |school| school.verified? } },
-            absence: { unless: proc { |school| school.verified? } },
             format: { with: /\d\d-\d\d-\d\d/, allow_nil: true }
   validate :verified_at_cannot_be_changed
   validate :code_cannot_be_changed
@@ -40,8 +42,11 @@ class School < ApplicationRecord
   before_validation :normalize_district_fields
   before_validation :normalize_school_roll_number
 
+  before_save :prevent_duplicate_school
   before_save :format_uk_postal_code, if: :should_format_uk_postal_code?
 
+  after_commit :generate_code!, on: :create, if: -> { FeatureFlags.immediate_school_onboarding? }
+
   def self.find_for_user!(user)
     school = Role.find_by(user_id: user.id)&.school || find_by(creator_id: user.id)
     raise ActiveRecord::RecordNotFound unless school
@@ -62,9 +67,18 @@ def rejected?
   end
 
   def verify!
+    generate_code! if ENV['ENABLE_IMMEDIATE_SCHOOL_ONBOARDING'].blank?
+
+    update!(verified_at: Time.zone.now)
+  end
+
+  def generate_code!
+    return code if code.present?
+
     attempts = 0
     begin
-      update!(verified_at: Time.zone.now, code: ForEducationCodeGenerator.generate)
+      new_code = ForEducationCodeGenerator.generate
+      update!(code: new_code)
     rescue ActiveRecord::RecordInvalid => e
       raise unless e.record.errors[:code].include?('has already been taken') && attempts <= 5
 
@@ -78,6 +92,8 @@ def reject
   end
 
   def reopen
+    return false unless rejected?
+
     update(rejected_at: nil)
   end
 
@@ -122,7 +138,7 @@ def rejected_at_cannot_be_changed
   end
 
   def code_cannot_be_changed
-    errors.add(:code, 'cannot be changed after verification') if code_was.present? && code_changed?
+    errors.add(:code, 'cannot be changed after onboarding') if code_was.present? && code_changed?
   end
 
   def should_format_uk_postal_code?
@@ -139,4 +155,29 @@ def format_uk_postal_code
     # ensures UK postcodes are always formatted correctly (as the inward code is always 3 chars long)
     self.postal_code = "#{cleaned_postal_code[0..-4]} #{cleaned_postal_code[-3..]}"
   end
+
+  def prevent_duplicate_school
+    name_threshold = 0.6
+    municipality_threshold = 0.7
+    postal_code_threshold = 0.8
+    max_edit_distance = 3
+
+    normalized_postal = postal_code.to_s.gsub(/\s+/, '')
+
+    duplicate_school = School
+                       .where.not(id:)
+                       .where(country_code:)
+                       .where(
+                         'similarity(lower(name), ?) >= ? AND levenshtein(lower(name), ?) <= ?',
+                         name.to_s, name_threshold, name.to_s, max_edit_distance
+                       )
+                       .where('similarity(lower(municipality), ?) >= ?', municipality.to_s, municipality_threshold)
+                       .where(
+                         "similarity(lower(replace(postal_code, ' ', '')), ?) >= ?",
+                         normalized_postal, postal_code_threshold
+                       )
+                       .first
+
+    raise DuplicateSchoolError, I18n.t('validations.school.duplicate_school') if duplicate_school
+  end
 end

app/services/school_onboarding_service.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class SchoolOnboardingService
+  attr_reader :school
+
+  def initialize(school)
+    @school = school
+  end
+
+  def onboard(token:)
+    School.transaction do
+      Role.owner.create!(user_id: school.creator_id, school:)
+      Role.teacher.create!(user_id: school.creator_id, school:)
+
+      ProfileApiClient.create_school(token:, id: school.id, code: school.code)
+    end
+  rescue StandardError => e
+    Sentry.capture_exception(e)
+    Rails.logger.error { "Failed to onboard school #{@school.id}: #{e.message}" }
+    false
+  else
+    true
+  end
+end

app/services/school_verification_service.rb

@@ -7,12 +7,11 @@ def initialize(school)
     @school = school
   end
 
-  def verify(token:)
+  def verify(token: nil)
     School.transaction do
       school.verify!
-      Role.owner.create!(user_id: school.creator_id, school:)
-      Role.teacher.create!(user_id: school.creator_id, school:)
-      ProfileApiClient.create_school(token:, id: school.id, code: school.code)
+
+      SchoolOnboardingService.new(school).onboard(token: token) unless FeatureFlags.immediate_school_onboarding?
     end
   rescue StandardError => e
     Sentry.capture_exception(e)

config/locales/en.yml

@@ -16,6 +16,7 @@ en:
     school:
       website: "must be a valid URL"
       school_roll_number: "must be numbers followed by letters (e.g., 01572D)"
+      duplicate_school: "A school with very similar details already exists"
     invitation:
       email_address: "'%<value>s' is invalid"
   activerecord:

lib/concepts/school/operations/create.rb

@@ -3,14 +3,23 @@
 class School
   class Create
     class << self
-      def call(school_params:, creator_id:)
+      def call(school_params:, creator_id:, token:)
         response = OperationResponse.new
         response[:school] = build_school(school_params.merge!(creator_id:))
-        response[:school].save!
+
+        School.transaction do
+          response[:school].save!
+
+          SchoolOnboardingService.new(response[:school]).onboard(token:) if FeatureFlags.immediate_school_onboarding?
+        end
+
+        response
+      rescue School::DuplicateSchoolError => e
+        response[:error] = e.message
         response
       rescue StandardError => e
         Sentry.capture_exception(e)
-        response[:error] = response[:school].errors
+        response[:error] = response[:school].errors.presence || [e.message]
         response
       end
 

lib/concepts/school/operations/update.rb

@@ -9,6 +9,10 @@ def call(school:, school_params:)
         response[:school].assign_attributes(school_params)
         response[:school].save!
         response
+      rescue School::DuplicateSchoolError => e
+        Sentry.capture_exception(e)
+        response[:error] = e.message
+        response
       rescue StandardError => e
         Sentry.capture_exception(e)
         errors = response[:school].errors.full_messages.join(',')

lib/feature_flags.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module FeatureFlags
+  def self.immediate_school_onboarding?
+    ENV['ENABLE_IMMEDIATE_SCHOOL_ONBOARDING'] == 'true'
+  end
+end