openactive-dataset_site 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06c3edb6feeae3a16036a6cc50150d5b7da364b0
-  data.tar.gz: c01bacae3dc20e6fdd5103e4e9549add20d648ac
+  metadata.gz: 27bda3050fa7bc5b745fe5f70a05bccd414031dc
+  data.tar.gz: 67d724394a705936913b5cbcddcf18ef1b34146a
 SHA512:
-  metadata.gz: c5b93fe8bf15a3e9e8557905e802c19a5e995466710ba5913a278a1c4650cd95f3973e7c5027bcde087af04bf6d19fe07387bd9aed3ffafebf737eccc9c0ddb2
-  data.tar.gz: 49aeee97614d863c02fed3340d802819a8ba746e500ea7c6c6f409d114c319a7c72098985ac5ca139e32adf1785551750ec8c82cb9485ea0a9fd9dd5abcd6762
+  metadata.gz: ae03e4c8ef2033020fb154a9d0987a6b656007276c489632596cae4d81548780b44ac1fcfbe2db228a168176578f2bb9454187ec2d2bbf983acd0ce8668bb048
+  data.tar.gz: 1078436fecde29e78b4ae0d77fb8892908278c57ad62f36050521348984c61c576a9dae043a10fa1549a729d088e6a22adae93b9e6569724eb794c90edddba3a

data/README.md

@@ -62,6 +62,140 @@ settings = OpenActive::DatasetSite::Settings.new(
 )
 ```
 
+
+### Feed-level customisation
+If you need to do feed specific overrides, then you may do this by overriding the method.
+```ruby
+settings = Class.new(OpenActive::DatasetSite::Settings) do
+  def data_download(feed_type)
+    val = super(feed_type)
+
+    case feed_type
+    when OpenActive::DatasetSite::FeedType::SESSION_SERIES
+      val.content_url = open_data_feed_base_url + "session_series"
+    end
+
+    val
+  end
+end.new(
+  data_feed_types: [
+    OpenActive::DatasetSite::FeedType::FACILITY_USE,
+    OpenActive::DatasetSite::FeedType::SCHEDULED_SESSION,
+    OpenActive::DatasetSite::FeedType::SESSION_SERIES,
+    OpenActive::DatasetSite::FeedType::SLOT,
+  ],
+  # rest of your settings here.
+)
+```
+
+To match the PHP/.NET usage, you may alternatively use this approach, however it's less advised as there are more details to get right (and it risks a mismatch between the downloads and the advertised feed types):
+```ruby
+settings = OpenActive::DatasetSite::Settings.new(
+    # your settings here,
+    data_feed_types: [
+      OpenActive::DatasetSite::FeedType::SESSION_SERIES,
+    ],
+    data_downloads: [
+        OpenActive::Models::DataDownload.new(
+          name: "SessionSeries",
+          additional_type: "https://openactive.io/SessionSeries",
+          encoding_format:  OpenActive::DatasetSite::Meta.RPDE_MEDIA_TYPE,
+          content_url: open_data_feed_base_url + "session-series",
+        )
+    ]
+)
+```
+
+### Dataset
+```ruby
+dataset = OpenActive::Models::Dataset.new(
+  id: "http://example.com/dataset/",
+  description:
+    "Near real-time availability and rich descriptions relating to the facilities and sessions available from Simpleweb",
+  url: "http://example.com/dataset/",
+  dateModified: "2019-12-09T15:36:15+00:00",
+  keywords:
+    ["Facilities",
+     "Sessions",
+     "Activities",
+     "Sports",
+     "Physical Activity",
+     "OpenActive"],
+  schemaVersion: "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",
+    ),
+  discussionUrl: "https://github.com/simpleweb/sw-oa-php-test-site",
+  datePublished: "2019-11-05T00:00:00+00:00",
+  inLanguage: ["en-GB"],
+  distribution:
+    [OpenActive::Models::DataDownload.new(
+      name: "FacilityUse",
+      additionalType: "https://openactive.io/FacilityUse",
+      encodingFormat: "application/vnd.openactive.rpde+json; version=1",
+      contentUrl: "http://example.com/feed/facility-uses",
+    ),
+     OpenActive::Models::DataDownload.new(
+       name: "ScheduledSession",
+       additionalType: "https://openactive.io/ScheduledSession",
+       encodingFormat: "application/vnd.openactive.rpde+json; version=1",
+       contentUrl: "http://example.com/feed/scheduled-sessions",
+     ),
+     OpenActive::Models::DataDownload.new(
+       name: "SessionSeries",
+       additionalType: "https://openactive.io/SessionSeries",
+       encodingFormat: "application/vnd.openactive.rpde+json; version=1",
+       contentUrl: "http://example.com/feed/session_series",
+     ),
+     OpenActive::Models::DataDownload.new(
+       name: "Slot",
+       additionalType: "https://openactive.io/Slot",
+       encodingFormat: "application/vnd.openactive.rpde+json; version=1",
+       contentUrl: "http://example.com/feed/slots",
+     )],
+  backgroundImage:
+    OpenActive::Models::ImageObject.new(
+      url:
+        "https://simpleweb.co.uk/wp-content/uploads/2017/06/IMG_8994-500x500-c-default.jpg",
+    ),
+  documentation: "https://developer.openactive.io/",
+  name: "Simpleweb Facilities and Sessions",
+)
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
+
+puts renderer.render
+```
+
+### Dataset patching
+The dataset generation should already be good for most purposes, if needing to change just a couple of fields then
+you may be better of patching just those fields.
+```ruby
+settings = OpenActive::DatasetSite::Settings.new(
+  # your settings here
+)
+
+dataset = settings.to_dataset
+
+dataset.description = "Some better non-generated description here."
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
+
+puts renderer.render
+```
+
 ### API
 
 #### OpenActive::DatasetSite::Settings

data/examples/dataset_example.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "openactive/dataset_site"
+
+dataset = OpenActive::Models::Dataset.new(
+  id: "http://example.com/dataset/",
+  description:
+    "Near real-time availability and rich descriptions relating to the facilities and sessions available from Simpleweb",
+  url: "http://example.com/dataset/",
+  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://developer.openactive.io/",
+  name: "Simpleweb Facilities and Sessions",
+)
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
+
+puts renderer.render

data/examples/dataset_patch.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "openactive/dataset_site"
+
+feed_types = [
+  OpenActive::DatasetSite::FeedType::FACILITY_USE,
+  OpenActive::DatasetSite::FeedType::SCHEDULED_SESSION,
+  OpenActive::DatasetSite::FeedType::SESSION_SERIES,
+  OpenActive::DatasetSite::FeedType::SLOT,
+]
+
+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_languages: ["en-GB"],
+  organisation_name: "Simpleweb",
+  organisation_url: "https://www.simpleweb.co.uk/",
+  organisation_legal_entity: "Simpleweb Ltd",
+  organisation_plain_text_description: "Simpleweb is a purpose driven software company that specialises in new "\
+                                       "technologies, product development, and human interaction.",
+  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...
+  data_feed_types: feed_types,
+)
+
+dataset = settings.to_dataset
+
+dataset.description = "Some better non-generated description here."
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(dataset)
+
+puts renderer.render

data/examples/specific_feed_override_example.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "openactive/dataset_site"
+
+feed_types = [
+  OpenActive::DatasetSite::FeedType::FACILITY_USE,
+  OpenActive::DatasetSite::FeedType::SCHEDULED_SESSION,
+  OpenActive::DatasetSite::FeedType::SESSION_SERIES,
+  OpenActive::DatasetSite::FeedType::SLOT,
+]
+
+settings = Class.new(OpenActive::DatasetSite::Settings) do
+  def data_download(feed_type)
+    val = super(feed_type)
+
+    case feed_type
+    when OpenActive::DatasetSite::FeedType::SESSION_SERIES
+      val.content_url = open_data_feed_base_url + "session_series"
+    end
+
+    val
+  end
+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_languages: ["en-GB"],
+  organisation_name: "Simpleweb",
+  organisation_url: "https://www.simpleweb.co.uk/",
+  organisation_legal_entity: "Simpleweb Ltd",
+  organisation_plain_text_description: "Simpleweb is a purpose driven software company that specialises in new "\
+                                       "technologies, product development, and human interaction.",
+  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...
+  data_feed_types: feed_types,
+)
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(settings)
+
+puts renderer.render

data/examples/specific_feed_override_example2.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "openactive/dataset_site"
+
+feed_types = [
+  OpenActive::DatasetSite::FeedType::FACILITY_USE,
+  OpenActive::DatasetSite::FeedType::SCHEDULED_SESSION,
+  OpenActive::DatasetSite::FeedType::SESSION_SERIES,
+  OpenActive::DatasetSite::FeedType::SLOT,
+]
+
+class CustomDatasetSettings < OpenActive::DatasetSite::Settings
+  def data_download(feed_type)
+    val = super(feed_type)
+
+    case feed_type
+    when OpenActive::DatasetSite::FeedType::SESSION_SERIES
+      val.content_url = open_data_feed_base_url + "session_series"
+    end
+
+    val
+  end
+end
+
+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_languages: ["en-GB"],
+  organisation_name: "Simpleweb",
+  organisation_url: "https://www.simpleweb.co.uk/",
+  organisation_legal_entity: "Simpleweb Ltd",
+  organisation_plain_text_description: "Simpleweb is a purpose driven software company that specialises in new "\
+                                       "technologies, product development, and human interaction.",
+  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...
+  data_feed_types: feed_types,
+)
+
+renderer = OpenActive::DatasetSite::TemplateRenderer.new(settings)
+
+puts renderer.render

data/lib/openactive/dataset_site/meta.rb

@@ -1,7 +1,7 @@
 module OpenActive
   module DatasetSite
     class Meta < TypesafeEnum::Base
-      new :RPDE_MEDIA_TYPE, "application/vnd.openactive.rpde+json; version=1"
+      RPDE_MEDIA_TYPE = "application/vnd.openactive.rpde+json; version=1".freeze
     end
   end
 end

data/lib/openactive/dataset_site/settings.rb

@@ -2,6 +2,8 @@ module OpenActive
   module DatasetSite
     class Settings
       def initialize(**params)
+        super()
+
         params.each do |k, v|
           setter_method = "#{k}="
 
@@ -33,6 +35,7 @@ module OpenActive
       attr_accessor :platform_software_version
 
       attr_accessor :data_feed_types
+      attr_accessor :data_downloads
 
       def data_feed_descriptions
         data_feed_types.map do |description|
@@ -48,6 +51,7 @@ module OpenActive
         data_feed_descriptions.to_sentence.downcase
       end
 
+      # @return [Array<String>] An array of keywords.
       def keywords
         [
           *data_feed_descriptions,
@@ -64,15 +68,30 @@ module OpenActive
               "#{organisation_name}"
       end
 
+      # @return [OpenActive::Models::DataDownload] A DataDownload object.
+      def data_download(feed_type)
+        OpenActive::Models::DataDownload.new(
+          name: feed_type.name,
+          additional_type: feed_type.same_as,
+          encoding_format: OpenActive::DatasetSite::Meta::RPDE_MEDIA_TYPE,
+          content_url: open_data_feed_base_url + feed_type.default_feed_path,
+        )
+      end
+
+      # @return [Array<OpenActive::Models::DataDownload>] An array of DataDownload objects.
       def data_downloads
-        data_feed_types.map do |feed_type|
-          OpenActive::Models::DataDownload.new(
-            name: feed_type.name,
-            additional_type: feed_type.same_as,
-            encoding_format: "application/vnd.openactive.rpde+json; version=1",
-            content_url: open_data_feed_base_url + feed_type.default_feed_path,
-          )
-        end
+        @data_downloads || data_feed_types.map { |feed_type| data_download(feed_type) }
+      end
+
+      # @return [OpenActive::Models::BookingService, nil]
+      def booking_service
+        return unless platform_name && !platform_name.empty?
+
+        OpenActive::Models::BookingService.new(
+          name: platform_name,
+          url: platform_url,
+          software_version: platform_software_version,
+        )
       end
 
       def to_dataset # rubocop:disable Metrics/MethodLength
@@ -105,12 +124,8 @@ module OpenActive
           date_published: date_first_published,
         )
 
-        if platform_name && !platform_name.empty?
-          dataset.booking_service = OpenActive::Models::BookingService.new(
-            name: platform_name,
-            url: platform_url,
-            software_version: platform_software_version,
-          )
+        if (booking_service_val = booking_service)
+          dataset.booking_service = booking_service_val
         end
 
         dataset

data/lib/openactive/dataset_site/template_renderer.rb

@@ -16,7 +16,7 @@ module OpenActive
       end
 
       def json
-        dataset.to_json(schema: true)
+        dataset.to_json(schema: true, pretty: true)
       end
 
       def method_missing(orig_method_name, *args)

data/lib/openactive/dataset_site/version.rb

@@ -1,5 +1,5 @@
 module OpenActive
   module DatasetSite
-    VERSION = "0.1.0".freeze
+    VERSION = "0.1.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.0
+  version: 0.1.1
 platform: ruby
 authors:
 - OpenActive Community
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -137,7 +137,11 @@ files:
 - README.md
 - bin/console
 - bin/setup
-- examples/example.rb
+- examples/basic_example.rb
+- examples/dataset_example.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.mustache
 - lib/openactive/dataset_site/feed_type.rb