gov_fake_notify 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d0b4a0c314fb0765dc52ded119d9de4c8116e102bac5700ab25397568b4fb23
+  data.tar.gz: eb26beb1c5413d77473206756baeec9fdd98bd57b2d4b0f77c1b61ff9a7664ad
+SHA512:
+  metadata.gz: 1cba914fabbf22c453f016048d460aa37b0b5fdccec28a616deefdef8c34b1deec1343dfb8a24477cbf36b59737762045d3960055406779ee9a2a5722a6bce93
+  data.tar.gz: d3d58b3c3e47e3fc8bec35948195a19c1bf3fcb4fb3d465baf6c2c131e09bdb19a84e18421078560d110020a835ac9821dd9ed6e9e4e8ff3877c8ce28d12557d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  TargetRubyVersion: 2.5

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-09-17 05:44:47 UTC using RuboCop version 1.21.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/gov_fake_notify.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gov_fake_notify.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    gov_fake_notify (1.1.1)
+      activemodel (>= 5.2.3)
+      iodine (~> 0.7)
+      jwt (~> 2.2, >= 2.2.3)
+      mail (~> 2.7, >= 2.7.1)
+      roda (~> 3.48)
+      thor (~> 1.1)
+      tilt (~> 2.0, >= 2.0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    iodine (0.7.44)
+    jwt (2.2.3)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.1.1)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    roda (3.48.0)
+      rack
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gov_fake_notify!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 garytaylor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,271 @@
+# GovFakeNotify
+
+This gem provides a standalone tool which emulates the real govuk notify service.  It is intended for test and development environments only.
+
+IMPORTANT: Whilst this tool can send real emails via SMTP, this is intended for use during development and test only - ideally using something 
+  like 'mailhog' instead of a real SMTP server.
+
+  If you have set it up with a real SMTP server, please ensure that the service is NOT exposed to the internet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gov_fake_notify'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gov_fake_notify
+
+## Usage
+
+### Command Line Usage
+
+If the gem is being used as part of a full stack test suite (i.e. the emails are being sent in a different process to the tests), it can be used as
+a command line tool like this
+
+gov_fake_notify start -c ./config.json
+
+which will start the server using the config file provided (see configuration below)
+
+#### Test Suite Configuration
+
+There are 2 ways of validating emails using this gem - either allow the gem to send real emails to a fake smtp server such as mailhog
+OR dont send emails at all and use the 'notifications-ruby-client' to read from the API provided by this gem to see what emails would
+have been sent.
+
+Please see the configuration section below to see how to switch modes etc..
+
+### In Process Usage
+
+if the gem is being used as part of a test suite where the code under test is in the same process as the tests, it can be used alongside 'webmock'
+as follows :-
+
+
+#### In a spec/support/*.rb file OR in rails_helper.rb etc..
+
+This is a partial example from the employment tribunals test suite
+
+```ruby
+require 'gov_fake_notify'
+RSpec.configure do |c|
+  c.before(:each) do
+    GovFakeNotify.reset!
+  end
+end
+GovFakeNotify.config do |c|
+  c.delivery_method = 'test'
+  c.include_templates = [
+    {
+      id: 'a55e0b84-8d65-4bf4-93a7-e974e0d8d48d', # Note - does not need to be exact id that is used in govuk notify UNLESS 
+      name: 'et1-confirmation-email-v1-en',       #  your system has hard coded id's or referenced by environment variables etc..
+      subject: 'Employment tribunal: claim submitted',
+      message: <<~EOS
+        Claim number: ((claim.reference))
+
+        ((primary_claimant.first_name)) ((primary_claimant.last_name))
+        
+        Thank you for submitting your claim to an employment tribunal.
+        
+        ---
+        
+        WHAT HAPPENS NEXT
+        
+        We'll contact you once we have sent your claim to the respondent and explain what happens next.
+        At present, this is taking us an average of 25 days.
+        Once we have sent them your claim, the respondent has 28 days to reply.
+        
+        ---
+        
+        SUBMISSION DETAILS
+        
+        Claim submitted:       ((submitted_date))
+        Tribunal office:       ((office.name))
+        Contact: ((office.email)), ((office.telephone))
+        
+        Your feedback helps us improve this service:
+        https://www.gov.uk/done/employment-tribunals-make-a-claim
+        
+        Contact us: http://www.justice.gov.uk/contacts/hmcts/tribunals/employment
+      EOS
+
+    }
+  ]
+  c.include_api_keys = [
+    {
+      service_name: 'Employment Tribunals',
+      service_email: 'employmenttribunals@email.com',
+      key: 'fake-key-7fc24bc8-1938-1827-bed3-fb237f9cd5e7-c34b3015-02a1-4e01-b922-1ea21f331d4d' # Your application under test's key - 
+                                                                                                #   the keys must match.    
+    }
+  ]
+end
+```
+
+## Configuration
+
+Configuration can be done using the command line, a config file, environment variables or directly (in process only).
+Note that the configuration can include an API key - do not be tempted to use the same value as the production environment
+as the chances are it will end up in github which is publically accessible.
+
+The following configuration entries are available
+
+port
+smtp_address
+smtp_port
+smtp_user_name
+smtp_password
+smtp_authentication
+smtp_enable_starttls_auto
+base_url
+database_file
+attachments_path
+delivery_method
+include_templates (config file or direct config only)
+include_api_keys (config file or direct config only)
+
+To configure via the command line - use the 'dash' version of the variable - for example
+
+--smtp-port instead of smtp_port
+
+To configure in the yaml file use the actual variable name
+
+### An example yaml config file (from employment tribunals config)
+
+```yaml
+---
+  port: 8081
+  delivery_method: test
+  include_templates:
+  - id: a55e0b84-8d65-4bf4-93a7-e974e0d8d48d
+    name: et1-confirmation-email-v1-en
+    subject: "Employment tribunal: claim submitted"
+    message: |
+      Claim number: ((claim.reference))
+
+      ((primary_claimant.first_name)) ((primary_claimant.last_name))
+      
+      Thank you for submitting your claim to an employment tribunal.
+      
+      ---
+      
+      WHAT HAPPENS NEXT
+      
+      We'll contact you once we have sent your claim to the respondent and explain what happens next.
+      At present, this is taking us an average of 25 days.
+      Once we have sent them your claim, the respondent has 28 days to reply.
+      
+      ---
+      
+      SUBMISSION DETAILS
+      
+      Claim submitted:       ((submitted_date))
+      Tribunal office:       ((office.name))
+      Contact: ((office.email)), ((office.telephone))
+      
+      ---
+      
+      Please use the link below to download a copy of your claim.
+      ((link_to_pdf))
+      
+      ---
+      
+      Additional Information File
+      
+      ((link_to_additional_info))
+      
+      ---
+      
+      Group Claim File
+      
+      ((link_to_claimants_file))
+      
+      ---
+      
+      
+      
+      Your feedback helps us improve this service:
+      https://www.gov.uk/done/employment-tribunals-make-a-claim
+      
+      Help us keep track. Complete our diversity monitoring questionnaire.
+      https://employmenttribunals.service.gov.uk/en/apply/diversity
+      
+      Contact us: http://www.justice.gov.uk/contacts/hmcts/tribunals/employment
+  - id: 97a117f1-727d-4631-bbc6-b2bc98d30a0f
+    name: et1-confirmation-email-v1-cy
+    subject: "Tribiwnlys Cyflogaeth: hawliad wedi’i gyflwyno"
+    message: |
+      Eich rhif hawliad: ((claim.reference))
+
+      ((primary_claimant.first_name)) ((primary_claimant.last_name))
+      Diolch am gyflwyno eich hawliad i dribiwnlys cyflogaeth.
+      ---
+      
+      BETH SY'N DIGWYDD NESAF
+      
+      Byddwn yn cysylltu â chi unwaith y byddwn wedi anfon eich hawliad at yr atebydd i egluro beth fydd yn digwydd nesaf. Ar hyn o bryd, mae’n cymryd oddeutu 25 diwrnod.
+      Unwaith y byddwn wedi anfon eich hawliad atynt, mae gan yr atebydd 28 diwrnod i ymateb.
+      
+      ---
+      
+      MANYLION CYFLWYNO
+      
+      Hawliad wedi'i gyflwyno:      Cyflwynwyd ar ((submitted_date))
+      Swyddfa tribiwnlys:           Cymru, Tribiwnlys Cyflogaeth
+      Cyswllt: ((office.email)), 0300 303 0654
+      
+      ---     
+      
+      Defnyddiwch y ddolen isod i lawrlwytho copi o’ch hawliad.
+      ((link_to_pdf))
+      
+      ---
+      
+      Ffeil Gwybodaeth Ychwanegol
+      
+      ((link_to_additional_info))
+      
+      ---
+      
+      Hawliad Grŵp
+      
+      ((link_to_claimants_file))
+      
+      ---
+      
+      Mae eich adborth yn ein helpu i wella'r gwasanaeth hwn:
+      https://www.gov.uk/done/employment-tribunals-make-a-claim
+      
+      Helpwch ni i gadw cofnodion cywir . Llenwch ein holiadur monitro amrywiaeth.
+      https://employmenttribunals.service.gov.uk/en/apply/diversity
+      
+      Cysylltu â ni: http://www.justice.gov.uk/contacts/hmcts/tribunals/employment
+  include_api_keys: 
+  - service_name: Employment Tribunals
+    service_email: employmenttribunals@email.com
+    key: fake-key-7fc24bc8-1938-1827-bed3-fb237f9cd5e7-c34b3015-02a1-4e01-b922-1ea21f331d4d
+    
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gov_fake_notify.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gov_fake_notify'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gov_fake_notify

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gov_fake_notify'
+GovFakeNotify::Cli::Root.start(ARGV)

data/gov_fake_notify.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gov_fake_notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gov_fake_notify'
+  spec.version       = GovFakeNotify::VERSION
+  spec.authors       = ['garytaylor']
+  spec.email         = ['gary.taylor@hismessages.com']
+
+  spec.summary       = 'A fake govuk notify service'
+  spec.description   = 'A fake govuk notify service that sends emails via smtp for ease of testing'
+  spec.homepage      = 'https://github.com/hmcts/gov_fake_notify'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hmcts/gov_fake_notify'
+  spec.metadata['changelog_uri'] = 'https://github.com/hmcts/gov_fake_notify/changelog.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '>= 5.2.3'
+  spec.add_dependency 'iodine', '~> 0.7'
+  spec.add_dependency 'jwt', '~> 2.2', '>= 2.2.3'
+  spec.add_dependency 'mail', '~> 2.7', '>= 2.7.1'
+  spec.add_dependency 'roda', '~> 3.48'
+  spec.add_dependency 'tilt', '~> 2.0', '>= 2.0.10'
+
+  spec.add_dependency 'thor', '~> 1.1'
+
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+end

data/lib/gov_fake_notify/attachment_store.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'pstore'
+require 'securerandom'
+module GovFakeNotify
+  # A central store for storing all state in the app - uses a basic PStore
+  class AttachmentStore
+    include Singleton
+
+    #
+    # Given a hash containing the data that comes from the client side 'prepare_upload' method,
+    #  this method stores the data in a file and returns the same hash but with the base64 data
+    #  replaced with a file path where the data is stored.
+    #
+    # @param [Hash] file_data The data as prepared by 'prepare_upload'
+    # @option file_data [String] :file The base64 encoded file
+    # @option file_data [Boolean] :is_csv Indicates if the file is csv or not
+    #
+    # @return [Hash] A copy of the file_data param but with the contents of file replaced
+    #  with the path of where the file is stored.
+    def store(file_data)
+      file_path = File.join(attachments_path, SecureRandom.uuid)
+      File.open(file_path, 'wb') do |file|
+        file.write(Base64.decode64(file_data['file']))
+      end
+      file_data.merge('file' => file_path)
+    end
+
+    #
+    # Fetch a file from the store
+    #
+    # @param [String] id The id of the file - which happens to be the filename
+    # @return [Hash, Nil] A hash containing 'file' (the file path) OR nil if not found
+    def fetch(id)
+      file_path = File.join(attachments_path, id.gsub(/[^a-zA-Z0-9\-]/, ''))
+      File.exist?(file_path) ? { 'file' => file_path } : nil
+    end
+
+    private
+
+    attr_reader :attachments_path
+
+    def initialize(attachments_path: GovFakeNotify.config.attachments_path)
+      @attachments_path = attachments_path
+    end
+  end
+end

data/lib/gov_fake_notify/cli/root.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'gov_fake_notify/iodine'
+require 'uri'
+require 'net/http'
+require 'yaml'
+module GovFakeNotify
+  module Cli
+    # Root of all commands
+    class Root < Thor
+      desc 'start', 'Run fake notify'
+      method_option :port, type: :numeric, aliases: '-p', description: 'The port number for the web server (defaults to 8080)'
+      method_option :config, type: :string, aliases: '-c', description: 'Configuration specified in a yaml file'
+      method_option :smtp_address, type: :string
+      method_option :smtp_port, type: :numeric
+      method_option :smtp_user_name, type: :string
+      method_option :smtp_password, type: :string
+      method_option :smtp_authentication, type: :string
+      method_option :smtp_enable_starttls_auto, type: :string
+      method_option :base_url, type: :string
+      method_option :database_file, type: :string
+      method_option :attachments_path, type: :string
+      method_option :delivery_method, type: :string
+
+      def start
+        if options.config
+          GovFakeNotify.config do |c|
+            c.from(YAML.parse(File.read(options.config)).to_ruby.merge(options.slice(*(options.keys - ['config']))))
+          end
+        end
+        Rack::Server.start app: GovFakeNotify::RootApp, Port: GovFakeNotify.config.port, server: 'iodine'
+      end
+
+      desc 'create-template', 'Create a template'
+      method_option :template_id, type: :string, required: true
+      method_option :path, type: :string, required: true
+      method_option :name, type: :string, required: true
+      method_option :subject, type: :string, required: true
+      def create_template
+        data = {
+          id: options.template_id,
+          message: File.read(options.path),
+          name: options.name,
+          subject: options.subject
+        }
+        res = Net::HTTP.post(URI("#{GovFakeNotify.config.base_url}/control/templates"), JSON.generate(data),
+                             { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
+        puts res.body
+      end
+    end
+  end
+end

data/lib/gov_fake_notify/cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'gov_fake_notify/cli/root'

data/lib/gov_fake_notify/commands/create_template_command.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'gov_fake_notify/store'
+module GovFakeNotify
+  # A service used internally to create a new template from the API / command line
+  class CreateTemplateCommand
+    def self.call(params)
+      # do nothing yet
+      new(params).call
+    end
+
+    def initialize(params, store: Store.instance)
+      @params = params
+      @store = store
+    end
+
+    def call
+      store.transaction { store["template-#{params['id']}"] = params }
+
+      self
+    end
+
+    def success?
+      true
+    end
+
+    def to_json(*_args)
+      JSON.generate({ success: true })
+    end
+
+    private
+
+    attr_reader :params, :store
+  end
+end