defra_ruby_mocks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a51d8ad9a6aacfc79ec4354df4b6ac22a95e4d3e
+  data.tar.gz: f97be7da287ba2987204dea1cc6ae72b188aa454
+SHA512:
+  metadata.gz: 4251aedd24958f9cb6bac0f0fc6378f741f8fbf798e87f07e4cce3379c2c276bbd5ce28ec6a89b8d8cef378eb8a9182679c4f53d823763df38c0d7b49ed45b87
+  data.tar.gz: d9ea74e870ab67ad6cca27b328a41ac7ddb0e132f435c718a596b91f1f0f9161067364497fc43b546b2fbff94c8a59a25a597976d65385d9fb3e166d4b7a1e07

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2019 Environment Agency
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,149 @@
+# Defra Ruby Mocks
+
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-mocks.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-mocks)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8b14cc1e0e1c1d6a33cc/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-mocks/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8b14cc1e0e1c1d6a33cc/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-mocks/test_coverage)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-mocks/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-mocks/master)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+A Rails Engine used by the [Ruby services team](https://github.com/DEFRA/ruby-services-team) in their digital services.
+
+We use it to mock external services such as Companies House, so we can performance test our services and not get in trouble!
+
+When mounted in an app, it will add additional endpoints which when called will 'mock' the functionality of the external service.
+
+Things to note
+
+- We have gone with an engine rather than an additional service, to simplify management of mocking in our environments
+- The mocks do not replicate all functionality an external service provides, only the features we use in our services
+
+## Prerequisites
+
+Make sure you already have:
+
+- Ruby 2.4.2
+- [Bundler](http://bundler.io/) – for installing Ruby gems
+
+## Mounting the engine
+
+Add the engine to your Gemfile:
+
+```ruby
+gem "defra_ruby_mocks",
+    git: "https://github.com/DEFRA/defra-ruby-mocks"
+```
+
+Install it with `bundle install`.
+
+Then mount the engine in your routes.rb file:
+
+```ruby
+Rails.application.routes.draw do
+  mount DefraRubyMocks::Engine => "/mocks"
+end
+```
+
+The engine should now be mounted at `/mocks` of your project. You can change `"/mocks"` to a different route if you'd prefer it to be elsewhere.
+
+## Configuration
+
+For the mock routes to be accessible you'll also need to enable them.
+
+```ruby
+# config/initializers/defra_ruby_mocks.rb
+require "defra_ruby_mocks"
+
+DefraRubyMocks.configure do |config|
+  config.enable = true
+  config.delay = 1000
+end
+```
+
+To protect against having them enabled when in production, by default the engine will not allow access unless they have been enabled in the config.
+
+We also provide an option to control how long the mock should delay before responding. The default is 1000ms (1 second).
+
+## Mocks
+
+The project currently mocks the following services.
+
+### Companies House
+
+When mounted into an app you can make requests to `/mocks/company/[company number]` to get a response that matches what our apps expect.
+
+This is an important distinction to note. When our apps like the [Waste Exemptions front office](https://github.com/DEFRA/waste-exemptions-front-office) make a real request to Companies House, they get a lot more information back in the JSON reponse. However the only thing they are interested in is the value of `"company_status"`.
+
+So rather than maintain a lot of unused JSON data, the mock just returns that bit of the JSON.
+
+```bash
+curl http://localhost:3000/mocks/company/SC123456
+{
+    "company_status": "active"
+}
+```
+
+#### Company numbers
+
+As long as the request is for a valid number the mock will return the status as `"active"`. (see <https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/426891/uniformResourceIdentifiersCustomerGuide.pdf> for details of valid number formats).
+
+The exceptions to this are the 'special' numbers listed below. Use them if you are looking for alternate responses.
+
+- `05868270` will return `"dissolved"`
+- `04270505` will return `"administration"`
+- `99999999` will mock a not found result and return a 404 error
+- `88888888` will return `"liquidation"`
+- `77777777` will return `"receivership"`
+- `66666666` will return `"converted-closed"`
+- `55555555` will return `"voluntary-arrangement"`
+- `44444444` will return `"insolvency-proceedings"`
+- `33333333` will return `"open"`
+- `22222222` will return `"closed"`
+
+The list of possible statuses was taken from
+
+- [Companies House API](https://developer.companieshouse.gov.uk/api/docs/company/company_number/companyProfile-resource.html)
+- [Companies House API enumerations](https://github.com/companieshouse/api-enumerations/blob/master/constants.yml)
+
+## Installation
+
+You don't need to do this if you're just mounting the engine without making any changes.
+
+However, if you want to edit the engine, you'll have to install it locally.
+
+Clone the repo and drop into the project:
+
+```bash
+git clone https://github.com/DEFRA/defra-ruby-mocks.git && cd defra-ruby-mocks
+```
+
+Then install the dependencies with `bundle install`.
+
+## Testing the engine
+
+The engine is mounted in a dummy Rails 4 app (in /spec/dummy) so we can properly test its behaviour.
+
+The test suite is written in RSpec.
+
+To run all the tests, use `bundle exec rspec`.
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+<http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3>
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "DefraRubyMocks"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+load "rails/tasks/statistics.rake"
+
+Dir[File.join(File.dirname(__FILE__), "lib/tasks/**/*.rake")].each { |f| load f }
+
+Bundler::GemHelper.install_tasks
+
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+# rubocop:disable Lint/HandleExceptions
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+# rubocop:enable Lint/HandleExceptions

data/app/controllers/defra_ruby_mocks/application_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+    before_action :delay_response
+
+    private
+
+    def delay_response
+      # sleep() expects the time to be specified in seconds, but we allow delay
+      # to be specified in milliseconds. Dividing by 1000 converts milliseconds
+      # to seconds.
+      sleep(DefraRubyMocks.configuration.delay / 1000)
+    end
+  end
+end

data/app/controllers/defra_ruby_mocks/company_controller.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class CompanyController < ApplicationController
+
+    before_action :set_default_response_format
+
+    def show
+      @status = CompaniesHouseService.run(params[:id])
+
+      respond_to :json
+    rescue NotFoundError
+      render "not_found", status: 404
+    end
+
+    private
+
+    def set_default_response_format
+      request.format = :json
+    end
+
+  end
+end

data/app/services/defra_ruby_mocks/base_service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class BaseService
+    def self.run(attrs = nil)
+      new.run(attrs)
+    end
+  end
+end

data/app/services/defra_ruby_mocks/companies_house_service.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class NotFoundError < StandardError
+  end
+
+  class CompaniesHouseService < BaseService
+
+    # Examples we need to validate are
+    # 10997904, 09764739
+    # SC534714, CE000958
+    # IP00141R, IP27702R, SP02252R
+    # https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/426891/uniformResourceIdentifiersCustomerGuide.pdf
+    VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX = Regexp.new(
+      /\A(\d{8,8}$)|([a-zA-Z]{2}\d{6}$)|([a-zA-Z]{2}\d{5}[a-zA-Z]{1}$)\z/i
+    ).freeze
+
+    NOT_FOUND = "99999999"
+
+    def self.special_company_numbers
+      {
+        "05868270" => "dissolved",
+        "04270505" => "administration",
+        "88888888" => "liquidation",
+        "77777777" => "receivership",
+        "66666666" => "converted-closed",
+        "55555555" => "voluntary-arrangement",
+        "44444444" => "insolvency-proceedings",
+        "33333333" => "open",
+        "22222222" => "closed"
+      }
+    end
+
+    def run(company_number)
+      raise NotFoundError unless valid_company_number?(company_number)
+      raise NotFoundError if company_number == NOT_FOUND
+
+      return specials[company_number] if specials.key?(company_number)
+
+      "active"
+    end
+
+    private
+
+    def valid_company_number?(company_number)
+      company_number.match?(VALID_COMPANIES_HOUSE_REGISTRATION_NUMBER_REGEX)
+    end
+
+    def specials
+      self.class.special_company_numbers
+    end
+
+  end
+end

data/app/views/defra_ruby_mocks/company/not_found.json.erb

@@ -0,0 +1,8 @@
+{
+  "errors": [
+    {
+      "type": "ch:service",
+      "error": "company-profile-not-found"
+    }
+  ]
+}

data/app/views/defra_ruby_mocks/company/show.json.erb

@@ -0,0 +1,3 @@
+{
+    "company_status": "<%= @status %>"
+}

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+DefraRubyMocks::Engine.routes.draw do
+  get "/company/:id",
+      to: "company#show",
+      as: "company",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+end

data/lib/defra_ruby_mocks.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "defra_ruby_mocks/engine"
+
+module DefraRubyMocks
+  # Enable the ability to configure the gem from its host app, rather than
+  # reading directly from env vars. Derived from
+  # https://robots.thoughtbot.com/mygem-configure-block
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Added for testing. Without we cannot test both a config object with and
+    # with set values in the same rspec session
+    def reset_configuration
+      @configuration = nil
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/defra_ruby_mocks/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class Configuration
+
+    DEFAULT_DELAY = 1000
+
+    attr_reader :delay
+
+    def initialize
+      @enable = false
+      @delay = DEFAULT_DELAY
+    end
+
+    # Controls whether the mocks are enabled. Only if set to true will the mock
+    # pages be accessible
+    def enable=(arg)
+      # We implement our own setter to handle values being passed in as strings
+      # rather than booleans
+      parsed = arg.to_s.downcase
+
+      @enable = parsed == "true"
+    end
+
+    def enabled?
+      @enable
+    end
+
+    # Set a delay in milliseconds for the mocks to respond.
+    # Defaults to 1000 (1 sec)
+    def delay=(arg)
+      # We implement our own setter to handle values being passed in as strings
+      # rather than integers
+      @delay = arg.to_i
+
+      @delay = DEFAULT_DELAY if @delay.zero?
+    end
+  end
+end

data/lib/defra_ruby_mocks/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "configuration"
+
+module DefraRubyMocks
+  class Engine < ::Rails::Engine
+    isolate_namespace DefraRubyMocks
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/defra_ruby_mocks/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  VERSION = "1.0.0"
+end

data/lib/tasks/changelog.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/task"
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = "DEFRA"
+  config.project = "defra-ruby-mocks"
+end

data/lib/tasks/defra_ruby_mocks_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# namespace :defra_ruby_mocks do
+#   desc "Explaining what the task does"
+#   task :test do
+#     # Task goes here
+#   end
+# end