Fyst 2142 implement pya sms contact validation (#61)

* add i18n and styling for landing page

* rubocop

* pr comments

* remove unused flash messages styles

* git ignore

* restore DS store

* rubocop

* client menu component

* wip dropdown menu'

* rubocop

* use unless prod for environemntal warning

* wip

* wip

* wip

* add specs

* rubocop

* clean up some unneeded changes

* wip

* Re-render show to show the error message but with error_status

* Pin necessary modules and include "application" since thats the entrypoint - without this importmap will load without executing application.js

* Fix rubocop

* Use the already available activestorage

* fix changed variable in honeycrisp

* try precomplie in app.json

* try fixing some css

* remove asset precompile

* add email address page

* rubocop

* i18n

* wip

* implement knockout page

* update path in is intake locked

* wip

* wip

* wip

* wip

* add sms functionality

* merge main

* contact preference controller redirects

* touch up

* new migration

* update contact preference case

* contact preference form no longer saves anything

* restore some development artificats

* wip

* contact preference is not a form

* remove unneeded files

* remove devise migration

* annotate

* make enum

* rubocop

* add turbo false to phone number

---------

Co-authored-by: Drew Proebstel <dproebstel@codeforamerica.org>
Co-authored-by: Arin Choi <achoi@codeforamerica.org>

Author: 3 people

Gemfile

@@ -7,6 +7,8 @@ gem "propshaft"
 gem "pg"
 gem "rails-i18n"
 gem "valid_email2", "~> 4.0.6"
+gem "phony"
+gem "auto_strip_attributes"
 
 # Use the Puma web server [https://github.com/puma/puma]
 gem "puma", ">= 5.0"

Gemfile.lock

@@ -90,11 +90,13 @@ GEM
       activerecord (>= 6.0.0)
       activesupport (>= 6.0.0)
     ast (2.4.3)
+    auto_strip_attributes (2.6.0)
+      activerecord (>= 4.0)
     autoprefixer-rails (10.4.21.0)
       execjs (~> 2)
     aws-eventstream (1.4.0)
-    aws-partitions (1.1124.0)
-    aws-sdk-core (3.226.2)
+    aws-partitions (1.1130.0)
+    aws-sdk-core (3.226.3)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
@@ -104,7 +106,7 @@ GEM
     aws-sdk-kms (1.106.0)
       aws-sdk-core (~> 3, >= 3.225.0)
       aws-sigv4 (~> 1.5)
-    aws-sdk-s3 (1.192.0)
+    aws-sdk-s3 (1.193.0)
       aws-sdk-core (~> 3, >= 3.225.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.5)
@@ -145,16 +147,16 @@ GEM
     diff-lcs (1.6.2)
     dotenv (3.1.8)
     drb (2.2.3)
-    erb (5.0.1)
+    erb (5.0.2)
     erubi (1.13.1)
     et-orbi (1.2.11)
       tzinfo
     execjs (2.10.0)
-    factory_bot (6.5.1)
+    factory_bot (6.5.4)
       activesupport (>= 6.1.0)
-    factory_bot_rails (6.4.4)
+    factory_bot_rails (6.5.0)
       factory_bot (~> 6.5)
-      railties (>= 5.0.0)
+      railties (>= 6.1.0)
     ffi (1.17.2-aarch64-linux-gnu)
     ffi (1.17.2-aarch64-linux-musl)
     ffi (1.17.2-arm-linux-gnu)
@@ -168,25 +170,25 @@ GEM
       raabro (~> 1.4)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    google-protobuf (4.31.0)
+    google-protobuf (4.31.1)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-aarch64-linux-gnu)
+    google-protobuf (4.31.1-aarch64-linux-gnu)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-aarch64-linux-musl)
+    google-protobuf (4.31.1-aarch64-linux-musl)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-arm64-darwin)
+    google-protobuf (4.31.1-arm64-darwin)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-x86_64-darwin)
+    google-protobuf (4.31.1-x86_64-darwin)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-x86_64-linux-gnu)
+    google-protobuf (4.31.1-x86_64-linux-gnu)
       bigdecimal
       rake (>= 13)
-    google-protobuf (4.31.0-x86_64-linux-musl)
+    google-protobuf (4.31.1-x86_64-linux-musl)
       bigdecimal
       rake (>= 13)
     http_accept_language (2.1.1)
@@ -196,7 +198,7 @@ GEM
       actionpack (>= 6.0.0)
       activesupport (>= 6.0.0)
       railties (>= 6.0.0)
-    io-console (0.8.0)
+    io-console (0.8.1)
     irb (1.15.2)
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
@@ -209,7 +211,7 @@ GEM
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
-    json (2.12.0)
+    json (2.13.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -222,12 +224,12 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.4)
-    matrix (0.4.2)
+    matrix (0.4.3)
     method_source (1.1.0)
     mini_mime (1.1.5)
     minitest (5.25.5)
     msgpack (1.8.0)
-    net-imap (0.5.8)
+    net-imap (0.5.9)
       date
       net-protocol
     net-pop (0.1.2)
@@ -258,15 +260,15 @@ GEM
       ast (~> 2.4.1)
       racc
     pg (1.5.9)
+    phony (2.22.3)
     pp (0.6.2)
       prettyprint
     prettyprint (0.2.0)
     prism (1.4.0)
-    propshaft (1.1.0)
+    propshaft (1.2.0)
       actionpack (>= 7.0.0)
       activesupport (>= 7.0.0)
       rack
-      railties (>= 7.0.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -330,14 +332,14 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rdoc (6.14.1)
+    rdoc (6.14.2)
       erb
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
     reline (0.6.1)
       io-console (~> 0.5)
     rexml (3.4.1)
-    rspec-core (3.13.4)
+    rspec-core (3.13.5)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -354,18 +356,18 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.4)
-    rubocop (1.75.7)
+    rubocop (1.78.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.46.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-performance (1.25.0)
@@ -386,21 +388,21 @@ GEM
     rubyzip (2.4.1)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
-    sass-embedded (1.89.0-aarch64-linux-gnu)
+    sass-embedded (1.89.2-aarch64-linux-gnu)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-aarch64-linux-musl)
+    sass-embedded (1.89.2-aarch64-linux-musl)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-arm-linux-gnueabihf)
+    sass-embedded (1.89.2-arm-linux-gnueabihf)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-arm-linux-musleabihf)
+    sass-embedded (1.89.2-arm-linux-musleabihf)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-arm64-darwin)
+    sass-embedded (1.89.2-arm64-darwin)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-x86_64-darwin)
+    sass-embedded (1.89.2-x86_64-darwin)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-x86_64-linux-gnu)
+    sass-embedded (1.89.2-x86_64-linux-gnu)
       google-protobuf (~> 4.31)
-    sass-embedded (1.89.0-x86_64-linux-musl)
+    sass-embedded (1.89.2-x86_64-linux-musl)
       google-protobuf (~> 4.31)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -421,7 +423,7 @@ GEM
       activejob (>= 7.2)
       activerecord (>= 7.2)
       railties (>= 7.2)
-    solid_queue (1.1.5)
+    solid_queue (1.2.0)
       activejob (>= 7.1)
       activerecord (>= 7.1)
       concurrent-ruby (>= 1.3.1)
@@ -470,7 +472,9 @@ PLATFORMS
   aarch64-linux-gnu
   aarch64-linux-musl
   arm-linux-gnu
+  arm-linux-gnueabihf
   arm-linux-musl
+  arm-linux-musleabihf
   arm64-darwin
   x86_64-darwin
   x86_64-linux
@@ -479,6 +483,7 @@ PLATFORMS
 
 DEPENDENCIES
   annotaterb
+  auto_strip_attributes
   aws-sdk-s3
   bootsnap
   brakeman
@@ -492,6 +497,7 @@ DEPENDENCIES
   importmap-rails
   jbuilder
   pg
+  phony
   propshaft
   pry-byebug
   puma (>= 5.0)
@@ -512,4 +518,4 @@ DEPENDENCIES
   web-console
 
 BUNDLED WITH
-   2.6.4
+   2.6.7

app/controllers/base_controller.rb

@@ -1,15 +1,20 @@
 class BaseController < ApplicationController
-    def current_archived_intake
-      # If a user does not have an associated email, we still create an ArchivedIntake
-      # so they can go through the flow. This prevents it from being obvious whether
-      # an email is linked to an existing intake.
-      #
-      # These intakes are created without an IP address, meaning the user will not
-      # be able to pass the identification number controller.
-      return unless session[:email_address].present?
+  def current_archived_intake
+    # If a user does not have an associated email or phone, we still create an ArchivedIntake
+    # so they can go through the flow. This prevents it from being obvious whether
+    # an email or phone is linked to an existing intake.
+    #
+    # These intakes are created without an IP address, meaning the user will not
+    # be able to pass the identification number controller.
 
+    if session[:phone_number].present?
+      phone = session[:phone_number]
+      existing = StateFileArchivedIntake.find_by(phone_number: phone)
+      existing || StateFileArchivedIntake.create(phone_number: phone, contact_preference: "text")
+    elsif session[:email_address].present?
       email = session[:email_address].downcase
       existing = StateFileArchivedIntake.find_by("LOWER(email_address) = ?", email)
-      existing || StateFileArchivedIntake.create(email_address: email)
+      existing || StateFileArchivedIntake.create(email_address: email, contact_preference: "email")
     end
+  end
 end

app/controllers/contact_preference_controller.rb

@@ -0,0 +1,4 @@
+class ContactPreferenceController < BaseController
+  def show
+  end
+end

app/controllers/email_address_controller.rb

@@ -11,6 +11,7 @@ def update
         session[:mailing_verified] = false
         session[:code_verified] = false
         session[:email_address] = @form.email_address
+        session[:phone_number] = nil
         current_archived_intake
         # TODO Add some kind of logging here
         # https://codeforamerica.atlassian.net/browse/FYST-2088

app/controllers/phone_number_controller.rb

@@ -0,0 +1,29 @@
+class PhoneNumberController < BaseController
+  def edit
+    @form = PhoneNumberForm.new
+  end
+
+  def update
+    @form = PhoneNumberForm.new(phone_number_form_params)
+
+    if @form.valid?
+      session[:ssn_verified] = false
+      session[:mailing_verified] = false
+      session[:code_verified] = false
+      session[:phone_number] = @form.phone_number
+      session[:email_address] = nil
+      current_archived_intake
+      # TODO Add some kind of logging here. https://codeforamerica.atlassian.net/browse/FYST-2088
+
+      redirect_to root_path
+    else
+      render :edit
+    end
+  end
+
+  private
+
+  def phone_number_form_params
+    params.require(:phone_number_form).permit(:phone_number)
+  end
+end

app/controllers/year_select_controller.rb

@@ -12,7 +12,7 @@ def update
         redirect_to edit_email_address_path
       when "2024"
         session[:year_selected] = "2024"
-        redirect_to edit_email_address_path
+        redirect_to contact_preference_show_path
       else
         render :show
       end

app/forms/phone_number_form.rb

@@ -0,0 +1,11 @@
+class PhoneNumberForm < Form
+  attr_accessor :phone_number
+
+  before_validation :normalize_phone_number
+
+  validates :phone_number, e164_phone: true
+
+  def normalize_phone_number
+    self.phone_number = PhoneParser.normalize(phone_number) if phone_number.present?
+  end
+end

app/models/state_file_archived_intake.rb

@@ -3,7 +3,7 @@
 # Table name: state_file_archived_intakes
 #
 #  id                      :bigint           not null, primary key
-#  contact_preference      :string
+#  contact_preference      :integer          default("unfilled"), not null
 #  email_address           :string
 #  fake_address_1          :string
 #  fake_address_2          :string
@@ -24,6 +24,8 @@ class StateFileArchivedIntake < ApplicationRecord
   has_one_attached :submission_pdf
   has_many :state_file_archived_intake_access_logs, class_name: "StateFileArchivedIntakeAccessLog"
 
+  enum :contact_preference, { unfilled: 0, email: 1, text: 2 }, prefix: :contact_preference
+
   def full_address
     address_parts = [ mailing_street, mailing_apartment, mailing_city, mailing_state, mailing_zip ]
     address_parts.compact_blank.join(", ")

app/services/phone_parser.rb

@@ -0,0 +1,27 @@
+class PhoneParser
+  def self.normalize(raw_phone_number)
+    valid, phony_normalized = self.phony_normalize_or_error(raw_phone_number)
+    valid ? self.e164(phony_normalized) : raw_phone_number&.to_s
+  end
+
+  private
+
+  def self.phony_normalize_or_error(raw_phone_number)
+    return [ false, nil ] if raw_phone_number.nil?
+    return [ false, "" ] if raw_phone_number == ""
+
+    raw_phone_number = raw_phone_number.to_s
+
+    phony_normalized = Phony.normalize(raw_phone_number, cc: "1")
+    if Phony.plausible?(phony_normalized)
+      [ true, phony_normalized ]
+    else
+      [ false, raw_phone_number ]
+    end
+  end
+
+  def self.e164(phony_normalized)
+    # Phony normalization results in a phone number with no punctuation and with a country calling code.
+    "+#{phony_normalized}"
+  end
+end