openactive-dataset_site 0.1.0

data/lib/openactive/dataset_site/feed_type.rb

@@ -0,0 +1,91 @@
+module OpenActive
+  module DatasetSite
+    class FeedType < TypesafeEnum::Base
+      new :COURSE, "Course" do
+        @name = "Course"
+        @same_as = "https://openactive.io/Course"
+        @default_feed_path = "courses"
+        @possible_kinds = ["Course"]
+        @display_name = "Courses"
+      end
+      new :COURSE_INSTANCE, "CourseInstance" do
+        @name = "CourseInstance"
+        @same_as = "https://openactive.io/CourseInstance"
+        @default_feed_path = "course-instances"
+        @possible_kinds = ["CourseInstance", "CourseInstance.Event"]
+        @display_name = "Courses"
+      end
+      new :EVENT, "Event" do
+        @name = "Event"
+        @same_as = "https://schema.org/Event"
+        @possible_kinds = ["Event"]
+        @display_name = "Events"
+      end
+      new :EVENT_SERIES, "EventSeries" do
+        @name = "EventSeries"
+        @same_as = "https://schema.org/EventSeries"
+        @default_feed_path = "event-series"
+        @possible_kinds = ["EventSeries"]
+        @display_name = "undefined"
+      end
+      new :FACILITY_USE, "FacilityUse" do
+        @name = "FacilityUse"
+        @same_as = "https://openactive.io/FacilityUse"
+        @default_feed_path = "facility-uses"
+        @possible_kinds = ["FacilityUse"]
+        @display_name = "Facilities"
+      end
+      new :HEADLINE_EVENT, "HeadlineEvent" do
+        @name = "HeadlineEvent"
+        @same_as = "https://openactive.io/HeadlineEvent"
+        @default_feed_path = "headline-events"
+        @possible_kinds = ["HeadlineEvent"]
+        @display_name = "Events"
+      end
+      new :INDIVIDUAL_FACILITY_USE, "IndividualFacilityUse" do
+        @name = "IndividualFacilityUse"
+        @same_as = "https://openactive.io/IndividualFacilityUse"
+        @default_feed_path = "individual-facility-uses"
+        @possible_kinds = ["IndividualFacilityUse"]
+        @display_name = "Facilities"
+      end
+
+      new :SCHEDULED_SESSION, "ScheduledSession" do
+        @name = "ScheduledSession"
+        @same_as = "https://openactive.io/ScheduledSession"
+        @default_feed_path = "scheduled-sessions"
+        @possible_kinds = ["ScheduledSession", "ScheduledSession.SessionSeries"]
+        @display_name = "Sessions"
+      end
+      new :SESSION_SERIES, "SessionSeries" do
+        @name = "SessionSeries"
+        @same_as = "https://openactive.io/SessionSeries"
+        @default_feed_path = "session-series"
+        @possible_kinds = ["SessionSeries", "SessionSeries.ScheduledSession"]
+        @display_name = "Sessions"
+      end
+      new :SLOT, "Slot" do
+        @name = "Slot"
+        @same_as = "https://openactive.io/Slot"
+        @default_feed_path = "slots"
+        @possible_kinds = ["FacilityUse/Slot", "IndividualFacilityUse/Slot"]
+        @display_name = "Facilities"
+      end
+
+      # @return [String]
+      attr_reader :name
+
+      # @return [String]
+      attr_reader :same_as
+
+      # @return [String]
+      attr_reader :default_feed_path
+
+      # @return [Array<String>]
+      attr_reader :possible_kinds
+
+      # @return [String]
+      attr_reader :display_name
+    end
+  end
+end

data/lib/openactive/dataset_site/meta.rb

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

data/lib/openactive/dataset_site/settings.rb

@@ -0,0 +1,120 @@
+module OpenActive
+  module DatasetSite
+    class Settings
+      def initialize(**params)
+        params.each do |k, v|
+          setter_method = "#{k}="
+
+          raise ArgumentError, "Unrecognised field #{k}" unless respond_to?(setter_method)
+
+          public_send(setter_method, v)
+        end
+      end
+
+      attr_accessor :open_data_feed_base_url
+
+      attr_accessor :dataset_site_url
+      attr_accessor :dataset_discussion_url
+      attr_accessor :dataset_documentation_url
+      attr_accessor :dataset_languages
+
+      attr_accessor :organisation_name
+      attr_accessor :organisation_legal_entity
+      attr_accessor :organisation_plain_text_description
+      attr_accessor :organisation_email
+      attr_accessor :organisation_url
+      attr_accessor :organisation_logo_url
+
+      attr_accessor :background_image_url
+      attr_accessor :date_first_published
+
+      attr_accessor :platform_name
+      attr_accessor :platform_url
+      attr_accessor :platform_software_version
+
+      attr_accessor :data_feed_types
+
+      def data_feed_descriptions
+        data_feed_types.map do |description|
+          description.respond_to?(:display_name) ? description.display_name : description
+        end.uniq
+      end
+
+      def name
+        "#{organisation_name} #{data_feed_descriptions.to_sentence}"
+      end
+
+      def data_feed_descriptions_sentence
+        data_feed_descriptions.to_sentence.downcase
+      end
+
+      def keywords
+        [
+          *data_feed_descriptions,
+          "Activities",
+          "Sports",
+          "Physical Activity",
+          "OpenActive"
+        ]
+      end
+
+      def description
+        "Near real-time availability and rich descriptions relating to the "\
+              "#{data_feed_descriptions_sentence} available from "\
+              "#{organisation_name}"
+      end
+
+      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
+      end
+
+      def to_dataset # rubocop:disable Metrics/MethodLength
+        dataset = OpenActive::Models::Dataset.new(
+          id: dataset_site_url,
+          url: dataset_site_url,
+          name: name,
+          description: description,
+          keywords: keywords,
+          license: "https://creativecommons.org/licenses/by/4.0/",
+          discussion_url: dataset_discussion_url,
+          documentation: dataset_documentation_url,
+          in_language: dataset_languages,
+          schema_version: "https://www.openactive.io/modelling-opportunity-data/2.0/",
+          publisher: OpenActive::Models::Organization.new(
+            name: organisation_name,
+            legal_name: organisation_legal_entity,
+            description: organisation_plain_text_description,
+            email: organisation_email,
+            url: organisation_url,
+            logo: OpenActive::Models::ImageObject.new(
+              url: organisation_logo_url,
+            ),
+          ),
+          date_modified: DateTime.now.new_offset(0),
+          background_image: OpenActive::Models::ImageObject.new(
+            url: background_image_url,
+          ),
+          distribution: data_downloads,
+          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,
+          )
+        end
+
+        dataset
+      end
+    end
+  end
+end

data/lib/openactive/dataset_site/template_renderer.rb

@@ -0,0 +1,39 @@
+require 'mustache'
+
+module OpenActive
+  module DatasetSite
+    class TemplateRenderer < Mustache
+      self.template_file = "#{__dir__}/datasetsite.mustache"
+
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def dataset
+        return @settings if @settings.is_a?(OpenActive::Models::Dataset)
+
+        @dataset ||= @settings.to_dataset
+      end
+
+      def json
+        dataset.to_json(schema: true)
+      end
+
+      def method_missing(orig_method_name, *args)
+        method_name = orig_method_name.to_s.underscore
+
+        return super unless dataset.respond_to?(method_name)
+
+        val = dataset.public_send(method_name, *args)
+
+        OpenActive::Helpers::JsonLd.serialize_value(val, nil)
+      end
+
+      def respond_to_missing?(orig_method_name, include_private = false)
+        method_name = orig_method_name.to_s.underscore
+
+        dataset.respond_to?(method_name) || super
+      end
+    end
+  end
+end

data/lib/openactive/dataset_site/version.rb

@@ -0,0 +1,5 @@
+module OpenActive
+  module DatasetSite
+    VERSION = "0.1.0".freeze
+  end
+end

data/openactive-dataset_site.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openactive/dataset_site/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openactive-dataset_site"
+  spec.version       = OpenActive::DatasetSite::VERSION
+  spec.authors       = ["OpenActive Community"]
+  spec.email         = ["hello@openactive.io"]
+
+  spec.summary       = 'Simplifies creation of dataset sites using templates.'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://openactive.io"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "mustache"
+  spec.add_runtime_dependency "openactive"
+  spec.add_runtime_dependency "typesafe_enum"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: openactive-dataset_site
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OpenActive Community
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustache
+  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: openactive
+  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: typesafe_enum
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hello@openactive.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- bin/console
+- bin/setup
+- examples/example.rb
+- lib/openactive/dataset_site.rb
+- lib/openactive/dataset_site/datasetsite.mustache
+- lib/openactive/dataset_site/feed_type.rb
+- lib/openactive/dataset_site/meta.rb
+- lib/openactive/dataset_site/settings.rb
+- lib/openactive/dataset_site/template_renderer.rb
+- lib/openactive/dataset_site/version.rb
+- openactive-dataset_site.gemspec
+homepage: https://openactive.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simplifies creation of dataset sites using templates.
+test_files: []