openactive 0.1.0.rc1

data/lib/openactive/helpers/json_ld.rb

@@ -0,0 +1,82 @@
+module OpenActive
+  module Helpers
+    class JsonLd
+      class << self
+        # Returns the JSON-LD type from a given thing.
+        #
+        # @param thing [::OpenActive::JsonLdModel]
+        # @return [string]
+        def get_type(thing)
+          # Append "type" attribute for all other classes
+          reflect = ::ReflectionClass.new(thing)
+
+          # Type is just the non-FQ class name
+          reflect.get_short_name
+        end
+
+        # Returns an associative array with the data ready for JSON-LD serialization.
+        #
+        # @param obj [::OpenActive::JsonLdModel] The given instance to convert to JSON-LD
+        # @param parent [object,null] The parent node in the structure.
+        # @return [array]
+        def prepare_data_for_serialization(obj, parent = nil, schema: false)
+          data = obj.values
+
+          # Only add context if object is subclass of BaseModel
+          # and no parent, or parent is an RPDE item
+          if obj.respond_to?(:context) && (parent.nil? || !parent.is_a?(OpenActive::JsonLdModel))
+
+            data["@context"] =
+              [
+                *obj.context,
+                *(schema ? ["https://schema.org"] : [])
+              ]
+          end
+
+          # Loop all class methods, find the getters
+          # and map defined attributes, normalizing attribute name
+          data = Hash[data.map do |method_name, attr_value|
+            attr_name = method_name
+
+            attr_value = serialize_value(attr_value, obj, schema: schema)
+
+            [attr_name.to_s, attr_value]
+          end]
+
+          # Remove empty elements
+          Hash[data.select do |_key, value|
+            next false if value.is_a?(Array) && value.empty?
+            next false if value.nil?
+            next false if value == ""
+
+            true
+          end]
+        end
+
+        def serialize_value(value, parent = nil, **kwargs)
+          if value.respond_to?(:iso8601)
+            value.iso8601
+          elsif value.is_a?(TypesafeEnum::Base)
+            value.value
+          elsif value.is_a?(Array)
+            value.map do |item|
+              serialize_value(item, parent, **kwargs)
+            end
+          elsif value.is_a?(OpenActive::BaseModel)
+            prepare_data_for_serialization(
+              value,
+              parent,
+              **kwargs,
+            )
+          elsif value.is_a?(Numeric)
+            value
+          elsif value.nil? # let nil be nil
+            nil
+          else
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openactive/json_ld_model.rb

@@ -0,0 +1,33 @@
+module OpenActive
+  class JsonLdModel < BaseModel
+    # Gets or sets the identifier used to uniquely identify things that are being described in the document with
+    # IRIs or blank node identifiers.
+    # To be able to externally reference nodes in a graph, it is important that nodes have an identifier. IRIs
+    # are a fundamental concept of Linked Data, for nodes to be truly linked, dereferencing the identifier should
+    # result in a representation of that node.This may allow an application to retrieve further information about
+    # a node. In JSON-LD, a node is identified using the @id keyword:
+    #
+    # @return [string]
+    attr_accessor :id
+    property :id, as: "@id"
+
+    property :type, as: "@type"
+
+    # Gets the context used to define the short-hand names that are used throughout a JSON-LD document.
+    # These short-hand names are called terms and help developers to express specific identifiers in a compact
+    # manner.
+    # When two people communicate with one another, the conversation takes place in a shared environment,
+    # typically called "the context of the conversation". This shared context allows the individuals to use
+    # shortcut terms, like the first name of a mutual friend, to communicate more quickly but without losing
+    # accuracy. A context in JSON-LD works in the same way. It allows two applications to use shortcut terms to
+    # communicate with one another more efficiently, but without losing accuracy.
+    # Simply speaking, a context is used to map terms to IRIs. Terms are case sensitive and any valid string that
+    # is not a reserved JSON-LD keyword can be used as a term.
+    #
+    # @return [Array<string>]
+    define_property :context, types: ["string[]"], default: [
+      "https://openactive.io/",
+      "https://openactive.io/ns-beta"
+    ], as: false
+  end
+end

data/lib/openactive/models/action.rb

@@ -0,0 +1,22 @@
+module OpenActive
+  module Models
+    # This type is derived from [Action](https://schema.org/Action), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Action < ::OpenActive::Models::Schema::Action
+      # @!attribute type
+      # @return [String]
+      def type
+        "Action"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [OpenActive::Models::EntryPoint]
+      define_property :target, as: "target", types: [
+        "OpenActive::Models::EntryPoint",
+      ]
+    end
+  end
+end

data/lib/openactive/models/baby_changing.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Models
+    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class BabyChanging < ::OpenActive::Models::LocationFeatureSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "BabyChanging"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/bar.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Models
+    # [NOTICE: This is a beta class, and is highly likely to change in future versions of this library.].
+    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Bar < ::OpenActive::Models::LocationFeatureSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "beta:Bar"
+      end
+    end
+  end
+end

data/lib/openactive/models/barcode.rb

@@ -0,0 +1,22 @@
+module OpenActive
+  module Models
+    # This type is derived from [Barcode](https://schema.org/Barcode), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Barcode < ::OpenActive::Models::ImageObject
+      # @!attribute type
+      # @return [String]
+      def type
+        "Barcode"
+      end
+
+      # @return [String]
+      define_property :text, as: "text", types: [
+        "string",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+    end
+  end
+end

data/lib/openactive/models/booking_service.rb

@@ -0,0 +1,31 @@
+module OpenActive
+  module Models
+    class BookingService < ::OpenActive::Models::Schema::Service
+      # @!attribute type
+      # @return [String]
+      def type
+        "BookingService"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :software_version, as: "softwareVersion", types: [
+        "string",
+      ]
+
+      # @return [Array<OpenActive::Models::Terms>]
+      define_property :terms_of_service, as: "termsOfService", types: [
+        "OpenActive::Models::Terms[]",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+    end
+  end
+end

data/lib/openactive/models/boolean_form_field_specification.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Models
+    # This type is derived from [PropertyValueSpecification](https://schema.org/PropertyValueSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class BooleanFormFieldSpecification < ::OpenActive::Models::PropertyValueSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "BooleanFormFieldSpecification"
+      end
+
+      # @return [String]
+      define_property :value_required, as: "valueRequired", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/brand.rb

@@ -0,0 +1,46 @@
+module OpenActive
+  module Models
+    # This type is derived from [Brand](https://schema.org/Brand), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Brand < ::OpenActive::Models::Schema::Brand
+      # @!attribute type
+      # @return [String]
+      def type
+        "Brand"
+      end
+
+      # @return [int,String,OpenActive::Models::PropertyValue,Array<OpenActive::Models::PropertyValue>,nil]
+      define_property :identifier, as: "identifier", types: [
+        "int",
+        "string",
+        "OpenActive::Models::PropertyValue",
+        "OpenActive::Models::PropertyValue[]",
+        "null",
+      ]
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :description, as: "description", types: [
+        "string",
+      ]
+
+      # @return [OpenActive::Models::ImageObject]
+      define_property :logo, as: "logo", types: [
+        "OpenActive::Models::ImageObject",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+
+      # @return [Array<OpenActive::Models::Schema::VideoObject>]
+      define_property :video, as: "beta:video", types: [
+        "OpenActive::Models::Schema::VideoObject[]",
+      ]
+    end
+  end
+end

data/lib/openactive/models/cafe.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Models
+    # [NOTICE: This is a beta class, and is highly likely to change in future versions of this library.].
+    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Cafe < ::OpenActive::Models::LocationFeatureSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "beta:Cafe"
+      end
+    end
+  end
+end

data/lib/openactive/models/cancellation_not_permitted_error.rb

@@ -0,0 +1,11 @@
+module OpenActive
+  module Models
+    class CancellationNotPermittedError < ::OpenActive::Models::OpenBookingError
+      # @!attribute type
+      # @return [String]
+      def type
+        "CancellationNotPermittedError"
+      end
+    end
+  end
+end

data/lib/openactive/models/changing_facilities.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Models
+    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class ChangingFacilities < ::OpenActive::Models::LocationFeatureSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "ChangingFacilities"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/concept.rb

@@ -0,0 +1,42 @@
+module OpenActive
+  module Models
+    # This type is derived from [Concept](http://www.w3.org/2004/02/skos/core#Concept), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Concept < ::OpenActive::JsonLdModel
+      # @!attribute type
+      # @return [String]
+      def type
+        "Concept"
+      end
+
+      # @return [Array<String>]
+      define_property :alt_label, as: "altLabel", types: [
+        "string[]",
+      ]
+
+      # @return [Array<URI>]
+      define_property :broader, as: "broader", types: [
+        "URI[]",
+      ]
+
+      # @return [URI]
+      define_property :in_scheme, as: "inScheme", types: [
+        "URI",
+      ]
+
+      # @return [Array<URI>]
+      define_property :narrower, as: "narrower", types: [
+        "URI[]",
+      ]
+
+      # @return [String]
+      define_property :notation, as: "notation", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :pref_label, as: "prefLabel", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/concept_collection.rb

@@ -0,0 +1,12 @@
+module OpenActive
+  module Models
+    # [NOTICE: This is a beta class, and is highly likely to change in future versions of this library.].
+    class ConceptCollection < ::OpenActive::Models::Schema::CreativeWork
+      # @!attribute type
+      # @return [String]
+      def type
+        "beta:ConceptCollection"
+      end
+    end
+  end
+end

data/lib/openactive/models/concept_scheme.rb

@@ -0,0 +1,37 @@
+module OpenActive
+  module Models
+    # This type is derived from [ConceptScheme](http://www.w3.org/2004/02/skos/core#ConceptScheme), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class ConceptScheme < ::OpenActive::JsonLdModel
+      # @!attribute type
+      # @return [String]
+      def type
+        "ConceptScheme"
+      end
+
+      # @return [String]
+      define_property :title, as: "title", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :description, as: "description", types: [
+        "string",
+      ]
+
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :concept, as: "concept", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
+      # @return [URI]
+      define_property :license, as: "license", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+    end
+  end
+end

data/lib/openactive/models/course.rb

@@ -0,0 +1,57 @@
+module OpenActive
+  module Models
+    # This type is derived from [Course](https://schema.org/Course), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Course < ::OpenActive::Models::Schema::Course
+      # @!attribute type
+      # @return [String]
+      def type
+        "Course"
+      end
+
+      # @return [int,String,OpenActive::Models::PropertyValue,Array<OpenActive::Models::PropertyValue>,nil]
+      define_property :identifier, as: "identifier", types: [
+        "int",
+        "string",
+        "OpenActive::Models::PropertyValue",
+        "OpenActive::Models::PropertyValue[]",
+        "null",
+      ]
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :description, as: "description", types: [
+        "string",
+      ]
+
+      # @return [Array<OpenActive::Models::Concept>]
+      define_property :activity, as: "activity", types: [
+        "OpenActive::Models::Concept[]",
+      ]
+
+      # @return [OpenActive::Models::Person,OpenActive::Models::Organization]
+      define_property :author, as: "author", types: [
+        "OpenActive::Models::Person",
+        "OpenActive::Models::Organization",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+
+      # @return [Array<OpenActive::Models::Schema::VideoObject>]
+      define_property :video, as: "beta:video", types: [
+        "OpenActive::Models::Schema::VideoObject[]",
+      ]
+
+      # @return [OpenActive::Models::ImageObject]
+      define_property :logo, as: "beta:logo", types: [
+        "OpenActive::Models::ImageObject",
+      ]
+    end
+  end
+end

data/lib/openactive/models/course_instance.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Models
+    # This type is derived from [CourseInstance](https://schema.org/CourseInstance), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class CourseInstance < ::OpenActive::Models::Event
+      # @!attribute type
+      # @return [String]
+      def type
+        "CourseInstance"
+      end
+
+      # @return [OpenActive::Models::Course]
+      define_property :course, as: "beta:course", types: [
+        "OpenActive::Models::Course",
+      ]
+    end
+  end
+end

data/lib/openactive/models/creche.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Models
+    # This type is derived from [LocationFeatureSpecification](https://schema.org/LocationFeatureSpecification), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Creche < ::OpenActive::Models::LocationFeatureSpecification
+      # @!attribute type
+      # @return [String]
+      def type
+        "Creche"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/data_download.rb

@@ -0,0 +1,37 @@
+module OpenActive
+  module Models
+    #
+    # ## **EARLY RELEASE NOTICE**
+    # In order to expedite the OpenActive tooling work, this class has been added to the model for the purposes of testing.
+    # IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://www.openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
+    #
+    # This type is derived from [DataDownload](https://schema.org/DataDownload), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class DataDownload < ::OpenActive::Models::Schema::DataDownload
+      # @!attribute type
+      # @return [String]
+      def type
+        "DataDownload"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [URI]
+      define_property :additional_type, as: "additionalType", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :content_url, as: "contentUrl", types: [
+        "URI",
+      ]
+
+      # @return [String]
+      define_property :encoding_format, as: "encodingFormat", types: [
+        "string",
+      ]
+    end
+  end
+end

data/lib/openactive/models/dataset.rb

@@ -0,0 +1,100 @@
+module OpenActive
+  module Models
+    #
+    # ## **EARLY RELEASE NOTICE**
+    # In order to expedite the OpenActive tooling work, this class has been added to the model for the purposes of testing.
+    # IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](https://www.openactive.io/dataset-api-discovery/EditorsDraft/) evolves.
+    #
+    # This type is derived from [Dataset](https://schema.org/Dataset), which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.
+    class Dataset < ::OpenActive::Models::Schema::Dataset
+      # @!attribute type
+      # @return [String]
+      def type
+        "Dataset"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :description, as: "description", types: [
+        "string",
+      ]
+
+      # @return [OpenActive::Models::WebAPI]
+      define_property :access_service, as: "accessService", types: [
+        "OpenActive::Models::WebAPI",
+      ]
+
+      # @return [OpenActive::Models::ImageObject]
+      define_property :background_image, as: "backgroundImage", types: [
+        "OpenActive::Models::ImageObject",
+      ]
+
+      # @return [OpenActive::Models::BookingService]
+      define_property :booking_service, as: "bookingService", types: [
+        "OpenActive::Models::BookingService",
+      ]
+
+      # @return [DateTime,nil]
+      define_property :date_modified, as: "dateModified", types: [
+        "DateTime",
+        "null",
+      ]
+
+      # @return [Date,DateTime,nil]
+      define_property :date_published, as: "datePublished", types: [
+        "Date",
+        "DateTime",
+        "null",
+      ]
+
+      # @return [URI]
+      define_property :discussion_url, as: "discussionUrl", types: [
+        "URI",
+      ]
+
+      # @return [Array<OpenActive::Models::DataDownload>]
+      define_property :distribution, as: "distribution", types: [
+        "OpenActive::Models::DataDownload[]",
+      ]
+
+      # @return [URI]
+      define_property :documentation, as: "documentation", types: [
+        "URI",
+      ]
+
+      # @return [Array<String>]
+      define_property :in_language, as: "inLanguage", types: [
+        "string[]",
+      ]
+
+      # @return [Array<String>]
+      define_property :keywords, as: "keywords", types: [
+        "string[]",
+      ]
+
+      # @return [URI]
+      define_property :license, as: "license", types: [
+        "URI",
+      ]
+
+      # @return [OpenActive::Models::Organization]
+      define_property :publisher, as: "publisher", types: [
+        "OpenActive::Models::Organization",
+      ]
+
+      # @return [URI]
+      define_property :schema_version, as: "schemaVersion", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :url, as: "url", types: [
+        "URI",
+      ]
+    end
+  end
+end