pact_broker 2.89.1 → 2.90.0

data/public/js/npm.js

@@ -1,13 +0,0 @@
-// This file is autogenerated via the `commonjs` Grunt task. You can require() this file in a CommonJS environment.
-require('../../js/transition.js')
-require('../../js/alert.js')
-require('../../js/button.js')
-require('../../js/carousel.js')
-require('../../js/collapse.js')
-require('../../js/dropdown.js')
-require('../../js/modal.js')
-require('../../js/tooltip.js')
-require('../../js/popover.js')
-require('../../js/scrollspy.js')
-require('../../js/tab.js')
-require('../../js/affix.js')

data/regression/.gitignore

@@ -1 +0,0 @@
-.examples.txt

data/regression/can_i_deploy_spec.rb

@@ -1,43 +0,0 @@
-require "pact_broker/domain"
-PACTICIPANT_LIMIT = 10
-VERSION_LIMIT = 10
-
-PACTICIPANTS = PactBroker::Domain::Pacticipant.order(Sequel.desc(:id)).limit(PACTICIPANT_LIMIT).all
-
-RSpec.describe "regression tests" do
-
-  def can_i_deploy(pacticipant_name, version_number, to_tag)
-    get("/can-i-deploy", { pacticipant: pacticipant_name, version: version_number, to: to_tag }, { "HTTP_ACCEPT" => "application/hal+json" })
-  end
-
-  PACTICIPANTS.each do | pacticipant |
-    describe pacticipant.name do
-
-      versions = PactBroker::Domain::Version.where(pacticipant_id: pacticipant.id).order(Sequel.desc(:order)).limit(VERSION_LIMIT)
-      versions.each do | version |
-        describe "version #{version.number}" do
-          it "has the same results for can-i-deploy" do
-
-            can_i_deploy_response = can_i_deploy(pacticipant.name, version.number, "prod")
-            results = {
-              request: {
-                name: "can-i-deploy",
-                params: {
-                  pacticipant_name: pacticipant.name,
-                  version_number: version.number,
-                  to_tag: "prod"
-                }
-              },
-              response: {
-                status: can_i_deploy_response.status,
-                body: JSON.parse(can_i_deploy_response.body)
-              }
-            }
-
-            Approvals.verify(results, :name => "regression_can_i_deploy_#{pacticipant.name}_version_#{version.number}", format: :json)
-          end
-        end
-      end
-    end
-  end
-end

data/regression/index_spec.rb

@@ -1,26 +0,0 @@
-require "pact_broker/domain"
-require "pact_broker/policies"
-require "pact_broker/ui/app"
-
-RSpec.describe "regression tests for index page" do
-  context "HTML" do
-    let(:app) { PactBroker::UI::App.new }
-
-    it "has the same response without tags" do
-      response = get("/", nil, { "HTTP_ACCEPT" => "text/html" } )
-      Approvals.verify(response.body, :name => "index_html", format: :html)
-    end
-
-    it "has the same response with tags" do
-      response = get("/", { "tags" => "true", "pageNumber" => "1", "pageSize" => "100"}, { "HTTP_ACCEPT" => "text/html" } )
-      Approvals.verify(response.body, :name => "index_html_with_tags", format: :html)
-    end
-  end
-
-  context "JSON" do
-    it "has the same response" do
-      response = get("/dashboard", { "HTTP_ACCEPT" => "application/hal+json" } )
-      Approvals.verify(JSON.parse(response.body), :name => "index_json", format: :json)
-    end
-  end
-end

data/regression/regression_helper.rb

@@ -1,63 +0,0 @@
-raise "Must set INSTALL_PG=true" unless ENV["INSTALL_PG"] == "true"
-raise "Must set DATABASE_ADAPTER=docker_postgres" unless ENV["DATABASE_ADAPTER"] == "docker_postgres"
-raise "Must set RACK_ENV=development" unless ENV["RACK_ENV"] == "development"
-
-$LOAD_PATH  << "."
-
-require "sequel"
-
-load "lib/db.rb"
-require "tasks/database"
-require "pact_broker/db"
-PactBroker::DB.connection = PactBroker::Database.database = DB::PACT_BROKER_DB
-PactBroker::DB::Migrate.call(PactBroker::DB.connection)
-require "approvals"
-require "rack/test"
-require "pact_broker/api"
-
-Approvals.configure do |c|
-  c.approvals_path = "regression/fixtures/approvals/"
-end
-
-RSpec.configure do | config |
-  config.before :each do
-    PactBroker.reset_configuration
-    PactBroker.configuration.seed_example_data = false
-    PactBroker.configuration.base_equality_only_on_content_that_affects_verification_results = false
-  end
-
-  config.include Rack::Test::Methods
-
-  config.define_derived_metadata do |meta|
-    meta[:aggregate_failures] = true unless meta.key?(:aggregate_failures)
-  end
-
-  config.example_status_persistence_file_path = "./regression/.examples.txt"
-  config.filter_run_excluding skip: true
-  config.filter_run focus: true
-  config.run_all_when_everything_filtered = true
-
-  def app
-    PactBroker::API
-  end
-
-  config.after(:each) do | example, _something |
-    if ENV["SHOW_REGRESSION_DIFF"] == "true"
-      if example.exception.is_a?(Approvals::ApprovalError)
-        require "pact/support"
-        parts = example.exception.message.split('"')
-        received_file = parts[1]
-        approved_file = parts[3]
-        received_hash = JSON.parse(File.read(received_file))
-        approved_hash = JSON.parse(File.read(approved_file))
-        diff = Pact::Matchers.diff(approved_hash, received_hash)
-        puts Pact::Matchers::UnixDiffFormatter.call(diff)
-      end
-    end
-  end
-end
-
-if ENV["DEBUG"] == "true"
-  SemanticLogger.add_appender(io: $stdout)
-  SemanticLogger.default_level = :info
-end

data/regression/script/approval-all.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-for file in $(find regression/fixtures/approvals -ipath "*.received.*"); do
-  approved_path=$(echo "$file" | sed 's/received/approved/')
-  mv "$file" "$approved_path"
-done;

data/regression/script/clear.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-rm regression/fixtures/approvals/*

data/regression/script/run.sh

@@ -1,3 +0,0 @@
-#/bin/sh
-
-REGRESSION=true INSTALL_PG=true DATABASE_ADAPTER=docker_postgres RACK_ENV=development bundle exec rake regression

data/scaffolding/README.md

@@ -1,23 +0,0 @@
-# Scaffolding
-
-Generates a new model class and its associated:
-
- * migration
- * resource
- * decorator (todo)
- * service (todo)
- * repository (todo)
- * resource spec (todo)
- * decorator spec (todo)
- * service spec (todo)
- * repository spec (todo)
-
-## Usage
-
-Set `MODEL_CLASS_FULL_NAME` to the full name of the class, and run:
-
- ```
-bundle exec ruby scaffolding/run.rb
- ```
-
-Note that the class name must be in the format X::Y::Z (a class nested inside two modules).

data/scaffolding/run.rb

@@ -1,242 +0,0 @@
-#!/usr/bin/env ruby
-
-require "pact_broker/string_refinements"
-require "pact_broker/project_root"
-require "date"
-require "erb"
-require "pathname"
-require "fileutils"
-
-using PactBroker::StringRefinements
-
-MODEL_CLASS_FULL_NAME = "PactBroker::Foos::Foo"
-DRY_RUN = true
-
-TEMPLATE_DIR = Pathname.new(File.join(__dir__, "templates"))
-MIGRATIONS_DIR = PactBroker.project_root.join("db", "migrations")
-LIB_DIR = PactBroker.project_root.join("lib")
-SPEC_DIR = PactBroker.project_root.join("spec", "lib")
-
-def model_full_class_name
-  MODEL_CLASS_FULL_NAME
-end
-
-def today
-  DateTime.now.strftime("%Y%m%d")
-end
-
-def require_path_prefix
-  model_top_module.snakecase
-end
-
-def migration_path
-  MIGRATIONS_DIR.join(today + "_create_#{table_name}_table.rb")
-end
-
-def model_class_name
-  model_full_class_name.split("::").last
-end
-
-def model_top_module
-  model_full_class_name.split("::").first
-end
-
-# Resource
-
-def resource_top_module
-  model_top_module
-end
-
-def resource_class_name
-  model_class_name
-end
-
-def resource_class_full_name
-  "#{resource_top_module}::Api::Resources::#{resource_class_name}"
-end
-
-def resource_url_path
-  model_class_name_snakecase.tr("_", "-") + "s"
-end
-
-# Decorator
-
-def decorator_class_name
-  model_class_name + "Decorator"
-end
-
-def decorator_full_class_name
-  "#{resource_top_module}::Api::Decorators::#{resource_class_name}Decorator"
-end
-
-def decorator_instance_name
-  model_class_name_snakecase + "_decorator"
-end
-
-# Service
-
-def service_class_full_name
-  model_full_class_name.split("::")[0..1].join("::") + "::Service"
-end
-
-def service_class_name
-  service_class_full_name.split("::").last
-end
-
-def model_secondary_module
-  model_full_class_name.split("::")[1]
-end
-
-def model_instance_name
-  model_class_name.snakecase
-end
-
-def policy_name
-  model_secondary_module.snakecase + "::" + model_class_name.snakecase
-end
-
-def service_instance_name
-  model_class_name.snakecase + "_service"
-end
-
-# Repository
-
-def repository_class_full_name
-  model_full_class_name.split("::")[0..1].join("::") + "::Repository"
-end
-
-def repository_class_name
-  repository_class_full_name.split("::").last
-end
-
-def repository_instance_name
-  model_class_name.snakecase + "_repository"
-end
-
-# Table
-
-def table_name
-  model_class_name.snakecase + "s"
-end
-
-def model_class_name_snakecase
-  model_class_name.snakecase
-end
-
-# File paths
-
-def migration_template_path
-  File.join(__dir__, "templates", "migration.erb")
-end
-
-def model_path
-  LIB_DIR.join(*model_full_class_name.split("::").collect(&:snakecase)).to_s.chomp("/") + ".rb"
-end
-
-def resource_path
-  LIB_DIR.join(model_top_module.snakecase, "api", "resources", model_class_name_snakecase + ".rb")
-end
-
-def resource_spec_path
-  resource_path.to_s.gsub(LIB_DIR.to_s, SPEC_DIR.to_s).gsub(".rb", "_spec.rb")
-end
-
-def resource_require_path
-  Pathname.new(resource_path).relative_path_from(LIB_DIR).to_s.chomp(".rb")
-end
-
-def decorator_path
-  LIB_DIR.join(model_top_module.snakecase, "api", "decorators", model_class_name_snakecase + "_decorator.rb")
-end
-
-def decorator_require_path
-  Pathname.new(decorator_path).relative_path_from(LIB_DIR).to_s.chomp(".rb")
-end
-
-def service_path
-  LIB_DIR.join(*service_class_full_name.split("::").collect(&:snakecase)).to_s.chomp("/") + ".rb"
-end
-
-def service_require_path
-  Pathname.new(service_path).relative_path_from(LIB_DIR).to_s.chomp(".rb")
-end
-
-def service_spec_path
-  service_path.to_s.gsub(LIB_DIR.to_s, SPEC_DIR.to_s).gsub(".rb", "_spec.rb")
-end
-
-def repository_path
-  LIB_DIR.join(*repository_class_full_name.split("::").collect(&:snakecase)).to_s.chomp("/") + ".rb"
-end
-
-def repository_require_path
-  Pathname.new(repository_path).relative_path_from(LIB_DIR).to_s.chomp(".rb")
-end
-
-def repository_spec_path
-  repository_path.to_s.gsub(LIB_DIR.to_s, SPEC_DIR.to_s).gsub(".rb", "_spec.rb")
-end
-
-# Generate
-
-def generate_migration_file
-  generate_file(migration_template_path, migration_path)
-end
-
-def generate_model_file
-  generate_file(TEMPLATE_DIR.join("model.erb"), model_path)
-end
-
-def generate_resource_file
-  generate_file(TEMPLATE_DIR.join("resource.erb"), resource_path)
-end
-
-def generate_resource_spec
-  generate_file(TEMPLATE_DIR.join("resource_spec.rb.erb"), resource_spec_path)
-end
-
-def generate_decorator_file
-  generate_file(TEMPLATE_DIR.join("decorator.rb.erb"), decorator_path)
-end
-
-def generate_service_file
-  generate_file(TEMPLATE_DIR.join("service.rb.erb"), service_path)
-end
-
-def generate_service_spec_file
-  generate_file(TEMPLATE_DIR.join("service_spec.rb.erb"), service_spec_path)
-end
-
-def generate_repository_file
-  generate_file(TEMPLATE_DIR.join("repository.rb.erb"), repository_path)
-end
-
-def generate_repository_spec_file
-  generate_file(TEMPLATE_DIR.join("repository_spec.rb.erb"), repository_spec_path)
-end
-
-
-def generate_file(template, destination)
-  puts "Generating file #{destination}"
-  file_content = ERB.new(File.read(template)).result(binding).tap { |it| puts it }
-  if !DRY_RUN
-    FileUtils.mkdir_p(File.dirname(destination))
-    if File.exist?(destination)
-      raise "File #{destination} already exists"
-    else
-      File.open(destination, "w") { |file| file << file_content }
-    end
-  end
-end
-
-generate_migration_file
-generate_model_file
-generate_resource_file
-generate_resource_spec
-generate_decorator_file
-generate_service_file
-generate_service_spec_file
-generate_repository_file
-generate_repository_spec_file
-
-puts "THIS WAS A DRY RUN. Set DRY_RUN = true to generate the files." if DRY_RUN

data/scaffolding/templates/decorator.rb.erb

@@ -1,15 +0,0 @@
-require "pact_broker/api/decorators/base_decorator"
-require "pact_broker/api/decorators/timestamps"
-
-
-module <%= resource_top_module %>
-  module Api
-    module Decorators
-      class <%= decorator_class_name %> < BaseDecorator
-        property :uuid
-
-        include Timestamps
-      end
-    end
-  end
-end

data/scaffolding/templates/migration.erb

@@ -1,12 +0,0 @@
-Sequel.migration do
-  change do
-    create_table(:<%= table_name %>, charset: "utf8") do
-      primary_key :id
-      String :uuid, null: false
-
-      DateTime :created_at, null: false
-      DateTime :updated_at, null: false
-      index [:uuid], unique: true, name: "<%= table_name %>_uuid_index"
-    end
-  end
-end

data/scaffolding/templates/model.erb

@@ -1,14 +0,0 @@
-require "sequel"
-require "pact_broker/repositories/helpers"
-
-module <%= model_top_module %>
-  module <%= model_secondary_module %>
-    class <%= model_class_name %> < Sequel::Model
-      plugin :timestamps, update_on_create: true
-
-      dataset_module do
-        include PactBroker::Repositories::Helpers
-      end
-    end
-  end
-end

data/scaffolding/templates/repository.rb.erb

@@ -1,18 +0,0 @@
-require "pact_broker/logging"
-require "pact_broker/error"
-
-module <%= model_top_module %>
-  module <%= model_secondary_module %>
-    class <%= repository_class_name %>
-      include PactBroker::Logging
-
-      def self.find_by_uuid(uuid)
-        <%= model_class_name %>.where(uuid: uuid).single_record
-      end
-
-      def self.find_by_uuid!(uuid)
-        find_by_uuid(uuid) or raise PactBroker::Error.new("<%= model_class_name %> with UUID #{uuid} does not exist")
-      end
-    end
-  end
-end

data/scaffolding/templates/repository_spec.rb.erb

@@ -1,9 +0,0 @@
-require "<%= repository_require_path %>"
-
-module <%= model_top_module %>
-  module <%= model_secondary_module %>
-    describe <%= repository_class_name %> do
-
-    end
-  end
-end

data/scaffolding/templates/resource.erb

@@ -1,46 +0,0 @@
-require "pact_broker/api/resources/base_resource"
-require "<%= decorator_require_path %>"
-
-module <%= resource_top_module %>
-  module Api
-    module Resources
-      class <%= resource_class_name %> < BaseResource
-        def content_types_provided
-          [["application/hal+json", :to_json]]
-        end
-
-        def allowed_methods
-          ["GET", "OPTIONS"]
-        end
-
-        def resource_exists?
-          !!<%= model_instance_name %>
-        end
-
-        def to_json
-          decorator_class(:<%= decorator_instance_name %>).new(<%= model_instance_name %>).to_json(decorator_options)
-        end
-
-        def policy_name
-          :'<%= policy_name %>'
-        end
-
-        private
-
-        attr_reader :<%= model_instance_name %>
-
-        def <%= model_instance_name %>
-          @<%= model_instance_name %> ||= <%= service_instance_name %>.find_by_uuid(uuid)
-        end
-
-        # DELETE THIS!!! It's just here so that the generated test can be run
-        def <%= service_instance_name %>
-        end
-
-        def uuid
-          identifier_from_path[:<%= model_instance_name %>_uuid]
-        end
-      end
-    end
-  end
-end

data/scaffolding/templates/resource_spec.rb.erb

@@ -1,78 +0,0 @@
-require "<%= resource_require_path %>"
-
-module <%= resource_top_module %>
-  module Api
-    module Resources
-      describe <%= resource_class_name %> do
-        before do
-          # Delete this when the route has been added to the API
-          allow_any_instance_of(described_class).to receive(:application_context).and_return(PactBroker::ApplicationContext.default_application_context)
-          allow_any_instance_of(described_class).to receive(:<%= service_instance_name %>).and_return(<%= service_instance_name %>)
-          allow(<%= service_instance_name %>).to receive(:find_by_uuid).and_return(<%= model_instance_name %>)
-          allow(<%= decorator_full_class_name %>).to receive(:new).and_return(decorator)
-        end
-
-        let(:<%= model_instance_name %>) { instance_double("<%= model_full_class_name %>") }
-        let(:parsed_<%= model_instance_name %>) { double("parsed <%= model_instance_name %>") }
-        let(:<%= service_instance_name %>) { class_double("<%= service_class_full_name %>").as_stubbed_const }
-        let(:path) { "/<%= resource_url_path %>/#{uuid}" }
-        let(:uuid) { "12345678" }
-        let(:rack_headers) do
-          {
-            "HTTP_ACCEPT" => "application/hal+json"
-          }
-        end
-        let(:decorator) do
-          instance_double("<%= decorator_full_class_name %>",
-            to_json: "response",
-            from_json: parsed_<%= model_instance_name %>
-          )
-        end
-
-        # Delete this when the route has been added to the API - this is just here so that the generated
-        # spec can be run to see if it works.
-        let(:app) do
-          pact_api = Webmachine::Application.new do |app|
-            app.routes do
-              add ["<%= resource_url_path %>", :<%= model_instance_name %>_uuid], <%= resource_class_full_name %>, { resource_name: "<%= model_instance_name %>" }
-            end
-          end
-          pact_api.configure do |config|
-            config.adapter = :RackMapped
-          end
-
-          pact_api.adapter
-        end
-
-        describe "GET" do
-          subject { get(path, nil, rack_headers) }
-
-          it "attempts to find the <%= model_class_name %>" do
-            expect(<%= service_class_full_name %>).to receive(:find_by_uuid).with(uuid)
-            subject
-          end
-
-          context "when the <%= model_instance_name %> does not exist" do
-            let(:<%= model_instance_name %>) { nil }
-
-            it { is_expected.to be_a_404_response }
-          end
-
-          context "when the <%= model_class_name %> exists" do
-            it "generates a JSON representation of the <%= model_class_name %>" do
-              expect(<%= decorator_full_class_name %>).to receive(:new).with(<%= model_instance_name %>)
-              expect(decorator).to receive(:to_json).with(user_options: hash_including(base_url: "http://example.org"))
-              subject
-            end
-
-            it { is_expected.to be_a_hal_json_success_response }
-
-            it "includes the JSON representation in the response body" do
-              expect(subject.body).to eq "response"
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/scaffolding/templates/service.rb.erb

@@ -1,22 +0,0 @@
-require "pact_broker/logging"
-require "<%= require_path_prefix %>/repositories"
-require "<%= require_path_prefix %>/services"
-
-module <%= model_top_module %>
-  module <%= model_secondary_module %>
-    module <%= service_class_name %>
-      extend self
-      extend <%= model_top_module %>::Repositories
-      extend <%= model_top_module %>::Services
-      include PactBroker::Logging
-
-      def self.find_by_uuid(uuid)
-        <%= repository_instance_name %>.find_by_uuid(uuid)
-      end
-
-      def self.find_by_uuid!(uuid)
-        <%= repository_instance_name %>.find_by_uuid!(uuid)
-      end
-    end
-  end
-end

data/scaffolding/templates/service_spec.rb.erb

@@ -1,9 +0,0 @@
-require "<%= service_require_path %>"
-
-module <%= model_top_module %>
-  module <%= model_secondary_module %>
-    describe <%= service_class_name %> do
-
-    end
-  end
-end