w3c_api 0.1.0

data/lib/w3c_api/models/delegate_enumerable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module W3cApi
+  module Models
+    # Module for delegating Enumerable methods to a collection attribute
+    module DelegateEnumerable
+      # Define enumerable methods delegated to the specified collection attribute
+      # @param collection_attr [Symbol] The name of the collection attribute
+      def delegate_enumerable(collection_attr)
+        include Enumerable
+
+        define_method(:each) do |&block|
+          send(collection_attr).each(&block)
+        end
+
+        define_method(:map) do |&block|
+          send(collection_attr).map(&block)
+        end
+
+        define_method(:select) do |&block|
+          send(collection_attr).select(&block)
+        end
+
+        define_method(:[]) do |index|
+          send(collection_attr)[index]
+        end
+
+        define_method(:first) do
+          send(collection_attr).first
+        end
+
+        define_method(:last) do
+          send(collection_attr).last
+        end
+
+        define_method(:empty?) do
+          send(collection_attr).empty?
+        end
+
+        define_method(:size) do
+          send(collection_attr).size
+        end
+
+        define_method(:length) do
+          send(collection_attr).length
+        end
+
+        define_method(:to_a) do
+          send(collection_attr)
+        end
+      end
+    end
+  end
+end

data/lib/w3c_api/models/ecosystem.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'link'
+
+# {
+#     "name": "Data and knowledge"
+#     "shortname": "data"
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/ecosystems/data"
+#         }
+#         "champion": {
+#             "href": "https://api.w3.org/users/t891ludoisggsccsw44o8goccc0s0ks"
+#             "title": "Pierre-Antoine Champin"
+#         }
+#         "evangelists": {
+#             "href": "https://api.w3.org/ecosystems/data/evangelists"
+#         }
+#         "groups": {
+#             "href": "https://api.w3.org/ecosystems/data/groups"
+#         }
+#         "member-organizations": {
+#             "href": "https://api.w3.org/ecosystems/data/member-organizations"
+#         }
+#     }
+# }
+
+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
+        end
+      end
+    end
+end

data/lib/w3c_api/models/ecosystems.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'ecosystem'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+# {
+#   "page": 1,
+#   "limit": 100,
+#   "pages": 1,
+#   "total": 9,
+#   "_links": {
+#     "ecosystems": [
+#       {
+#         "href": "https://api.w3.org/ecosystems/advertising",
+#         "title": "Web Advertising"
+#       },
+#       {
+#         "href": "https://api.w3.org/ecosystems/e-commerce",
+#         "title": "E-commerce"
+#       },
+
+module W3cApi
+    module Models
+      class Ecosystems < CollectionBase
+        attribute :ecosystems, Ecosystem, collection: true
+
+        delegate_enumerable :ecosystems
+        collection_instance_class Ecosystem, :ecosystems
+      end
+    end
+end

data/lib/w3c_api/models/extension.rb

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

data/lib/w3c_api/models/group.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'join_emails'
+require_relative 'link'
+
+# {
+#     "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"
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/groups/wg/ag"
+#         }
+#         "homepage": {
+#             "href": "https://www.w3.org/WAI/GL/"
+#         }
+#         "users": {
+#             "href": "https://api.w3.org/groups/wg/ag/users"
+#         }
+#         "services": {
+#             "href": "https://api.w3.org/groups/wg/ag/services"
+#         }
+#         "specifications": {
+#             "href": "https://api.w3.org/groups/wg/ag/specifications"
+#         }
+#         "chairs": {
+#             "href": "https://api.w3.org/groups/wg/ag/chairs"
+#         }
+#         "team-contacts": {
+#             "href": "https://api.w3.org/groups/wg/ag/teamcontacts"
+#         }
+#         "charters": {
+#             "href": "https://api.w3.org/groups/wg/ag/charters"
+#         }
+#         "active-charter": {
+#             "href": "https://api.w3.org/groups/wg/ag/charters/492"
+#         }
+#         "join": {
+#             "href": "https://www.w3.org/groups/wg/ag/join"
+#         }
+#         "pp-status": {
+#             "href": "https://www.w3.org/groups/wg/ag/ipr"
+#         }
+#         "participations": {
+#             "href": "https://api.w3.org/groups/wg/ag/participations"
+#         }
+#     }
+#     "type": "working group"
+#     "start-date": "1997-10-06"
+#     "end-date": "2025-10-31"
+# }
+
+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
+      attribute :type, :string
+      attribute :href, :string
+      attribute :title, :string
+      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
+        end
+        group
+      end
+    end
+  end
+end

data/lib/w3c_api/models/groups.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'group'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+# Response body:
+# {
+#   "page": 1,
+#   "limit": 100,
+#   "pages": 3,
+#   "total": 257,
+#   "_links": {
+#     "groups": [
+#       {
+#         "href": "https://api.w3.org/groups/tf/ab-liaisons-to-bod",
+#         "title": "AB Liaisons to the Board of Directors"
+#       },
+#       {
+#         "href": "https://api.w3.org/groups/cg/a11yedge",
+#         "title": "Accessibility at the Edge Community Group"
+#       },
+#       {
+#         "href": "https://api.w3.org/groups/tf/wcag-act",
+#         "title": "Accessibility Conformance Testing (ACT) Task Force"
+#       },
+
+module W3cApi
+  module Models
+    class Groups < CollectionBase
+      attribute :groups, Group, collection: true
+
+      delegate_enumerable :groups
+      collection_instance_class Group, :groups
+    end
+  end
+end

data/lib/w3c_api/models/join_emails.rb

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

data/lib/w3c_api/models/link.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+# {
+#   "href"=>"https://api.w3.org/specifications/png-2/versions/20031110",
+#   "title"=>"Recommendation"
+# }
+
+module W3cApi
+    module Models
+      class Link < Lutaml::Model::Serializable
+        attribute :href, :string
+        attribute :title, :string
+      end
+    end
+end

data/lib/w3c_api/models/participation.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'link'
+
+# Example participation response:
+# {
+#     "created": "2023-01-01T12:00:00Z",
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/participations/123"
+#         },
+#         "group": {
+#             "href": "https://api.w3.org/groups/456",
+#             "title": "Example Group"
+#         },
+#         "user": {
+#             "href": "https://api.w3.org/users/789",
+#             "title": "John Doe"
+#         },
+#         "organization": {
+#             "href": "https://api.w3.org/affiliations/101",
+#             "title": "Example Organization"
+#         },
+#         "participants": {
+#             "href": "https://api.w3.org/participations/123/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
+        end
+      end
+    end
+end

data/lib/w3c_api/models/participations.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'participation'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+module W3cApi
+    module Models
+      class Participations < CollectionBase
+        attribute :participations, Participation, collection: true
+
+        delegate_enumerable :participations
+        collection_instance_class Participation, :participations
+      end
+    end
+end

data/lib/w3c_api/models/serie.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'link'
+
+# {
+#     "shortname": "css-backgrounds",
+#     "name": "CSS Backgrounds and Borders Module",
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/specification-series/css-backgrounds"
+#         },
+#         "specifications": {
+#             "href": "https://api.w3.org/specification-series/css-backgrounds/specifications"
+#         },
+#         "current-specification": {
+#             "href": "https://api.w3.org/specifications/css-backgrounds-3"
+#         }
+#     }
+# }
+#
+# {
+#   "shortname": "2dcontext",
+#   "name": "HTML Canvas 2D Context",
+#   "_links": {
+#     "self": {
+#       "href": "https://api.w3.org/specification-series/2dcontext"
+#     },
+#     "specifications": {
+#       "href": "https://api.w3.org/specification-series/2dcontext/specifications"
+#     },
+#     "current-specification": {
+#       "href": "https://api.w3.org/specifications/2dcontext"
+#     }
+#   }
+# }
+
+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
+        end
+      end
+    end
+end

data/lib/w3c_api/models/series.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'serie'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+# {
+#   "page": 1,
+#   "limit": 1000,
+#   "pages": 2,
+#   "total": 1426,
+#   "_links": {
+#     "specification-series": [
+#       {
+#         "href": "https://api.w3.org/specification-series/2dcontext",
+#         "title": "2dcontext"
+#       },
+#       {
+#         "href": "https://api.w3.org/specification-series/abstract-ui",
+#         "title": "abstract-ui"
+#       },
+#       {
+#         "href": "https://api.w3.org/specification-series/cors",
+#         "title": "cors"
+#       },
+#       {
+#         "href": "https://api.w3.org/specification-series/accessibility-metrics-report",
+#         "title": "accessibility-metrics-report"
+#       },
+
+module W3cApi
+    module Models
+      class Series < CollectionBase
+        attribute :series, Serie, collection: true
+
+        delegate_enumerable :series
+        collection_instance_class Serie, :series
+      end
+    end
+end

data/lib/w3c_api/models/series_collection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'series'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+module W3cApi
+    module Models
+      class SeriesCollection < CollectionBase
+        attribute :series, Series, collection: true
+
+        delegate_enumerable :series
+        collection_instance_class Series, :series
+      end
+    end
+end