openactive-dataset_site 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfb043291daab358f768329f6311fbb0b57a6c4319d0942c046c3aad08d4cdc0
-  data.tar.gz: 166637b71a34034a6b78de8aa5a27e7a3814a528f9a2ea10718007c60192d19b
+  metadata.gz: dcec1c1660055adf1bebf78c1c053384875e7bdb908c60c6d6acc5b6dc1dec19
+  data.tar.gz: 0403306a9b923e6932adf4d4e33bfa8c42ed7c1c704536a902f21d24c0e460c3
 SHA512:
-  metadata.gz: 121509a0550e74c56656f32da17a8d84bf885546504337abaa0dadb102c58dee6f5f5b586eee102bc2d2187778261172d04a3d31c94ba714907911b6cf820815
-  data.tar.gz: d659df7dfb8242304c8653ad7f9ca61b693900767a251fbf336e2243190c8fe7d21c89abf04f48db84015b0ffbe66c1fd395ae79e3c924d38279e4d2ac9a5897
+  metadata.gz: ad23349806cc2c429b86bc5d62d5f501f794d99090493cfad091aa3f2bf03dfbb11f58c19e5f2164682943ac2569bc25e69166deb9ab77576b88f04133a3cd75
+  data.tar.gz: a16e05635a6ea76f852ec5625581b691c267e5b07f876a6065032e53f57e41b86c39806f45a6db6a19b3b1bf736453a0abc1ffd7225c5408b52eefccbc549fc1

data/.github/workflows/create-dataset-site-template-pr.yaml

@@ -48,7 +48,7 @@ jobs:
           body: |
             Update to the latest version of the [Dataset Site Template](https://github.com/openactive/dataset-site-template)
           
-            **Reviewer note:** Major version numbers of this library should match those of the `dataset-site-template` on which this library depends. Any updates to the dataset site template files or assets should always be a major version update in both libraries. Hence this PR, once merged, should be released with a major version bump to match its contents.
+            **Reviewer note:** Major version numbers of this library should match those of the `dataset-site-template` on which this library depends. Any updates to the dataset site template files or assets should always be a major version update in both libraries. Hence this PR, once merged, should be released with a major version bump to match its contents. Therefore, the major version number in the file `lib/openactive/dataset_site/version.rb` should be bumped in this branch before the PR is merged. 
             
           labels: |
             automated pr

data/README.md

@@ -58,7 +58,7 @@ settings = OpenActive::DatasetSite::Settings.new(
     organisation_email: "info@better.org.uk",
     platform_name: "AcmeBooker",
     platform_url: "https://acmebooker.example.com/",
-    platform_software_version: "2.0",
+    platform_software_version: "2.0.1",
     background_image_url: "https://data.better.org.uk/images/bg.jpg",
     date_first_published: "2019-10-28",
     open_booking_api_base_url: "https://reference-implementation.openactive.io/api/openbooking",
@@ -202,6 +202,7 @@ dataset = OpenActive::Models::Dataset.new(
     OpenActive::Models::BookingService.new(
       name: "SimpleWeb Booking",
       url: "https://www.example.com/",
+      software_version: "2.0.0",
       has_credential: "https://certificates.reference-implementation.openactive.io/examples/all-features/controlled/",
     )
 )

data/examples/basic_example_with_booking.rb

@@ -27,6 +27,7 @@ settings = OpenActive::DatasetSite::Settings.new(
   date_first_published: "2019-11-05",
   platform_name: "AcmeBooker",
   platform_url: "https://acmebooker.example.com/",
+  platform_software_version: "2.0.1",
   open_booking_api_base_url: "https://reference-implementation.openactive.io/api/openbooking",
   open_booking_api_authentication_authority_url: "https://auth.reference-implementation.openactive.io",
   open_booking_api_documentation_url: "https://permalink.openactive.io/dataset-site/open-booking-api-documentation",

data/examples/basic_example_with_booking_minimal.rb

@@ -14,7 +14,6 @@ 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://permalink.openactive.io/dataset-site/open-data-documentation",
   dataset_languages: ["en-GB"],
   organisation_name: "Simpleweb",
   organisation_url: "https://www.simpleweb.co.uk/",
@@ -26,7 +25,6 @@ settings = OpenActive::DatasetSite::Settings.new(
   background_image_url: "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
   date_first_published: "2019-11-05",
   open_booking_api_base_url: "https://reference-implementation.openactive.io/api/openbooking",
-  open_booking_api_documentation_url: "https://permalink.openactive.io/dataset-site/open-booking-api-documentation",
   open_booking_api_registration_url: "https://example.com/api-landing-page",
   test_suite_certificate_url: "https://certificates.reference-implementation.openactive.io/examples/all-features/controlled/",
   data_feed_types: feed_types,

data/examples/dataset_csp_example_with_booking.rb

@@ -83,6 +83,7 @@ dataset = OpenActive::Models::Dataset.new(
     OpenActive::Models::BookingService.new(
       name: "SimpleWeb Booking",
       url: "https://www.example.com/",
+      software_version: "2.0.0",
       has_credential: "https://certificates.reference-implementation.openactive.io/examples/all-features/controlled/",
     ),
 )

data/examples/dataset_example_with_booking.rb

@@ -83,6 +83,7 @@ dataset = OpenActive::Models::Dataset.new(
     OpenActive::Models::BookingService.new(
       name: "SimpleWeb Booking",
       url: "https://www.example.com/",
+      software_version: "2.0.0",
       has_credential: "https://certificates.reference-implementation.openactive.io/examples/all-features/controlled/",
     ),
 )

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

@@ -1,10 +1,10 @@
 <!DOCTYPE HTML>
 <!--
-  OpenActive Dataset Site Template version 6, from https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite-csp.mustache
+  OpenActive Dataset Site Template version 7, from https://unpkg.com/@openactive/dataset-site-template@7.0.0/dist/datasetsite-csp.mustache
   
-  This HTML file must reference a self-hosted 'datasetsite.styles.v6.css' file, co-located with the rest
+  This HTML file must reference a self-hosted 'datasetsite.styles.v7.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
+  https://unpkg.com/@openactive/dataset-site-template@7.0.0/dist/datasetsite-csp.static.zip
 -->
 <!--
   Design: Identity by HTML5 UP
@@ -47,11 +47,11 @@
     </script>
     
     <!--
-      This stylesheet href must reference a self-hosted 'datasetsite.styles.v6.css' file in
+      This stylesheet href must reference a self-hosted 'datasetsite.styles.v7.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
+      https://unpkg.com/@openactive/dataset-site-template@7.0.0/dist/datasetsite-csp.static.zip
     -->
-    <link rel="stylesheet" href="{{{staticAssetsPathUrl}}}/datasetsite.styles.v6.css" crossorigin="anonymous">
+    <link rel="stylesheet" href="{{{staticAssetsPathUrl}}}/datasetsite.styles.v7.css" crossorigin="anonymous">
 
 </head>
 <body id="booking" background="{{backgroundImage.url}}">
@@ -59,9 +59,9 @@
       <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>"staticAssetsPathUrl" is currently set to "{{staticAssetsPathUrl}}", and this page has failed to access this file: <pre>{{staticAssetsPathUrl}}/datasetsite.styles.v7.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>
+      <a href="https://unpkg.com/@openactive/dataset-site-template@7.0.0/dist/datasetsite-csp.static.zip">datasetsite-csp.static.zip version 7</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>
@@ -196,7 +196,7 @@
             <!-- 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>
+                    <li>{{#bookingService.name}}Platform: {{/bookingService.name}}{{#bookingService.url}}<a href="{{.}}">{{/bookingService.url}}{{bookingService.name}}{{#bookingService.softwareVersion}} {{.}}{{/bookingService.softwareVersion}}{{#bookingService.url}}</a>{{/bookingService.url}}{{#bookingService.name}}. {{/bookingService.name}}Design: <a href="http://html5up.net">HTML5 UP</a>.</li>
                 </ul>
             </footer>
         </div>

data/lib/openactive/dataset_site/datasetsite.mustache

@@ -1,6 +1,6 @@
 <!DOCTYPE HTML>
 <!--
-  OpenActive Dataset Site Template version 6, from https://unpkg.com/@openactive/dataset-site-template@6.0.0/dist/datasetsite.mustache
+  OpenActive Dataset Site Template version 7, from https://unpkg.com/@openactive/dataset-site-template@7.0.0/dist/datasetsite.mustache
 -->
 <!--
   Design: Identity by HTML5 UP
@@ -1341,7 +1341,7 @@ body {
             <!-- 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>
+                    <li>{{#bookingService.name}}Platform: {{/bookingService.name}}{{#bookingService.url}}<a href="{{.}}">{{/bookingService.url}}{{bookingService.name}}{{#bookingService.softwareVersion}} {{.}}{{/bookingService.softwareVersion}}{{#bookingService.url}}</a>{{/bookingService.url}}{{#bookingService.name}}. {{/bookingService.name}}Design: <a href="http://html5up.net">HTML5 UP</a>.</li>
                 </ul>
             </footer>
         </div>

data/lib/openactive/dataset_site/settings.rb

@@ -132,13 +132,17 @@ module OpenActive
         access_service = OpenActive::Models::WebAPI.new(
           name: 'Open Booking API',
           description: webapi_description,
-          documentation: open_booking_api_documentation_url,
+          documentation: "https://permalink.openactive.io/dataset-site/open-booking-api-documentation",
           endpoint_url: open_booking_api_base_url,
           conforms_to: ["https://openactive.io/open-booking-api/EditorsDraft/"],
           endpoint_description: "https://www.openactive.io/open-booking-api/EditorsDraft/swagger.json",
           landing_page: open_booking_api_registration_url
         )
 
+        if (open_booking_api_documentation_url_val = open_booking_api_documentation_url)
+          access_service.documentation = open_booking_api_documentation_url_val
+        end
+
         if (open_booking_api_authentication_authority_url_val = open_booking_api_authentication_authority_url)
           access_service.authentication_authority = open_booking_api_authentication_authority_url_val
         end
@@ -159,7 +163,7 @@ module OpenActive
           keywords: keywords,
           license: "https://creativecommons.org/licenses/by/4.0/",
           discussion_url: dataset_discussion_url,
-          documentation: dataset_documentation_url,
+          documentation: "https://permalink.openactive.io/dataset-site/open-data-documentation",
           in_language: dataset_languages,
           schema_version: "https://www.openactive.io/modelling-opportunity-data/2.0/",
           publisher: OpenActive::Models::Organization.new(
@@ -180,6 +184,10 @@ module OpenActive
           date_published: date_first_published,
         )
 
+        if (dataset_documentation_url_val = dataset_documentation_url)
+          dataset.documentation = dataset_documentation_url_val
+        end
+
         if (booking_service_val = booking_service)
           dataset.booking_service = booking_service_val
         end

data/lib/openactive/dataset_site/version.rb

@@ -1,5 +1,5 @@
 module OpenActive
   module DatasetSite
-    VERSION = "6.0.0".freeze
+    VERSION = "7.0.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openactive-dataset_site
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - OpenActive Community
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache