require "gds_api/test_helpers/json_client_helper"
require "json"
module GdsApi
module TestHelpers
module EmailAlertApi
EMAIL_ALERT_API_ENDPOINT = Plek.find("email-alert-api")
def stub_email_alert_api_has_updated_subscriber(id, new_address)
stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
.to_return(
status: 200,
body: get_subscriber_response(id, new_address).to_json,
)
end
def stub_email_alert_api_does_not_have_updated_subscriber(id)
stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
.to_return(status: 404)
end
def stub_email_alert_api_invalid_update_subscriber(id)
stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
.to_return(status: 422)
end
def stub_email_alert_api_has_updated_subscription(subscription_id, frequency)
stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{subscription_id}")
.to_return(
status: 200,
body: get_subscription_response(subscription_id, frequency: frequency).to_json,
)
end
def stub_email_alert_api_does_not_have_updated_subscription(subscription_id)
stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{subscription_id}")
.to_return(status: 404)
end
def stub_email_alert_api_has_subscriber_subscriptions(id, address, order = nil, subscriptions: nil)
params = order ? "?order=#{order}" : ""
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions#{params}")
.to_return(
status: 200,
body: get_subscriber_subscriptions_response(id, address, subscriptions: subscriptions).to_json,
)
end
def stub_email_alert_api_does_not_have_subscriber_subscriptions(id)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions")
.to_return(status: 404)
end
def stub_email_alert_api_has_subscription(
id,
frequency,
title: "Some title",
subscriber_id: 1,
subscriber_list_id: 1000,
ended: false
)
response = get_subscription_response(
id,
frequency: frequency,
title: title,
subscriber_id: subscriber_id,
subscriber_list_id: subscriber_list_id,
ended: ended,
).to_json
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}")
.to_return(status: 200, body: response)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}/latest")
.to_return(status: 200, body: response)
end
# Stubs the API responses as if each subscription happened in the order they are passed.
# Useful if you need to query the '/latest' endpoint of a subscription.
# Takes an array of hashes.
#
# @example
# stub_email_alert_api_has_subscriptions([
# {
# id: 'id-of-my-subscriber-list',
# frequency: 'weekly',
# ended: true,
# },
# {
# id: 'id-of-my-subscriber-list',
# frequency: 'daily',
# },
# ])
#
# @param subscriptions [Array]
def stub_email_alert_api_has_subscriptions(subscriptions)
subscriptions.map! { |subscription| apply_subscription_defaults(subscription) }
subscriptions.each do |id, params|
latest_id, latest_params = get_latest_matching(params, subscriptions)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}")
.to_return(status: 200, body: get_subscription_response(id, **params).to_json)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}/latest")
.to_return(status: 200, body: get_subscription_response(latest_id, **latest_params).to_json)
end
end
def apply_subscription_defaults(subscription)
parameters = {
title: "Some title",
subscriber_id: 1,
subscriber_list_id: 1000,
ended: true,
}.merge(subscription)
# Strip out ID as subsequent call to `get_subscription_response` throws `ArgumentError`
id = parameters.delete(:id)
[id, parameters]
end
def get_latest_matching(params, subscriptions)
matching = subscriptions.select do |_current_id, current_params|
params[:subscriber_id] == current_params[:subscriber_id] &&
params[:subscriber_list_id] == current_params[:subscriber_list_id]
end
matching.last
end
def stub_email_alert_api_creates_subscriber_list(attributes)
stub_request(:post, build_subscriber_lists_url)
.to_return(
status: 201,
body: get_subscriber_list_response(attributes).to_json,
)
end
def stub_email_alert_api_has_subscriber_list(attributes)
stub_request(:get, build_subscriber_lists_url(attributes))
.to_return(
status: 200,
body: get_subscriber_list_response(attributes).to_json,
)
end
def stub_email_alert_api_does_not_have_subscriber_list(attributes)
stub_request(:get, build_subscriber_lists_url(attributes))
.to_return(status: 404)
end
def stub_email_alert_api_refuses_to_create_subscriber_list
stub_request(:post, build_subscriber_lists_url)
.to_return(status: 422)
end
def stub_email_alert_api_accepts_content_change
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/content-changes")
.to_return(status: 202, body: {}.to_json)
end
def stub_email_alert_api_accepts_message
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/messages")
.to_return(status: 202, body: {}.to_json)
end
def stub_email_alert_api_accepts_email
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/emails")
.to_return(status: 202, body: {}.to_json)
end
def stub_any_email_alert_api_call
stub_request(:any, %r{\A#{EMAIL_ALERT_API_ENDPOINT}})
end
def assert_email_alert_api_content_change_created(attributes = nil)
if attributes
matcher = lambda do |request|
payload = JSON.parse(request.body)
payload.select { |k, _| attributes.key?(k) } == attributes
end
end
assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/content-changes", times: 1, &matcher)
end
def assert_email_alert_api_message_created(attributes = nil)
if attributes
matcher = lambda do |request|
payload = JSON.parse(request.body)
payload.select { |k, _| attributes.key?(k) } == attributes
end
end
assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/messages", times: 1, &matcher)
end
def stub_email_alert_api_unsubscribes_a_subscription(uuid)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}")
.with(body: "{}")
.to_return(status: 204)
end
def stub_email_alert_api_has_no_subscription_for_uuid(uuid)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}")
.with(body: "{}")
.to_return(status: 404)
end
def stub_email_alert_api_unsubscribes_a_subscriber(subscriber_id)
stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}")
.to_return(status: 204)
end
def stub_email_alert_api_has_no_subscriber(subscriber_id)
stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}")
.to_return(status: 404)
end
def stub_email_alert_api_creates_a_subscription(
subscriber_list_id: nil,
address: nil,
frequency: nil,
returned_subscription_id: nil,
skip_confirmation_email: false,
subscriber_id: nil
)
response = get_subscription_response(
returned_subscription_id,
frequency: frequency,
subscriber_list_id: subscriber_list_id,
subscriber_id: subscriber_id,
)
request_params = {
subscriber_list_id: subscriber_list_id,
address: address,
frequency: frequency,
skip_confirmation_email: skip_confirmation_email,
}
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
.with(body: hash_including(request_params.compact))
.to_return(status: 200, body: response.to_json)
end
def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
.with(
body: hash_including(
subscriber_list_id: subscriber_list_id,
address: address,
frequency: frequency,
),
).to_return(status: 422)
end
def stub_email_alert_api_sends_subscription_verification_email(address, frequency, topic_id)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/auth-token")
.with(
body: { address: address, frequency: frequency, topic_id: topic_id }.to_json,
).to_return(status: 200)
end
def stub_email_alert_api_subscription_verification_email_invalid(address, frequency, topic_id)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/auth-token")
.with(
body: { address: address, frequency: frequency, topic_id: topic_id }.to_json,
).to_return(status: 422)
end
def stub_email_alert_api_sends_subscriber_verification_email(subscriber_id, address)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
.to_return(
status: 201,
body: get_subscriber_response(subscriber_id, address).to_json,
)
end
def stub_email_alert_api_subscriber_verification_email_invalid
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
.to_return(status: 422)
end
def stub_email_alert_api_subscriber_verification_email_no_subscriber
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
.to_return(status: 404)
end
def stub_email_alert_api_authenticate_subscriber_by_govuk_account(govuk_account_session, subscriber_id, address, new_govuk_account_session: nil)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
.with(
body: { govuk_account_session: govuk_account_session }.to_json,
).to_return(
status: 200,
body: {
govuk_account_session: new_govuk_account_session,
}.compact.merge(get_subscriber_response(subscriber_id, address)).to_json,
)
end
def stub_email_alert_api_authenticate_subscriber_by_govuk_account_session_invalid(govuk_account_session)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
.with(
body: { govuk_account_session: govuk_account_session }.to_json,
).to_return(
status: 401,
)
end
def stub_email_alert_api_authenticate_subscriber_by_govuk_account_email_unverified(govuk_account_session, new_govuk_account_session: nil)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
.with(
body: { govuk_account_session: govuk_account_session }.to_json,
).to_return(
status: 403,
body: {
govuk_account_session: new_govuk_account_session,
}.compact.to_json,
)
end
def stub_email_alert_api_authenticate_subscriber_by_govuk_account_no_subscriber(govuk_account_session, new_govuk_account_session: nil)
stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
.with(
body: { govuk_account_session: govuk_account_session }.to_json,
).to_return(
status: 404,
body: {
govuk_account_session: new_govuk_account_session,
}.compact.to_json,
)
end
def assert_unsubscribed(uuid)
assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}", times: 1)
end
def assert_subscribed(subscriber_list_id, address, frequency = "immediately")
assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") do |req|
JSON.parse(req.body).symbolize_keys == {
subscriber_list_id: subscriber_list_id,
address: address,
frequency: frequency,
}
end
end
def stub_email_alert_api_has_subscriber_list_by_slug(slug:, returned_attributes:)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
.to_return(
status: 200,
body: {
subscriber_list: returned_attributes,
}.to_json,
)
end
def stub_email_alert_api_does_not_have_subscriber_list_by_slug(slug:)
stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}")
.to_return(status: 404)
end
private
def get_subscriber_response(id, address)
{
"subscriber" => {
"id" => id,
"address" => address,
},
}
end
def get_subscription_response(
id,
frequency: "daily",
title: "Some title",
subscriber_id: 1,
subscriber_list_id: 1000,
ended: false
)
{
"subscription" => {
"id" => id,
"frequency" => frequency,
"source" => "user_signed_up",
"ended_at" => ended ? Time.now.iso8601 : nil,
"ended_reason" => ended ? "unsubscribed" : nil,
"subscriber" => {
"id" => subscriber_id,
"address" => "test@example.com",
},
"subscriber_list" => {
"id" => subscriber_list_id,
"slug" => "some-thing",
"title" => title,
},
},
}
end
def get_subscriber_subscriptions_response(id, address, subscriptions:)
{
"subscriber" => {
"id" => id,
"address" => address,
},
"subscriptions" => subscriptions || [
{
"subscriber_id" => 1,
"subscriber_list_id" => 1000,
"frequency" => "daily",
"id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
"subscriber_list" => {
"id" => 1000,
"slug" => "some-thing",
},
},
],
}
end
def get_subscriber_list_response(attributes)
{
"subscriber_list" => {
"id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
"title" => "Some title",
"active_subscriptions_count" => 42,
}.merge(attributes),
}
end
def post_alert_response
{}
end
def build_subscriber_lists_url(attributes = nil)
if attributes
tags = attributes["tags"]
links = attributes["links"]
document_type = attributes["document_type"]
email_document_supertype = attributes["email_document_supertype"]
government_document_supertype = attributes["government_document_supertype"]
content_purpose_supergroup = attributes["content_purpose_supergroup"]
combine_mode = attributes["combine_mode"]
params = {}
params[:tags] = tags if tags
params[:links] = links if links
params[:document_type] = document_type if document_type
params[:email_document_supertype] = email_document_supertype if email_document_supertype
params[:government_document_supertype] = government_document_supertype if government_document_supertype
params[:content_purpose_supergroup] = content_purpose_supergroup if content_purpose_supergroup
params[:combine_mode] = combine_mode if combine_mode
query = Rack::Utils.build_nested_query(params)
end
url = "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists"
query ? "#{url}?#{query}" : url
end
end
end
end