diff --git a/app/components/requester_form_component.rb b/app/components/requester_form_component.rb
new file mode 100644
index 0000000..21b7f9f
--- /dev/null
+++ b/app/components/requester_form_component.rb
@@ -0,0 +1,105 @@
+# Form that allows the user to request data deletion from various companies.
+class RequesterFormComponent < ApplicationComponent
+ # Constructor.
+ #
+ # @param bulk_deletion_request [BulkDeletionRequest, nil]
+ # Optional, for retaining submitted data
+ # @param url [String] The URL to submit the form to
+ # @param flash [ActionDispatch::Flash::FlashHash, nil] Flash, if any
+ # @param regulation [Hash, nil] See `Region::REGULATIONS`
+ # @return [RequesterFormComponent]
+ def initialize(url:, bulk_deletion_request: nil, flash: nil, regulation: nil)
+ @bulk_deletion_request = bulk_deletion_request
+ @url = url
+ @flash = flash
+ @regulation = regulation
+ end
+
+ # Gives the email subject field's value.
+ #
+ # @return [String]
+ def email_subject_value
+ retained_value = @bulk_deletion_request&.params&.dig("email_subject")
+ i18n_value = I18n.t("components.requester_form.email_subject_value")
+ retained_value || i18n_value
+ end
+
+ # Gives the email body field's value.
+ #
+ # @return [String]
+ def email_body_value
+ retained_value = @bulk_deletion_request&.params&.dig("email_body")
+
+ # Stripping the i18n value to avoid extra whitespace in a textarea.
+ i18n_value = I18n
+ .t(
+ "components.requester_form.email_body_value",
+ regulation_name: @regulation&.dig(:name),
+ regulation_code: @regulation&.dig(:id)&.upcase,
+ region: @regulation&.dig(:region)
+ )
+ .strip
+
+ retained_value || i18n_value
+ end
+
+ # Gives an array of options for the SMTP provider dropdown.
+ #
+ # @return [Array]
+ def smtp_provider_options
+ SmtpConfig::PROVIDERS.map { |key, value| [value[:label], key] }
+ end
+
+ # Gives the SMTP provider field's selected value.
+ #
+ # @return [String]
+ def smtp_provider_selected
+ retained_value = @bulk_deletion_request&.params&.dig("smtp_provider")
+ first_provider = SmtpConfig::PROVIDERS.keys.first
+ retained_value || first_provider
+ end
+
+ # Gives the SMTP provider field's value, if any.
+ #
+ # @return [String, nil]
+ def smtp_username_value
+ @bulk_deletion_request&.params&.dig("smtp_username")
+ end
+
+ # Determines if the flash should be rendered.
+ #
+ # @return [Boolean]
+ def show_flash?
+ @flash.present?
+ end
+
+ # Gives the flash message, if any.
+ #
+ # @return [String, nil]
+ def flash_message
+ @flash[:notice]
+ end
+
+ # Determines if the flash has errors.
+ #
+ # @return [Boolean]
+ def errors?
+ @flash[:alert].present? && @flash[:alert].is_a?(Array)
+ end
+
+ # Fetches errors from the flash.
+ #
+ # @return [Array]
+ def errors
+ @flash[:alert]
+ end
+
+ # Gets a list of providers and links to their app password articles.
+ #
+ # @return [Array]
+ def providers
+ SmtpConfig::PROVIDERS.map do |_key, value|
+ value.slice(:label, :app_password_article_url)
+ end
+ end
+end
diff --git a/app/components/steps_content_component.html.erb b/app/components/steps_content_component.html.erb
new file mode 100644
index 0000000..e2bd0ee
--- /dev/null
+++ b/app/components/steps_content_component.html.erb
@@ -0,0 +1,12 @@
+
+
<%= @heading %>
+
+
+ <% @steps.each.with_index do |step, index| %>
+
+
<%= step[:title] %>
+
<%= step[:description] %>
+
+ <% end %>
+
+
diff --git a/app/components/steps_content_component.rb b/app/components/steps_content_component.rb
new file mode 100644
index 0000000..9277a48
--- /dev/null
+++ b/app/components/steps_content_component.rb
@@ -0,0 +1,12 @@
+# Renders a list of steps with a title and a description.
+class StepsContentComponent < ApplicationComponent
+ # Constructor.
+ #
+ # @param heading [String, nil] Optional heading
+ # @param steps [Array<{title: String, description: String}>]
+ # @return [StepsContentComponent]
+ def initialize(steps:, heading: nil)
+ @steps = steps
+ @heading = heading
+ end
+end
diff --git a/app/controllers/bulk_deletion_requests_controller.rb b/app/controllers/bulk_deletion_requests_controller.rb
new file mode 100644
index 0000000..7391c05
--- /dev/null
+++ b/app/controllers/bulk_deletion_requests_controller.rb
@@ -0,0 +1,25 @@
+class BulkDeletionRequestsController < ApplicationController
+ # @route GET /bulk_deletion_requests/new (new_bulk_deletion_request)
+ def new
+ @regulation = Region::REGULATIONS.find { |r| r[:id] == params[:regulation] }
+ redirect_to root_path if @regulation.blank?
+ end
+
+ # @route POST /bulk_deletion_requests (bulk_deletion_requests)
+ def create
+ @bulk_deletion_request = BulkDeletionRequest.new(params)
+ if @bulk_deletion_request.invalid?
+ flash.now[:alert] = @bulk_deletion_request.errors
+ render(:new, status: :unprocessable_entity) && return
+ end
+
+ begin
+ @bulk_deletion_request.deliver_emails
+ rescue Net::SMTPAuthenticationError
+ flash.now[:alert] = t(".smtp_authentication_alert")
+ render(:new, status: :unprocessable_entity) && return
+ end
+
+ redirect_to root_path, notice: t(".notice")
+ end
+end
diff --git a/app/controllers/companies_controller.rb b/app/controllers/companies_controller.rb
new file mode 100644
index 0000000..fa02f2f
--- /dev/null
+++ b/app/controllers/companies_controller.rb
@@ -0,0 +1,7 @@
+class CompaniesController < ApplicationController
+ # @route GET /companies (companies)
+ def index
+ @companies = Company.all.order(:website)
+ @last_updated_at = Company.maximum(:updated_at).to_fs(:long)
+ end
+end
diff --git a/app/controllers/pages_controller.rb b/app/controllers/pages_controller.rb
new file mode 100644
index 0000000..23e9a25
--- /dev/null
+++ b/app/controllers/pages_controller.rb
@@ -0,0 +1,10 @@
+class PagesController < ApplicationController
+ # @route GET / (root)
+ def home
+ @regulations = Region::REGULATIONS
+ end
+
+ # @route GET /about (about)
+ def about
+ end
+end
diff --git a/app/javascript/controllers/hello_controller.js b/app/javascript/controllers/hello_controller.js
deleted file mode 100644
index 5975c07..0000000
--- a/app/javascript/controllers/hello_controller.js
+++ /dev/null
@@ -1,7 +0,0 @@
-import { Controller } from "@hotwired/stimulus"
-
-export default class extends Controller {
- connect() {
- this.element.textContent = "Hello World!"
- }
-}
diff --git a/app/mailers/deletion_request_mailer.rb b/app/mailers/deletion_request_mailer.rb
new file mode 100644
index 0000000..2f40eac
--- /dev/null
+++ b/app/mailers/deletion_request_mailer.rb
@@ -0,0 +1,23 @@
+class DeletionRequestMailer < ApplicationMailer
+ # Personal information deletion request email generated from a given `DeletionRequest`.
+ #
+ # @param serialized_deletion_request [Hash]
+ # @return [Mail::Message]
+ def deletion_request(serialized_deletion_request)
+ @deletion_request = DeletionRequest.deserialize(serialized_deletion_request)
+
+ delivery_options = {
+ user_name: @deletion_request.smtp_config.username,
+ password: @deletion_request.smtp_config.password,
+ address: @deletion_request.smtp_config.address,
+ port: @deletion_request.smtp_config.port,
+ authentication: :login
+ }
+
+ mail \
+ from: @deletion_request.smtp_config.username,
+ to: @deletion_request.company.email,
+ subject: @deletion_request.email_subject,
+ delivery_method_options: delivery_options
+ end
+end
diff --git a/app/models/bulk_deletion_request.rb b/app/models/bulk_deletion_request.rb
new file mode 100644
index 0000000..bb1b637
--- /dev/null
+++ b/app/models/bulk_deletion_request.rb
@@ -0,0 +1,73 @@
+# Responsible for handling server requests to send out many deletion request emails.
+class BulkDeletionRequest
+ attr_reader :params, :errors
+
+ # Constructor.
+ #
+ # @param params [ActionControler::Parameters]
+ # @return [BulkDeletionRequest]
+ def initialize(params = {})
+ @params = params
+ @emails = []
+ @errors = nil
+
+ generate_emails
+ end
+
+ # Check if the bulk deletion request is valid.
+ #
+ # @return [Boolean]
+ def valid?
+ @errors.blank?
+ end
+
+ # Check if the bulk deletion request is invalid.
+ #
+ # @return [Boolean]
+ def invalid?
+ !valid?
+ end
+
+ # Send out all generated deletion request emails.
+ #
+ # @raise [Net::SMTPAuthenticationError] If SMTP authentication fails
+ # @return [void]
+ def deliver_emails
+ @emails.each.with_index do |email, index|
+ index.zero? ? email.deliver_now : email.deliver_later
+ end
+ end
+
+ private
+
+ # Generate a deletion request email for each California data brokers.
+ #
+ # @return [void]
+ def generate_emails
+ Company.california_data_brokers.find_each.with_index do |company, index|
+ deletion_request = DeletionRequest.new \
+ company: company,
+ smtp_config: smtp_config,
+ email_subject: @params[:email_subject],
+ email_body: @params[:email_body]
+
+ if deletion_request.invalid?
+ @errors = deletion_request.errors.full_messages
+ break
+ end
+
+ serialized_deletion_request = deletion_request.serialize
+ @emails << DeletionRequestMailer.deletion_request(serialized_deletion_request)
+ end
+ end
+
+ # Construct a memoized SMTP configuration object from the given parameters.
+ #
+ # @return [SmtpConfig]
+ def smtp_config
+ @_smtp_config ||= SmtpConfig.new \
+ provider: @params[:smtp_provider],
+ username: @params[:smtp_username],
+ password: @params[:smtp_password]
+ end
+end
diff --git a/app/models/company.rb b/app/models/company.rb
new file mode 100644
index 0000000..c9727cd
--- /dev/null
+++ b/app/models/company.rb
@@ -0,0 +1,62 @@
+# == Schema Information
+#
+# Table name: companies
+#
+# id :integer not null, primary key
+# category :string not null
+# email :string not null
+# name :string not null
+# website :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
+#
+# Indexes
+#
+# index_companies_on_category (category)
+# index_companies_on_website (website) UNIQUE
+#
+class Company < ApplicationRecord
+ include CaliforniaDataBrokersRequestable
+ include DataBrokersWatchRequestable
+
+ CATEGORIES = {
+ california_data_broker: "california_data_broker",
+ data_brokers_watch: "data_brokers_watch"
+ }.freeze
+
+ validates :category, inclusion: {in: CATEGORIES.values}
+ validates :email, presence: true, format: {with: URI::MailTo::EMAIL_REGEXP}
+ validates :name, presence: true
+ validates :website, presence: true, uniqueness: true
+
+ before_save :domainify_website!
+ before_save :downcase_email!
+
+ # Ensures we're only saving website domains to better enforce uniqueness.
+ #
+ # @return [void]
+ def domainify_website!
+ hostified_website = URI(website).host || website
+ self.website = hostified_website.gsub(/^www\./, "")
+ end
+
+ # Ensures we're normalizing emails before saving.
+ #
+ # @return [void]
+ def downcase_email!
+ email.downcase!
+ end
+
+ # Generates a human-readable source from which this company was gathered.
+ #
+ # @return [String]
+ def source
+ humanized_category =
+ {
+ CATEGORIES[:california_data_broker] => "CPPA",
+ CATEGORIES[:data_brokers_watch] => "DataBrokersWatch.org"
+ }[category]
+
+ I18n.t("models.company.source", source: humanized_category)
+ end
+end
diff --git a/app/models/concerns/company/california_data_brokers_requestable.rb b/app/models/concerns/company/california_data_brokers_requestable.rb
new file mode 100644
index 0000000..5785d8c
--- /dev/null
+++ b/app/models/concerns/company/california_data_brokers_requestable.rb
@@ -0,0 +1,35 @@
+module Company::CaliforniaDataBrokersRequestable
+ require "net/http"
+ require "csv"
+
+ extend ActiveSupport::Concern
+
+ REGISTRY_CSV_URI = URI("https://cppa.ca.gov/data_broker_registry/registry.csv").freeze
+
+ included do
+ scope :california_data_brokers, -> { where(category: Company::CATEGORIES[:california_data_broker]) }
+ end
+
+ class_methods do
+ # Attempts to fetch and update all registered California data brokers.
+ #
+ # @return [void]
+ def update_california_data_brokers
+ registry_csv = Net::HTTP.get(REGISTRY_CSV_URI)
+
+ CSV.parse(registry_csv, headers: true, row_sep: "\r\n") do |row|
+ email = row["Business primary contact email address"]
+ name = row["Business name"]
+ website = row["Business primary website"]
+ next if email.blank? || name.blank? || website.blank?
+
+ company = Company.find_or_initialize_by(email: email)
+ company.update \
+ category: Company::CATEGORIES[:california_data_broker],
+ name: name,
+ website: website
+ rescue ActiveRecord::RecordNotUnique
+ end
+ end
+ end
+end
diff --git a/app/models/concerns/company/data_brokers_watch_requestable.rb b/app/models/concerns/company/data_brokers_watch_requestable.rb
new file mode 100644
index 0000000..d6257f8
--- /dev/null
+++ b/app/models/concerns/company/data_brokers_watch_requestable.rb
@@ -0,0 +1,33 @@
+module Company::DataBrokersWatchRequestable
+ require "net/http"
+
+ extend ActiveSupport::Concern
+
+ API_URI = URI("https://databrokerswatch.org/api/databrokers").freeze
+
+ included do
+ scope :data_brokers_watch, -> { where(category: Company::CATEGORIES[:data_brokers_watch]) }
+ end
+
+ class_methods do
+ def update_data_brokers_watch_companies
+ response = Net::HTTP.get(API_URI)
+ response_json = JSON.parse(response)
+ companies = response_json.dig("DataBrokers")
+
+ companies.each do |company|
+ email = company.dig("Emails").split(";").first
+ name = company.dig("Company Name") || company.dig("Domain")
+ website = company.dig("Domain")
+ next if email.blank? || name.blank? || website.blank?
+
+ company = Company.find_or_initialize_by(email: email)
+ company.update \
+ category: Company::CATEGORIES[:data_brokers_watch],
+ name: name,
+ website: website
+ rescue ActiveRecord::RecordNotUnique
+ end
+ end
+ end
+end
diff --git a/app/models/concerns/deletion_request/serializable.rb b/app/models/concerns/deletion_request/serializable.rb
new file mode 100644
index 0000000..09fc528
--- /dev/null
+++ b/app/models/concerns/deletion_request/serializable.rb
@@ -0,0 +1,32 @@
+# Responsible for custom serialization and deserialization of `DeletionRequest` objects.
+# Opted to write a custom class outside of ActiveJob's support for custom serializers
+# to avoid messing with autoload config.
+module DeletionRequest::Serializable
+ extend ActiveSupport::Concern
+
+ class_methods do
+ # Deserializes the given serialized deletion request.
+ #
+ # @param hash [Hash]
+ # @return [DeletionRequest]
+ def deserialize(hash)
+ DeletionRequest.new \
+ company: Company.find_by(id: hash.dig("company", "id")),
+ smtp_config: SmtpConfig.new(hash["smtp_config"]),
+ email_subject: hash["email_subject"],
+ email_body: hash["email_body"]
+ end
+ end
+
+ # Serializes the deletion request.
+ #
+ # @return [Hash]
+ def serialize
+ {
+ "company" => {"id" => company.id},
+ "smtp_config" => smtp_config.serializable_hash,
+ "email_subject" => email_subject,
+ "email_body" => email_body
+ }
+ end
+end
diff --git a/app/models/concerns/deletion_request/validator.rb b/app/models/concerns/deletion_request/validator.rb
new file mode 100644
index 0000000..e04f835
--- /dev/null
+++ b/app/models/concerns/deletion_request/validator.rb
@@ -0,0 +1,74 @@
+class DeletionRequest::Validator < ActiveModel::Validator
+ # Validates a `DeletionRequest`.
+ #
+ # @param record [DeletionRequest]
+ # @return [void]
+ def validate(record)
+ validate_company_attached(record)
+ validate_smtp_config_attached(record)
+ validate_email_subject(record)
+ validate_email_body(record)
+ end
+
+ private
+
+ # Validates that a corresponding, valid `Company` object is attached.
+ #
+ # @param record [DeletionRequest]
+ # @return [void]
+ def validate_company_attached(record)
+ if !record.company&.is_a?(Company) || record.company.invalid?
+ record.errors.add(:company, I18n.t("models.deletion_request.company_missing"))
+ end
+ end
+
+ # Validates that a corresponding, valid `SmtpConfig` object is attached.
+ #
+ # @param record [DeletionRequest]
+ # @return [void]
+ def validate_smtp_config_attached(record)
+ if !record.smtp_config&.is_a?(SmtpConfig) || record.smtp_config.invalid?
+ record.errors.add(:smtp_config, I18n.t("models.deletion_request.smtp_config_missing"))
+ end
+ end
+
+ # Validates that the email subject is present.
+ #
+ # @param record [DeletionRequest]
+ # @return [void]
+ def validate_email_subject(record)
+ if record.email_subject.blank?
+ record.errors.add(:email_subject, I18n.t("models.deletion_request.email_subject_missing"))
+ end
+ end
+
+ # Validates that the body has been edited to no longer contain placeholder copy.
+ #
+ # @param record [DeletionRequest]
+ # @return [void]
+ def validate_email_body(record)
+ if record.email_body.blank?
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.missing"))
+ end
+
+ if record.email_body&.include?(DeletionRequest::TOKENS[:full_name])
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.full_name_missing"))
+ end
+
+ if record.email_body&.include?(DeletionRequest::TOKENS[:full_address])
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.full_address_missing"))
+ end
+
+ if record.email_body&.include?(DeletionRequest::TOKENS[:email_addresses])
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.email_addresses_missing"))
+ end
+
+ if record.email_body&.include?(DeletionRequest::TOKENS[:phone_numbers])
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.phone_numbers_missing"))
+ end
+
+ if record.email_body&.include?(DeletionRequest::TOKENS[:signature_name])
+ record.errors.add(:email_body, I18n.t("models.deletion_request.email_body.signature_name_missing"))
+ end
+ end
+end
diff --git a/app/models/concerns/smtp_config/providers_supportable.rb b/app/models/concerns/smtp_config/providers_supportable.rb
new file mode 100644
index 0000000..1975658
--- /dev/null
+++ b/app/models/concerns/smtp_config/providers_supportable.rb
@@ -0,0 +1,63 @@
+module SmtpConfig::ProvidersSupportable
+ extend ActiveSupport::Concern
+
+ PROVIDERS =
+ {
+ # @see https://support.google.com/a/answer/176600
+ gmail: {
+ label: "Gmail",
+ address: "smtp.gmail.com",
+ port: 587,
+ authentication: :login,
+ app_password_article_url: "https://support.google.com/accounts/answer/185833"
+ },
+
+ # @see https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040
+ outlook: {
+ label: "Outlook",
+ address: "smtp-mail.outlook.com",
+ port: 587,
+ authentication: :login,
+ app_password_article_url: "https://support.microsoft.com/en-us/account-billing/manage-app-passwords-for-two-step-verification-d6dc8c6d-4bf7-4851-ad95-6d07799387e9"
+ },
+
+ # @see https://proton.me/support/smtp-submission
+ protonmail: {
+ label: "Proton Mail",
+ address: "smtp.protonmail.ch",
+ port: 587,
+ authentication: :plain,
+ app_password_article_url: "https://proton.me/support/smtp-submission#setup"
+ },
+
+ # @see https://www.fastmail.help/hc/en-us/articles/1500000279921-IMAP-POP-and-SMTP#01H8Q4KWEZ2JK8YS0FP85FM0H7
+ fastmail: {
+ label: "Fastmail",
+ address: "smtp.fastmail.com",
+ port: 587,
+ authentication: :login,
+ app_password_article_url: "https://www.fastmail.help/hc/en-us/articles/360058752854-App-passwords"
+ }
+ }.freeze
+
+ # Returns the address of the SMTP provider.
+ #
+ # @return [String]
+ def address
+ PROVIDERS.dig(provider.to_sym, :address)
+ end
+
+ # Returns the port of the SMTP provider.
+ #
+ # @return [Integer]
+ def port
+ PROVIDERS.dig(provider.to_sym, :port)
+ end
+
+ # Returns the authentication method of the SMTP provider.
+ #
+ # @return [Symbol]
+ def authentication
+ PROVIDERS.dig(provider.to_sym, :authentication)
+ end
+end
diff --git a/app/models/deletion_request.rb b/app/models/deletion_request.rb
new file mode 100644
index 0000000..7d078d5
--- /dev/null
+++ b/app/models/deletion_request.rb
@@ -0,0 +1,31 @@
+# Unpersisted object representing a new personal information deletion request to
+# a company.
+class DeletionRequest
+ include ActiveModel::API
+ include ActiveModel::Attributes
+ include Serializable
+
+ TOKENS =
+ {
+ company_name: "{COMPANY NAME}",
+ full_name: "[YOUR FULL NAME]",
+ full_address: "[YOUR FULL ADDRESS]",
+ email_addresses: "[YOUR EMAIL ADDRESS(ES)]",
+ phone_numbers: "[YOUR PHONE NUMBER(S)]",
+ signature_name: "[YOUR SIGNATURE NAME]"
+ }.freeze
+
+ attr_accessor :company
+ attr_accessor :smtp_config
+ attribute :email_subject, :string
+ attribute :email_body, :string
+
+ validates_with Validator
+
+ # Gives the email body but with applicable tokens interpolated with relevant data.
+ #
+ # @return [String]
+ def interpolated_email_body
+ email_body.gsub(TOKENS[:company_name], company.name)
+ end
+end
diff --git a/app/models/region.rb b/app/models/region.rb
new file mode 100644
index 0000000..b07a88e
--- /dev/null
+++ b/app/models/region.rb
@@ -0,0 +1,64 @@
+class Region
+ REGULATIONS =
+ [
+ {
+ id: "lgpd",
+ name: "Brazilian General Data Protection Law",
+ region: "Brazil"
+ },
+
+ {
+ id: "ccpa",
+ name: "California Consumer Privacy Act",
+ region: "California"
+ },
+
+ {
+ id: "pipeda",
+ name: "Personal Information Protection and Electronic Documents Act",
+ region: "Canada"
+ },
+
+ {
+ id: "cpa",
+ name: "Colorado Privacy Act",
+ region: "Colorado"
+ },
+
+ {
+ id: "ctdpa",
+ name: "Connecticut Data Privacy Act",
+ region: "Connecticut"
+ },
+
+ {
+ id: "gdpr",
+ name: "General Data Protections Regulation",
+ region: "European Union"
+ },
+
+ {
+ id: "appi",
+ name: "Act on the Protection of Personal Information",
+ region: "Japan"
+ },
+
+ {
+ id: "dpa",
+ name: "Data Protection Act",
+ region: "UK"
+ },
+
+ {
+ id: "ucpa",
+ name: "Utah Consumer Privacy Act",
+ region: "Utah"
+ },
+
+ {
+ id: "vcdpa",
+ name: "Virginia Consumer Data Protection Act",
+ region: "Virginia"
+ }
+ ].freeze
+end
diff --git a/app/models/smtp_config.rb b/app/models/smtp_config.rb
new file mode 100644
index 0000000..a05c3af
--- /dev/null
+++ b/app/models/smtp_config.rb
@@ -0,0 +1,25 @@
+# Unpersisted object representing SMTP configuration.
+class SmtpConfig
+ include ActiveModel::API
+ include ActiveModel::Attributes
+ include ActiveModel::Serialization
+ include ProvidersSupportable
+
+ attribute :provider, :string
+ attribute :username, :string
+ attribute :password, :string
+
+ validates :provider, inclusion: {in: PROVIDERS.keys.map(&:to_s)}
+ validates :username, :password, presence: true
+
+ # To support `ActiveModel::Serialization`.
+ #
+ # @return [Hash]
+ def attributes
+ {
+ "provider" => nil,
+ "username" => nil,
+ "password" => nil
+ }
+ end
+end
diff --git a/app/views/bulk_deletion_requests/new.html.erb b/app/views/bulk_deletion_requests/new.html.erb
new file mode 100644
index 0000000..c697e4c
--- /dev/null
+++ b/app/views/bulk_deletion_requests/new.html.erb
@@ -0,0 +1,23 @@
+<% content_for(:title, t(".title")) %>
+
+<%=
+ render(
+ HeroComponent.new(
+ heading: t(".hero.heading", company_count: Company.count),
+ description: t(".hero.description"),
+ )
+ )
+%>
+
+<%= turbo_frame_tag "requester_form" do %>
+ <%=
+ render(
+ RequesterFormComponent.new(
+ bulk_deletion_request: @bulk_deletion_request,
+ url: bulk_deletion_requests_path,
+ flash: flash,
+ regulation: @regulation
+ )
+ )
+ %>
+<% end %>
diff --git a/app/views/companies/index.html.erb b/app/views/companies/index.html.erb
new file mode 100644
index 0000000..6f77979
--- /dev/null
+++ b/app/views/companies/index.html.erb
@@ -0,0 +1,12 @@
+<% content_for(:title, t(".title")) %>
+
+<%=
+ render(
+ HeroComponent.new(
+ heading: t(".hero.heading"),
+ description: t(".hero.description", last_updated_at: @last_updated_at)
+ )
+ )
+%>
+
+<%= render CompanyGridComponent.new(companies: @companies) %>
diff --git a/app/views/deletion_request_mailer/deletion_request.text.erb b/app/views/deletion_request_mailer/deletion_request.text.erb
new file mode 100644
index 0000000..269a07f
--- /dev/null
+++ b/app/views/deletion_request_mailer/deletion_request.text.erb
@@ -0,0 +1 @@
+<%= @deletion_request.interpolated_email_body %>
diff --git a/app/views/layouts/application.html.erb b/app/views/layouts/application.html.erb
index cf1bf4f..874bdd0 100644
--- a/app/views/layouts/application.html.erb
+++ b/app/views/layouts/application.html.erb
@@ -1,7 +1,7 @@
-
+
- Pidr
+ <%= content_for?(:title) ? "#{yield(:title)} | Naisho" : "Naisho" %>
<%= csrf_meta_tags %>
<%= csp_meta_tag %>
@@ -11,6 +11,14 @@
- <%= yield %>
+ <%= render ContainerComponent.new do %>
+ <%= render HeaderComponent.new %>
+
+
+ <%= yield %>
+
+
+ <%= render FooterComponent.new %>
+ <% end %>
diff --git a/app/views/layouts/mailer.html.erb b/app/views/layouts/mailer.html.erb
deleted file mode 100644
index 3aac900..0000000
--- a/app/views/layouts/mailer.html.erb
+++ /dev/null
@@ -1,13 +0,0 @@
-
-
-
-
-
-
-
-
- <%= yield %>
-
-
diff --git a/app/views/pages/about.html.erb b/app/views/pages/about.html.erb
new file mode 100644
index 0000000..28c7dc0
--- /dev/null
+++ b/app/views/pages/about.html.erb
@@ -0,0 +1,32 @@
+<% content_for(:title, t(".title")) %>
+
+<%=
+ render(
+ HeroComponent.new(
+ heading: t(".hero.heading"),
+ description: t(".hero.description"),
+ )
+ )
+%>
+
+<%=
+ render(
+ StepsContentComponent.new(
+ heading: t(".steps.heading"),
+ steps: [
+ {title: t(".steps.one.title"), description: t(".steps.one.description")},
+ {title: t(".steps.two.title"), description: t(".steps.two.description")},
+ {title: t(".steps.three.title"), description: t(".steps.three.description")}
+ ]
+ )
+ )
+%>
+
+<%=
+ render(
+ FaqComponent.new(
+ heading: t(".faq.heading"),
+ questions: t(".faq.questions")
+ )
+ )
+%>
diff --git a/app/views/pages/home.html.erb b/app/views/pages/home.html.erb
new file mode 100644
index 0000000..d96c4a9
--- /dev/null
+++ b/app/views/pages/home.html.erb
@@ -0,0 +1,23 @@
+<%=
+ render(
+ HeroComponent.new(
+ heading: t(".hero.heading"),
+ description: t(".hero.description"),
+ )
+ ) do |hero|
+%>
+ <% hero.with_actions do %>
+ <%= form_with url: new_bulk_deletion_request_path, method: :get, class: "mt-sm" do |form| %>
+
<%= t(".hero.region") %>
+
+
+
+ <%= render(ButtonComponent.new(text: t(".hero.button"), type: "submit", name: nil)) %>
+ <% end %>
+ <% end %>
+<% end %>
diff --git a/bin/docker-entrypoint b/bin/docker-entrypoint
index 67ef493..a8de834 100755
--- a/bin/docker-entrypoint
+++ b/bin/docker-entrypoint
@@ -1,8 +1,10 @@
#!/bin/bash -e
-# If running the rails server then create or migrate existing database
+# If running the Rails server then create or migrate existing database. Also
+# sync companies from sources.
if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then
./bin/rails db:prepare
+ ./bin/rake sync_companies
fi
exec "${@}"
diff --git a/config/application.rb b/config/application.rb
index 6bc6057..6c549de 100644
--- a/config/application.rb
+++ b/config/application.rb
@@ -23,5 +23,16 @@ class Application < Rails::Application
#
# config.time_zone = "Central Time (US & Canada)"
# config.eager_load_paths << Rails.root.join("extras")
+
+ config.active_job.queue_adapter = :litejob
+
+ # Redact `BulkDeletionRequestController` parameters from logs.
+ config.filter_parameters += %i[
+ email_subject
+ email_body
+ smtp_provider
+ smtp_username
+ smtp_password
+ ]
end
end
diff --git a/config/dockerfile.yml b/config/dockerfile.yml
new file mode 100644
index 0000000..223e505
--- /dev/null
+++ b/config/dockerfile.yml
@@ -0,0 +1,6 @@
+# generated by dockerfile-rails
+
+---
+options:
+ label:
+ fly_launch_runtime: rails
diff --git a/config/environments/development.rb b/config/environments/development.rb
index 2e7fb48..6d25247 100644
--- a/config/environments/development.rb
+++ b/config/environments/development.rb
@@ -36,10 +36,8 @@
# Store uploaded files on the local file system (see config/storage.yml for options).
config.active_storage.service = :local
- # Don't care if the mailer can't send.
- config.action_mailer.raise_delivery_errors = false
-
config.action_mailer.perform_caching = false
+ config.action_mailer.delivery_method = :smtp
# Print deprecation notices to the Rails logger.
config.active_support.deprecation = :log
diff --git a/config/environments/production.rb b/config/environments/production.rb
index 96dd0d1..2b59008 100644
--- a/config/environments/production.rb
+++ b/config/environments/production.rb
@@ -72,6 +72,7 @@
# config.active_job.queue_name_prefix = "pidr_production"
config.action_mailer.perform_caching = false
+ config.action_mailer.delivery_method = :smtp
# Ignore bad email addresses and do not raise email delivery errors.
# Set this to true and configure the email server for immediate delivery to raise delivery errors.
diff --git a/config/locales/en.yml b/config/locales/en.yml
index 6c349ae..521b717 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -28,4 +28,149 @@
# enabled: "ON"
en:
- hello: "Hello world"
+ components:
+ header:
+ nav:
+ about: "About"
+ github: "GitHub →"
+
+ requester_form:
+ smtp_provider_label: "SMTP provider"
+ smtp_username_label: "SMTP username"
+ smtp_password_label: "SMTP password"
+ email_subject_label: "Email subject"
+ email_subject_value: "Personal information deletion request"
+ email_body_label: "Email body"
+
+ # The double newlines are intentional because of the way underlying helpers parse
+ # the email body value.
+ email_body_value: >
+ Dear {COMPANY NAME},
+
+
+ I am writing to formally request the deletion of my personally identifiable information as per my rights under the %{regulation_name} (%{regulation_code}, %{region}). I am a resident and, as such, I am entitled to request the deletion of my personal data that you may have collected, processed, or sold.
+
+
+ Please find below the details necessary to identify and locate my information in your database:
+
+
+ • Full Name: [YOUR FULL NAME]
+
+ • Address: [YOUR FULL ADDRESS]
+
+ • Email Address(es): [YOUR EMAIL ADDRESS(ES)]
+
+ • Phone Number(s): [YOUR PHONE NUMBER(S)]
+
+ • Any other relevant information you may have associated with my profile
+
+
+ Under the %{regulation_code}, the above information can only be used for verification purposes and you may not collect it.
+
+
+ I kindly request that you promptly delete all of my personal information from your records and confirm in writing once this has been completed. Please also provide details on the steps taken to ensure that my data has been permanently removed from your systems and any third parties with whom you may have shared it.
+
+
+ I expect full compliance with this request within the time frame stipulated by %{region} law. Failure to do so may result in further action being taken to protect my privacy rights.
+
+
+ Thank you for your prompt attention to this matter. I look forward to receiving confirmation of the deletion of my personal information.
+
+
+ Sincerely,
+
+ [YOUR SIGNATURE NAME]
+ submit: "Send to all"
+ help: "Help, I'm confused"
+ popover:
+ smtp_heading: "What's SMTP?"
+ smtp_text: "SMTP stands for Simple Mail Transfer Protocol. It's a standard for sending emails over the internet. Naisho uses SMTP to send your emails directly from your email provider so that you don't have to sign up using your email account."
+ creds_heading: "How do I get my SMTP credentials?"
+ creds_text: "That depends on your email provider, but in general, it's your email/password combination. It's best practice to generate an app password that's separate from your regular password for one-time use. Here are help articles for each provider we support:"
+ tokens_heading: "What are these {curly braces} and [brackets] in the email body?"
+ tokens_text: "These are placeholders. The curly braces will automatically be replaced by our system when sending emails out, and the brackets are where you should fill in your verification information."
+ after_heading: "What happens after I send all these emails?"
+ after_text: "You may or may not get a response from the data brokers. Unfortunately, it's up to them to comply with your request. If you don't hear back, you can follow up with them directly or file a complaint with your region's relevant government body."
+
+ footer:
+ text: "Naisho is a free and open-source tool that helps you exercise your privacy rights. It doesn't track, collect, or store any data from you."
+
+ models:
+ deletion_request:
+ email_subject_missing: "is missing"
+ email_body:
+ missing: "is missing"
+ full_name_missing: "still has a full name placeholder"
+ full_address_missing: "still has a full address placeholder"
+ email_addresses_missing: "still has an email address placeholder"
+ phone_numbers_missing: "still has a phone number placeholder"
+ signature_name_missing: "still has a signature name placeholder"
+ company_missing: "is missing or invalid"
+ smtp_config_missing: "is missing or invalid"
+
+ company:
+ source: "Sourced from %{source}"
+
+ pages:
+ home:
+ hero:
+ heading: "Exercise your privacy rights"
+ description: "Send personal data deletion request emails to hundreds of data brokers at once. No signups, no tracking."
+ region: "I'm a resident of"
+ region_placeholder: "Choose..."
+ button: "Get started"
+
+ about:
+ title: "About"
+
+ hero:
+ heading: "About"
+ description: "Naisho is a free and open-source tool that helps you exercise your privacy rights. It doesn't track, collect, or store any data from you."
+
+ steps:
+ heading: "How it works"
+ one:
+ title: "Draft your email"
+ description: "Use a provided template to draft an email requesting the deletion of your personal information."
+ two:
+ title: "Email all data brokers"
+ description: "Send your email to all data brokers at once through your own email provider using SMTP."
+ three:
+ title: "Wait for responses"
+ description: "All responses will be sent directly to your email inbox. Any further communications are managed entirely by you."
+
+ faq:
+ heading: "FAQ"
+ questions:
+ - question: "What are data brokers?"
+ answer: "Data brokers are companies that collect, analyze, and sell personal information about individuals to other companies, often without their knowledge or consent."
+ - question: "How does this service source data brokers?"
+ answer: "Naisho uses the data broker list from the California Privacy Protection Agency (CPPA) as well as DataBrokersWatch.org."
+ - question: "How can I trust this service?"
+ answer: "Naisho is completely open-source. The site you are using right now is operated by the same code you can find on our GitHub repository."
+ - question: "Can I run this service myself? Can I self-host this?"
+ answer: "Yes and yes! You can find the source code and instructions on running the app locally or self-hosting on GitHub."
+ - question: "The email template has placeholders for personal information. What if I don't want to give that out?"
+ answer: "The email template includes language to explicitly prohibit the collection of included personal information, but you are free to edit the email as you see fit."
+ - question: "What if I don't get a response from a data broker?"
+ answer: "Unfortunately, it's up to the data broker to comply with your request. If you don't hear back, you can follow up with them directly or file a complaint with your region's relevant government body."
+ - question: "I want to help. How can I contribute?"
+ answer: "Naisho is open-source and contributions are welcome. You can find the source code and join the discussion on GitHub."
+
+ bulk_deletion_requests:
+ new:
+ title: "New bulk deletion request"
+ hero:
+ heading: "Ask %{company_count} data brokers to delete your data"
+ description: "Draft an email below and send it to all data brokers at once through your own email provider. Nothing is stored on our servers."
+
+ create:
+ notice: "Deletion requests being sent through your SMTP provider. Check your email outbox for confirmation."
+ smtp_authentication_alert: "SMTP authentication failed. Please check your SMTP username and password."
+
+ companies:
+ index:
+ title: "Companies"
+ hero:
+ heading: "Companies"
+ description: "This is the full list of companies in our database. We source from the California Privacy Protection Agency (CPPA) as well as DataBrokersWatch.org. Last updated: %{last_updated_at} UTC."
diff --git a/config/routes.rb b/config/routes.rb
index 9f768e5..fd25814 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -1,10 +1,10 @@
Rails.application.routes.draw do
- # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+ root "pages#home"
+ get "about" => "pages#about"
- # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
- # Can be used by load balancers and uptime monitors to verify that the app is live.
- get "up" => "rails/health#show", :as => :rails_health_check
+ resources :bulk_deletion_requests, only: [:new, :create]
+ resources :companies, only: [:index]
- # Defines the root path route ("/")
- # root "posts#index"
+ # Healthcheck
+ get "up" => "rails/health#show", :as => :rails_health_check
end
diff --git a/db/migrate/20240606193101_create_companies.rb b/db/migrate/20240606193101_create_companies.rb
new file mode 100644
index 0000000..ce20c36
--- /dev/null
+++ b/db/migrate/20240606193101_create_companies.rb
@@ -0,0 +1,11 @@
+class CreateCompanies < ActiveRecord::Migration[7.1]
+ def change
+ create_table :companies do |t|
+ t.string :name, null: false
+ t.string :email, null: false
+ t.string :website, null: false, index: {unique: true}
+ t.string :category, null: false, index: true
+ t.timestamps
+ end
+ end
+end
diff --git a/db/schema.rb b/db/schema.rb
new file mode 100644
index 0000000..5214a11
--- /dev/null
+++ b/db/schema.rb
@@ -0,0 +1,25 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.1].define(version: 2024_06_06_193101) do
+ create_table "companies", force: :cascade do |t|
+ t.string "name", null: false
+ t.string "email", null: false
+ t.string "website", null: false
+ t.string "category", null: false
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ t.index ["category"], name: "index_companies_on_category"
+ t.index ["website"], name: "index_companies_on_website", unique: true
+ end
+
+end
diff --git a/lib/tasks/auto_annotate_models.rake b/lib/tasks/auto_annotate_models.rake
new file mode 100644
index 0000000..60381ab
--- /dev/null
+++ b/lib/tasks/auto_annotate_models.rake
@@ -0,0 +1,59 @@
+# NOTE: only doing this in development as some production environments (Heroku)
+# NOTE: are sensitive to local FS writes, and besides -- it's just not proper
+# NOTE: to have a dev-mode tool do its thing in production.
+if Rails.env.development?
+ require "annotate"
+ task :set_annotation_options do
+ # You can override any of these by setting an environment variable of the
+ # same name.
+ Annotate.set_defaults(
+ "active_admin" => "false",
+ "additional_file_patterns" => [],
+ "routes" => "false",
+ "models" => "true",
+ "position_in_routes" => "before",
+ "position_in_class" => "before",
+ "position_in_test" => "before",
+ "position_in_fixture" => "before",
+ "position_in_factory" => "before",
+ "position_in_serializer" => "before",
+ "show_foreign_keys" => "true",
+ "show_complete_foreign_keys" => "false",
+ "show_indexes" => "true",
+ "simple_indexes" => "false",
+ "model_dir" => "app/models",
+ "root_dir" => "",
+ "include_version" => "false",
+ "require" => "",
+ "exclude_tests" => "false",
+ "exclude_fixtures" => "false",
+ "exclude_factories" => "false",
+ "exclude_serializers" => "false",
+ "exclude_scaffolds" => "true",
+ "exclude_controllers" => "true",
+ "exclude_helpers" => "true",
+ "exclude_sti_subclasses" => "false",
+ "ignore_model_sub_dir" => "false",
+ "ignore_columns" => nil,
+ "ignore_routes" => nil,
+ "ignore_unknown_models" => "false",
+ "hide_limit_column_types" => "integer,bigint,boolean",
+ "hide_default_column_types" => "json,jsonb,hstore",
+ "skip_on_db_migrate" => "false",
+ "format_bare" => "true",
+ "format_rdoc" => "false",
+ "format_yard" => "false",
+ "format_markdown" => "false",
+ "sort" => "false",
+ "force" => "false",
+ "frozen" => "false",
+ "classified_sort" => "true",
+ "trace" => "false",
+ "wrapper_open" => nil,
+ "wrapper_close" => nil,
+ "with_comment" => "true"
+ )
+ end
+
+ Annotate.load_tasks
+end
diff --git a/lib/tasks/sync_companies.rake b/lib/tasks/sync_companies.rake
new file mode 100644
index 0000000..07d77e9
--- /dev/null
+++ b/lib/tasks/sync_companies.rake
@@ -0,0 +1,6 @@
+# Runs the relevant methods to update the companies table with the latest data from
+# the California Privacy Protection Agency (CPPA) and DataBrokersWatch.org.
+task sync_companies: :environment do
+ Company.update_california_data_brokers
+ Company.update_data_brokers_watch_companies
+end
diff --git a/public/favicon.ico b/public/favicon.ico
index e69de29..d4e0218 100644
Binary files a/public/favicon.ico and b/public/favicon.ico differ
diff --git a/public/robots.txt b/public/robots.txt
index c19f78a..39ed19c 100644
--- a/public/robots.txt
+++ b/public/robots.txt
@@ -1 +1,27 @@
-# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file
+# Block OpenAI.
+User-agent: GPTBot
+Disallow: /
+
+# Block OpenAI.
+User-agent: ChatGPT-User
+Disallow: /
+
+# Block Google Bard/Gemini.
+User-agent: Google-Extended
+Disallow: /
+
+# Block Common Crawl.
+User-agent: CCBot
+Disallow: /
+
+# Block Anthropic.
+User-agent: anthropic-ai
+Disallow: /
+
+# Block Anthropic.
+User-agent: Claude-Web
+Disallow: /
+
+# Block Facebook.
+User-agent: FacebookBot
+Disallow: /
diff --git a/test/fixtures/companies.yml b/test/fixtures/companies.yml
new file mode 100644
index 0000000..3d96407
--- /dev/null
+++ b/test/fixtures/companies.yml
@@ -0,0 +1,22 @@
+# == Schema Information
+#
+# Table name: companies
+#
+# id :integer not null, primary key
+# category :string not null
+# email :string not null
+# name :string not null
+# website :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
+#
+# Indexes
+#
+# index_companies_on_category (category)
+# index_companies_on_website (website) UNIQUE
+#
+california_data_broker:
+ category: "california_data_broker"
+ email: "test-ca-broker@localhost"
+ name: "Test CA Broker"
+ website: "https://test-ca-broker.localhost"
diff --git a/test/integration/deletion_request_flows_test.rb b/test/integration/deletion_request_flows_test.rb
new file mode 100644
index 0000000..9cf1a42
--- /dev/null
+++ b/test/integration/deletion_request_flows_test.rb
@@ -0,0 +1,45 @@
+class DeletionRequestFlowsTest < ActionDispatch::IntegrationTest
+ test "able to deliver emails for a valid bulk deletion request" do
+ # Creating an extra California data broker company separate from fixtures.
+ Company.create! \
+ category: "california_data_broker",
+ email: "test-ca-broker-2@localhost",
+ name: "Test CA Broker 2",
+ website: "https://test-ca-broker-2.localhost"
+
+ post \
+ bulk_deletion_requests_path,
+ params: {
+ email_subject: "Test deletion request subject",
+ email_body: "Test deletion request body",
+ smtp_provider: "gmail",
+ smtp_username: "test_username",
+ smtp_password: "test_password"
+ }
+
+ # The first email should be delivered immediately to ensure SMTP configuration
+ # is correct.
+ assert_emails 1
+ assert_enqueued_emails 1
+ assert_redirected_to root_path
+ assert_equal "Deletion requests being sent through your SMTP provider. Check your email outbox for confirmation.", flash[:notice]
+
+ # The rest of the emails should be able to be delivered later.
+ perform_enqueued_jobs
+ assert_emails 2
+ end
+
+ test "sets alert flash for invalid requests" do
+ post \
+ bulk_deletion_requests_path,
+ params: {
+ email_subject: "Test deletion request subject",
+ email_body: "Test deletion request body",
+ smtp_provider: "invalid_provider", # INVALID
+ smtp_username: "test_username",
+ smtp_password: "test_password"
+ }
+
+ assert_equal ["Smtp config is missing or invalid"], flash[:alert]
+ end
+end
diff --git a/test/integration/smoke_test.rb b/test/integration/smoke_test.rb
new file mode 100644
index 0000000..4e554ce
--- /dev/null
+++ b/test/integration/smoke_test.rb
@@ -0,0 +1,31 @@
+class SmokeTest < ActionDispatch::IntegrationTest
+ test "home page" do
+ get "/"
+
+ assert_response :success
+ end
+
+ test "about page" do
+ get "/about"
+
+ assert_response :success
+ end
+
+ test "companies page" do
+ get "/companies"
+
+ assert_response :success
+ end
+
+ test "new bulk deletion request page" do
+ get "/bulk_deletion_requests/new?regulation=ccpa"
+
+ assert_response :success
+ end
+
+ test "new bulk deletion request page redirects without regulation" do
+ get "/bulk_deletion_requests/new"
+
+ assert_redirected_to "/"
+ end
+end
diff --git a/test/models/company_test.rb b/test/models/company_test.rb
new file mode 100644
index 0000000..b2c8494
--- /dev/null
+++ b/test/models/company_test.rb
@@ -0,0 +1,78 @@
+# == Schema Information
+#
+# Table name: companies
+#
+# id :integer not null, primary key
+# category :string not null
+# email :string not null
+# name :string not null
+# website :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
+#
+# Indexes
+#
+# index_companies_on_category (category)
+# index_companies_on_website (website) UNIQUE
+#
+class CompanyTest < ActiveSupport::TestCase
+ test "valid object" do
+ company = Company.new \
+ category: "california_data_broker",
+ email: "test-company@localhost",
+ name: "Test Company",
+ website: "https://localhost"
+
+ assert company.valid?
+ end
+
+ test "invalid without a valid category" do
+ company = Company.new \
+ category: "invalid_category",
+ email: "test-company@localhost",
+ name: "Test Company",
+ website: "https://localhost"
+
+ assert company.invalid?
+ end
+
+ test "invalid without a valid email" do
+ company = Company.new \
+ category: "california_data_broker",
+ email: "invalid-email",
+ name: "Test Company",
+ website: "https://localhost"
+
+ assert company.invalid?
+ end
+
+ test "invalid without a name" do
+ company = Company.new \
+ category: "california_data_broker",
+ email: "test-company@localhost",
+ website: "https://localhost"
+
+ assert company.invalid?
+ end
+
+ test "invalid without a website" do
+ company = Company.new \
+ category: "california_data_broker",
+ email: "test-company@localhost",
+ name: "Test Company"
+
+ assert company.invalid?
+ end
+
+ test "#domainify_website! strips www. from website" do
+ company = Company.new \
+ category: "california_data_broker",
+ email: "test-company@localhost",
+ name: "Test Company",
+ website: "https://www.localhost"
+
+ company.domainify_website!
+
+ assert_equal "localhost", company.website
+ end
+end
diff --git a/test/models/deletion_request_test.rb b/test/models/deletion_request_test.rb
new file mode 100644
index 0000000..f984730
--- /dev/null
+++ b/test/models/deletion_request_test.rb
@@ -0,0 +1,164 @@
+class DeletionRequestTest < ActiveSupport::TestCase
+ test "valid object" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "Test deletion request body"
+
+ assert deletion_request.valid?
+ end
+
+ test "invalid without a valid company" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: Company.new,
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "Test deletion request body"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid without a valid SMTP config" do
+ smtp_config = SmtpConfig.new \
+ provider: "invalid_provider",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "Test deletion request body"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid without an email subject" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_body: "Test deletion request body"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid without an email body" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid with full name token still remaining" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "[YOUR FULL NAME]"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid with full address token still remaining" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "[YOUR FULL ADDRESS]"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid with email addresses token still remaining" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "[YOUR EMAIL ADDRESS(ES)]"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid with phone numbers token still remaining" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "[YOUR PHONE NUMBER(S)]"
+
+ assert deletion_request.invalid?
+ end
+
+ test "invalid with signature name token still remaining" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "[YOUR SIGNATURE NAME]"
+
+ assert deletion_request.invalid?
+ end
+
+ test "#interpolated_email_body returns expected output" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ deletion_request = DeletionRequest.new \
+ company: companies(:california_data_broker),
+ smtp_config: smtp_config,
+ email_subject: "Test deletion request subject",
+ email_body: "Hello {COMPANY NAME}"
+
+ assert_equal "Hello Test CA Broker", deletion_request.interpolated_email_body
+ end
+end
diff --git a/test/models/smtp_config_test.rb b/test/models/smtp_config_test.rb
new file mode 100644
index 0000000..f24c64a
--- /dev/null
+++ b/test/models/smtp_config_test.rb
@@ -0,0 +1,53 @@
+class SmtpConfigTest < ActiveSupport::TestCase
+ test "valid object" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ assert smtp_config.valid?
+ end
+
+ test "invalid without a valid provider" do
+ smtp_config = SmtpConfig.new \
+ provider: "invalid_provider",
+ username: "test_username",
+ password: "test_password"
+
+ assert smtp_config.invalid?
+ end
+
+ test "invalid without username" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ password: "test_password"
+
+ assert smtp_config.invalid?
+ end
+
+ test "invalid without password" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username"
+
+ assert smtp_config.invalid?
+ end
+
+ test "#address" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ assert_equal "smtp.gmail.com", smtp_config.address
+ end
+
+ test "#port" do
+ smtp_config = SmtpConfig.new \
+ provider: "gmail",
+ username: "test_username",
+ password: "test_password"
+
+ assert_equal 587, smtp_config.port
+ end
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
index 0c22470..f2a4bda 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -1,3 +1,8 @@
+require "simplecov"
+SimpleCov.start "rails" do
+ add_filter "app/channels"
+end
+
ENV["RAILS_ENV"] ||= "test"
require_relative "../config/environment"
require "rails/test_help"
@@ -7,6 +12,10 @@ class TestCase
# Run tests in parallel with specified workers
parallelize(workers: :number_of_processors)
+ # Get parallel tests to play nice with SimpleCov.
+ parallelize_setup { |worker| SimpleCov.command_name("\#{SimpleCov.command_name}-\#{worker}") }
+ parallelize_teardown { |worker| SimpleCov.result }
+
# Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
fixtures :all