w3c_api 0.1.0 → 0.1.2

data/lib/w3c_api/models/charter.rb

@@ -1,110 +1,69 @@
 # frozen_string_literal: true
 
-require_relative 'base'
 require_relative 'extension'
-require_relative 'link'
 
-# Example charter response format - specific fields may vary by group:
+# https://api.w3.org/groups/109735/charters/361
 # {
-#     "end": "2025-10-31"
-#     "title": "Accessibility Guidelines Working Group Charter"
-#     "start": "1997-10-06"
-#     "initial_end": "1999-10-06"
-#     "uri": "https://www.w3.org/2022/05/accessibility-guidelines-wg-charter.html"
-#     "cfp_uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/..."
-#     "extensions": [...]
-#     "required_new_commitments": false
-#     "patent_policy": "pre-2020"
+#     "end": "2020-04-30",
+#     "doc-licenses": [],
+#     "start": "2018-09-24",
+#     "initial-end": "2020-03-01",
+#     "uri": "https://www.w3.org/2018/09/immersive-web-wg-charter.html",
+#     "cfp-uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/2018JulSep/0053.html",
+#     "extensions": [
+#         {
+#             "end": "2020-04-30",
+#             "announcement_uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/2020JanMar/0028.html"
+#         }
+#     ],
+#     "required-new-commitments": true,
+#     "patent-policy": "https://www.w3.org/Consortium/Patent-Policy-20170801/",
 #     "_links": {
 #         "self": {
-#             "href": "https://api.w3.org/groups/wg/ag/charters/492"
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters/361"
 #         },
 #         "group": {
-#             "href": "https://api.w3.org/groups/wg/ag"
+#             "href": "https://api.w3.org/groups/wg/immersive-web",
+#             "title": "Immersive Web Working Group"
+#         },
+#         "next-charter": {
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters/405"
 #         }
 #     }
 # }
 
 module W3cApi
-    module Models
-      class CharterLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :group, Link
-      end
-
-      class Charter < Base
-        attribute :end, :string # Date-time format
-        attribute :href, :string
-        attribute :title, :string
-        attribute :start, :string # Date-time format
-        attribute :initial_end, :string # Date-time format
-        attribute :uri, :string, pattern: %r{https?://www\.w3\.org.*}
-        attribute :cfp_uri, :string, pattern: %r{https://lists\.w3\.org/Archives/Member/w3c-ac-members/.*}
-        attribute :extensions, Extension, collection: true
-        attribute :required_new_commitments, :boolean
-        attribute :patent_policy, :string
-        attribute :_links, CharterLinks
-
-        # Return the group this charter belongs to
-        def group(client = nil)
-          return nil unless client && _links&.group
-
-          group_href = _links.group.href
-          group_id = group_href.split('/').last
-
-          client.group(group_id)
-        end
-
-        # Parse date strings to Date objects
-        def end_date
-          Date.parse(self.end) if self.end
-        rescue Date::Error
-          nil
-        end
-
-        def start_date
-          Date.parse(start) if start
-        rescue Date::Error
-          nil
-        end
-
-        def initial_end_date
-          Date.parse(initial_end) if initial_end
-        rescue Date::Error
-          nil
-        end
-
-        # Check if this charter is active
-        def active?
-          start_date &&
-            (end_date.nil? || end_date >= Date.today) &&
-            start_date <= Date.today
-        rescue Date::Error
-          false
-        end
-
-        # Check if this charter has been extended
-        def extended?
-          !extensions.nil? && !extensions.empty?
-        end
+  module Models
+    class Charter < Lutaml::Hal::Resource
+      attribute :end, :date_time
+      attribute :doc_licenses, :string, collection: true
+      attribute :start, :date_time
+      attribute :initial_end, :date_time
+      attribute :uri, :string
+      attribute :cfp_uri, :string
+      attribute :extensions, Extension, collection: true
+      attribute :required_new_commitments, :boolean
+      attribute :patent_policy, :string
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'Charter'
+      hal_link :group, key: 'group', realize_class: 'Group'
+      hal_link :next_charter, key: 'next-charter', realize_class: 'Charter'
 
-          charter = 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
-              charter._links = CharterLinks.new(links)
-            else
-              charter.send("#{key}=", value) if charter.respond_to?("#{key}=")
-            end
+      key_value do
+        %i[
           end
-          charter
+          doc_licenses
+          start
+          initial_end
+          uri
+          cfp_uri
+          extensions
+          required_new_commitments
+          patent_policy
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/charter_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'charter'
+
+module W3cApi
+  module Models
+    class CharterIndex < Lutaml::Hal::Page
+      hal_link :charters, key: 'charters', realize_class: 'Charter', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/connected_account.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
 # {
 #   "created"=>"2019-07-18T21:28:31+00:00",
 #   "updated"=>"2021-01-21T10:49:57+00:00",
@@ -18,37 +16,30 @@ require 'lutaml/model'
 # }
 
 module W3cApi
-    module Models
-      class ConnectedAccountLinks < Lutaml::Model::Serializable
-        attribute :user, Link
-      end
+  module Models
+    class ConnectedAccount < Lutaml::Hal::Resource
+      attribute :created, :date_time
+      attribute :updated, :date_time
+      attribute :service, :string
+      attribute :identifier, :string
+      attribute :nickname, :string
+      attribute :profile_picture, :string
+      attribute :href, :string
 
-      class ConnectedAccount < Base
-        attribute :created, :date_time
-        attribute :updated, :date_time
-        attribute :service, :string
-        attribute :identifier, :string
-        attribute :nickname, :string
-        attribute :profile_picture, :string
-        attribute :href, :string
-        attribute :_links, ConnectedAccountLinks
+      hal_link :user, key: 'user', realize_class: 'User'
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
-          account = 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
-              account._links = ConnectedAccountLinks.new(links)
-            else
-              account.send("#{key}=", value) if account.respond_to?("#{key}=")
-            end
-          end
-          account
+      key_value do
+        %i[
+          created
+          updated
+          service
+          identifier
+          nickname
+          profile_picture
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/ecosystem.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
 # {
 #     "name": "Data and knowledge"
 #     "shortname": "data"
@@ -27,46 +24,27 @@ require_relative 'link'
 # }
 
 module W3cApi
-    module Models
-      class EcosystemLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :champion, Link
-        attribute :evangelists, Link
-        attribute :groups, Link
-        attribute :member_organizations, Link
-      end
-
-      class Ecosystem < Base
-        attribute :name, :string
-        attribute :shortname, :string
-        attribute :href, :string
-        attribute :title, :string
-        attribute :_links, EcosystemLinks
-
-        # Return groups in this ecosystem
-        def groups(client = nil)
-          return nil unless client && _links&.groups
-
-          client.ecosystem_groups(shortname)
-        end
-
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
-
-          ecosystem = 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
-              ecosystem._links = EcosystemLinks.new(links)
-            else
-              ecosystem.send("#{key}=", value) if ecosystem.respond_to?("#{key}=")
-            end
-          end
-          ecosystem
+  module Models
+    class Ecosystem < Lutaml::Hal::Resource
+      attribute :name, :string
+      attribute :shortname, :string
+      attribute :href, :string
+      attribute :title, :string
+
+      hal_link :self, key: 'self', realize_class: 'Ecosystem'
+      hal_link :champion, key: 'champion', realize_class: 'User'
+      hal_link :evangelists, key: 'evangelists', realize_class: 'EvangelistIndex'
+      hal_link :groups, key: 'groups', realize_class: 'GroupIndex'
+      hal_link :member_organizations, key: 'member-organizations', realize_class: 'AffiliationIndex'
+
+      key_value do
+        %i[
+          name
+          shortname
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/{ecosystems.rb → ecosystem_index.rb}

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
 require_relative 'ecosystem'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
 
 # {
 #   "page": 1,
@@ -22,12 +19,9 @@ require_relative 'collection_base'
 #       },
 
 module W3cApi
-    module Models
-      class Ecosystems < CollectionBase
-        attribute :ecosystems, Ecosystem, collection: true
-
-        delegate_enumerable :ecosystems
-        collection_instance_class Ecosystem, :ecosystems
-      end
+  module Models
+    class EcosystemIndex < Lutaml::Hal::Page
+      hal_link :ecosystems, key: 'ecosystems', realize_class: 'Ecosystem', collection: true
     end
+  end
 end

data/lib/w3c_api/models/evangelist_index.rb

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

data/lib/w3c_api/models/extension.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
 module W3cApi
-    module Models
-      class Extension < Lutaml::Model::Serializable
-        attribute :end, :string
-        attribute :announcement, :string
-      end
+  module Models
+    class Extension < Lutaml::Model::Serializable
+      attribute :end, :date_time
+      attribute :announcement_uri, :string
     end
+  end
 end

data/lib/w3c_api/models/group.rb

@@ -1,172 +1,93 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'join_emails'
-require_relative 'link'
-
+# https://api.w3.org/groups/109735
 # {
-#     "id": 35422
-#     "name": "Accessibility Guidelines Working Group"
-#     "is_closed": false
-#     "description": "The mission of the Accessibility Guidelines Working Group (AG WG) is to develop specifications to make content on the Web accessible for people with disabilities and to participate in the development and maintenance of implementation support materials for the Web Content Accessibility Guidelines."
-#     "shortname": "ag"
-#     "discr": "w3cgroup"
+#     "id": 109735,
+#     "name": "Immersive Web Working Group",
+#     "is_closed": false,
+#     "description": "The mission of the Immersive Web Working Group is to help bring high-performance Virtual Reality (VR) and Augmented Reality (AR) (collectively known as XR) to the open Web via APIs to interact with XR devices and sensors in browsers.",
+#     "shortname": "immersive-web",
+#     "discr": "w3cgroup",
 #     "_links": {
 #         "self": {
-#             "href": "https://api.w3.org/groups/wg/ag"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web"
+#         },
 #         "homepage": {
-#             "href": "https://www.w3.org/WAI/GL/"
-#         }
+#             "href": "https://www.w3.org/immersive-web/"
+#         },
 #         "users": {
-#             "href": "https://api.w3.org/groups/wg/ag/users"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/users"
+#         },
 #         "services": {
-#             "href": "https://api.w3.org/groups/wg/ag/services"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/services"
+#         },
 #         "specifications": {
-#             "href": "https://api.w3.org/groups/wg/ag/specifications"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/specifications"
+#         },
 #         "chairs": {
-#             "href": "https://api.w3.org/groups/wg/ag/chairs"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/chairs"
+#         },
 #         "team-contacts": {
-#             "href": "https://api.w3.org/groups/wg/ag/teamcontacts"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/teamcontacts"
+#         },
 #         "charters": {
-#             "href": "https://api.w3.org/groups/wg/ag/charters"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters"
+#         },
 #         "active-charter": {
-#             "href": "https://api.w3.org/groups/wg/ag/charters/492"
-#         }
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters/514"
+#         },
 #         "join": {
-#             "href": "https://www.w3.org/groups/wg/ag/join"
-#         }
+#             "href": "https://www.w3.org/groups/wg/immersive-web/join"
+#         },
 #         "pp-status": {
-#             "href": "https://www.w3.org/groups/wg/ag/ipr"
-#         }
+#             "href": "https://www.w3.org/groups/wg/immersive-web/ipr"
+#         },
 #         "participations": {
-#             "href": "https://api.w3.org/groups/wg/ag/participations"
+#             "href": "https://api.w3.org/groups/wg/immersive-web/participations"
 #         }
-#     }
-#     "type": "working group"
-#     "start-date": "1997-10-06"
-#     "end-date": "2025-10-31"
+#     },
+#     "type": "working group",
+#     "start-date": "2018-09-24",
+#     "end-date": "2026-09-25"
 # }
 
 module W3cApi
   module Models
-    class GroupLinks < Lutaml::Model::Serializable
-      attribute :self, Link
-      attribute :homepage, Link
-      attribute :users, Link
-      attribute :services, Link
-      attribute :specifications, Link
-      attribute :chairs, Link
-      attribute :team_contacts, Link
-      attribute :charters, Link
-      attribute :active_charter, Link
-      attribute :join, Link
-      attribute :pp_status, Link
-      attribute :participations, Link
-    end
-
-    class Group < Base
-      attribute :id, :integer
-      attribute :name, :string
+    # Group model representing a W3C working group
+    class Group < Lutaml::Hal::Resource
+      attribute :id, :string
       attribute :type, :string
-      attribute :href, :string
-      attribute :title, :string
+      attribute :name, :string
+      attribute :is_closed, :boolean
       attribute :description, :string
       attribute :shortname, :string
-      attribute :shortlink, :string
       attribute :discr, :string
-      attribute :created, :string # Date-time format
-      attribute :start_date, :string # Date-time format
-      attribute :end_date, :string # Date-time format
-      attribute :is_closed, :boolean
-      attribute :patent_policy, :string
-      attribute :charter_closed, :boolean
-      attribute :join_emails, JoinEmails
-      attribute :_links, GroupLinks
-
-      # Return users in this group
-      def users(client = nil)
-        return nil unless client && _links&.users
-
-        client.group_users(id)
-      end
-
-      # Return specifications in this group
-      def specifications(client = nil)
-        return nil unless client && _links&.specifications
-
-        client.group_specifications(id)
-      end
-
-      # Return charters for this group
-      def charters(client = nil)
-        return nil unless client && _links&.charters
-
-        client.group_charters(id)
-      end
-
-      # Return chairs for this group
-      def chairs(client = nil)
-        return nil unless client && _links&.chairs
-
-        client.group_chairs(id)
-      end
-
-      # Return team contacts for this group
-      def team_contacts(client = nil)
-        return nil unless client && _links&.team_contacts
-
-        client.group_team_contacts(id)
-      end
-
-      # Parse date strings to Date objects
-      def created_date
-        Date.parse(created) if created
-      rescue Date::Error
-        nil
-      end
-
-      def start_date_parsed
-        Date.parse(start_date) if start_date
-      rescue Date::Error
-        nil
-      end
-
-      def end_date_parsed
-        Date.parse(end_date) if end_date
-      rescue Date::Error
-        nil
-      end
-
-      # Check if this group is active
-      def active?
-        !is_closed && (!end_date || Date.parse(end_date) > Date.today)
-      rescue Date::Error
-        !is_closed
-      end
-
-      def self.from_response(response)
-        transformed_response = transform_keys(response)
 
-        group = 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
-            group._links = GroupLinks.new(links)
-          else
-            group.send("#{key}=", value) if group.respond_to?("#{key}=")
-          end
+      hal_link :self, key: 'self', realize_class: 'Group'
+      hal_link :homepage, key: 'homepage', realize_class: 'String'
+      hal_link :users, key: 'users', realize_class: 'UserIndex'
+      # hal_link :services, key: 'services', realize_class: 'ServiceIndex'
+      hal_link :specifications, key: 'specifications', realize_class: 'SpecificationIndex'
+      hal_link :chairs, key: 'chairs', realize_class: 'UserIndex'
+      hal_link :team_contacts, key: 'team-contacts', realize_class: 'UserIndex'
+      hal_link :charters, key: 'charters', realize_class: 'CharterIndex'
+      hal_link :active_charters, key: 'active-charter', realize_class: 'Charter'
+      hal_link :join, key: 'join', realize_class: 'String'
+      hal_link :pp_status, key: 'pp-status', realize_class: 'String'
+      hal_link :participations, key: 'participations', realize_class: 'ParticipationIndex'
+
+      key_value do
+        %i[
+          id
+          type
+          name
+          is_closed
+          description
+          shortname
+          discr
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
-        group
       end
     end
   end

data/lib/w3c_api/models/group_index.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'group'
+
+module W3cApi
+  module Models
+    # Collection of groups
+    class GroupIndex < Lutaml::Hal::Page
+      hal_link :groups, key: 'groups', realize_class: 'Group', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/group_link_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'specification_index'
+
+module W3cApi
+  module Models
+    # Manual GroupLinkSet class to fix collection issue
+    class GroupLinkSet < Lutaml::Hal::LinkSet
+      # Define the specifications attribute with collection: true
+      # This is needed because the Group model's specifications link
+      # realizes to a SpecificationIndex which contains a collection
+      attribute :specifications, SpecificationIndexLink, collection: true
+
+      key_value do
+        map 'specifications', to: :specifications
+      end
+    end
+
+    # Define the link class for SpecificationIndex
+    class SpecificationIndexLink < Lutaml::Hal::Link
+      attribute :type, :string, default: 'SpecificationIndex'
+    end
+  end
+end

data/lib/w3c_api/models/join_emails.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-
 module W3cApi
-    module Models
-      class JoinEmails < Lutaml::Model::Serializable
-        attribute :public, :string
-        attribute :member, :string
-      end
+  module Models
+    class JoinEmailIndex < Lutaml::Model::Serializable
+      attribute :public, :string
+      attribute :member, :string
     end
+  end
 end