datashift_journey 0.1.2

data/app/models/datashift_journey/collector/data_node.rb

@@ -0,0 +1,18 @@
+module DatashiftJourney
+  module Collector
+    class DataNode < ActiveRecord::Base
+
+      self.table_name = 'dsj_data_nodes'
+
+      # Instance of the DatashiftJourney.journey_plan_class this data was collected for.
+      #
+      # Model holding the state machine Plan
+      belongs_to :plan, polymorphic: true
+
+      # generic definition of the field this data relates to - card type, street address, profile id etc
+      belongs_to :form_field, class_name: 'DatashiftJourney::Collector::FormField', foreign_key: :form_field_id
+
+      validates_presence_of :field_value
+    end
+  end
+end

data/app/models/datashift_journey/collector/form_definition.rb

@@ -0,0 +1,35 @@
+module DatashiftJourney
+  module Collector
+
+    # Associated with a REFORM class - stores related Form definition data in the DB,
+    # such as the fields associated with this form.
+    #
+    # Each step or state in the plan will have an associated ReForm + FormDefinition
+    #
+    # Similar in intention to the Page Object Pattern, store and provide helpers for
+    # rendering forms and HTML in the associated state View
+    #
+    class FormDefinition < ActiveRecord::Base
+
+      self.table_name = 'dsj_form_definitions'
+
+      has_many :form_fields, class_name: 'DatashiftJourney::Collector::FormField', dependent: :destroy, foreign_key: :form_definition_id
+      accepts_nested_attributes_for :form_fields
+
+      validates_presence_of :state
+      validates_uniqueness_of :state
+
+      def field_ids
+        form_fields.collect(&:id)
+      end
+
+      private
+
+      # N.B Validations are called BEFORE before_create or before_save
+      before_validation do |record|
+        record.state ||= DatashiftJourney::FormObjectFactory.state_name(self.klass)
+      end
+
+    end
+  end
+end

data/app/models/datashift_journey/collector/form_field.rb

@@ -0,0 +1,61 @@
+module DatashiftJourney
+  module Collector
+
+    # This DEFINES a single Field in a Form, where a field is generally a form
+    # element that collects some kind of data
+    #
+    class FormField < ActiveRecord::Base
+
+      self.table_name = 'dsj_form_fields'
+
+      belongs_to :form_definition, class_name: 'FormDefinition', foreign_key: :form_definition_id
+
+      validates_presence_of :form_definition, :name, :category
+
+      # Notes:
+      #
+      #  Cannot use "select" - keyword already defined by Active Record.
+      #
+      #   When assigning a category of - :select_option - the form should also provide a helper method
+      #   to populate the select dropdown as per https://api.rubyonrails.org/v6.0.3.4/classes/ActionView/Helpers/FormOptionsHelper.html
+      #
+      #   The expected method format is : options_for_select_<field name>
+      #
+      #   So a field definition :
+      #
+      #       journey_plan_form_field name: :run_time, category: :select_option
+      #
+      #   Would also require a select dropdown helper method called options_for_select_run_time, for example,
+      #   in our Form we could do something like:
+      #
+      #       def options_for_select_run_time
+      #         options_for_select(run_times, run_times)
+      #       end
+      #
+      #       private
+      #
+      #       def run_times
+      #         @run_times ||= %w[PyTorch TensorFlow TensorRT]
+      #       end
+      #
+      enum category: [:string, :select_option, :text_area, :number, :date ]
+      #  :check_box, :radio_button, password range date time datetime_local month week search email telephone url color }
+
+      scope :for_form_and_field, ->(form_name, field_name) {
+        page_state = DatashiftJourney::Collector::FormDefinition.where('state = ?', form_name).first
+        return nil unless page_state
+        page_state.form_fields.where('name = ?', field_name).first
+      }
+
+      # TODO - revisit snippets
+      #
+      # many :snippets, class_name: 'FieldSnippet', foreign_key: :form_field_id, dependent: :destroy
+      # has_many :field_snippets, foreign_key: :form_field_id
+      # has_many :snippets, through: :field_snippets # , foreign_key: :page_state_id
+      # def question
+      #   Snippet.to_sentance(snippets)
+      # end
+
+    end
+  end
+end

data/app/models/datashift_journey/journey_review.rb

@@ -0,0 +1,65 @@
+module DatashiftJourney
+  # This handles supplying data for a SUMMARY or REVIEW page or e.g. an email contaning a summary,
+  # usually as the key/value data, associated with an Enrollment state.
+  #
+  # N.B - Our state engine collector the state of the journey (not essentially the state of the journey_plan), hence a state
+  # is more analogous to Page
+  # So here review data is assigned for DATA collected DURING a particular state - effectively the data
+  # saved during the UPDATE on that State
+  #
+  class JourneyReview
+
+    extend PrepareDataForReview
+    include PrepareDataForReview
+
+    attr_reader :journey_plan, :root_i18n_scope
+    delegate :state, :state_name, to: :journey_plans
+
+    # This class can be reused anywhere that requires yaml-parsed summary data for an journey_plan.
+    # Hence the root_i18n_scope specifies the scope under which there must be a :common key at
+    # least. It is recommended that the root_i18n_scopeis a folder under a config/locales
+    # directory containing at least a common.en.yml file, and probably organisation-
+    # specific yml files too, which override common sections (see #prepare_review_data_list).
+    def initialize(journey_plan, root_i18n_scope = '.journey_plan_review')
+      @journey_plan = journey_plan
+      @root_i18n_scope = root_i18n_scope
+    end
+
+    # Merge common 'sections' in the review data with any app-specific
+    # sections; if an app-specific section matches by heading (title) then it replaces
+    # the standard one. In this way apps can override discrete sections
+    # in the summary data.
+    #
+    def prepare_review_data_list
+      merged_sections = common_sections.each_with_index do |common_section, idx|
+        replacement = organisation_specific_sections.find do |org_specific_section|
+          org_specific_section.heading == common_section.heading
+        end
+        common_sections[idx] = replacement if replacement
+      end
+      merged_sections
+    end
+
+    private
+
+    def common_sections
+      @common_sections ||= prepare_from_locale(journey_plan, common_i18n_key)
+    end
+
+    def app_specific_sections
+      @app_specific_review_data ||= begin
+        prepare_from_locale(journey_plan, app_type_i18n_key)
+      end
+    end
+
+    # e.g. ".journey_plan_review"
+    def common_i18n_key
+      root_i18n_scope.to_s
+    end
+
+    # e.g. ".journey_plan_review.limited_company"
+    def app_type_i18n_key
+      "#{root_i18n_scope}.#{@journey_plan.app.type_name}"
+    end
+  end
+end

data/app/models/datashift_journey/review_data_section.rb

@@ -0,0 +1,32 @@
+module DatashiftJourney
+
+  class ReviewDataSection
+
+    attr_accessor :heading
+    attr_accessor :rows
+
+    # :link_state - The target url for Change This. If not specified, defaults to the section page/state
+    #               Supports :none to leave column empty
+    #
+    Struct.new('ReviewDataRow', :title, :data, :link_state, :link_title, :heading) do
+      def target(journey_plan)
+        return nil if link_state.to_sym == :none
+        DatashiftJourney::Engine.routes.url_helpers.review_state_path(link_state, journey_plan)
+      end
+    end
+
+    def initialize(heading)
+      @heading = heading
+      @rows = []
+    end
+
+    # Add a new row to this Section. Returns the ReviewDataRow created
+    def add(title, data, link_state, link_title)
+      rows << Struct::ReviewDataRow.new(title, data, link_state, link_title, heading)
+      rows.last
+    end
+
+    delegate :size, :empty?, to: :rows
+
+  end
+end

data/app/serializers/datashift_journey/collector/page_state_serializer.rb

@@ -0,0 +1,9 @@
+module DatashiftJourney
+  module Collector
+    class PageStateSerializer < ActiveModel::Serializer
+      attributes :id, :form_name, :created_at
+
+      link(:self) {page_state_url(object) }
+    end
+  end
+end

data/app/serializers/state_machines/state/state_serializer.rb

@@ -0,0 +1,5 @@
+module StateMachines
+    class StateSerializer < ActiveModel::Serializer
+      attributes :name, :value, :initial
+    end
+end

data/app/views/datashift_journey/collector/_generic_form.html.erb

@@ -0,0 +1,14 @@
+<header class="text">
+  <h1 class="form-title heading-large" id="groupLabel"><%= form.model.header %></h1>
+</header>
+
+<fieldset>
+
+  <% form.model.form_fields.each do |ff| %>
+      <%= fields_for :data_nodes do |d| %>
+          <legend class="visuallyhidden"><%= ff.question %></legend>
+          <%= d.label ff.field,  ff.question, class: 'form-label' %>
+          <%= d.text_field :field, class: 'form-control form-control-char-50' %>
+      <% end %>
+  <% end %>
+</fieldset>

data/app/views/datashift_journey/errors/401.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title, create_title('global.401_unauthorized.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.401_unauthorized.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%= t 'global.401_unauthorized.message1' %></p>
+
+<p style="max-width: 30em;"><%=t 'global.401_unauthorized.message2'%></p>

data/app/views/datashift_journey/errors/403.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title, create_title('global.403_forbidden.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.403_forbidden.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%=t 'global.403_forbidden.message1'%></p>
+
+<p style="max-width: 30em;"><%=t 'global.403_forbidden.message2'%></p>

data/app/views/datashift_journey/errors/404.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title, create_title('global.404_notfound.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.404_notfound.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%=t 'global.404_notfound.message1'%></p>
+
+<p style="max-width: 30em;"><%=t 'global.404_notfound.message2'%></p>

data/app/views/datashift_journey/errors/422.html.erb

@@ -0,0 +1,11 @@
+<% content_for :page_title, create_title('global.422_unprocessable_entity.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.422_unprocessable_entity.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%=t 'global.422_unprocessable_entity.message1'%></p>

data/app/views/datashift_journey/errors/500.html.erb

@@ -0,0 +1,13 @@
+<% content_for :page_title, create_title('global.500_internal_server_error.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.500_internal_server_error.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%=t 'global.500_internal_server_error.message1'%></p>
+
+<p style="max-width: 30em;"><%=t 'global.500_internal_server_error.message2'%></p>

data/app/views/datashift_journey/errors/503.html.erb

@@ -0,0 +1,11 @@
+<% content_for :page_title, create_title('global.503_bad_gateway.heading') + " (#{response.status})" %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top:30px; margin-bottom:15px;">
+    <%=t 'global.503_bad_gateway.heading'%>
+  </h1>
+</header>
+
+<p style="max-width: 30em;"><%=t 'global.503_bad_gateway.message1'%></p>

data/app/views/datashift_journey/errors/invalid_authenticity_token.html.erb

@@ -0,0 +1,14 @@
+<% content_for :page_title, create_title('global.invalid_authenticity_token.heading') %>
+
+<%= yield :error_header %>
+
+<header>
+  <h1 style="font-size: 48px; font-weight:bold; margin-top: 30px; margin-bottom: 15px;">
+    <%=t 'global.invalid_authenticity_token.heading'%>
+  </h1>
+</header>
+
+<p>
+  <%= t 'global.invalid_authenticity_token.message_html',
+        link: link_to('cookies', main_app.page_path('cookies')) %>
+</p>

data/app/views/datashift_journey/journey_ends/new.html.erb

@@ -0,0 +1,5 @@
+<p id="notice"><%= notice %></p>
+
+<div class="field">
+  COMPLETE - there are no further pages defined
+</div>

data/app/views/datashift_journey/journey_ends/show.html.erb

@@ -0,0 +1,5 @@
+<p id="notice"><%= notice %></p>
+
+<div class="field">
+  COMPLETE - there are no further pages defined
+</div>

data/app/views/datashift_journey/journey_plans/_form.html.erb

@@ -0,0 +1,14 @@
+<%= render 'datashift_journey/shared/errors', form: form %>
+<%= render 'datashift_journey/state_jumper/toolbar' %>
+
+<% state = journey_plan.state %>
+
+<% url = local_assigns[:form_url] ? form_url : datashift_journey.edit_journey_plan_path %>
+<% method = local_assigns[:form_method] ? form_method : :post %>
+
+<%= form_for form, as: state, url: url, method: method, class: 'form' do |f| %>
+
+  <%= hidden_field_tag "rendered_state", local_assigns[:rendered_state] || state  %>
+
+  <%= render_if_exists state, form: form, f: f, journey_plan: journey_plan %>
+<% end %>

data/app/views/datashift_journey/journey_plans/_render_fields.html.erb

@@ -0,0 +1,24 @@
+<% ids = form.definition.field_ids  %>
+
+<% key = form.params_key %>
+
+<% form.journey_plan.data_nodes.select { |dn| ids.include?(dn.form_field_id)  }.sort.each_with_index do |data_node, i| %>
+  <%= f.fields_for :data_nodes, data_node do |a| %>
+
+    <% name = data_node.form_field.name %>
+
+    <div class="form-group">
+      <%= a.label name %>
+      <%= hidden_field_tag "#{key}[data_nodes][form_field][#{i}]", name %>
+
+      <% if data_node.form_field.select_option? %>
+        <%= select_tag "#{key}[data_nodes][field_value][#{i}]", form.send("options_for_select_#{name}"),  { class: 'form-control', required: true } %>
+      <% elsif data_node.form_field.number? %>
+        <%= number_field_tag "#{key}[data_nodes][field_value][#{i}]", data_node.field_value,  { class: 'form-control', required: true } %>
+      <% else %>
+        <%= text_field_tag "#{key}[data_nodes][field_value][#{i}]", data_node.field_value, size: "64", class: "form-control", required: true %>
+      <% end %>
+
+    </div>
+  <% end  %>
+<% end  %>

data/app/views/datashift_journey/journey_plans/edit.html.erb

@@ -0,0 +1,6 @@
+<%= render 'form',
+           form: form,
+           journey_plan: journey_plan,
+           form_method: :patch,
+           form_url: datashift_journey.journey_plan_path(journey_plan)
+%>

data/app/views/datashift_journey/journey_plans/new.html.erb

@@ -0,0 +1,6 @@
+<%= render 'form',
+           form: form,
+           journey_plan: journey_plan,
+           form_url: url_for(:controller => 'journey_plans', :action => 'create')
+%>
+

data/app/views/datashift_journey/shared/_default_actions.html.erb

@@ -0,0 +1,6 @@
+<% css = local_assigns[:form_group_css] ?  form_group_css : "col pull-right" %>
+
+<div class="form-group <%= css %>">
+  <%= f.submit t('.', :default => t("global.continue")), class: "journey-plans-submit-button"  %>
+  <%= back_a_state_link(@journey_plan) %>
+</div>

data/app/views/datashift_journey/shared/_errors.html.erb

@@ -0,0 +1,19 @@
+<% errors = form.errors || [] %>
+
+<% if errors.size > 0 %>
+    <div class="error-summary" role="group" aria-labelledby="groupLabel" tabindex="-1">
+
+      <h1 class="heading-medium error-summary-heading" id="error-summary-heading">
+        <%= t '.you_have' %> <%= pluralize(errors.count, "error") %>
+      </h1>
+
+      <ul class="error-summary-list">
+        <% errors.each do |attr, msg| %>
+            <li>
+              <%= link_to msg.html_safe, "##{error_link_id(attr)}", class: "error-text" %>
+            </li>
+        <% end %>
+      </ul>
+    </div>
+<% end %>
+

data/app/views/datashift_journey/shared/_submit_action.html.erb

@@ -0,0 +1,5 @@
+<% css = local_assigns[:form_group_css] ?  form_group_css : "col pull-right" %>
+
+<div class="form-group <%= css %>">
+  <%= f.submit t('.', :default => t("global.continue")), class: "journey-plans-submit-button"  %>
+</div>

data/app/views/datashift_journey/state_jumper/_toolbar.html.erb

@@ -0,0 +1,16 @@
+<%
+  if( Rails.env.development? &&
+      DatashiftJourney::Configuration.call.add_state_jumper_toolbar &&
+      DatashiftJourney::Configuration.call.state_jumper_states.size > 0)
+%>
+  <%- content_for :datashift_journey_state_jumper do %>
+    <div id="datashift_journey_state_jumper">
+      <ul>
+        <li>DS Journey State Jumper: </li>
+        <% DatashiftJourney::Configuration.call.state_jumper_states.each do |entry| %>
+          <li> <%= link_to entry.display, datashift_journey.build_and_display_path(entry.state, entry.factory) %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+<% end %>

data/config/brakeman.ignore

@@ -0,0 +1,42 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "Cross Site Scripting",
+      "warning_code": 4,
+      "fingerprint": "f1fc7068ce25236b1c6f9b137081e044d819fbbc32cb0a5100e86720cd10ba96",
+      "message": "Unsafe parameter value in link_to href",
+      "file": "app/views/datashift_journey/addresses/edit.html.erb",
+      "line": 4,
+      "link": "http://brakemanscanner.org/docs/warning_types/link_to_href",
+      "code": "link_to(\"Show\", datashift_journey.address_path(DatashiftJourney::Address.find(params[:id])))",
+      "render_path": ["DatashiftJourney::AddressesController#edit"],
+      "location": {
+        "type": "template",
+        "template": "datashift_journey/addresses/edit (DatashiftJourney::AddressesController#edit)"
+      },
+      "user_input": "params",
+      "confidence": "Medium",
+      "note": "Ideally we would pass the instance of @address directly to link_to however because of the namespacing we have to call address_path passing the instance to that. It is still not a user entered value hence this is a false positive by brakeman."
+    },
+    {
+      "warning_type": "Cross Site Scripting",
+      "warning_code": 4,
+      "fingerprint": "49f08e33accfe24201463ed567cc259387b05b215fdab284d03697d01e013ca1",
+      "message": "Unsafe parameter value in link_to href",
+      "file": "app/views/datashift_journey/addresses/show.html.erb",
+      "line": 2,
+      "link": "http://brakemanscanner.org/docs/warning_types/link_to_href",
+      "code": "link_to(\"Edit\", datashift_journey.edit_address_path(DatashiftJourney::Address.find(params[:id])))",
+      "render_path": ["DatashiftJourney::AddressesController#show"],
+      "location": {
+        "type": "template",
+        "template": "datashift_journey/addresses/show (DatashiftJourney::AddressesController#show)"
+      },
+      "user_input": "params",
+      "confidence": "Medium",
+      "note": "Ideally we would pass the instance of @address directly to link_to however because of the namespacing we have to call address_path passing the instance to that. It is still not a user entered value hence this is a false positive by brakeman."
+    }
+  ],
+  "updated": "2015-06-26 15:03:34 +0100",
+  "brakeman_version": "3.0.3"
+}

data/config/i18n-tasks.yml

@@ -0,0 +1,103 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    - config/locales/%{locale}.yml
+    ## More files:
+    - config/locales/**/*.%{locale}.yml
+    - spec/dummy/config/locales/%{locale}.yml
+    ## Another gem:
+    # - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: convervative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/views
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/presenters
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # include: ["*.rb", "*.html.slim"]
+
+  ## Default scanner finds t() and I18n.t() calls.
+  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
+
+## Google Translate
+# translation:
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   api_key: "AbC-dEf5"
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+# ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*

data/config/initializers/exceptions_app.rb

@@ -0,0 +1,3 @@
+unless Rails.application.config.consider_all_requests_local
+  Rails.application.config.exceptions_app = DatashiftJourney::Engine.routes
+end

data/config/initializers/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/vnd.api+json", :json

data/config/initializers/rswag-api.rb

@@ -0,0 +1,14 @@
+Rswag::Api.configure do |c|
+
+  # Specify a root folder where Swagger JSON files are located
+  # This is used by the Swagger middleware to serve requests for API descriptions
+  # NOTE: We are using rswag-specs to generate Swagger, sp this PATH is duplicated in spec/swagger_helper.rb
+
+  c.swagger_root = File.join(DatashiftJourney::Engine.root, 'spec', 'swagger')
+
+  # Inject a lamda function to alter the returned Swagger prior to serialization
+  # The function will have access to the rack env for the current request
+  # For example, you could leverage this to dynamically assign the "host" property
+  #
+  #c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

data/config/initializers/rswag-ui.rb

@@ -0,0 +1,9 @@
+Rswag::Ui.configure do |c|
+
+  # List the Swagger endpoints that you want to be documented through the swagger-ui
+  # The first parameter is the path (absolute or relative to the UI host) to the corresponding
+  # JSON endpoint and the second is a title that will be displayed in the document selector
+  # NOTE: If you're using rspec-api to expose Swagger files (under swagger_root) as JSON endpoints,
+  # then the list below should correspond to the relative paths for those endpoints
+  c.swagger_endpoint '/api-docs/v1/swagger.json', 'API V1 Docs'
+end