Move set up to a job

OAuth requires the callback to be a GET request, by moving it a Job we can avoid a write from a GET request

Author: monorkin

app/controllers/integrations/basecamps/callbacks_controller.rb

@@ -3,6 +3,6 @@ class Integrations::Basecamps::CallbacksController < ApplicationController
   allow_unauthenticated_access
 
   def show
-    Integration::Basecamp.set_up(code: params[:code], state: params[:state])
+    Integration::Basecamp.set_up_later(code: params[:code], state: params[:state])
   end
 end

app/jobs/integration/basecamp/set_up_job.rb

@@ -0,0 +1,5 @@
+class Integration::Basecamp::SetUpJob < ApplicationJob
+  def perform(code:, state:)
+    Integration::Basecamp.set_up(code: code, state: state)
+  end
+end

app/models/integration/basecamp.rb

@@ -5,6 +5,10 @@ class Integration::Basecamp < Integration
   store_accessor :data, :access_token, :refresh_token
 
   class << self
+    def set_up_later(code:, state:)
+      Integration::Basecamp::SetUpJob.perform_later(code: code, state: state)
+    end
+
     def set_up(code:, state:)
       with_tenant_from_state(state) do
         integration = locate_by_state(state)

test/controllers/integrations/basecamps/callbacks_controller_test.rb

@@ -10,7 +10,7 @@ class Integrations::Basecamps::CallbacksControllerTest < ActionDispatch::Integra
     Rails.application.config.action_controller.default_url_options = @original_url_options
   end
 
-  test "show sets up integration with code and state" do
+  test "show enqueues job to set up integration" do
     integration = integrations(:kevins_basecamp)
     integration.update!(data: {})
 
@@ -19,24 +19,11 @@ class Integrations::Basecamps::CallbacksControllerTest < ActionDispatch::Integra
       for: Integration::Basecamp::AUTH_URL_STATE_PURPOSE
     ).to_s
 
-    credentials = Rails.application.credentials.integrations.basecamp
-    oauth_server_url = credentials[:oauth_server_url]
-
-    stub_request(:post, "#{oauth_server_url}/authorization/token")
-      .to_return(
-        status: 200,
-        body: {
-          access_token: "new_access_token",
-          refresh_token: "new_refresh_token"
-        }.to_json,
-        headers: { "Content-Type" => "application/json" }
-      )
-
-    get basecamp_integration_callback_path, params: { code: "test_code", state: state }
+    assert_enqueued_with(job: Integration::Basecamp::SetUpJob, args: [{ code: "test_code", state: state }]) do
+      get basecamp_integration_callback_path, params: { code: "test_code", state: state }
+    end
 
     assert_response :success
-    assert integration.reload.setup?
-    assert_equal "new_access_token", integration.access_token
-    assert_equal "new_refresh_token", integration.refresh_token
   end
-end
+end
+

test/controllers/integrations/basecamps_controller_test.rb

@@ -17,13 +17,23 @@ class Integrations::BasecampsControllerTest < ActionDispatch::IntegrationTest
   end
 
   test "create" do
+    sign_in_as :kevin
+
+    assert_no_difference "Integration::Basecamp.count" do
+      post basecamp_integration_path
+    end
+
+    assert_response :success, "Renders the 'integration already setup' screen"
+
+    users(:kevin).integrations.delete_all
+
     assert_difference "Integration::Basecamp.count", 1 do
       post basecamp_integration_path
     end
 
     integration = Integration::Basecamp.last
     assert_equal users(:kevin), integration.owner
-    assert_response :redirect
+    assert_response :redirect, "Redirects to launchpad"
     assert_match %r{launchpad\.localhost:3011/authorization/new}, response.redirect_url
   end
 end

test/models/integration/basecamp_test.rb

@@ -0,0 +1,99 @@
+require "test_helper"
+
+class Integration::BasecampTest < ActiveSupport::TestCase
+  setup do
+    @integration = integrations(:kevins_basecamp)
+    @original_url_options = Rails.application.config.action_controller.default_url_options
+    Rails.application.config.action_controller.default_url_options = { host: "example.com" }
+  end
+
+  teardown do
+    Rails.application.config.action_controller.default_url_options = @original_url_options
+  end
+
+  test "setup?" do
+    assert @integration.setup?
+
+    @integration.access_token = nil
+    @integration.refresh_token = nil
+
+    assert_not @integration.setup?
+  end
+
+  test "authorization_url" do
+    url = @integration.authorization_url
+
+    assert_match %r{launchpad\.localhost:3011/authorization/new}, url
+    assert_match(/client_id=/, url)
+    assert_match(/redirect_uri=/, url)
+    assert_match(/state=/, url)
+    assert_match(/type=web_server/, url)
+  end
+
+  test "refresh_tokens" do
+    credentials = Rails.application.credentials.integrations.basecamp
+
+    stub_request(:post, "#{credentials[:oauth_server_url]}/authorization/token")
+      .to_return(
+        status: 200,
+        body: { access_token: "refreshed_access_token" }.to_json,
+        headers: { "Content-Type" => "application/json" }
+      )
+
+    @integration.refresh_tokens
+
+    assert_equal "refreshed_access_token", @integration.access_token
+
+    @integration.update!(data: { access_token: "original_token" })
+    @integration.refresh_tokens
+    assert_equal "original_token", @integration.reload.access_token
+  end
+
+  test "set_up_later" do
+    state = @integration.to_sgid(
+      expires_in: Integration::Basecamp::AUTH_URL_STATE_EXPIRATION,
+      for: Integration::Basecamp::AUTH_URL_STATE_PURPOSE
+    ).to_s
+
+    assert_enqueued_with(job: Integration::Basecamp::SetUpJob, args: [ { code: "code", state: state } ]) do
+      Integration::Basecamp.set_up_later(code: "code", state: state)
+    end
+  end
+
+  test "set_up" do
+    @integration.update!(data: {})
+    credentials = Rails.application.credentials.integrations.basecamp
+
+    state = @integration.to_sgid(
+      expires_in: Integration::Basecamp::AUTH_URL_STATE_EXPIRATION,
+      for: Integration::Basecamp::AUTH_URL_STATE_PURPOSE
+    ).to_s
+
+    stub_request(:post, "#{credentials[:oauth_server_url]}/authorization/token")
+      .to_return(
+        status: 200,
+        body: {
+          access_token: "new_access_token",
+          refresh_token: "new_refresh_token"
+        }.to_json,
+        headers: { "Content-Type" => "application/json" }
+      )
+
+    Integration::Basecamp.set_up(code: "code", state: state)
+
+    assert @integration.reload.setup?
+    assert_equal "new_access_token", @integration.access_token
+    assert_equal "new_refresh_token", @integration.refresh_token
+
+    state = @integration.to_sgid(
+      expires_in: Integration::Basecamp::AUTH_URL_STATE_EXPIRATION,
+      for: Integration::Basecamp::AUTH_URL_STATE_PURPOSE
+    ).to_s
+
+    original_access_token = @integration.access_token
+
+    Integration::Basecamp.set_up(code: "code", state: state)
+
+    assert_equal original_access_token, @integration.reload.access_token, "Set up is skipped if the integration already is setup"
+  end
+end