defra_ruby_mocks 1.0.0

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  RSpec.describe Configuration do
+    let(:subject) { described_class.new }
+
+    describe "#enable=" do
+      context "when passed true as boolean" do
+        it "sets enable to 'true'" do
+          subject.enable = true
+
+          expect(subject.enabled?).to be(true)
+        end
+      end
+
+      context "when passed false as a boolean" do
+        it "sets enable to 'false'" do
+          subject.enable = false
+
+          expect(subject.enabled?).to be(false)
+        end
+      end
+
+      context "when passed true as string" do
+        it "sets enable to 'true'" do
+          subject.enable = "true"
+
+          expect(subject.enabled?).to be(true)
+        end
+      end
+
+      context "when passed false as a string" do
+        it "sets enable to 'false'" do
+          subject.enable = "false"
+
+          expect(subject.enabled?).to be(false)
+        end
+      end
+    end
+
+    describe "#delay=" do
+      context "when passed 200 as an integer" do
+        it "sets delay to 200" do
+          subject.delay = 200
+
+          expect(subject.delay).to be(200)
+        end
+      end
+
+      context "when passed 200 as a string" do
+        it "sets delay to 200" do
+          subject.delay = "200"
+
+          expect(subject.delay).to be(200)
+        end
+      end
+
+      context "when passed a string that's not a number" do
+        it "sets delay to its default" do
+          subject.delay = ""
+
+          expect(subject.delay).to be(Configuration::DEFAULT_DELAY)
+        end
+      end
+
+      context "when passed nil" do
+        it "sets delay to its default" do
+          subject.delay = nil
+
+          expect(subject.delay).to be(Configuration::DEFAULT_DELAY)
+        end
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require "spec_helper"
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("dummy/config/environment", __dir__)
+
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require "rspec/rails"
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# We make an exception for simplecov because that will already have been
+# required and run at the very top of spec_helper.rb
+support_files = Dir["./spec/support/**/*.rb"].reject { |file| file == "./spec/support/simplecov.rb" }
+support_files.each { |f| require f }
+
+RSpec.configure do |config|
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/spec/requests/company_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRuby
+  RSpec.describe "Company", type: :request do
+
+    let(:path) { "/defra_ruby_mocks/company" }
+
+    context "when mocks are enabled" do
+      before(:all) { Helpers::Configuration.prep_for_tests }
+      after(:all) { Helpers::Configuration.reset_for_tests }
+
+      context "when the company number is 99999999 for not found" do
+        let(:company_number) { "99999999" }
+
+        it "returns a JSON response with a code of 404" do
+          get "#{path}/#{company_number}"
+          content = JSON.parse(response.body)
+
+          expect(response.content_type).to eq("application/json")
+          expect(response.code).to eq("404")
+          expect(content).to include("errors")
+        end
+      end
+
+      context "when the company number is from the 'specials' list" do
+        let(:company_number) { "05868270" }
+
+        it "returns a JSON response with a 200 code and a status that isn't 'active'" do
+          get "#{path}/#{company_number}"
+          company_status = JSON.parse(response.body)["company_status"]
+
+          expect(response.content_type).to eq("application/json")
+          expect(response.code).to eq("200")
+          expect(company_status).not_to eq("active")
+        end
+      end
+
+      context "when the company number is not from the 'specials' list" do
+        context "and it is valid" do
+          let(:company_number) { "SC247974" }
+
+          it "returns a JSON response with a 200 code and a status of 'active'" do
+            get "#{path}/#{company_number}"
+            company_status = JSON.parse(response.body)["company_status"]
+
+            expect(response.content_type).to eq("application/json")
+            expect(response.code).to eq("200")
+            expect(company_status).to eq("active")
+          end
+        end
+
+        context "and it is not valid" do
+          let(:company_number) { "foo" }
+
+          it "returns a JSON response with a 404 code" do
+            get "#{path}/#{company_number}"
+            content = JSON.parse(response.body)
+
+            expect(response.content_type).to eq("application/json")
+            expect(response.code).to eq("404")
+            expect(content).to include("errors")
+          end
+        end
+      end
+    end
+
+    context "when mocks are disabled" do
+      before(:all) { DefraRubyMocks.configuration.enable = false }
+
+      let(:company_number) { "SC247974" }
+
+      it "cannot load the page" do
+        expect { get "#{path}/#{company_number}" }.to raise_error(ActionController::RoutingError)
+      end
+    end
+
+  end
+end

data/spec/services/companies_house_service_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+module DefraRubyMocks
+  RSpec.describe CompaniesHouseService do
+    describe ".run" do
+      context "when the company number is 99999999 for not found" do
+        let(:company_number) { "99999999" }
+
+        it "raises a NotFoundError" do
+          expect { described_class.run(company_number) }.to raise_error(NotFoundError)
+        end
+      end
+
+      context "when the company number is from the 'specials' list" do
+        specials = CompaniesHouseService.special_company_numbers
+
+        specials.each do |company_number, status|
+          context "and the number is #{company_number}" do
+            it "returns a status of '#{status}'" do
+              expect(described_class.run(company_number)).to eq(status)
+            end
+          end
+        end
+      end
+
+      context "when the company number is not from the 'specials' list" do
+        context "and it is valid" do
+          let(:company_number) { "SC247974" }
+
+          it "returns a status of 'active'" do
+            expect(described_class.run(company_number)).to eq("active")
+          end
+        end
+
+        context "and it is not valid" do
+          let(:company_number) { "foo" }
+
+          it "raises a NotFoundError" do
+            expect { described_class.run(company_number) }.to raise_error(NotFoundError)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/helpers/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Helpers
+  module Configuration
+    def self.prep_for_tests(delay = 100)
+      DefraRubyMocks.configure do |config|
+        config.enable = true
+        config.delay = delay
+      end
+    end
+
+    def self.reset_for_tests
+      DefraRubyMocks.reset_configuration
+    end
+  end
+end

data/spec/support/pry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Support debugging in the tests. Add `binding.pry` wherever you want execution
+# to stop and the debugger to kick in.
+# Details on the debugging commands can be found here
+# https://github.com/deivid-rodriguez/pry-byebug#commands
+require "pry-byebug"

data/spec/support/simplecov.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov"
+
+# We start it with the rails param to ensure it includes coverage for all code
+# started by the rails app, and not just the files touched by our unit tests.
+# This gives us the most accurate assessment of our unit test coverage
+# https://github.com/colszowka/simplecov#getting-started
+SimpleCov.start do
+  # We filter the spec folder, mainly to ensure that any dummy apps don't get
+  # included in the coverage report. However our intent is that nothing in the
+  # spec folder should be included
+  add_filter "/spec/"
+  # The version file is simply just that, so we do not feel the need to ensure
+  # we have a test for it
+  add_filter "lib/defra_ruby/mocks/version"
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_mocks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Defra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.11.1
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: defra_ruby_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine which can be used to mock external services when loaded
+  into an application
+email:
+- alan.cruikshanks@environment-agency.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/defra_ruby_mocks/application_controller.rb
+- app/controllers/defra_ruby_mocks/company_controller.rb
+- app/services/defra_ruby_mocks/base_service.rb
+- app/services/defra_ruby_mocks/companies_house_service.rb
+- app/views/defra_ruby_mocks/company/not_found.json.erb
+- app/views/defra_ruby_mocks/company/show.json.erb
+- config/routes.rb
+- lib/defra_ruby_mocks.rb
+- lib/defra_ruby_mocks/configuration.rb
+- lib/defra_ruby_mocks/engine.rb
+- lib/defra_ruby_mocks/version.rb
+- lib/tasks/changelog.rake
+- lib/tasks/defra_ruby_mocks_tasks.rake
+- spec/defra_ruby_mocks_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/to_time_preserves_timezone.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/examples.txt
+- spec/lib/configuration_spec.rb
+- spec/rails_helper.rb
+- spec/requests/company_spec.rb
+- spec/services/companies_house_service_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers/configuration.rb
+- spec/support/pry.rb
+- spec/support/simplecov.rb
+homepage: https://github.com/DEFRA/defra-ruby-mocks
+licenses:
+- The Open Government Licence (OGL) Version 3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Defra Ruby on Rails external API mocking engine
+test_files:
+- spec/spec_helper.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/config/secrets.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/to_time_preserves_timezone.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config.ru
+- spec/dummy/Rakefile
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/404.html
+- spec/dummy/log/test.log
+- spec/dummy/log/development.log
+- spec/dummy/README.rdoc
+- spec/examples.txt
+- spec/defra_ruby_mocks_spec.rb
+- spec/requests/company_spec.rb
+- spec/support/simplecov.rb
+- spec/support/pry.rb
+- spec/support/helpers/configuration.rb
+- spec/lib/configuration_spec.rb
+- spec/rails_helper.rb
+- spec/services/companies_house_service_spec.rb