openactive 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88ea62add4f15cd402a29d350d7186717da3c8c0b7feb3eb080f08156c0a792
-  data.tar.gz: 0b72d6feb18932a711e2a390038aac95c6e0e028bd0b68efe61162b94d5a7939
+  metadata.gz: 82b696d4a30a021350671e17b0a73704ae990789611057b175e9dfb7ac1360dc
+  data.tar.gz: 9fa2f6b38f7a0a841b4e0a6104ad6bbc2eff6054afe94cd2e856d75ea93525f1
 SHA512:
-  metadata.gz: b60135e0c0aa90f25f80a90219a3690fc6899886f638f0940e14a3d44d1c9f1a2204a5f654b119c9164878ed016054398690587f3232978ef49ae45db9748998
-  data.tar.gz: 2151a398e7907a1a7f8395c547f7d2acad88c888753c121bef946306afb0052eee52c32e8e2ff909a1c33cc61d95f35c507504fd6c0798d67870c60014901fd5
+  metadata.gz: 957654bbfcbac075430bcf3842e4853b2477540522484e22f3ba95dc5ee6c2800532a9bb77b9e0c9b79257792187bfbc1c0b3d86d3e3dae0920e1159719ab5aa
+  data.tar.gz: e1e39a7cfdc09372b4f257e252fda4a45254502facda28e91c2e4c2e33b9c06145ce053add03268026b83c268aa0357b374231c27bb6783c39983d1f705d553b

data/README.md

@@ -60,6 +60,81 @@ The OpenActive data model builds on top of Schema.org, which means that you are
 
 To reflect this, OpenActive uses inheritance to build ontop of a copy of Schema.org, these are available within the OpenActive::Models::Schema and OpenActive::Enums::Schema namespaces. And so makes it easy to use additional properties from schema.org on any given type.
 
+### Full Models Example
+```ruby
+session_series = OpenActive::Models::SessionSeries.new(
+    name: "Virtual BODYPUMP",
+    description: "This is the virtual version of the original barbell class, which will help you get lean, toned and fit - fast",
+    start_date: "2017-04-24T19:30:00-08:00",
+    end_date: "2017-04-24T23:00:00-08:00",
+    location: OpenActive::Models::Place.new(
+        name: "Raynes Park High School, 46A West Barnes Lane",
+        geo: OpenActive::Models::GeoCoordinates.new(
+            latitude: 51.4034423828125,
+            longitude: -0.2369088977575302,
+        )
+    ),
+    activity: OpenActive::Models::Concept.new(
+        id: "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
+        pref_label: "Bodypump™",
+        in_scheme: "https://openactive.io/activity-list"
+    ),
+    organizer: OpenActive::Models::Organization.new(
+        name: "Central Speedball Association",
+        url: "http://www.speedball-world.com"
+    ),
+    offers: [OpenActive::Models::Offer.new(
+        identifier: "OX-AD",
+        name: "Adult",
+        price: 3.30,
+        price_currency: "GBP",
+        url: "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB"
+    )]
+)
+
+session_series.to_json
+```
+This results in
+
+```json
+{
+  "@context": ["https://openactive.io/", "https://openactive.io/ns-beta"],
+  "@type": "SessionSeries",
+  "description": "This is the virtual version of the original barbell class, which will help you get lean, toned and fit - fast",
+  "offers": [{
+    "@type": "Offer",
+    "name": "Adult",
+    "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB",
+    "price": "3.33",
+    "priceCurrency": "GBP",
+    "identifier": "OX-AD"
+  }],
+  "startDate": "2017-04-24T19:30:00-08:00",
+  "endDate": "2017-04-24T23:00:00-08:00",
+  "location": {
+    "@type": "Place",
+    "name": "Raynes Park High School, 46A West Barnes Lane",
+    "geo": {
+      "@type": "GeoCoordinates",
+      "longitude": "-0.2369088977575302e0",
+      "latitude": "0.514034423828125e2"
+    }
+  },
+  "organizer": {
+    "@type": "Organization",
+    "name": "Central Speedball Association",
+    "url": "http://www.speedball-world.com"
+  },
+  "activity": {
+    "@type": "Concept",
+    "@id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351",
+    "inScheme": "https://openactive.io/activity-list",
+    "prefLabel": "Bodypump™"
+  },
+  "name": "Virtual BODYPUMP"
+}
+```
+
 ## RPDE Feed Publishing 
 
 To publish an OpenActive data feed (see this [video explainer](https://developer.openactive.io/publishing-data/data-feeds/how-a-data-feed-works)), The OpenActive gem provides a drop-in solution to render the feed pages. This also includes validation for the underlying feed query.

data/lib/openactive/base_model.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module OpenActive
   class BaseModel
     include OpenActive::Concerns::JsonLdSerializable
@@ -112,8 +114,12 @@ module OpenActive
       self.class.serialize(self, **kwargs)
     end
 
-    def to_json(*args, schema: false, **kwargs)
-      serialize(schema: schema).to_json(*args, **kwargs)
+    def to_json(schema: false, pretty: false)
+      serialized = serialize(schema: schema)
+
+      return JSON.pretty_generate(serialized) if pretty
+
+      serialized.to_json
     end
   end
 end

data/lib/openactive/helpers/json_ld.rb

@@ -28,11 +28,29 @@ module OpenActive
 
             data["@context"] =
               [
+                *(schema ? ["https://schema.org"] : []),
                 *obj.context,
-                *(schema ? ["https://schema.org"] : [])
               ]
           end
 
+          # push @'s to the start
+          data = data.sort_by do |k, _v|
+            case k
+            when '@context'
+              0
+            when '@type'
+              1
+            when '@id'
+              2
+            else
+              if k.start_with?('@')
+                3
+              else
+                4
+              end
+            end
+          end
+
           # Loop all class methods, find the getters
           # and map defined attributes, normalizing attribute name
           data = Hash[data.map do |method_name, attr_value|
@@ -68,6 +86,8 @@ module OpenActive
               parent,
               **kwargs,
             )
+          elsif value.is_a?(BigDecimal)
+            value.to_s('F')
           elsif value.is_a?(Numeric)
             value
           elsif value.nil? # let nil be nil

data/lib/openactive/validators/time_validator.rb

@@ -5,7 +5,7 @@ module OpenActive
     class TimeValidator < BaseValidator
       # https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s07.html#id2175516
       # Minor additions to make second values and timezone optional
-      REGEX = /(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])?(?<timezone>Z|[+-](?:2[0-3]|[01][0-9])(?::?(?:[0-5][0-9]))?)?/
+      REGEX = /(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])?(?<timezone>Z|[+-](?:2[0-3]|[01][0-9])(?::?(?:[0-5][0-9]))?)?/.freeze
 
       # Coerce given value to the type the validator is validating against.
       # PLEASE NOTE: no checks are performed on the given value.

data/lib/openactive/version.rb

@@ -1,3 +1,3 @@
 module OpenActive
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openactive
 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: bundler