w3c_api 0.1.0 → 0.1.2

data/lib/w3c_api/models/participant_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'user'
+
+module W3cApi
+  module Models
+    class ParticipantIndex < Lutaml::Hal::Page
+      hal_link :participants, key: 'participants', realize_class: 'User', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/participation.rb

@@ -1,109 +1,50 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
-# Example participation response:
+# https://api.w3.org/participations/38785
 # {
-#     "created": "2023-01-01T12:00:00Z",
+#     "individual": false,
+#     "invited-expert": false,
+#     "created": "2022-11-17 22:54:08",
 #     "_links": {
 #         "self": {
-#             "href": "https://api.w3.org/participations/123"
+#             "href": "https://api.w3.org/participations/38785"
 #         },
 #         "group": {
-#             "href": "https://api.w3.org/groups/456",
-#             "title": "Example Group"
-#         },
-#         "user": {
-#             "href": "https://api.w3.org/users/789",
-#             "title": "John Doe"
+#             "href": "https://api.w3.org/groups/cg/silver",
+#             "title": "Silver Community Group"
 #         },
 #         "organization": {
-#             "href": "https://api.w3.org/affiliations/101",
-#             "title": "Example Organization"
+#             "href": "https://api.w3.org/affiliations/1092",
+#             "title": "MITRE Corporation"
 #         },
 #         "participants": {
-#             "href": "https://api.w3.org/participations/123/participants"
+#             "href": "https://api.w3.org/participations/38785/participants"
 #         }
 #     }
 # }
-
 module W3cApi
-    module Models
-      class ParticipationLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :group, Link
-        attribute :user, Link
-        attribute :organization, Link
-        attribute :participants, Link
-      end
-
-      class Participation < Base
-        attribute :title, :string
-        attribute :href, :string
-        attribute :created, :date_time # Date-time format
-        attribute :_links, ParticipationLinks
-
-        # Parse date strings to Date objects
-        def created_date
-          Date.parse(created) if created
-        rescue Date::Error
-          nil
-        end
-
-        # Get the group this participation is for
-        def group(client = nil)
-          return nil unless client && _links&.group
-
-          href = _links.group.href
-          id = href.split('/').last
-          client.group(id)
-        end
-
-        # Get the user participating
-        def user(client = nil)
-          return nil unless client && _links&.user
-
-          href = _links.user.href
-          id = href.split('/').last
-          client.user(id)
-        end
-
-        # Get the organization participating
-        def organization(client = nil)
-          return nil unless client && _links&.organization
-
-          href = _links.organization.href
-          id = href.split('/').last
-          client.affiliation(id)
-        end
-
-        # Get participants in this participation
-        def participants(client = nil)
-          return nil unless client && _links&.participants
-
-          href = _links.participants.href
-          id = href.split('/').last
-          client.participation_participants(id)
-        end
-
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
-
-          participation = new
-          transformed_response.each do |key, value|
-            case key
-            when :_links
-              links = value.each_with_object({}) do |(link_name, link_data), acc|
-                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
-              end
-              participation._links = ParticipationLinks.new(links)
-            else
-              participation.send("#{key}=", value) if participation.respond_to?("#{key}=")
-            end
-          end
-          participation
+  module Models
+    class Participation < Lutaml::Hal::Resource
+      attribute :title, :string
+      attribute :href, :string
+      attribute :created, :date_time
+      attribute :individual, :boolean
+      attribute :invited_expert, :boolean
+
+      hal_link :self, key: 'self', realize_class: 'Participation'
+      hal_link :group, key: 'group', realize_class: 'Group'
+      hal_link :organization, key: 'organization', realize_class: 'Affiliation'
+      hal_link :participants, key: 'participants', realize_class: 'ParticipantIndex'
+
+      key_value do
+        %i[
+          individual
+          invited_expert
+          created
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/participation_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'participation'
+
+module W3cApi
+  module Models
+    class ParticipationIndex < Lutaml::Hal::Page
+      hal_link :participations, key: 'participations', realize_class: 'Participation', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/photo.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+#         "photos": [
+#             {
+#                 "href": "https://www.w3.org/thumbnails/360/avatar-images/f1ovb5rydm8s0go04oco0cgk0sow44w.webp?x-version=3",
+#                 "name": "large"
+#             },
+
+module W3cApi
+  module Models
+    # User model representing a W3C user/participant
+    class Photo < Lutaml::Model::Serializable
+      attribute :href, :string
+      attribute :name, :string
+
+      key_value do
+        %i[
+          href
+          name
+        ].each do |key|
+          map key.to_s, to: key
+        end
+      end
+    end
+  end
+end

data/lib/w3c_api/models/serie.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
+# https://api.w3.org/specification-series/css-backgrounds
 # {
 #     "shortname": "css-backgrounds",
-#     "name": "CSS Backgrounds and Borders Module",
+#     "name": "CSS Backgrounds and Borders",
 #     "_links": {
 #         "self": {
 #             "href": "https://api.w3.org/specification-series/css-backgrounds"
@@ -18,7 +16,7 @@ require_relative 'link'
 #         }
 #     }
 # }
-#
+
 # {
 #   "shortname": "2dcontext",
 #   "name": "HTML Canvas 2D Context",
@@ -36,53 +34,25 @@ require_relative 'link'
 # }
 
 module W3cApi
-    module Models
-      class SerieLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :specifications, Link
-        attribute :current_specification, Link
-      end
-
-      class Serie < Base
-        attribute :shortname, :string
-        attribute :name, :string
-        attribute :href, :string
-        attribute :title, :string
-        attribute :_links, SerieLinks
-
-        # Get specifications in this series
-        def specifications(client = nil)
-          return nil unless client && _links&.specifications
-
-          client.series_specifications(shortname)
-        end
-
-        # Get current specification in this series
-        def current_specification(client = nil)
-          return nil unless client && _links&.current_specification
-
-          href = _links.current_specification.href
-          shortname = href.split('/').last
-          client.specification(shortname)
-        end
-
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
-
-          series = new
-          transformed_response.each do |key, value|
-            case key
-            when :_links
-              links = value.each_with_object({}) do |(link_name, link_data), acc|
-                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
-              end
-              series._links = SerieLinks.new(links)
-            else
-              series.send("#{key}=", value) if series.respond_to?("#{key}=")
-            end
-          end
-          series
+  module Models
+    class Serie < Lutaml::Hal::Resource
+      attribute :shortname, :string
+      attribute :name, :string
+      attribute :href, :string
+      attribute :title, :string
+
+      hal_link :self, key: 'self', realize_class: 'Serie'
+      hal_link :specifications, key: 'specifications', realize_class: 'SpecificationIndex'
+      hal_link :current_specification, key: 'current-specification', realize_class: 'SpecVersion'
+
+      key_value do
+        %i[
+          shortname
+          name
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/{series.rb → serie_index.rb}

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
 require_relative 'serie'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
 
+# https://api.w3.org/specification-series
 # {
 #   "page": 1,
-#   "limit": 1000,
-#   "pages": 2,
+#   "limit": 100,
+#   "pages": 15,
 #   "total": 1426,
 #   "_links": {
 #     "specification-series": [
@@ -28,14 +26,25 @@ require_relative 'collection_base'
 #         "href": "https://api.w3.org/specification-series/accessibility-metrics-report",
 #         "title": "accessibility-metrics-report"
 #       },
-
+#     ],
+#     "self": {
+#         "href": "https://api.w3.org/specification-series?page=1&items=100"
+#     },
+#     "first": {
+#         "href": "https://api.w3.org/specification-series?page=1&items=100"
+#     },
+#     "last": {
+#         "href": "https://api.w3.org/specification-series?page=15&items=100"
+#     },
+#     "next": {
+#         "href": "https://api.w3.org/specification-series?page=2&items=100"
+#     }
+#   }
+# }
 module W3cApi
-    module Models
-      class Series < CollectionBase
-        attribute :series, Serie, collection: true
-
-        delegate_enumerable :series
-        collection_instance_class Serie, :series
-      end
+  module Models
+    class SerieIndex < Lutaml::Hal::Page
+      hal_link :series, key: 'specification-series', realize_class: 'Serie', collection: true
     end
+  end
 end

data/lib/w3c_api/models/spec_version.rb

@@ -1,96 +1,82 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
-# Example spec version response format:
+# https://api.w3.org/specifications/html5/versions/20180327
 # {
-#   "date": "2023-09-21"
-#   "status": "REC"
-#   "rec_track": true
-#   "editor-draft": "https://w3c.github.io/example-draft/"
-#   "uri": "https://www.w3.org/TR/2023/REC-example-20230921/"
-#   "title": "Example Specification"
-#   "shortlink": "https://www.w3.org/TR/example/"
-#   "process-rules": "2021"
-#   "_links": {
-#     "self": {
-#       "href": "https://api.w3.org/specifications/example/versions/20230921"
-#     },
-#     "specification": {
-#       "href": "https://api.w3.org/specifications/example"
+#     "status": "Retired",
+#     "rec-track": true,
+#     "uri": "https://www.w3.org/TR/2018/SPSD-html5-20180327/",
+#     "date": "2018-03-27",
+#     "informative": false,
+#     "title": "HTML5",
+#     "shortlink": "https://www.w3.org/TR/html5/",
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20180327"
+#         },
+#         "editors": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20180327/editors"
+#         },
+#         "deliverers": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20180327/deliverers"
+#         },
+#         "specification": {
+#             "href": "https://api.w3.org/specifications/html5"
+#         },
+#         "predecessor-version": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20180327/predecessors"
+#         }
 #     }
-#   }
 # }
 
 module W3cApi
-    module Models
-      class SpecVersionLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :specification, Link
-      end
-
-      class SpecVersion < Base
-        attribute :status, :string
-        attribute :rec_track, :boolean
-        attribute :editor_draft, :string
-        attribute :uri, :string, pattern: %r{https://www\.w3\.org/.*}
-        attribute :date, :date_time # Date-time format
-        attribute :last_call_feedback_due, :date_time # Date-time format
-        attribute :pr_reviews_date, :date_time # Date-time format
-        attribute :implementation_feedback_due, :date_time # Date-time format
-        attribute :per_reviews_due, :date_time # Date-time format
-        attribute :informative, :boolean
-        attribute :title, :string
-        attribute :href, :string
-        attribute :shortlink, :string, pattern: %r{https://www\.w3\.org/.*}
-        attribute :translation, :string
-        attribute :errata, :string
-        attribute :process_rules, :string
-        attribute :_links, SpecVersionLinks
-
-        # Return the specification this version belongs to
-        def specification(client = nil)
-          return nil unless client && _links&.specification
-
-          spec_href = _links.specification.href
-          spec_shortname = spec_href.split('/').last
-
-          client.specification(spec_shortname)
-        end
-
-        # Check if this spec version is a Recommendation
-        def recommendation?
-          status == 'REC'
-        end
-
-        # Check if this spec version is a Working Draft
-        def working_draft?
-          status == 'WD'
-        end
-
-        # Check if this spec version is a Candidate Recommendation
-        def candidate_recommendation?
-          status == 'CR'
-        end
+  module Models
+    class SpecVersion < Lutaml::Hal::Resource
+      attribute :status, :string
+      attribute :rec_track, :boolean
+      attribute :editor_draft, :string
+      attribute :uri, :string
+      attribute :date, :date_time
+      attribute :last_call_feedback_due, :date_time
+      attribute :pr_reviews_date, :date_time
+      attribute :implementation_feedback_due, :date_time
+      attribute :per_reviews_due, :date_time
+      attribute :informative, :boolean
+      attribute :title, :string
+      attribute :href, :string
+      attribute :shortlink, :string
+      attribute :translation, :string
+      attribute :errata, :string
+      attribute :process_rules, :string
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'SpecVersion'
+      hal_link :editors, key: 'editors', realize_class: 'UserIndex'
+      hal_link :deliverers, key: 'deliverers', realize_class: 'UserIndex'
+      hal_link :specification, key: 'specification', realize_class: 'Specification'
+      hal_link :predecessor_version, key: 'predecessor-version', realize_class: 'SpecVersionIndex'
+      hal_link :successor_version, key: 'successor-version', realize_class: 'SpecVersionIndex'
 
-          spec_version = new
-          transformed_response.each do |key, value|
-            case key
-            when :_links
-              links = value.each_with_object({}) do |(link_name, link_data), acc|
-                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
-              end
-              spec_version._links = SpecVersionLinks.new(links)
-            else
-              spec_version.send("#{key}=", value) if spec_version.respond_to?("#{key}=")
-            end
-          end
-          spec_version
+      key_value do
+        %i[
+          status
+          rec_track
+          editor_draft
+          uri
+          date
+          last_call_feedback_due
+          pr_reviews_date
+          implementation_feedback_due
+          per_reviews_due
+          informative
+          title
+          href
+          shortlink
+          translation
+          errata
+          process_rules
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/spec_version_index.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'spec_version'
+
+module W3cApi
+  module Models
+    class SpecVersionIndex < Lutaml::Hal::Page
+      hal_link :versions, key: 'versions', realize_class: 'SpecVersion', collection: true
+      hal_link :spec_versions, key: 'version-history', realize_class: 'SpecVersion', collection: true
+      hal_link :predecessor_version, key: 'predecessor-version', realize_class: 'SpecVersion', collection: true
+      hal_link :successor_version, key: 'successor-version', realize_class: 'SpecVersion', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/spec_version_ref.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
 module W3cApi
-    module Models
-      class SpecVersionRef < Lutaml::Model::Serializable
-        attribute :status, :string
-        attribute :rec_track, :boolean
-        attribute :editor_draft, :string
-        attribute :uri, :string
-        attribute :date, :string
-        attribute :title, :string
-        attribute :shortlink, :string
-        attribute :process_rules, :string
-      end
+  module Models
+    class SpecVersionRef < Lutaml::Model::Serializable
+      attribute :status, :string
+      attribute :rec_track, :boolean
+      attribute :editor_draft, :string
+      attribute :uri, :string
+      attribute :date, :string
+      attribute :title, :string
+      attribute :shortlink, :string
+      attribute :process_rules, :string
     end
+  end
 end