openactive 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93c227814f9139f11ffc43555c7d667fdc100e04110de9d70612811c6fb22aaa
+  data.tar.gz: 2ec12d6038256e74a7f01ba2ac38139fec37dd0dd0d61bdaa72b5b191eb1dd8a
+SHA512:
+  metadata.gz: e8ed3a7f93fca01494ed42d8e9acfe256a6297f9e273f42b5bcd7bfd1fcafeeeb4820248104fbfeecb68f0ea59413360d19e88404ceadb94dd4f94c1e19146e0
+  data.tar.gz: c48c618544c7be88f31adec42443ab9067acd440842bc07b0b045b875a7184b32d34a016d26a5ce0ebca40aea9159091b846d556cf59c457f4e4bd4332c16992

data/.gitignore

@@ -0,0 +1,68 @@
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,98 @@
+require:
+  - rubocop-rspec
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: true
+  Max: 20
+  Exclude:
+    - 'db/**/*.rb'
+
+Bundler/OrderedGems:
+  Enabled: false
+RSpec/ExampleWording:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyCaseCondition:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+# check this against SW styleguide
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+# check this against SW styleguide
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  EnforcedStyleForMultiline: comma
+Style/SymbolArray:
+  EnforcedStyle: brackets
+Style/WordArray:
+  EnforcedStyle: brackets
+RSpec/ExampleLength:
+  Max: 15
+  Exclude:
+    - 'spec/features/**/*.rb' # feature specs are just naturally long
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+RSpec/NestedGroups:
+  Max: 5
+Style/AsciiComments:
+  Enabled: false
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - as
+    - id
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+  Exclude:
+    - 'lib/openactive/models/**/*.rb'
+    - 'lib/openactive/enums/**/*.rb'
+    - 'openactive.gemspec'
+Naming/PredicateName:
+  Exclude:
+    - 'lib/openactive/models/**/*.rb'
+    - 'lib/openactive/enums/**/*.rb'
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/openactive/models/**/*.rb'
+    - 'lib/openactive/enums/**/*.rb'
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/openactive/models/**/*.rb'
+    - 'lib/openactive/enums/**/*.rb'
+Layout/SpaceInsideArrayLiteralBrackets:
+  Exclude:
+    - 'lib/openactive/models/**/*.rb'
+
+# Specs aren't being used in an entirely typical way, so these rules clash
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/FilePath:
+  Enabled: false
+
+# While these do great at indicating code smell, the code is inheritantly complicated and would need major refactoring
+# (which would further obfuscate what it's doing!)
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.yardopts

@@ -0,0 +1 @@
+-e yard_extensions.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in OpenActive.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 OpenActive
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -0,0 +1,11 @@
+.PHONY :
+
+lint_rb:
+	bundle exec rubocop
+
+fix_rb:
+	bundle exec rubocop -a
+
+lint: lint_rb
+
+fix: fix_rb

data/README.md

@@ -0,0 +1,35 @@
+# openactive gem - Ruby implementation of OpenActive's data model
+
+Ruby Models for the OpenActive Opportunity and Booking Specifications
+
+OpenActive aims to provide model files for all classes defined in its Opportunity and Booking specifications across the PHP, Ruby, and .NET languages. This repository is intended for the Ruby files; see also the [PHP](https://github.com/openactive/models-php) and [.NET](https://github.com/openactive/OpenActive.NET) implementations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openactive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openactive
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/openactive/models-ruby.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openactive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/openactive/base_model.rb

@@ -0,0 +1,122 @@
+module OpenActive
+  class BaseModel
+    include OpenActive::Concerns::JsonLdSerializable
+    include OpenActive::Concerns::TypeChecker
+
+    def initialize(attributes = {})
+      assign_attributes(attributes) if attributes
+
+      super()
+    end
+
+    def assign_attributes(attributes)
+      attributes.each do |key, value|
+        set_property(key, value)
+      end
+    end
+
+    def self.define_property(property, types: nil, as: nil, default: nil)
+      attr_accessor property
+      property property, as: as || property.to_s if as != false
+      validate_property property, types: types if types
+
+      if default
+        define_method property do
+          instance_variable_get("@#{property}") || default
+        end
+      end
+      property
+    end
+
+    def set_property(key, value)
+      attr_name = key.to_s.underscore
+
+      attr_name = attr_name[1..] if attr_name.start_with?('@')
+
+      val = value
+
+      val = deserialize_value(value) if value.is_a?(Array) || value.is_a?(Hash)
+
+      return if ["context", "type"].include?(attr_name)
+
+      # Calling the setter will type-enforce it
+      send("#{attr_name}=", val)
+    end
+
+    ##
+    # Returns an object from a given JSON-LD representation.
+    #
+    # @param data [string,Array] If a string is provided, we attempt JSON-decoding first
+    # @return [object]
+    #
+    def self.deserialize(data)
+      # If a string is provided, we attempt JSON-decoding first
+      data = JSON.parse(data) if data.is_a?(String)
+
+      inst = new
+
+      # If data provided is not an array, return an empty class
+      return inst unless data.is_a?(Array) || data.is_a?(Hash)
+
+      data.each do |key, value|
+        inst.set_property(key, value)
+      end
+
+      inst
+    end
+
+    def deserialize(*data)
+      self.class.deserialize(data)
+    end
+
+    # Returns a value from a given JSON-LD deserialized array.
+    #
+    # @param value [mixed] If an array is provided, we recursively deserialize it
+    # @return [mixed]
+    def deserialize_value(value)
+      if value.is_a?(Hash)
+        # If an associative array with a type, return its deserialization form,
+        # so that it gets converted from array to object
+        # (associative arrays are still arrays in PHP)
+        if value.key?("@type") || value.key?("type")
+
+          type = value["@type"] || value["type"]
+
+          # only schema is in a subdir, everything else is flat
+          type = type.split(":")[1] if type.include?(':') && !type.start_with?("schema:")
+
+          klass = ::OpenActive::Models.const_get(type)
+
+          inst = klass.deserialize(value)
+
+          return inst
+        end
+      elsif value.is_a?(Array)
+        # NOTE: OpenActive is more strict than schema.org in this regard, so no single element array handling here.
+        # If providing a non-associative array
+        # Loop through it and serialize each item if needed
+        value = value.map do |item|
+          deserialize_value(item)
+        end
+      end
+      value
+    end
+
+    # Returns the JSON-LD representation of the given instance.
+    #
+    # @param obj [::OpenActive::BaseModel] The given instance to convert to JSON-LD
+    # @return [string] JSON-LD string representation of the given instance.
+    # TODO: make this more Ruby-esque (to_h, to_hash, to_json)
+    def self.serialize(obj, **kwargs)
+      ::OpenActive::Helpers::JsonLd.prepare_data_for_serialization(obj, **kwargs)
+    end
+
+    def serialize(**kwargs)
+      self.class.serialize(self, **kwargs)
+    end
+
+    def to_json(*args, schema: false, **kwargs)
+      serialize(schema: schema).to_json(*args, **kwargs)
+    end
+  end
+end

data/lib/openactive/concerns/json_ld_serializable.rb

@@ -0,0 +1,43 @@
+module OpenActive
+  module Concerns
+    module JsonLdSerializable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def properties
+          @properties ||= begin
+            if superclass.respond_to?(:properties)
+              superclass.properties.clone
+            else
+              {}
+            end
+          end
+        end
+
+        def property(field, as:)
+          properties[as] = {
+            field: field,
+          }
+        end
+      end
+
+      def values
+        data = {}
+        self.class.properties.each do |key, field:|
+          data[key] = send(field)
+        end
+        data
+      end
+
+      def to_h
+        data = {}
+        self.class.properties.each do |_key, field:|
+          data[field] = send(field)
+        end
+        data
+      end
+    end
+  end
+end

data/lib/openactive/concerns/type_checker.rb

@@ -0,0 +1,65 @@
+module OpenActive
+  module Concerns
+    module TypeChecker
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def validate_property(meth, types:)
+          type_validation_module.define_method "#{meth}=" do |value|
+            result = check_types(value, types: types)
+            super(result)
+          rescue StandardError => e
+            raise $ERROR_INFO, "error setting field \"#{meth}\"", $ERROR_INFO.backtrace
+          end
+        end
+
+        def check_types(*args)
+          self.class.check_types(*args)
+        end
+
+        private
+
+        def type_validation_module
+          return @type_validation_module if @type_validation_module
+
+          mod = Module.new
+          const_set("TypeChecker", mod) # make it clear in ancestor chain
+          prepend mod
+
+          @type_validation_module ||= mod
+        end
+      end
+
+      # Check if the given value is of at least one of the given types.
+      #
+      # @param value [Object]
+      # @param types [Array<string>]
+      # @return [Boolean]
+      # @raise [OpenActive::Exceptions::InvalidArgumentException] If the provided argument is not of a supported type.
+      def check_types(value, types:)
+        validators = types.map { |type| OpenActive::Validators::BaseValidator.get_validator(type) }.compact
+
+        return value if validators.empty?
+
+        validators.each do |validator|
+          if validator.run(value)
+            # If validation passes for the given type
+            # We coerce the type to mitigate PHP loose types
+            return validator.coerce(value)
+          end
+        end
+
+        val = value.to_s
+        val += " (#{val.to_h})" if val.respond_to?(:to_h)
+
+        # If validation does not pass for any of the provided types,
+        # type invalid
+        raise StandardError,
+              "The first argument type does not match any of the declared parameter types "\
+              "(#{types.join(',')}) for #{val}."
+      end
+    end
+  end
+end

data/lib/openactive/enums/available_channel_type.rb

@@ -0,0 +1,14 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    # [NOTICE: This is a beta enumeration, and is highly likely to change in future versions of this library.]
+    # An enumeration of channels through which a booking can be made.
+    class AvailableChannelType < TypesafeEnum::Base
+      new :TelephoneAdvanceBooking, "https://openactive.io/ns-beta#TelephoneAdvanceBooking"
+      new :TelephonePrepayment, "https://openactive.io/ns-beta#TelephonePrepayment"
+      new :OnlinePrepayment, "https://openactive.io/ns-beta#OnlinePrepayment"
+      new :OpenBookingPrepayment, "https://openactive.io/ns-beta#OpenBookingPrepayment"
+    end
+  end
+end

data/lib/openactive/enums/broker_type.rb

@@ -0,0 +1,11 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class BrokerType < TypesafeEnum::Base
+      new :AgentBroker, "https://openactive.io/AgentBroker"
+      new :NoBroker, "https://openactive.io/NoBroker"
+      new :ResellerBroker, "https://openactive.io/ResellerBroker"
+    end
+  end
+end

data/lib/openactive/enums/facility_setting_type.rb

@@ -0,0 +1,12 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    # [NOTICE: This is a beta enumeration, and is highly likely to change in future versions of this library.]
+    # An enumeration of settings in which a facility can exist.
+    class FacilitySettingType < TypesafeEnum::Base
+      new :IndoorFacility, "https://openactive.io/ns-beta#IndoorFacility"
+      new :OutdoorFacility, "https://openactive.io/ns-beta#OutdoorFacility"
+    end
+  end
+end

data/lib/openactive/enums/gender_restriction_type.rb

@@ -0,0 +1,12 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    # Enumerated types for gender restrictions that are applied to Events
+    class GenderRestrictionType < TypesafeEnum::Base
+      new :NoRestriction, "https://openactive.io/NoRestriction"
+      new :MaleOnly, "https://openactive.io/MaleOnly"
+      new :FemaleOnly, "https://openactive.io/FemaleOnly"
+    end
+  end
+end

data/lib/openactive/enums/open_booking_flow_requirement.rb

@@ -0,0 +1,14 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class OpenBookingFlowRequirement < TypesafeEnum::Base
+      new :OnlinePrepayment, "https://openactive.io/OnlinePrepayment"
+      new :OpenBookingIntakeForm, "https://openactive.io/OpenBookingIntakeForm"
+      new :OpenBookingAttendeeDetails, "https://openactive.io/OpenBookingAttendeeDetails"
+      new :OpenBookingApproval, "https://openactive.io/OpenBookingApproval"
+      new :OpenBookingNegotiation, "https://openactive.io/OpenBookingNegotiation"
+      new :OpenBookingMessageExchange, "https://openactive.io/OpenBookingMessageExchange"
+    end
+  end
+end

data/lib/openactive/enums/order_creation_status.rb

@@ -0,0 +1,12 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class OrderCreationStatus < TypesafeEnum::Base
+      new :OrderCreationPaymentAuthorized, "https://openactive.io/OrderCreationPaymentAuthorized"
+      new :OrderCreationPaymentCaptured, "https://openactive.io/OrderCreationPaymentCaptured"
+      new :OrderCreationComplete, "https://openactive.io/OrderCreationComplete"
+      new :OrderCreationPaymentDue, "https://openactive.io/OrderCreationPaymentDue"
+    end
+  end
+end

data/lib/openactive/enums/order_item_status.rb

@@ -0,0 +1,13 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class OrderItemStatus < TypesafeEnum::Base
+      new :SellerCancelled, "https://openactive.io/SellerCancelled"
+      new :CustomerCancelled, "https://openactive.io/CustomerCancelled"
+      new :OrderProposed, "https://openactive.io/OrderProposed"
+      new :OrderConfirmed, "https://openactive.io/OrderConfirmed"
+      new :CustomerAttended, "https://openactive.io/CustomerAttended"
+    end
+  end
+end

data/lib/openactive/enums/order_proposal_status.rb

@@ -0,0 +1,12 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class OrderProposalStatus < TypesafeEnum::Base
+      new :AwaitingSellerConfirmation, "https://openactive.io/AwaitingSellerConfirmation"
+      new :SellerAccepted, "https://openactive.io/SellerAccepted"
+      new :SellerRejected, "https://openactive.io/SellerRejected"
+      new :CustomerRejected, "https://openactive.io/CustomerRejected"
+    end
+  end
+end

data/lib/openactive/enums/payment_method.rb

@@ -0,0 +1,10 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class PaymentMethod < TypesafeEnum::Base
+      new :Cash, "http://purl.org/goodrelations/v1#Cash"
+      new :PaymentMethodCreditCard, "http://purl.org/goodrelations/v1#PaymentMethodCreditCard"
+    end
+  end
+end

data/lib/openactive/enums/required_status_type.rb

@@ -0,0 +1,11 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    class RequiredStatusType < TypesafeEnum::Base
+      new :Required, "https://openactive.io/Required"
+      new :Optional, "https://openactive.io/Optional"
+      new :Unavailable, "https://openactive.io/Unavailable"
+    end
+  end
+end

data/lib/openactive/enums/schema/action_status_type.rb

@@ -0,0 +1,15 @@
+require 'typesafe_enum'
+
+module OpenActive
+  module Enums
+    module Schema
+      # The status of an Action.
+      class ActionStatusType < TypesafeEnum::Base
+        new :PotentialActionStatus, "https://schema.org/PotentialActionStatus"
+        new :FailedActionStatus, "https://schema.org/FailedActionStatus"
+        new :CompletedActionStatus, "https://schema.org/CompletedActionStatus"
+        new :ActiveActionStatus, "https://schema.org/ActiveActionStatus"
+      end
+    end
+  end
+end