govuk_tech_docs 1.5.0 → 1.6.0

data/lib/govuk_tech_docs/api_reference/templates/api_reference_full.html.erb

@@ -0,0 +1,9 @@
+<h1 id="<%=  info.title.parameterize %>"><%= info.title %> v<%= info.version %></h1>
+<%= markdown(info.description) %>
+<% if server %>
+<h2 id="base-url">Base URL</h2>
+<p><strong><%= server.url %></strong></p>
+<% end %>
+<%= paths %>
+<h2 id="schemas">Schemas</h2>
+<%= schemas %>

data/lib/govuk_tech_docs/api_reference/templates/operation.html.erb

@@ -0,0 +1,11 @@
+<h3 id="<%= id %>"><%= key %></h3>
+<% if operation.summary %>
+  <p><em><%= operation.summary %></em></p>
+<% end %>
+<% if operation.description %>
+  <p><%= markdown(operation.description) %></p>
+<% end %>
+
+<%= parameters %>
+
+<%= responses %>

data/lib/govuk_tech_docs/api_reference/templates/parameters.html.erb

@@ -0,0 +1,28 @@
+<% if parameters.any? %>
+<h4 id="<%= id %>">Parameters</h4>
+<table>
+<thead>
+<tr><th>Parameter</th><th>In</th><th>Type</th><th>Required</th><th>Description</th></tr>
+</thead>
+<tbody>
+<% parameters.each do |parameter| %>
+<tr>
+<td><%= parameter.name %></td>
+<td><%= parameter.in %></td>
+<td><%= parameter.schema.type %></td>
+<td><%= parameter.required? %></td>
+<td><%= markdown(parameter.description) %>
+<% if parameter.schema.enum %>
+<p>Available items:</p>
+<ul>
+<% parameter.schema.enum.each do |item| %>
+<li><%= item %></li>
+<% end %>
+</ul>
+<% end %>
+</td>
+</tr>
+<% end %>
+</tbody>
+</table>
+<% end %>

data/lib/govuk_tech_docs/api_reference/templates/path.html.erb

@@ -0,0 +1,4 @@
+<% if text %>
+<h2 id="<%= id %>"><%= text %></h2>
+<% end %>
+<%= operations %>

data/lib/govuk_tech_docs/api_reference/templates/responses.html.erb

@@ -0,0 +1,33 @@
+<% if responses.any? %>
+<h4 id="<%= id %>">Responses</h4>
+<table>
+<thead>
+<tr><th>Status</th><th>Description</th><th>Schema</th></tr>
+</thead>
+<tbody>
+<% responses.each do |key,response| %>
+<tr>
+<td><%= key %></td>
+<td>
+<%= markdown(response.description) %>
+<% if response.content['application/json']
+if response.content['application/json']["example"]
+  request_body = json_prettyprint(response.content['application/json']["example"])
+else
+  request_body = json_output(response.content['application/json'].schema)
+end
+end %>
+<% if !request_body.blank? %>
+<pre><code><%= request_body %></code></pre>
+<% end %>
+</td>
+<td>
+<%= if response.content['application/json']
+  get_schema_link(response.content['application/json'].schema)
+end %>
+</td>
+</tr>
+<% end %>
+</tbody>
+</table>
+<% end %>

data/lib/govuk_tech_docs/api_reference/templates/schema.html.erb

@@ -0,0 +1,29 @@
+<h3 id="<%= id = 'schema-' + title; id.parameterize %>"><%= title %></h3>
+<%= markdown(schema.description) %>
+<% if properties.any? %>
+<table>
+<thead>
+<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th><th>Schema</th></tr>
+</thead>
+<tbody>
+<% properties.each do |property| %>
+<tr>
+<td><%= property[0] %></td>
+<td><%= property[1].type %></td>
+<td><%= property[1].required.present? %></td>
+<td><%= markdown(property[1].description) %></td>
+<td>
+  <%=
+  schema = property[1]
+  # If property is an array, check the items property for a reference.
+  if property[1].type == 'array'
+    schema = property[1]['items']
+  end
+  # Only print a link if it's a referenced object.
+  get_schema_link(schema) if schema.node_context.referenced_by.to_s.include? '#/components/schemas' and !schema.node_context.source_location.to_s.include? '/properties/' %>
+</td>
+</tr>
+<% end %>
+</tbody>
+</table>
+<% end %>

data/lib/govuk_tech_docs/page_review.rb

@@ -2,8 +2,9 @@ module GovukTechDocs
   class PageReview
     attr_reader :page
 
-    def initialize(page)
+    def initialize(page, config = {})
       @page = page
+      @config = config
     end
 
     def review_by
@@ -24,13 +25,24 @@ module GovukTechDocs
     end
 
     def owner_slack
-      page.data.owner_slack
+      page.data.owner_slack || default_owner_slack
     end
 
     def owner_slack_url
+      return "" unless owner_slack_workspace
       # Slack URLs don't have the # (channels) or @ (usernames)
       slack_identifier = owner_slack.to_s.delete('#').delete('@')
-      "https://govuk.slack.com/messages/#{slack_identifier}"
+      "https://#{owner_slack_workspace}.slack.com/messages/#{slack_identifier}"
+    end
+
+  private
+
+    def default_owner_slack
+      @config[:tech_docs][:default_owner_slack]
+    end
+
+    def owner_slack_workspace
+      @config[:tech_docs][:owner_slack_workspace]
     end
   end
 end

data/lib/govuk_tech_docs/pages.rb

@@ -15,11 +15,12 @@ module GovukTechDocs
 
     def as_json
       pages.map do |page|
+        review = PageReview.new(page, @config)
         {
           title: page.data.title,
           url: "#{@config[:tech_docs][:host]}#{page.url}",
-          review_by: PageReview.new(page).review_by,
-          owner_slack: page.data.owner_slack,
+          review_by: review.review_by,
+          owner_slack: review.owner_slack,
         }
       end
     end

data/lib/govuk_tech_docs/tech_docs_html_renderer.rb

@@ -4,6 +4,16 @@ module GovukTechDocs
   class TechDocsHTMLRenderer < Middleman::Renderers::MiddlemanRedcarpetHTML
     include Redcarpet::Render::SmartyPants
 
+    def initialize(options = {})
+      @local_options = options.dup
+      @app = @local_options[:context].app
+      super
+    end
+
+    def paragraph(text)
+      @app.api("<p>#{text.strip}</p>\n")
+    end
+
     def header(text, level)
       anchor = UniqueIdentifierGenerator.instance.create(text, level)
       %(<h#{level} id="#{anchor}">#{text}</h#{level}>)

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.5.0".freeze
+  VERSION = "1.6.0".freeze
 end

data/lib/source/layouts/_header.erb

@@ -8,7 +8,7 @@
       <% end %>
         <% if config[:tech_docs][:show_govuk_logo] %>
           <span class="govuk-logo">
-            <img class="govuk-logo__printable-crown" src="/images/gov.uk_logotype_crown_invert_trans.png" height="32" width="36">
+            <img class="govuk-logo__printable-crown" src="/images/gov.uk_logotype_crown_invert_trans.png" height="32" width="36" alt="">
             GOV.UK
           </span>
         <% end %>
@@ -33,9 +33,7 @@
           <ul>
             <% config[:tech_docs][:header_links].each do |title, path| %>
               <li<% if active_page(path) %> class="active"<% end %>>
-                <a href="<%= path %>">
-                  <%= title %>
-                </a>
+                <a href="<%= path %>"><%= title %></a>
               </li>
             <% end %>
           </ul>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -274,10 +302,13 @@ files:
 - docs/frontmatter.md
 - docs/layout-layout.png
 - docs/not-expired-page.png
+- docs/page-expiry.md
 - example/.ruby-version
 - example/Gemfile
 - example/config.rb
 - example/config/tech-docs.yml
+- example/source/api-path.html.md
+- example/source/api-reference.html.md
 - example/source/child-of-expired-page.html.md
 - example/source/core-layout.html.md.erb
 - example/source/expired-page-with-owner.html.md
@@ -286,6 +317,7 @@ files:
 - example/source/index.html.md.erb
 - example/source/javascripts/application.js
 - example/source/not-expired-page.html.md
+- example/source/pets.yml
 - example/source/stylesheets/print.css.scss
 - example/source/stylesheets/screen-old-ie.css.scss
 - example/source/stylesheets/screen.css.scss
@@ -347,6 +379,14 @@ files:
 - lib/assets/stylesheets/utilities/_printable.scss
 - lib/assets/stylesheets/vendor/_fixedsticky.scss
 - lib/govuk_tech_docs.rb
+- lib/govuk_tech_docs/api_reference/api_reference_extension.rb
+- lib/govuk_tech_docs/api_reference/api_reference_renderer.rb
+- lib/govuk_tech_docs/api_reference/templates/api_reference_full.html.erb
+- lib/govuk_tech_docs/api_reference/templates/operation.html.erb
+- lib/govuk_tech_docs/api_reference/templates/parameters.html.erb
+- lib/govuk_tech_docs/api_reference/templates/path.html.erb
+- lib/govuk_tech_docs/api_reference/templates/responses.html.erb
+- lib/govuk_tech_docs/api_reference/templates/schema.html.erb
 - lib/govuk_tech_docs/contribution_banner.rb
 - lib/govuk_tech_docs/meta_tags.rb
 - lib/govuk_tech_docs/page_review.rb
@@ -366,8 +406,6 @@ files:
 - lib/source/favicon.ico
 - lib/source/images/anchored-heading-icon-2x.png
 - lib/source/images/anchored-heading-icon.png
-- lib/source/images/arrow-down.svg
-- lib/source/images/arrow-up.svg
 - lib/source/images/gov.uk_logotype_crown-2x.png
 - lib/source/images/gov.uk_logotype_crown.png
 - lib/source/images/gov.uk_logotype_crown_invert_trans.png

data/lib/source/images/arrow-down.svg

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 34 34" style="enable-background:new 0 0 34 34;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#0B0C0C;}
-</style>
-<polygon class="st0" points="17,25.7 1.6,11.5 4.4,8.5 17,20.3 29.6,8.5 32.4,11.5 "/>
-</svg>

data/lib/source/images/arrow-up.svg

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 22.1.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 34 34" style="enable-background:new 0 0 34 34;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#0B0C0C;}
-</style>
-<polygon class="st0" points="29.6,25.5 17,13.7 4.4,25.5 1.6,22.5 17,8.3 32.4,22.5 "/>
-</svg>