openactive 0.1.0.rc1

data/lib/openactive/models/unable_to_process_order_item_error.rb

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

data/lib/openactive/models/unacceptable_offer_error.rb

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

data/lib/openactive/models/unauthenticated_error.rb

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

data/lib/openactive/models/unavailable_opportunity_error.rb

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

data/lib/openactive/models/unknown_offer_error.rb

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

data/lib/openactive/models/unknown_opportunity_details_error.rb

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

data/lib/openactive/models/unknown_or_incorrect_endpoint_error.rb

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

data/lib/openactive/models/unknown_order_error.rb

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

data/lib/openactive/models/web_api.rb

@@ -0,0 +1,57 @@
+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 [WebAPI](https://pending.schema.org/WebAPI), 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 WebAPI < ::OpenActive::JsonLdModel
+      # @!attribute type
+      # @return [String]
+      def type
+        "WebAPI"
+      end
+
+      # @return [String]
+      define_property :name, as: "name", types: [
+        "string",
+      ]
+
+      # @return [String]
+      define_property :description, as: "description", types: [
+        "string",
+      ]
+
+      # @return [Array<URI>]
+      define_property :conforms_to, as: "conformsTo", types: [
+        "URI[]",
+      ]
+
+      # @return [URI]
+      define_property :documentation, as: "documentation", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :endpoint_description, as: "endpointDescription", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :endpoint_url, as: "endpointURL", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :landing_page, as: "landingPage", types: [
+        "URI",
+      ]
+
+      # @return [URI]
+      define_property :terms_of_service, as: "termsOfService", types: [
+        "URI",
+      ]
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/deleted_items_data_exception.rb

@@ -0,0 +1,11 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class DeletedItemsDataException < RpdeException
+        def initialize(msg = "Deleted items must not contain data.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/first_time_after_change_number_exception.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class FirstTimeAfterChangeNumberException < RpdeException
+        def initialize(msg = "First item in the feed must never have same 'modified' as afterChangeNumber query "\
+                             "parameter. Please check the RPDE specification and ensure you are using the correct "\
+                             "query for your ordering strategy.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/first_time_after_timestamp_and_after_id_exception.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class FirstTimeAfterTimestampAndAfterIdException < RpdeException
+        def initialize(msg = "First item in the feed must never have same 'modified' and 'id' as afterTimestamp and "\
+                             "afterId query parameters. Please check the RPDE specification and ensure you are using "\
+                             "the correct query for your ordering strategy.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/incomplete_items_data_exception.rb

@@ -0,0 +1,11 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class IncompleteItemsDataException < RpdeException
+        def initialize(msg = "All RPDE feed items must include id, modified, state, and kind.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/modified_id_items_order_exception.rb

@@ -0,0 +1,12 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class ModifiedIdItemsOrderException < RpdeException
+        def initialize(msg = "Items must be ordered first by 'modified', then by 'id'. Please check the RPDE "\
+                             "specification and ensure you are using the correct query for your ordering strategy.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/next_change_numbers_items_order_exception.rb

@@ -0,0 +1,12 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class NextChangeNumbersItemsOrderException < RpdeException
+        def initialize(msg = "Items must be ordered by 'modified'. Please check the RPDE specification and ensure you "\
+                             "are using the correct query for your ordering strategy.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/openactive/rpde/exceptions/rpde_exception.rb

@@ -0,0 +1,8 @@
+module OpenActive
+  module Rpde
+    module Exceptions
+      class RpdeException < StandardError
+      end
+    end
+  end
+end

data/lib/openactive/rpde/rpde_body.rb

@@ -0,0 +1,157 @@
+# rubocop:disable Metrics/MethodLength
+module OpenActive
+  module Rpde
+    class RpdeBody < OpenActive::BaseModel
+      define_property :next, types: ["string"]
+      define_property :items, types: ["OpenActive::Rpde::RpdeItem[]"]
+      define_property :license, types: ["string"], default: "https://creativecommons.org/licenses/by/4.0/"
+
+      # Create an RpdeBody object from a given feed base URL, an array of RpdeItem, and either a modified int,
+      # and id, or a change_number.
+      # Checks are performed to see if the provided "modified" and "id" attributes
+      # are valid.
+      # @param [Hash] opts the options to create a message with.
+      # @option opts [String]  feed_base_url string
+      # @option opts [Integer]  modified int
+      # @option opts [String,Integer]  id string|int
+      # @option opts [Array<::OpenActive::Rpde::RpdeItem>] items
+      # @return self
+      # @raise [::OpenActive::Rpde::Exceptions::FirstTimeAfterTimestampAndAfterIdException]
+      #        If the afterId and afterTimestamp provided are of the first item in the feed
+      # @raise [::OpenActive::Rpde::Exceptions::DeletedItemsDataException]
+      #        If any deleted items provided (if any) contain data
+      # @raise [::OpenActive::Rpde::Exceptions::IncompleteItemsDataException]
+      #        If any RPDE feed item does not include id, modified, state, or kind.
+      # @raise [::OpenActive::Rpde::Exceptions::ModifiedIdItemsOrderException]
+      #        If the feed items are not in "modified", then "id", order.
+      # @raise [::OpenActive::Exceptions::InvalidArgumentException]
+      #        If the provided argument is not of a supported type.
+      def self.create(feed_base_url:, modified: nil, id: nil, change_number: nil, items:)
+        if !modified.nil? && !id.nil? && change_number.nil?
+          create_from_modified_id(feed_base_url, modified, id, items)
+        elsif modified.nil? && id.nil? && !change_number.nil?
+          create_from_next_change_number(feed_base_url, change_number, items)
+        else
+          raise ArgumentError
+        end
+      end
+
+      # Create an RpdeBody object from a given feed base URL, a modified int,
+      # an id, and an array of RpdeItem.
+      # Checks are performed to see if the provided "modified" and "id" attributes
+      # are valid.
+      #
+      # @param [String] feed_base_url
+      # @param [Integer] modified int
+      # @param [String,Integer] id
+      # @param [Array<::OpenActive::Rpde::RpdeItem>] items
+      # @return self
+      # @raise [::OpenActive::Rpde::Exceptions::FirstTimeAfterTimestampAndAfterIdException]
+      #        If the afterId and afterTimestamp provided are of the first item in the feed
+      # @raise [::OpenActive::Rpde::Exceptions::DeletedItemsDataException]
+      #        If any deleted items provided (if any) contain data
+      # @raise [::OpenActive::Rpde::Exceptions::IncompleteItemsDataException]
+      #        If any RPDE feed item does not include id, modified, state, or kind.
+      # @raise [::OpenActive::Rpde::Exceptions::ModifiedIdItemsOrderException]
+      #        If the feed items are not in "modified", then "id", order.
+      # @raise [::OpenActive::Exceptions::InvalidArgumentException]
+      #        If the provided argument is not of a supported type.
+      def self.create_from_modified_id(feed_base_url, modified, id, items)
+        rpde_body = new(
+          items: items,
+        )
+        if !items.empty?
+          first_item = items.first
+
+          # Checks that the afterId and afterTimestamp provided are not the
+          # first item in the feed (helps detect whether query is correct)
+          if first_item.modified.to_s == modified.to_s && first_item.id.to_s == id.to_s
+            raise Exceptions::FirstTimeAfterTimestampAndAfterIdException
+          end
+
+          current_modified = -1
+          current_id = first_item.id
+          items.each do |item|
+            if item.state == OpenActive::Rpde::RpdeState::DELETED && !item.data.nil?
+              raise Exceptions::DeletedItemsDataException
+            end
+
+            if item.state.nil? || item.kind.nil? || item.modified.nil? || item.id.nil?
+              raise Exceptions::IncompleteItemsDataException
+            end
+
+            unless item.modified > current_modified ||
+                   (item.modified == current_modified && item.id > current_id)
+              raise Exceptions::ModifiedIdItemsOrderException
+            end
+
+            current_modified = item.modified
+            current_id = item.id
+          end
+          # Create 'next' URL depending on whether there are items available
+          rpde_body.next = "#{feed_base_url}?afterTimestamp=#{CGI.escape(items.last.modified.to_s)}&"\
+                           "afterId=#{CGI.escape(items.last.id.to_s)}"
+        elsif !modified.nil? && !id.nil?
+          rpde_body.next = "#{feed_base_url}?afterTimestamp=#{CGI.escape(modified.to_s)}&"\
+                           "afterId=#{CGI.escape(id.to_s)}"
+        end
+        rpde_body
+      end
+
+      # Create an RpdeBody object from a given feed base URL, a change number int,
+      # and an array of RpdeItem.
+      # Checks are performed to see if the provided "changeNumber" attribute
+      # is valid.
+      #
+      # @param [String] feed_base_url
+      # @param [Integer] change_number
+      # @param [Array<::OpenActive::Rpde::RpdeItem>]items
+      # @return self
+      # @raise [::OpenActive::Rpde::Exceptions::FirstTimeAfterTimestampAndAfterIdException]
+      #        If the afterId and afterTimestamp provided are of the first item in the feed
+      # @raise [::OpenActive::Rpde::Exceptions::DeletedItemsDataException]
+      #        If any deleted items provided (if any) contain data
+      # @raise [::OpenActive::Rpde::Exceptions::IncompleteItemsDataException]
+      #        If any RPDE feed item does not include id, modified, state, or kind.
+      # @raise [::OpenActive::Rpde::Exceptions::ModifiedIdItemsOrderException]
+      #        If the feed items are not in "modified", then "id", order.
+      # @raise [::OpenActive::Exceptions::InvalidArgumentException]
+      #        If the provided argument is not of a supported type.
+      def self.create_from_next_change_number(feed_base_url, change_number, items)
+        rpde_body = new(
+          items: items,
+        )
+        if !items.empty?
+          first_item = items.first
+
+          # Checks that the afterId and afterTimestamp provided are not the
+          # first item in the feed (helps detect whether query is correct)
+          raise Exceptions::FirstTimeAfterChangeNumberException if first_item.modified == change_number
+
+          current_change_number = -1
+          items.each do |item|
+            if item.state == OpenActive::Rpde::RpdeState::DELETED && !item.data.nil?
+              raise Exceptions::DeletedItemsDataException
+            end
+
+            if item.state.nil? || item.kind.nil? || item.modified.nil? || item.id.nil?
+              raise Exceptions::IncompleteItemsDataException
+            end
+
+            raise Exceptions::NextChangeNumbersItemsOrderException unless item.modified > current_change_number
+
+            current_change_number = item.modified
+          end
+          # Create 'next' URL depending on whether there are items available
+          rpde_body.next = "#{feed_base_url}?afterChangeNumber=#{CGI.escape(items.last.modified.to_s)}"
+        else
+          unless change_number.nil?
+            rpde_body.next = "#{feed_base_url}?afterChangeNumber=#{CGI.escape(change_number.to_s)}"
+          end
+        end
+        rpde_body
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/MethodLength

data/lib/openactive/rpde/rpde_item.rb

@@ -0,0 +1,11 @@
+module OpenActive
+  module Rpde
+    class RpdeItem < OpenActive::BaseModel
+      define_property :state, types: ["OpenActive::Rpde::RpdeState"]
+      define_property :kind, types: ["OpenActive::Rpde::RpdeKind"]
+      define_property :id, types: ["string", "int"], as: "@id"
+      define_property :modified, types: ["int"]
+      define_property :data, types: ["OpenActive::BaseModel", "null"]
+    end
+  end
+end

data/lib/openactive/rpde/rpde_kind.rb

@@ -0,0 +1,19 @@
+module OpenActive
+  module Rpde
+    class RpdeKind < TypesafeEnum::Base
+      new :SESSION_SERIES, "SessionSeries"
+      new :SCHEDULED_SESSION, "ScheduledSession"
+      new :SCHEDULED_SESSION_SESSION_SERIES, "ScheduledSession.SessionSeries"
+      new :SESSION_SERIES_SCHEDULED_SESSION, "SessionSeries.ScheduledSession"
+      new :FACILITY_USE, "FacilityUse"
+      new :INDIVIDUAL_FACILITY_USE, "IndividualFacilityUse"
+      new :FACILITY_USE_SLOT, "FacilityUse/Slot"
+      new :INDIVIDUAL_FACILITY_USE_SLOT, "IndividualFacilityUse/Slot"
+      new :COURSE, "Course"
+      new :COURSE_INSTANCE, "CourseInstance"
+      new :HEADLINE_EVENT, "HeadlineEvent"
+      new :EVENT, "Event"
+      new :EVENT_SERIES, "EventSeries"
+    end
+  end
+end

data/lib/openactive/rpde/rpde_state.rb

@@ -0,0 +1,8 @@
+module OpenActive
+  module Rpde
+    class RpdeState < TypesafeEnum::Base
+      new :DELETED
+      new :UPDATED
+    end
+  end
+end

data/lib/openactive/validators/array_of_validator.rb

@@ -0,0 +1,45 @@
+module OpenActive
+  module Validators
+    class ArrayOfValidator < BaseValidator
+      attr_accessor :item_validator
+
+      def initialize(item_validator)
+        @item_validator = item_validator
+      end
+
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+
+      def coerce(value)
+        # NOTE: OpenActive is more strict than plain json-ld, so no coercion into arrays
+        value
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+
+      def run(value)
+        null_validator = NullValidator.new
+
+        # NOTE: OpenActive is more strict than plain json-ld, so no coercion into arrays
+
+        # Check if value is an array
+        return true if item_validator.run(value) == true
+
+        return false if ArrayValidator.new.run(value) == false
+
+        value.each do |item|
+          # If any of the provided items is not null nor an instance of the provided class name
+          return false if null_validator.run(item) == false && item_validator.run(item) == false
+        end
+        true
+      end
+    end
+  end
+end

data/lib/openactive/validators/array_validator.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Validators
+    class ArrayValidator < BaseValidator
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        value.is_a?(Array)
+      end
+    end
+  end
+end

data/lib/openactive/validators/base_model_validator.rb

@@ -0,0 +1,17 @@
+module OpenActive
+  module Validators
+    class BaseModelValidator < BaseValidator
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        # With BaseModelValidator we are a bit more relaxed
+        # in terms of checking the class name.
+        # We allow the class to be an instanceof BaseModel
+        # Or to be a sub class (BaseModel is one of its parent)
+        value.is_a?(OpenActive::JsonLdModel)
+      end
+    end
+  end
+end

data/lib/openactive/validators/base_validator.rb

@@ -0,0 +1,79 @@
+module OpenActive
+  module Validators
+    class BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      def coerce(value)
+        # For all the classes that inherit BaseValidator
+        # that don't need to coerce,
+        # This is a no-op
+        value
+      end
+
+      # Run validation on the given value.
+      #
+      # @param _value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(_value)
+        false
+      end
+
+      # Returns a validator instance from a given type name.
+      #
+      # @param type [string] The type name
+      # @return [::OpenActive::Validators::ValidatorInterface]
+      def self.get_validator(type) # rubocop:disable Metrics/MethodLength
+        # If last 2 characters are "[]"
+        # We are validating an array
+        if type.end_with?('[]')
+          # Build item validator name
+          # (remove last 2 characters "[]")
+          item_type = type[0...-2]
+
+          # Instantiate validator
+          return ArrayOfValidator.new(get_validator(item_type))
+        end
+
+        # If first letter of type is a lower case letter
+        # We are validating a native type
+        if type.match(/^[[:lower:]]/)
+          # Build item validator name (FQ)
+          class_name = "#{type.classify}Validator"
+          validator = ::OpenActive::Validators.const_get(class_name)
+
+          return validator.new
+        end
+
+        validator =
+          case type
+          when "URI"
+            UriValidator.new
+          when "Time"
+            TimeValidator.new
+          when "DateTime"
+            DateTimeValidator.new
+          when "DateInterval"
+            DateIntervalValidator.new
+          when "Number"
+            NumberValidator.new
+          end
+
+        return validator if validator
+
+        # everything beyond this we're dealing with actual classes.. hopefully
+        klass = Object.const_get(type)
+
+        return EnumValidator.new(klass) if klass.ancestors.include?(TypesafeEnum::Base)
+
+        # If type is an OpenActive BaseModel class
+        return BaseModelValidator.new if klass == OpenActive::JsonLdModel
+
+        InstanceValidator.new(klass)
+      end
+    end
+  end
+end

data/lib/openactive/validators/bool_validator.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Validators
+    class BoolValidator < BaseValidator
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        [true, false].include?(value)
+      end
+    end
+  end
+end

data/lib/openactive/validators/date_interval_validator.rb

@@ -0,0 +1,38 @@
+module OpenActive
+  module Validators
+    class DateIntervalValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      # @raise [::Exception] When value cannot be parsed as a ::DateInterval
+      def coerce(value)
+        return value if value.is_a?(ActiveSupport::Duration)
+
+        # If not passing a DateInterval object, try and create one from value
+        # Assuming that the string will be an interval spec in ISO 8601 format
+        ActiveSupport::Duration.parse(value)
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        return true if value.is_a?(ActiveSupport::Duration)
+
+        # If not a string - fail validation
+        return false unless value.is_a?(String)
+
+        begin
+          ActiveSupport::Duration.parse(value)
+          true
+        rescue ArgumentError => _e
+          false
+        end
+      end
+    end
+  end
+end