defra_ruby_email 1.0.0 → 1.1.0

data/spec/examples.txt

@@ -0,0 +1,38 @@
+example_id                                         | status | run_time        |
+-------------------------------------------------- | ------ | --------------- |
+./spec/defra_ruby_email_spec.rb[1:1:1]             | passed | 0.00413 seconds |
+./spec/defra_ruby_email_spec.rb[1:2:1:1]           | passed | 0.00548 seconds |
+./spec/defra_ruby_email_spec.rb[1:2:2:1]           | passed | 0.00015 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:1:1]       | passed | 0.00025 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:1:2]       | passed | 0.00016 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:2:1:1]     | passed | 0.006 seconds   |
+./spec/lib/last_email_cache_spec.rb[1:1:2:1:2]     | passed | 0.00465 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:2:1:3]     | passed | 0.16939 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:2:2:1]     | passed | 0.00418 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:2:2:2]     | passed | 0.00217 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:2:2:3]     | passed | 0.00255 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:1:1]     | passed | 0.00681 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:1:2]     | passed | 0.00816 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:1:3]     | passed | 0.00772 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:2:1]     | passed | 0.01331 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:2:2]     | passed | 0.01288 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:2:3]     | passed | 0.01322 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:3:1]     | passed | 0.01055 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:3:2]     | passed | 0.01425 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:3:3]     | passed | 0.01011 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:4:1]     | passed | 0.00944 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:3:4:2]     | passed | 0.0113 seconds  |
+./spec/lib/last_email_cache_spec.rb[1:1:3:4:3]     | passed | 0.01069 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:4:1]       | passed | 0.00774 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:4:2]       | passed | 0.00763 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:4:3]       | passed | 0.00662 seconds |
+./spec/lib/last_email_cache_spec.rb[1:1:4:4]       | passed | 0.0138 seconds  |
+./spec/lib/last_notify_message_spec.rb[1:1:1]      | passed | 0.01227 seconds |
+./spec/lib/last_notify_message_spec.rb[1:2:1:1]    | passed | 0.00018 seconds |
+./spec/lib/last_notify_message_spec.rb[1:2:1:2]    | passed | 0.00024 seconds |
+./spec/lib/last_notify_message_spec.rb[1:2:2:1]    | passed | 0.00066 seconds |
+./spec/lib/last_notify_message_spec.rb[1:2:2:2]    | passed | 0.0005 seconds  |
+./spec/requests/last_email_spec.rb[1:1:1]          | passed | 0.02328 seconds |
+./spec/requests/last_email_spec.rb[1:2:1]          | passed | 0.02231 seconds |
+./spec/requests/last_notify_message_spec.rb[1:1:1] | passed | 0.05642 seconds |
+./spec/requests/last_notify_message_spec.rb[1:2:1] | passed | 0.01434 seconds |

data/spec/lib/last_notify_message_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyEmail
+  RSpec.describe LastNotifyMessage do
+    subject(:instance) { described_class.instance }
+
+    before(:each) { instance.reset }
+
+    let(:client) { double(:client, get_notifications: notifications) }
+    let(:notifications) { double(:notifications, collection: collection) }
+    let(:collection) { double(:collection, first: notification) }
+    let(:notification) do
+      double(:notification,
+             type: "email",
+             template: "template",
+             subject: "Subject",
+             body: "Body",
+             sent_at: "datetime",
+             email_address: "test@example.com",
+             phone_number: nil,
+             line_1: nil,
+             line_2: nil,
+             line_3: nil,
+             line_4: nil,
+             line_5: nil,
+             line_6: nil,
+             postcode: nil)
+    end
+
+    let(:expected_keys) { %w[type template subject body date to line_1 line_2 line_3 line_4 line_5 line_6 postcode] }
+
+    describe "#retrieve_last_notify_message" do
+      it "makes a call to the Notify client" do
+        expect(Notifications::Client).to receive(:new).with(DefraRubyEmail.configuration.notify_api_key).and_return(client)
+        expect(client).to receive(:get_notifications).and_return(notifications)
+
+        expect(instance.last_notify_message).to eq(nil)
+
+        instance.retrieve_last_notify_message
+
+        expect(instance.last_notify_message).to eq(notification)
+      end
+    end
+
+    describe "#last_notify_message_json" do
+      context "when no messages have been sent" do
+        let(:expected_keys) { %w[error] }
+
+        it "returns a JSON string" do
+          result = instance.last_notify_message_json
+
+          expect(result).to be_a(String)
+          expect { JSON.parse(result) }.to_not raise_error
+        end
+
+        it "responds with an error message" do
+          result = JSON.parse(instance.last_notify_message_json)
+
+          expect(result.keys).to match_array(expected_keys)
+        end
+      end
+
+      context "when a message has been sent" do
+        before(:each) do
+          instance.last_notify_message = notification
+        end
+
+        it "returns a JSON string" do
+          result = instance.last_notify_message_json
+
+          expect(result).to be_a(String)
+          expect { JSON.parse(result) }.to_not raise_error
+        end
+
+        it "contains the attributes of the message" do
+          result = JSON.parse(instance.last_notify_message_json)
+
+          expect(result["last_notify_message"].keys).to match_array(expected_keys)
+        end
+      end
+    end
+  end
+end

data/spec/requests/last_notify_message_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "notifications/client"
+
+module DefraRubyEmail
+  RSpec.describe "LastNotifyMessage", type: :request do
+    after(:all) { Helpers::Configuration.reset_for_tests }
+
+    let(:path) { "/defra_ruby_email/last-notify-message" }
+
+    let(:notify_api_key) { "hello-i-am-a-key" }
+    let(:client) { double(:client, get_notifications: notifications) }
+    let(:notifications) { double(:notifications, collection: collection) }
+    let(:collection) { double(:collection, first: notification) }
+    let(:notification) do
+      double(:notification,
+             type: "email",
+             template: "template",
+             subject: "Subject",
+             body: "Body",
+             sent_at: "datetime",
+             email_address: "test@example.com",
+             phone_number: nil,
+             line_1: nil,
+             line_2: nil,
+             line_3: nil,
+             line_4: nil,
+             line_5: nil,
+             line_6: nil,
+             postcode: nil)
+    end
+
+    context "when the API is enabled" do
+      let(:expected_data) do
+        {
+          last_notify_message: {
+            type: "email",
+            template: "template",
+            subject: "Subject",
+            body: "Body",
+            date: "datetime",
+            to: "test@example.com",
+            line_1: nil,
+            line_2: nil,
+            line_3: nil,
+            line_4: nil,
+            line_5: nil,
+            line_6: nil,
+            postcode: nil
+          }
+        }.to_json
+      end
+
+      before(:each) do
+        Helpers::Configuration.prep_for_tests
+
+        expect(DefraRubyEmail.configuration).to receive(:notify_api_key).and_return(notify_api_key)
+
+        expect(Notifications::Client).to receive(:new).with(notify_api_key).and_return(client)
+        expect(client).to receive(:get_notifications).and_return(notifications)
+      end
+
+      it "returns a JSON response with a 200 code containing details of the last Notify message sent" do
+        get path
+
+        expect(response.content_type).to eq("application/json")
+        expect(response.code).to eq("200")
+
+        expect(response.body).to eq(expected_data)
+      end
+    end
+
+    context "when the API is disabled" do
+      before(:all) { DefraRubyEmail.configuration.enable = false }
+
+      it "cannot load the page" do
+        expect { get path }.to raise_error(ActionController::RoutingError)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_email
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Defra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: notifications-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,7 @@ files:
 - app/assets/images/defra_ruby_email/govuk_logotype_email.png
 - app/controllers/defra_ruby_email/application_controller.rb
 - app/controllers/defra_ruby_email/last_email_controller.rb
+- app/controllers/defra_ruby_email/last_notify_message_controller.rb
 - app/mailers/defra_ruby_email/test_mailer.rb
 - config/routes.rb
 - lib/defra_ruby_email.rb
@@ -129,6 +144,7 @@ files:
 - lib/defra_ruby_email/engine.rb
 - lib/defra_ruby_email/last_email_cache.rb
 - lib/defra_ruby_email/last_email_observer.rb
+- lib/defra_ruby_email/last_notify_message.rb
 - lib/defra_ruby_email/version.rb
 - lib/tasks/changelog.rake
 - lib/tasks/defra_ruby_email.rake
@@ -155,6 +171,7 @@ files:
 - spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/defra_ruby_email.rb
 - spec/dummy/config/initializers/filter_parameter_logging.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
@@ -169,9 +186,12 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/examples.txt
 - spec/lib/last_email_cache_spec.rb
+- spec/lib/last_notify_message_spec.rb
 - spec/rails_helper.rb
 - spec/requests/last_email_spec.rb
+- spec/requests/last_notify_message_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers/configuration.rb
 - spec/support/pry.rb
@@ -226,6 +246,7 @@ test_files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/defra_ruby_email.rb
 - spec/dummy/config/initializers/to_time_preserves_timezone.rb
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
@@ -236,10 +257,13 @@ test_files:
 - spec/dummy/public/404.html
 - spec/dummy/log/test.log
 - spec/dummy/README.rdoc
+- spec/examples.txt
 - spec/requests/last_email_spec.rb
+- spec/requests/last_notify_message_spec.rb
 - spec/support/simplecov.rb
 - spec/support/pry.rb
 - spec/support/helpers/configuration.rb
 - spec/lib/last_email_cache_spec.rb
+- spec/lib/last_notify_message_spec.rb
 - spec/rails_helper.rb
 - spec/defra_ruby_email_spec.rb