openactive-dataset_site 0.1.1 → 6.0.1

data/examples/dataset_example_with_booking.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "openactive/dataset_site"
+
+dataset = OpenActive::Models::Dataset.new(
+  id: "http://example.com/dataset/",
+  url: "http://example.com/dataset/",
+  description:
+    "Near real-time availability and rich descriptions relating to the facilities and sessions available from Simpleweb",
+  access_service:
+    OpenActive::Models::WebAPI.new(
+      name: 'Open Booking API',
+      description: "API that allows for seamless booking experiences to be created for facilities and sessions available from Simpleweb",
+      documentation: "https://permalink.openactive.io/dataset-site/open-booking-api-documentation",
+      terms_of_service: "https://example.com/api-terms-page",
+      endpoint_url: "https://reference-implementation.openactive.io/api/openbooking",
+      authentication_authority: "https://auth.reference-implementation.openactive.io",
+      conforms_to: ["https://openactive.io/open-booking-api/EditorsDraft/"],
+      endpoint_description: "https://www.openactive.io/open-booking-api/EditorsDraft/swagger.json",
+      landing_page: "https://example.com/api-landing-page"
+    ),
+  date_modified: "2019-12-09T15:36:15+00:00",
+  keywords:
+    ["Facilities",
+     "Sessions",
+     "Activities",
+     "Sports",
+     "Physical Activity",
+     "OpenActive"],
+  schema_version: "https://www.openactive.io/modelling-opportunity-data/2.0/",
+  license: "https://creativecommons.org/licenses/by/4.0/",
+  publisher:
+    OpenActive::Models::Organization.new(
+      name: "Simpleweb",
+      description:
+        "Simpleweb is a purpose driven software company that specialises in new technologies, product development, and human interaction.",
+      url: "https://www.simpleweb.co.uk/",
+      legalName: "Simpleweb Ltd",
+      logo:
+        OpenActive::Models::ImageObject.new(
+          url:
+            "https://simpleweb.co.uk/wp-content/uploads/2015/07/facebook-default.png",
+        ),
+      email: "spam@simpleweb.co.uk",
+    ),
+  discussion_url: "https://github.com/simpleweb/sw-oa-php-test-site",
+  date_published: "2019-11-05T00:00:00+00:00",
+  in_language: ["en-GB"],
+  distribution:
+    [OpenActive::Models::DataDownload.new(
+      name: "FacilityUse",
+      additional_type: "https://openactive.io/FacilityUse",
+      encoding_format: "application/vnd.openactive.rpde+json; version=1",
+      content_url: "http://example.com/feed/facility-uses",
+    ),
+     OpenActive::Models::DataDownload.new(
+       name: "ScheduledSession",
+       additional_type: "https://openactive.io/ScheduledSession",
+       encoding_format: "application/vnd.openactive.rpde+json; version=1",
+       content_url: "http://example.com/feed/scheduled-sessions",
+     ),
+     OpenActive::Models::DataDownload.new(
+       name: "SessionSeries",
+       additional_type: "https://openactive.io/SessionSeries",
+       encoding_format: "application/vnd.openactive.rpde+json; version=1",
+       content_url: "http://example.com/feed/session_series",
+     ),
+     OpenActive::Models::DataDownload.new(
+       name: "Slot",
+       additional_type: "https://openactive.io/Slot",
+       encoding_format: "application/vnd.openactive.rpde+json; version=1",
+       content_url: "http://example.com/feed/slots",
+     )],
+  background_image:
+    OpenActive::Models::ImageObject.new(
+      url:
+        "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
+    ),
+  documentation: "https://permalink.openactive.io/dataset-site/open-data-documentation",
+  name: "Simpleweb Facilities and Sessions",
+  booking_service:
+    OpenActive::Models::BookingService.new(
+      name: "SimpleWeb Booking",
+      url: "https://www.example.com/",
+      has_credential: "https://certificates.reference-implementation.openactive.io/examples/all-features/controlled/",
+    ),
+)
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
+
+puts renderer.render

data/examples/dataset_patch.rb

@@ -14,7 +14,7 @@ settings = OpenActive::DatasetSite::Settings.new(
   open_data_feed_base_url: "http://example.com/feed/",
   dataset_site_url: "http://example.com/dataset/",
   dataset_discussion_url: "https://github.com/simpleweb/sw-oa-php-test-site",
-  dataset_documentation_url: "https://developer.openactive.io/",
+  dataset_documentation_url: "https://permalink.openactive.io/dataset-site/open-data-documentation",
   dataset_languages: ["en-GB"],
   organisation_name: "Simpleweb",
   organisation_url: "https://www.simpleweb.co.uk/",
@@ -24,13 +24,13 @@ settings = OpenActive::DatasetSite::Settings.new(
   organisation_logo_url: "https://simpleweb.co.uk/wp-content/uploads/2015/07/facebook-default.png",
   organisation_email: "spam@simpleweb.co.uk",
   background_image_url: "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
-  date_first_published: "2019-11-05", # remember, remember the fifth of November...
+  date_first_published: "2019-11-05",
   data_feed_types: feed_types,
 )
 
 dataset = settings.to_dataset
 
-dataset.description = "Some better non-generated description here."
+dataset.description = "Some better non-generated description here"
 
 renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
 

data/examples/specific_feed_override_example.rb

@@ -25,7 +25,7 @@ end.new(
   open_data_feed_base_url: "http://example.com/feed/",
   dataset_site_url: "http://example.com/dataset/",
   dataset_discussion_url: "https://github.com/simpleweb/sw-oa-php-test-site",
-  dataset_documentation_url: "https://developer.openactive.io/",
+  dataset_documentation_url: "https://permalink.openactive.io/dataset-site/open-data-documentation",
   dataset_languages: ["en-GB"],
   organisation_name: "Simpleweb",
   organisation_url: "https://www.simpleweb.co.uk/",
@@ -35,7 +35,7 @@ end.new(
   organisation_logo_url: "https://simpleweb.co.uk/wp-content/uploads/2015/07/facebook-default.png",
   organisation_email: "spam@simpleweb.co.uk",
   background_image_url: "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
-  date_first_published: "2019-11-05", # remember, remember the fifth of November...
+  date_first_published: "2019-11-05",
   data_feed_types: feed_types,
 )
 

data/examples/specific_feed_override_example2.rb

@@ -27,7 +27,7 @@ settings = CustomDatasetSettings.new(
   open_data_feed_base_url: "http://example.com/feed/",
   dataset_site_url: "http://example.com/dataset/",
   dataset_discussion_url: "https://github.com/simpleweb/sw-oa-php-test-site",
-  dataset_documentation_url: "https://developer.openactive.io/",
+  dataset_documentation_url: "https://permalink.openactive.io/dataset-site/open-data-documentation",
   dataset_languages: ["en-GB"],
   organisation_name: "Simpleweb",
   organisation_url: "https://www.simpleweb.co.uk/",
@@ -37,7 +37,7 @@ settings = CustomDatasetSettings.new(
   organisation_logo_url: "https://simpleweb.co.uk/wp-content/uploads/2015/07/facebook-default.png",
   organisation_email: "spam@simpleweb.co.uk",
   background_image_url: "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
-  date_first_published: "2019-11-05", # remember, remember the fifth of November...
+  date_first_published: "2019-11-05",
   data_feed_types: feed_types,
 )
 

data/lib/openactive/dataset_site/datasetsite-csp.mustache

@@ -0,0 +1,205 @@
+<!DOCTYPE HTML>
+<!--
+  OpenActive Dataset Site Template version 6, from https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite-csp.mustache
+  
+  This HTML file must reference a self-hosted 'datasetsite.styles.v6.css' file, co-located with the rest
+  of the static assets from the following archive:
+  https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite-csp.static.zip
+-->
+<!--
+  Design: Identity by HTML5 UP
+  html5up.net | @ajlkn
+  Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
+
+  DCAT Template: Nick Evans / imin
+  imin.co | @nickevans / @_imin_
+  For openactive.io
+  Free for personal and commercial use under the CC-BY v4.0 license (https://creativecommons.org/licenses/by/4.0/)
+-->
+<html prefix="dct: http://purl.org/dc/terms/
+              rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
+              dcat: http://www.w3.org/ns/dcat#
+              foaf: http://xmlns.com/foaf/0.1/
+              og: http://ogp.me/ns#
+              odrs: http://schema.theodi.org/odrs#"
+      lang="en">
+<head>
+    <title>{{name}} - Open Data</title>
+
+    <meta name="title" content="{{name}}  - Open Data" />
+    <meta name="identifier" content="{{url}}" />
+    <meta name="Keywords" content="{{#keywords}}{{.}},{{/keywords}}Open Data" />
+    <meta name="Description" content="{{description}}" />
+    <meta name="language" content="English" />
+
+    <meta property="og:title" content="{{name}} - Open Data" />
+    <meta property="og:description" content="{{description}}" />
+    <meta property="og:locale" content="en_GB" />
+    <meta property="og:url" content="{{url}}" />
+    <meta property="og:image" content="{{publisher.logo.url}}" />
+
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    
+    <!-- JSON-LD conforming to Google Structured Data specification. -->
+    <script type="application/ld+json">
+{{{jsonld}}}
+    </script>
+    
+    <!--
+      This stylesheet href must reference a self-hosted 'datasetsite.styles.v6.css' file in
+      the same directory as the other static assets sourced from the following archive:
+      https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite-csp.static.zip
+    -->
+    <link rel="stylesheet" href="{{{staticAssetsPathUrl}}}/datasetsite.styles.v6.css" crossorigin="anonymous">
+
+</head>
+<body id="booking" background="{{backgroundImage.url}}">
+    <table class="always-hidden" bgcolor="#FFFFFF" width="100%" height="500px"><tr><td align="center">
+      <p></p>
+      <p><large><strong>Error: Static Assets Not Found</strong><large></p>
+      <p>This HTML page must reference self-hosted static assets located at the relative or absolute path configured by "staticAssetsPathUrl" in the mustache template source data.</p>
+      <p>"staticAssetsPathUrl" is currently set to "{{staticAssetsPathUrl}}", and this page has failed to access this file: <pre>{{staticAssetsPathUrl}}/datasetsite.styles.v6.css</pre></p>
+      <p>Please ensure that the assets at this location exactly match those in
+      <a href="https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite-csp.static.zip">datasetsite-csp.static.zip version 6</a>.</p>
+      <p></p>
+      <p>See the <a href="https://github.com/openactive/dataset-site-template">"CSP compatible template" documentation</a> for more information</p>
+      <p></p>
+    </td></tr></table>
+  
+    <div class="outerscene">
+        <div id="anchor"></div>
+        <!-- Wrapper -->
+        <div id="wrapper" typeof="dcat:Dataset" resource="{{url}}">
+            {{#accessService}}
+                <a class="tab left" href="#"><div>Open Data</div></a>
+                <a class="tab right" href="#booking"><div><span class="short">Open</span> Booking <span class="short">API</span></div></a>
+            {{/accessService}}
+            <div class="content">
+                <div class="bar">
+                    {{#disambiguatingDescription}}
+                    <p class="warning">{{.}}</p>
+                    {{/disambiguatingDescription}}
+                </div>
+                <div class="scene">
+                    <div class="flip">
+                        <!-- Front -->
+                        <section id="main" class="front card">
+                            
+                            <header>                    
+                                <div>
+                                    <a href="{{publisher.url}}" about="{{publisher.url}}" property="foaf:homepage">
+                                        <span class="avatar" property="foaf:name" content="{{publisher.name}}"><img class="logo" src="{{publisher.logo.url}}" alt="" /></span>
+                                    </a>
+                                </div>
+
+                                <h1>Open Data</h1>
+
+                                <h2 property="dct:title">{{name}}</h2>
+
+                                <p class="description">{{description}}, published using <a href='https://www.openactive.io/'>OpenActive</a> <a href='https://openactive.io/realtime-paged-data-exchange/1.0/'>RPDE 1.0</a> and <a href='{{schemaVersion}}'>Model 2.0</a>.</p>
+                                <p class="metadata" property="dct:description">{{description}}.</p>
+                                <p class="metadata" property="dct:created" content='{{datePublished}}' datatype='xsd:dateTime'></p>
+                                {{#keywords}}
+                                <p class="metadata" property="dcat:keyword">{{.}}</p>
+                                {{/keywords}}
+                                <a class="metadata" href="http://purl.org/linked-data/sdmx/2009/code#freq-N" property="dct:accrualPeriodicity">Every minute</a>
+                                <ul class="icons">
+                                    <li><a href="{{documentation}}" class="fa-info">Documentation</a><br /><span>Documentation</span></li>
+                                    <li><a href="{{discussionUrl}}" class="fa-comments">Discussion</a><br /><span>Discussion</span></li>
+                                    {{#bookingService.hasCredential}}
+                                    <li><a href="{{.}}" class="fa-certificate">Certificate</a><br /><span>Certificate</span></li>
+                                    {{/bookingService.hasCredential}}
+                                </ul> 
+                            </header>
+
+                            <ul class="download">
+                                {{#distribution}}
+                                <li>
+                                    <a property='dcat:distribution' typeof='dcat:Distribution' href='{{contentUrl}}'>
+                                        <i class="fa fa-cloud-download"></i>
+                                        <span property="dct:title">{{name}}</span>
+                                        <span class="metadata" content='{{encodingFormat}}' property='dcat:mediaType'>OpenActive RPDE v1.0 Endpoints conforming to Modelling Specification 2.0.</span>
+                                    </a>
+                                </li>
+                                {{/distribution}}
+                            </ul>
+
+                            <footer>
+                                <div class="license">
+                                    <span property="dct:license" resource="{{license}}">
+                                        This data is owned by <a property="dct:publisher" href="{{publisher.url}}">{{publisher.legalName}}</a> and is licensed under the
+                                        <a href="{{license}}"><span property="dct:title">Creative Commons Attribution Licence (CC-BY v4.0)</span></a>
+                                        for anyone to access, use and share;
+                                    </span>
+                                    <span property="dct:rights" resource="#rights" typeof="odrs:RightsStatement">
+                                        <span class="metadata" property="rdfs:label">Rights Statement</span>
+                                        <a class="metadata" href="{{license}}" property="odrs:dataLicense">Creative Commons Attribution Licence (CC-BY v4.0)</a>
+                                        <a class="metadata" href="{{license}}" property="odrs:contentLicense">Creative Commons Attribution Licence (CC-BY v4.0)</a>
+                                        using attribution
+                                        "<a href="{{url}}" property="odrs:attributionURL"><span property="odrs:attributionText">{{publisher.name}}</span></a>".
+                                    </span>
+                                </div>
+                                <span class="avatar"><a href="https://www.openactive.io/"><div class="logo-sm openactive-logo" alt="OpenActive"></div></a></span>
+                            </footer>
+                        </section>
+
+                        <!-- Back -->
+                        <section id="access" class="back card">
+                            <header>
+                                <div>
+                                    <a href="{{publisher.url}}">
+                                        <span class="avatar"><img class="logo" src="{{publisher.logo.url}}" alt="" /></span>
+                                    </a>
+                                </div>
+
+                                <h1>Open Booking API</h1>
+
+                                <h2>{{name}}</h2>
+
+                                <p class="description">{{accessService.description}}, conforming to <a href='https://www.openactive.io/'>OpenActive</a> <a href='https://openactive.io/open-booking-api/EditorsDraft/1.0CR3/'>Open Booking 1.0 CR3</a>.</p>
+                                <ul class="icons">
+                                    <li><a href="{{accessService.landingPage}}" class="fa-key">Access</a><br /><span>Access</span></li>
+                                    <li><a href="{{accessService.documentation}}" class="fa-info">Documentation</a><br /><span>Documentation</span></li>
+                                    <li><a href="{{discussionUrl}}" class="fa-comments">Discussion</a><br /><span>Discussion</span></li>
+                                    <li><a href="{{bookingService.hasCredential}}" class="fa-certificate">Certificate</a><br /><span>Certificate</span></li>
+                                </ul> 
+                            </header>
+                            
+                            <div class="baseurls">
+                                <div class="baseurl">
+                                    <label for="txtEndpointUrl">Base URI</label>
+                                    <input id="txtEndpointUrl" type="text" class="code" value="{{accessService.endpointUrl}}" disabled>
+                                </div>
+                                
+                                {{#accessService.authenticationAuthority}}
+                                <div class="baseurl">
+                                    <label for="txtAuthenticationAuthority">Authentication Authority</label>
+                                    <input id="txtAuthenticationAuthority" type="text" class="code" value="{{.}}" disabled>
+                                </div>
+                                {{/accessService.authenticationAuthority}}
+                            </div>
+
+                            <footer>
+                                {{#accessService.termsOfService}}
+                                <div class="license">
+                                    Use of this API is governed by specific <a href="{{.}}">Terms of Service</a>.
+                                </div>
+                                {{/accessService.termsOfService}}
+                                <span class="avatar"><a href="https://www.openactive.io/"><div class="logo-sm openactive-logo" alt="OpenActive"></div></a></span>
+                            </footer>
+                        </section>
+                    </div>
+                </div>
+            </div>
+
+            <!-- Footer -->
+            <footer id="footer">
+                <ul class="copyright">
+                    <li>{{#bookingService}}Platform: <a href="{{url}}">{{name}} {{softwareVersion}}</a>. {{/bookingService}}Design: <a href="http://html5up.net">HTML5 UP</a>.</li>
+                </ul>
+            </footer>
+        </div>
+    </div>
+</body>
+</html>