Hide state action behind feature flag

The Civic API is going to be shut down in a week or two. We need to remove
the corresponding code and decide on if/how to move forward with a new service
that provides representative info.

In meantime this turns off the state level actions from the user interface
(public and admin) and returns a 404 from the corresponding endpoint in the
tools controller when STATE_ACTIONS_ENABLED is unset.

In the future, we can swap out the backend logic and reenable by setting
the env var to true.

Author: hartsick

.env.example

@@ -80,6 +80,9 @@ unthrottled_ips=
 # Analytics
 MATOMO_SITE_ID=
 
+# Feature flags
+STATE_ACTIONS_ENABLED=true
+
 #
 # End of application environment variables
 #

app/controllers/tools_controller.rb

@@ -127,6 +127,8 @@ def email
   # This endpoint is hit by the js for state legislator lookup-by-address actions.
   # It renders json containing html markup for presentation on the view
   def state_reps
+    raise ActionController::RoutingError.new("Not Found") unless Rails.application.config.state_actions_enabled
+
     @email_campaign = EmailCampaign.find(params[:email_campaign_id])
     @actionPage = @email_campaign.action_page
     # TODO: strong params this

app/views/admin/action_pages/_email_fields.html.erb

@@ -10,30 +10,32 @@
     <%= sf.text_area :message %>
   </div>
 
-  <fieldset class="form-item">
-    <legend>Select State-Level Legislators</legend>
+  <% if Rails.application.config.state_actions_enabled %>
+    <fieldset class="form-item">
+      <legend>Select State-Level Legislators</legend>
 
-    <%= sf.label :state, class: "fancy" do %>
-      <%= sf.select :state, options_for_select(EmailCampaign::STATES, @actionPage.email_campaign.state), include_blank: "- none -" %><span class="ui"></span>
-    <% end %>
-
-    <div id="state-level-target-selection">
-      <p>For now, please choose only one.</p>
-      <%= sf.label :target_state_lower_chamber do %>
-        <%= sf.check_box :target_state_lower_chamber, class: "fancy" %><span class="ui"></span>
-        Lower Chamber
-      <% end %>
-
-      <%= sf.label :target_state_upper_chamber do %>
-        <%= sf.check_box :target_state_upper_chamber, class: "fancy" %><span class="ui"></span>
-        Upper Chamber
+      <%= sf.label :state, class: "fancy" do %>
+        <%= sf.select :state, options_for_select(EmailCampaign::STATES, @actionPage.email_campaign.state), include_blank: "- none -" %><span class="ui"></span>
       <% end %>
 
-      <%= sf.label :target_governor do %>
-        <%= sf.check_box :target_governor, class: "fancy" %><span class="ui"></span>
-        Governor
-      <% end %>
-    </div>
+      <div id="state-level-target-selection">
+        <p>For now, please choose only one.</p>
+        <%= sf.label :target_state_lower_chamber do %>
+          <%= sf.check_box :target_state_lower_chamber, class: "fancy" %><span class="ui"></span>
+          Lower Chamber
+        <% end %>
+
+        <%= sf.label :target_state_upper_chamber do %>
+          <%= sf.check_box :target_state_upper_chamber, class: "fancy" %><span class="ui"></span>
+          Upper Chamber
+        <% end %>
+
+        <%= sf.label :target_governor do %>
+          <%= sf.check_box :target_governor, class: "fancy" %><span class="ui"></span>
+          Governor
+        <% end %>
+      </div>
+    <% end %>
 
     <br></br>
 

app/views/tools/_container.html.erb

@@ -7,7 +7,7 @@
     <%= render "tools/petition" if @actionPage.enable_petition? && @actionPage.petition %>
     <%= render "tools/call" if @actionPage.enable_call? && @actionPage.call_campaign %>
     <% if @actionPage.enable_email? && @actionPage.email_campaign %>
-      <% if @actionPage.email_campaign.state? %>
+      <% if Rails.application.config.state_actions_enabled && @actionPage.email_campaign.state? %>
         <%= render "tools/state_leg_email" %>
       <% else %>
         <%= render "tools/email" %>

config/application.rb

@@ -45,6 +45,6 @@ class Application < Rails::Application
     config.congress_forms_url = Rails.application.secrets.congress_forms_url
     config.google_civic_api_url = Rails.application.secrets.google_civic_api_url
     config.time_zone = Rails.application.secrets.time_zone || "Eastern Time (US & Canada)"
-
+    config.state_actions_enabled = Rails.application.secrets.state_actions_enabled
   end
 end

spec/requests/tools_spec.rb

@@ -21,17 +21,23 @@
   let!(:headers) { { "CONTENT_TYPE" => "application/javascript" } }
 
   describe "POST tools/state_reps" do
-    it "returns json containing rep data for a given address" do
-      civic_api = class_double("CivicApi")
-        .as_stubbed_const(transfer_nested_constants: true)
-      allow(civic_api).to receive(:state_rep_search)
-        .with(address, campaign.leg_level)
-        .and_return(officials)
+    context "when state actions enabled" do
+      before do
+        allow(Rails.application.config).to receive(:state_actions_enabled) { "true" }
+      end
 
-      post "/tools/state_reps", params: params, xhr: true
+      it "returns json containing rep data for a given address" do
+        civic_api = class_double("CivicApi")
+          .as_stubbed_const(transfer_nested_constants: true)
+        allow(civic_api).to receive(:state_rep_search)
+          .with(address, campaign.leg_level)
+          .and_return(officials)
 
-      expect(response).to have_http_status(200)
-      expect(response.body).to include(officials.first["name"])
+        post "/tools/state_reps", params: params, xhr: true
+
+        expect(response).to have_http_status(200)
+        expect(response.body).to include(officials.first["name"])
+      end
     end
   end
 end

spec/system/action_pages/state_leg_email_action_spec.rb

@@ -17,6 +17,8 @@
   before do
     stub_request(:get, "https://civic.example.com/?address=815%20Eddy%20St%2094109&includeOffices=true&key=test-key-for-civic-api&levels=administrativeArea1&roles=legislatorUpperBody")
       .to_return(status: 200, body: data.to_json, headers: {})
+
+    allow(Rails.application.config).to receive(:state_actions_enabled) { "true" }
   end
 
   it "allows vistors to see look up their representatives" do