Module: GdsApi::TestHelpers::EmailAlertApi
- Defined in:
- lib/gds_api/test_helpers/email_alert_api.rb
Constant Summary collapse
- EMAIL_ALERT_API_ENDPOINT =
Plek.find("email-alert-api")
Instance Method Summary collapse
- #assert_email_alert_sent(attributes = nil) ⇒ Object
- #assert_subscribed(subscribable_id, address, frequency = "immediately") ⇒ Object
- #assert_unsubscribed(uuid) ⇒ Object
- #email_alert_api_accepts_alert ⇒ Object
- #email_alert_api_accepts_unpublishing_message ⇒ Object
- #email_alert_api_creates_a_subscription(subscribable_id, address, frequency, returned_subscription_id) ⇒ Object
- #email_alert_api_creates_an_auth_token(subscriber_id, address) ⇒ Object
- #email_alert_api_creates_an_existing_subscription(subscribable_id, address, frequency, returned_subscription_id) ⇒ Object
- #email_alert_api_creates_subscriber_list(attributes) ⇒ Object
- #email_alert_api_does_not_have_subscribable(reference:) ⇒ Object
- #email_alert_api_does_not_have_subscriber_list(attributes) ⇒ Object
- #email_alert_api_does_not_have_subscriber_subscriptions(id) ⇒ Object
- #email_alert_api_does_not_have_updated_subscriber(id) ⇒ Object
- #email_alert_api_does_not_have_updated_subscription(subscription_id) ⇒ Object
- #email_alert_api_has_no_subscriber(subscriber_id) ⇒ Object
- #email_alert_api_has_no_subscription_for_uuid(uuid) ⇒ Object
- #email_alert_api_has_notification(notification) ⇒ Object
- #email_alert_api_has_notifications(notifications, start_at = nil) ⇒ Object
- #email_alert_api_has_subscribable(reference:, returned_attributes:) ⇒ Object
- #email_alert_api_has_subscriber_list(attributes) ⇒ Object
- #email_alert_api_has_subscriber_subscriptions(id, address) ⇒ Object
- #email_alert_api_has_subscription(id, frequency, title: "Some title", subscriber_id: 1, subscriber_list_id: 1000, ended: false) ⇒ Object
- #email_alert_api_has_updated_subscriber(id, new_address) ⇒ Object
- #email_alert_api_has_updated_subscription(subscription_id, frequency) ⇒ Object
- #email_alert_api_refuses_to_create_subscriber_list ⇒ Object
- #email_alert_api_refuses_to_create_subscription(subscribable_id, address, frequency) ⇒ Object
- #email_alert_api_unsubscribes_a_subscriber(subscriber_id) ⇒ Object
- #email_alert_api_unsubscribes_a_subscription(uuid) ⇒ Object
- #stub_any_email_alert_api_call ⇒ Object
Instance Method Details
#assert_email_alert_sent(attributes = nil) ⇒ Object
110 111 112 113 114 115 116 117 118 119 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 110 def assert_email_alert_sent(attributes = nil) if attributes matcher = ->(request) do payload = JSON.parse(request.body) payload.select { |k, _| attributes.key?(k) } == attributes end end assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/notifications", times: 1, &matcher) end |
#assert_subscribed(subscribable_id, address, frequency = "immediately") ⇒ Object
197 198 199 200 201 202 203 204 205 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 197 def assert_subscribed(subscribable_id, address, frequency = "immediately") assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") do |req| JSON.parse(req.body).symbolize_keys == { subscribable_id: subscribable_id, address: address, frequency: frequency } end end |
#assert_unsubscribed(uuid) ⇒ Object
193 194 195 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 193 def assert_unsubscribed(uuid) assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}", times: 1) end |
#email_alert_api_accepts_alert ⇒ Object
101 102 103 104 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 101 def email_alert_api_accepts_alert stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/notifications") .to_return(status: 202, body: {}.to_json) end |
#email_alert_api_accepts_unpublishing_message ⇒ Object
96 97 98 99 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 96 def stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unpublish-messages") .to_return(status: 202, body: {}.to_json) end |
#email_alert_api_creates_a_subscription(subscribable_id, address, frequency, returned_subscription_id) ⇒ Object
164 165 166 167 168 169 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 164 def email_alert_api_creates_a_subscription(subscribable_id, address, frequency, returned_subscription_id) stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") .with( body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json) end |
#email_alert_api_creates_an_auth_token(subscriber_id, address) ⇒ Object
185 186 187 188 189 190 191 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 185 def email_alert_api_creates_an_auth_token(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 |
#email_alert_api_creates_an_existing_subscription(subscribable_id, address, frequency, returned_subscription_id) ⇒ Object
171 172 173 174 175 176 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 171 def email_alert_api_creates_an_existing_subscription(subscribable_id, address, frequency, returned_subscription_id) stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") .with( body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json) end |
#email_alert_api_creates_subscriber_list(attributes) ⇒ Object
83 84 85 86 87 88 89 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 83 def 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 |
#email_alert_api_does_not_have_subscribable(reference:) ⇒ Object
217 218 219 220 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 217 def email_alert_api_does_not_have_subscribable(reference:) stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}") .to_return(status: 404) end |
#email_alert_api_does_not_have_subscriber_list(attributes) ⇒ Object
78 79 80 81 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 78 def email_alert_api_does_not_have_subscriber_list(attributes) stub_request(:get, build_subscriber_lists_url(attributes)) .to_return(status: 404) end |
#email_alert_api_does_not_have_subscriber_subscriptions(id) ⇒ Object
43 44 45 46 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 43 def email_alert_api_does_not_have_subscriber_subscriptions(id) stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions") .to_return(status: 404) end |
#email_alert_api_does_not_have_updated_subscriber(id) ⇒ Object
17 18 19 20 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 17 def email_alert_api_does_not_have_updated_subscriber(id) stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}") .to_return(status: 404) end |
#email_alert_api_does_not_have_updated_subscription(subscription_id) ⇒ Object
30 31 32 33 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 30 def 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 |
#email_alert_api_has_no_subscriber(subscriber_id) ⇒ Object
159 160 161 162 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 159 def email_alert_api_has_no_subscriber(subscriber_id) stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}") .to_return(status: 404) end |
#email_alert_api_has_no_subscription_for_uuid(uuid) ⇒ Object
148 149 150 151 152 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 148 def 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 |
#email_alert_api_has_notification(notification) ⇒ Object
133 134 135 136 137 138 139 140 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 133 def email_alert_api_has_notification(notification) url = "#{EMAIL_ALERT_API_ENDPOINT}/notifications/#{notification['web_service_bulletin']['to_param']}" stub_request(:get, url).to_return( status: 200, body: notification.to_json ) end |
#email_alert_api_has_notifications(notifications, start_at = nil) ⇒ Object
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 121 def email_alert_api_has_notifications(notifications, start_at = nil) url = "#{EMAIL_ALERT_API_ENDPOINT}/notifications" url += "?start_at=#{start_at}" if start_at url_regexp = Regexp.new("^#{Regexp.escape(url)}$") stub_request(:get, url_regexp) .to_return( status: 200, body: notifications.to_json ) end |
#email_alert_api_has_subscribable(reference:, returned_attributes:) ⇒ Object
207 208 209 210 211 212 213 214 215 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 207 def email_alert_api_has_subscribable(reference:, returned_attributes:) stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribables/#{reference}") .to_return( status: 200, body: { subscribable: returned_attributes }.to_json ) end |
#email_alert_api_has_subscriber_list(attributes) ⇒ Object
70 71 72 73 74 75 76 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 70 def 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 |
#email_alert_api_has_subscriber_subscriptions(id, address) ⇒ Object
35 36 37 38 39 40 41 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 35 def email_alert_api_has_subscriber_subscriptions(id, address) stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}/subscriptions") .to_return( status: 200, body: get_subscriber_subscriptions_response(id, address).to_json, ) end |
#email_alert_api_has_subscription(id, frequency, title: "Some title", subscriber_id: 1, subscriber_list_id: 1000, ended: false) ⇒ Object
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 48 def email_alert_api_has_subscription( id, frequency, title: "Some title", subscriber_id: 1, subscriber_list_id: 1000, ended: false ) stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}") .to_return( status: 200, body: get_subscription_response( id, frequency: frequency, title: title, subscriber_id: subscriber_id, subscriber_list_id: subscriber_list_id, ended: ended, ).to_json, ) end |
#email_alert_api_has_updated_subscriber(id, new_address) ⇒ Object
9 10 11 12 13 14 15 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 9 def 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 |
#email_alert_api_has_updated_subscription(subscription_id, frequency) ⇒ Object
22 23 24 25 26 27 28 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 22 def 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 |
#email_alert_api_refuses_to_create_subscriber_list ⇒ Object
91 92 93 94 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 91 def email_alert_api_refuses_to_create_subscriber_list stub_request(:post, build_subscriber_lists_url) .to_return(status: 422) end |
#email_alert_api_refuses_to_create_subscription(subscribable_id, address, frequency) ⇒ Object
178 179 180 181 182 183 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 178 def email_alert_api_refuses_to_create_subscription(subscribable_id, address, frequency) stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions") .with( body: { subscribable_id: subscribable_id, address: address, frequency: frequency }.to_json ).to_return(status: 422) end |
#email_alert_api_unsubscribes_a_subscriber(subscriber_id) ⇒ Object
154 155 156 157 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 154 def email_alert_api_unsubscribes_a_subscriber(subscriber_id) stub_request(:delete, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{subscriber_id}") .to_return(status: 204) end |
#email_alert_api_unsubscribes_a_subscription(uuid) ⇒ Object
142 143 144 145 146 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 142 def email_alert_api_unsubscribes_a_subscription(uuid) stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}") .with(body: "{}") .to_return(status: 204) end |
#stub_any_email_alert_api_call ⇒ Object
106 107 108 |
# File 'lib/gds_api/test_helpers/email_alert_api.rb', line 106 def stub_any_email_alert_api_call stub_request(:any, %r{\A#{EMAIL_ALERT_API_ENDPOINT}}) end |