openactive-dataset_site 0.1.1 → 6.0.1

data/lib/openactive/dataset_site/settings.rb

@@ -37,6 +37,18 @@ module OpenActive
       attr_accessor :data_feed_types
       attr_accessor :data_downloads
 
+      # **** OPEN BOOKING ****
+
+      attr_accessor :open_booking_api_base_url
+      attr_accessor :open_booking_api_documentation_url
+      attr_accessor :open_booking_api_terms_service_url
+      attr_accessor :open_booking_api_registration_url
+      attr_accessor :open_booking_api_authentication_authority_url
+
+      # **** TEST SUITE CERTIFICATE ****
+
+      attr_accessor :test_suite_certificate_url
+
       def data_feed_descriptions
         data_feed_types.map do |description|
           description.respond_to?(:display_name) ? description.display_name : description
@@ -62,12 +74,18 @@ module OpenActive
         ]
       end
 
-      def description
+      def dataset_description
         "Near real-time availability and rich descriptions relating to the "\
               "#{data_feed_descriptions_sentence} available from "\
               "#{organisation_name}"
       end
 
+      def webapi_description
+        "API that allows for seamless booking experiences to be created for  "\
+              "#{data_feed_descriptions_sentence} available from "\
+              "#{organisation_name}"
+      end
+
       # @return [OpenActive::Models::DataDownload] A DataDownload object.
       def data_download(feed_type)
         OpenActive::Models::DataDownload.new(
@@ -85,13 +103,55 @@ module OpenActive
 
       # @return [OpenActive::Models::BookingService, nil]
       def booking_service
-        return unless platform_name && !platform_name.empty?
+        return unless (platform_name && !platform_name.empty?) || (test_suite_certificate_url && !test_suite_certificate_url.empty?)
+
+        booking_service = OpenActive::Models::BookingService.new()
+
+        if (platform_name_val = platform_name)
+          booking_service.name = platform_name_val
+        end
+
+        if (platform_url_val = platform_url)
+          booking_service.url = platform_url_val
+        end
+
+        if (platform_software_version_val = platform_software_version)
+          booking_service.software_version = platform_software_version_val
+        end
 
-        OpenActive::Models::BookingService.new(
-          name: platform_name,
-          url: platform_url,
-          software_version: platform_software_version,
+        if (has_credential_val = test_suite_certificate_url)
+          booking_service.has_credential = has_credential_val
+        end
+
+        booking_service
+      end
+
+      def access_service
+        return unless open_booking_api_base_url && !open_booking_api_base_url.empty?
+        
+        access_service = OpenActive::Models::WebAPI.new(
+          name: 'Open Booking API',
+          description: webapi_description,
+          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
+
+        if (open_booking_api_terms_service_url_val = open_booking_api_terms_service_url)
+          access_service.terms_of_service = open_booking_api_terms_service_url_val
+        end
+
+        access_service
       end
 
       def to_dataset # rubocop:disable Metrics/MethodLength
@@ -99,11 +159,11 @@ module OpenActive
           id: dataset_site_url,
           url: dataset_site_url,
           name: name,
-          description: description,
+          description: dataset_description,
           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(
@@ -124,10 +184,18 @@ 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
 
+        if (access_service_val = access_service)
+          dataset.access_service = access_service_val
+        end
+
         dataset
       end
     end

data/lib/openactive/dataset_site/template_renderer.rb

@@ -3,22 +3,32 @@ require 'mustache'
 module OpenActive
   module DatasetSite
     class TemplateRenderer < Mustache
-      self.template_file = "#{__dir__}/datasetsite.mustache"
+      attr_reader :settings
 
-      def initialize(settings)
+      def initialize(settings, static_assets_path_url = nil)
         @settings = settings
+        if static_assets_path_url.nil? then
+          @template_file =  "#{__dir__}/datasetsite.mustache"
+        else
+          @template_file =  "#{__dir__}/datasetsite-csp.mustache"
+          @static_assets_path_url = static_assets_path_url.chomp("/")
+        end
       end
 
       def dataset
-        return @settings if @settings.is_a?(OpenActive::Models::Dataset)
+        return settings if settings.is_a?(OpenActive::Models::Dataset)
 
-        @dataset ||= @settings.to_dataset
+        @dataset ||= settings.to_dataset
       end
 
-      def json
+      def jsonld
         dataset.to_json(schema: true, pretty: true)
       end
 
+      def staticAssetsPathUrl
+        @static_assets_path_url
+      end
+
       def method_missing(orig_method_name, *args)
         method_name = orig_method_name.to_s.underscore
 

data/lib/openactive/dataset_site/version.rb

@@ -1,5 +1,5 @@
 module OpenActive
   module DatasetSite
-    VERSION = "0.1.1".freeze
+    VERSION = "6.0.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openactive-dataset_site
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 6.0.1
 platform: ruby
 authors:
 - OpenActive Community
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -129,20 +129,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/create-dataset-site-template-pr.yaml"
+- ".github/workflows/release.yaml"
+- ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
 - LICENSE
 - Makefile
 - README.md
+- Rakefile
 - bin/console
 - bin/setup
+- examples/basic_csp_example_with_booking.rb
 - examples/basic_example.rb
+- examples/basic_example_with_booking.rb
+- examples/basic_example_with_booking_minimal.rb
+- examples/dataset_csp_example_with_booking.rb
 - examples/dataset_example.rb
+- examples/dataset_example_with_booking.rb
 - examples/dataset_patch.rb
 - examples/specific_feed_override_example.rb
 - examples/specific_feed_override_example2.rb
 - lib/openactive/dataset_site.rb
+- lib/openactive/dataset_site/datasetsite-csp.mustache
+- lib/openactive/dataset_site/datasetsite-csp.static.zip
 - lib/openactive/dataset_site/datasetsite.mustache
 - lib/openactive/dataset_site/feed_type.rb
 - lib/openactive/dataset_site/meta.rb
@@ -169,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Simplifies creation of dataset sites using templates.