w3c_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5227c6f6b71312ce390dadc6053628d111cc387d1477e43ab7aa2473200e611
-  data.tar.gz: a6b3afb0ee859b549234c9fe0c55c64896c14d0d2ddc31d20d19040d2859772a
+  metadata.gz: 0c0510c0782d6254f3b44a3a7beedd38e75347803c4c1bd24caca60a154210db
+  data.tar.gz: 1be78e42272c5b5b6b67eb02193605a0845f68ac2c85cb2fb3a59217d67973ef
 SHA512:
-  metadata.gz: d9a9ffeb9cf9b32c35015b22f89c8d152e508098b14365b964ae12c21712371f1bd8c9793e634444a5e96539887d709b59a08540e65c80b72c357efa3e95fa22
-  data.tar.gz: cd5575a30e2c307de3fa1b679de2f10fb9c07ff340b9f76e76d3aa030ff68be73623f24b29bcb0dfde2926f0a31f6ba584e580ac1521c19b8f6bb210f6f33475
+  metadata.gz: d043016ab770ef2df85493e3589f72acc960e6e5db4bd34dfdfbbdf09d1bb87a490a0d0bf0d624e1f536a0271d67382ed118e2ee093bd3e95b572e19d9decd71
+  data.tar.gz: ad8b105ca1cbff73c29ea76cfa757288f056c683f13b583c7066620883e641ab1b6340f998117db55b41416083df146a5b50bb5f799cb0cc5148fe6e3e74cbef

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-07-03 16:44:51 UTC using RuboCop version 1.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 32
+
+# Offense count: 35
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 373
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 225
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 184
+
+# Offense count: 30
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 457

data/README.adoc

@@ -11,27 +11,27 @@ A Ruby client implementation for the W3C web API with a CLI interface.
 This gem provides:
 
 * A complete client for the W3C API (oft-used endpoints implemented)
-
 * Data models created with
 https://github.com/lutaml/lutaml-hal[lutaml-hal] and
 https://github.com/lutaml/lutaml-model[lutaml-model]
 for all W3C API resources
-
-* HAL (Hypertext Application Language) implementation for recursive resource traversal
-
+* HAL (Hypertext Application Language) implementation for recursive resource
+traversal
 * A command-line interface using Thor following GitHub CLI patterns
 
 The endpoint supported is at https://api.w3.org.
 
 This gem is developed against the W3C API documented at https://api.w3.org/doc.
 
-
 == Illustrative example usage
 
 This is an example demonstrating the power of this library as inherited
 from `lutaml-hal`, showing multiple levels of automatic link resolution.
 
+[example]
+====
 .Calling the Ruby API with multiple levels of link resolution
+
 [source,ruby]
 ----
 > require 'w3c_api'
@@ -100,7 +100,7 @@ from `lutaml-hal`, showing multiple levels of automatic link resolution.
 #   @pages=1,
 #   @total=1>
 ----
-
+====
 
 == Ruby API
 
@@ -121,6 +121,38 @@ versions = client.specification_versions('webrtc')
 version = client.specification_version('webrtc', '20241008')
 specs_by_status = client.specifications_by_status('Recommendation')
 
+# Get predecessor and successor versions
+predecessors = client.specification_version_predecessors('webrtc', '20241008')
+successors = client.specification_version_successors('webrtc', '20241008')
+
+# All client methods support comprehensive options including:
+
+# Pagination options
+specifications = client.specifications(page: 2, items: 50)
+groups = client.groups(page: 1, items: 10)
+
+# HTTP client options
+user = client.user('hash', timeout: 30, headers: { 'User-Agent' => 'MyApp/1.0' })
+spec = client.specification('html5', read_timeout: 45, open_timeout: 10)
+
+# Query parameters for filtering and sorting
+rec_specs = client.specifications_by_status('REC', sort: 'date', order: 'desc')
+active_groups = client.groups(type: 'working-group', status: 'active')
+
+# Combining multiple options
+options = {
+  page: 1,
+  per_page: 25,
+  headers: { 'Accept-Language' => 'en-US' },
+  timeout: 60,
+  sort: 'name'
+}
+specs = client.specifications(options)
+
+# Backward compatibility - existing code continues to work
+specifications = client.specifications  # No options
+specification = client.specification('webrtc')  # Required params only
+
 # Work with linked resources directly
 spec = client.specification('webrtc')
 spec_versions = spec.links.versions
@@ -170,6 +202,155 @@ ecosystems = client.ecosystems
 ecosystem = client.ecosystem('data')
 ----
 
+=== Pagination
+
+All index endpoints support pagination with the following parameters:
+
+* `page` - The page number to retrieve (default: 1)
+* `items` - The number of items per page (default: 100)
+
+==== Basic pagination
+
+[source,ruby]
+----
+# Get first page with default limit (100 items)
+specifications = client.specifications
+
+# Get specific page with custom limit
+specifications = client.specifications(page: 2, items: 25)
+
+# Get first page with smaller limit
+groups = client.groups(page: 1, items: 10)
+----
+
+==== Navigation links
+
+All paginated responses include navigation links that can be used to traverse
+pages:
+
+[source,ruby]
+----
+# Get first page
+specs_page1 = client.specifications(page: 1, items: 10)
+
+# Access navigation links
+links = specs_page1.links
+
+# Check available navigation options
+puts "Has next page: #{!links.next.nil?}"
+puts "Has previous page: #{!links.prev.nil?}"
+
+# Navigate to next page using the link
+if links.next
+  next_page = links.next.realize
+  puts "Next page number: #{next_page.page}"
+  puts "Items on next page: #{next_page.links.specifications.length}"
+end
+
+# Navigate to first/last pages
+first_page = links.first.realize if links.first
+last_page = links.last.realize if links.last
+----
+
+==== Pagination information
+
+Each paginated response includes metadata about the pagination state:
+
+[source,ruby]
+----
+specs = client.specifications(page: 2, items: 25)
+
+puts "Current page: #{specs.page}"        # 2
+puts "Items per page: #{specs.limit}"     # 25
+puts "Total items: #{specs.total}"        # e.g., 1643
+puts "Total pages: #{specs.pages}"        # e.g., 66
+----
+
+==== Iterating through all pages
+
+[source,ruby]
+----
+# Method 1: Using navigation links
+current_page = client.specifications(page: 1, items: 50)
+all_specifications = []
+
+loop do
+  all_specifications.concat(current_page.links.specifications)
+
+  break unless current_page.links.next
+
+  current_page = current_page.links.next.realize
+end
+
+puts "Total specifications collected: #{all_specifications.length}"
+
+# Method 2: Manual page iteration
+page = 1
+all_specifications = []
+
+loop do
+  current_page = client.specifications(page: page, items: 50)
+  specifications = current_page.links.specifications
+
+  break if specifications.empty?
+
+  all_specifications.concat(specifications)
+  page += 1
+end
+----
+
+==== Pagination for nested resources
+
+Nested resources also support pagination:
+
+[source,ruby]
+----
+# Get a group
+group = client.group(109735)
+
+# Get paginated specifications for this group
+specs = group.specifications(page: 1, items: 10)
+
+# Navigate through pages
+if specs.links.next
+  next_specs = specs.links.next.realize
+end
+
+# Other nested resources with pagination
+users = group.users(page: 1, items: 20)
+chairs = group.chairs(page: 1, items: 5)
+participations = group.participations(page: 1, items: 15)
+
+# Affiliation nested resources
+affiliation = client.affiliation(35662)
+participants = affiliation.participants(page: 1, items: 10)
+participations = affiliation.participations(page: 1, items: 10)
+----
+
+==== Supported endpoints
+
+All the following endpoints support pagination:
+
+* `client.specifications(page:, items:)`
+* `client.groups(page:, items:)`
+* `client.affiliations(page:, items:)`
+* `client.series(page:, items:)`
+* `client.translations(page:, items:)`
+* `client.ecosystems(page:, items:)`
+* `group.specifications(page:, items:)`
+* `group.users(page:, items:)`
+* `group.chairs(page:, items:)`
+* `group.team_contacts(page:, items:)`
+* `group.participations(page:, items:)`
+* `affiliation.participants(page:, items:)`
+* `affiliation.participations(page:, items:)`
+* `participation.participants(page:, items:)`
+* `user.groups(page:, items:)`
+* `user.specifications(page:, items:)`
+* `user.affiliations(page:, items:)`
+* `user.participations(page:, items:)`
+* And many more nested resource endpoints
+
 === Models
 
 ==== General
@@ -247,8 +428,8 @@ W3C API provides a command-line interface (CLI) for various operations.
 
 The main executable is `w3c_api`.
 
-By default, the output is in YAML format. You can specify the output format using the
-`--format` option, which accepts `json` or `yaml`.
+By default, the output is in YAML format. You can specify the output format
+using the `--format` option, which accepts `json` or `yaml`.
 
 [source,shell]
 ----
@@ -535,9 +716,12 @@ specifications:
 This command provides access to W3C users.
 
 [IMPORTANT]
-.User ID Formats
+.User ID formats
 ====
-The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g., `f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands support both formats. The format depends on how the user is referenced in API responses.
+The W3C API uses both numeric IDs (e.g., `128112`) and string IDs (e.g.,
+`f1ovb5rydm8s0go04oco0cgk0sow44w`) for users. All user-related commands
+support both formats. The format depends on how the user is referenced in API
+responses.
 ====
 
 ==== Get
@@ -742,7 +926,7 @@ participations:
 ----
 ====
 
-==== Chair of Groups
+==== Chair of groups
 
 Getting groups a user chairs.
 

data/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/w3c_api/client.rb

@@ -7,185 +7,134 @@ require_relative 'hal'
 
 module W3cApi
   class Client
-    def specifications(options = {})
-      Hal.instance.register.fetch(:specification_index)
+    # Specification methods
+    def specifications(options = nil)
+      fetch_resource(:specification_index, **(options || {}))
     end
 
     def specification(shortname, options = {})
-      Hal.instance.register.fetch(:specification_resource, shortname: shortname)
+      fetch_resource(:specification_resource, shortname: shortname, **options)
     end
 
     def specification_versions(shortname, options = {})
-      Hal.instance.register.fetch(:specification_resource_version_index, shortname: shortname)
+      fetch_resource(:specification_resource_version_index,
+                     shortname: shortname, **options)
     end
 
     def specification_version(shortname, version, options = {})
-      Hal.instance.register.fetch(:specification_resource_version_resource, shortname: shortname, version: version)
+      fetch_resource(:specification_resource_version_resource,
+                     shortname: shortname, version: version, **options)
     end
 
     def specifications_by_status(status, options = {})
-      Hal.instance.register.fetch(:specification_by_status_index, status: status)
+      fetch_resource(:specification_by_status_index, status: status, **options)
     end
 
-    def specification_supersedes(shortname, options = {})
-      Hal.instance.register.fetch(:specification_supersedes_index, shortname: shortname)
-    end
-
-    def specification_superseded_by(shortname, options = {})
-      Hal.instance.register.fetch(:specification_superseded_by_index, shortname: shortname)
-    end
-
-    # New methods for editors and deliverers
-
-    def specification_editors(shortname, options = {})
-      Hal.instance.register.fetch(:specification_editors_index, shortname: shortname)
-    end
-
-    def specification_deliverers(shortname, options = {})
-      Hal.instance.register.fetch(:specification_deliverers_index, shortname: shortname)
+    %w[supersedes superseded_by editors deliverers].each do |method_suffix|
+      define_method("specification_#{method_suffix}") do |shortname, options = {}|
+        fetch_resource(:"specification_#{method_suffix}_index",
+                       shortname: shortname, **options)
+      end
     end
 
     # Series methods
-
     def series(options = {})
-      Hal.instance.register.fetch(:serie_index)
+      fetch_resource(:serie_index, **options)
     end
 
     def series_by_shortname(shortname, options = {})
-      Hal.instance.register.fetch(:serie_resource, shortname: shortname)
+      fetch_resource(:serie_resource, shortname: shortname, **options)
     end
 
     def series_specifications(shortname, options = {})
-      Hal.instance.register.fetch(:serie_specification_resource, shortname: shortname)
+      fetch_resource(:serie_specification_resource,
+                     shortname: shortname, **options)
     end
 
     # Group methods
-
     def groups(options = {})
-      Hal.instance.register.fetch(:group_index)
+      fetch_resource(:group_index, **options)
     end
 
     def group(id, options = {})
-      Hal.instance.register.fetch(:group_resource, id: id)
-    end
-
-    def group_specifications(id, options = {})
-      Hal.instance.register.fetch(:group_specifications_index, id: id)
+      fetch_resource(:group_resource, id: id, **options)
     end
 
-    def group_users(id, options = {})
-      Hal.instance.register.fetch(:group_users_index, id: id)
-    end
-
-    def group_charters(id, options = {})
-      Hal.instance.register.fetch(:group_charters_index, id: id)
-    end
-
-    def group_chairs(id, options = {})
-      Hal.instance.register.fetch(:group_chairs_index, id: id)
-    end
-
-    def group_team_contacts(id, options = {})
-      Hal.instance.register.fetch(:group_team_contacts_index, id: id)
-    end
-
-    def group_participations(id, options = {})
-      Hal.instance.register.fetch(:group_participations_index, id: id)
+    %w[specifications users charters chairs team_contacts participations].each do |resource|
+      define_method("group_#{resource}") do |id, options = {}|
+        fetch_resource(:"group_#{resource}_index", id: id, **options)
+      end
     end
 
     # User methods
-
-    # def users(options = {})
-    #   raise ArgumentError,
-    #         'The W3C API does not support fetching all users. You must provide a specific user ID with the user method.'
-    # end
-
     def user(hash, options = {})
-      Hal.instance.register.fetch(:user_resource, hash: hash)
-    end
-
-    def user_groups(hash, options = {})
-      Hal.instance.register.fetch(:user_groups_index, hash: hash)
-    end
-
-    def user_affiliations(hash, options = {})
-      Hal.instance.register.fetch(:user_affiliations_index, hash: hash)
+      fetch_resource(:user_resource, hash: hash, **options)
     end
 
-    def user_participations(hash, options = {})
-      Hal.instance.register.fetch(:user_participations_index, hash: hash)
-    end
-
-    def user_chair_of_groups(hash, options = {})
-      Hal.instance.register.fetch(:user_chair_of_groups_index, hash: hash)
-    end
-
-    def user_team_contact_of_groups(hash, options = {})
-      Hal.instance.register.fetch(:user_team_contact_of_groups_index, hash: hash)
-    end
-
-    def user_specifications(hash, options = {})
-      Hal.instance.register.fetch(:user_specifications_index, hash: hash)
+    %w[groups affiliations participations chair_of_groups
+       team_contact_of_groups specifications].each do |resource|
+      define_method("user_#{resource}") do |hash, options = {}|
+        fetch_resource(:"user_#{resource}_index", hash: hash, **options)
+      end
     end
 
     # Translation methods
-
     def translations(options = {})
-      Hal.instance.register.fetch(:translation_index)
+      fetch_resource(:translation_index, **options)
     end
 
     def translation(id, options = {})
-      Hal.instance.register.fetch(:translation_resource, id: id)
+      fetch_resource(:translation_resource, id: id, **options)
     end
 
     # Affiliation methods
-
     def affiliations(options = {})
-      Hal.instance.register.fetch(:affiliation_index)
+      fetch_resource(:affiliation_index, **options)
     end
 
     def affiliation(id, options = {})
-      Hal.instance.register.fetch(:affiliation_resource, id: id)
+      fetch_resource(:affiliation_resource, id: id, **options)
     end
 
-    def affiliation_participants(id, options = {})
-      Hal.instance.register.fetch(:affiliation_participants_index, id: id)
-    end
-
-    def affiliation_participations(id, options = {})
-      Hal.instance.register.fetch(:affiliation_participations_index, id: id)
+    %w[participants participations].each do |resource|
+      define_method("affiliation_#{resource}") do |id, options = {}|
+        fetch_resource(:"affiliation_#{resource}_index", id: id, **options)
+      end
     end
 
     # Ecosystem methods
-
     def ecosystems(options = {})
-      Hal.instance.register.fetch(:ecosystem_index)
+      fetch_resource(:ecosystem_index, **options)
     end
 
     def ecosystem(id, options = {})
-      Hal.instance.register.fetch(:ecosystem_resource, id: id)
+      fetch_resource(:ecosystem_resource, id: id, **options)
     end
 
-    def ecosystem_groups(shortname, options = {})
-      Hal.instance.register.fetch(:ecosystem_groups_index, shortname: shortname)
-    end
-
-    def ecosystem_evangelists(shortname, options = {})
-      Hal.instance.register.fetch(:ecosystem_evangelists_index, shortname: shortname)
-    end
-
-    def ecosystem_member_organizations(shortname, options = {})
-      Hal.instance.register.fetch(:ecosystem_member_organizations_index, shortname: shortname)
+    %w[groups evangelists member_organizations].each do |resource|
+      define_method("ecosystem_#{resource}") do |shortname, options = {}|
+        fetch_resource(:"ecosystem_#{resource}_index",
+                       shortname: shortname, **options)
+      end
     end
 
     # Participation methods
-
     def participation(id, options = {})
-      Hal.instance.register.fetch(:participation_resource, id: id)
+      fetch_resource(:participation_resource, id: id, **options)
     end
 
     def participation_participants(id, options = {})
-      Hal.instance.register.fetch(:participation_participants_index, id: id)
+      fetch_resource(:participation_participants_index, id: id, **options)
+    end
+
+    private
+
+    def fetch_resource(resource_key, **params)
+      if params.any?
+        Hal.instance.register.fetch(resource_key, **params)
+      else
+        Hal.instance.register.fetch(resource_key)
+      end
     end
   end
 end

data/lib/w3c_api/hal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require_relative 'models'
 
@@ -5,124 +7,236 @@ module W3cApi
   class Hal
     include Singleton
 
+    API_URL = 'https://api.w3.org/'
+
     def initialize
       setup
     end
 
     def client
-      @client ||= Lutaml::Hal::Client.new(api_url: 'https://api.w3.org/')
+      @client ||= Lutaml::Hal::Client.new(api_url: API_URL)
     end
 
     def register
       return @register if @register
 
       @register = Lutaml::Hal::ModelRegister.new(name: :w3c_api, client: client)
-      Lutaml::Hal::GlobalRegister.instance.register(:w3c_api, @register)
+      Lutaml::Hal::GlobalRegister.instance.register(
+        :w3c_api, @register
+      )
       @register
     end
 
-    def setup
-      register.add_endpoint(id: :affiliation_index, type: :index, url: '/affiliations', model: Models::AffiliationIndex)
-      register.add_endpoint(id: :affiliation_resource, type: :resource, url: '/affiliations/{id}',
-                            model: Models::Affiliation)
-      register.add_endpoint(id: :affiliation_participants_index, type: :index, url: '/affiliations/{id}/participants',
-                            model: Models::ParticipantIndex)
-      register.add_endpoint(id: :affiliation_participations_index, type: :index, url: '/affiliations/{id}/participations',
-                            model: Models::ParticipationIndex)
-
-      # register.add_endpoint(id: :charter_resource, type: :resource, url: '/charters/{id}', model: Models::Charter)
-
-      register.add_endpoint(id: :ecosystem_index, type: :index, url: '/ecosystems', model: Models::EcosystemIndex)
-      register.add_endpoint(id: :ecosystem_resource, type: :resource, url: '/ecosystems/{id}', model: Models::Ecosystem)
-      register.add_endpoint(id: :ecosystem_evangelists_index, type: :index, url: '/ecosystems/{shortname}/evangelists',
-                            model: Models::EvangelistIndex)
-      register.add_endpoint(id: :ecosystem_groups_index, type: :index, url: '/ecosystems/{shortname}/groups',
-                            model: Models::GroupIndex)
-      register.add_endpoint(id: :ecosystem_member_organizations_index, type: :index, url: '/ecosystems/{shortname}/member-organizations',
-                            model: Models::AffiliationIndex)
-
-      register.add_endpoint(id: :group_index, type: :index, url: '/groups', model: Models::GroupIndex)
-      register.add_endpoint(id: :group_resource, type: :resource, url: '/groups/{id}', model: Models::Group)
-      register.add_endpoint(id: :group_specifications_index, type: :index, url: '/groups/{id}/specifications',
-                            model: Models::SpecificationIndex)
-      register.add_endpoint(id: :group_charters_index, type: :index, url: '/groups/{id}/charters',
-                            model: Models::CharterIndex)
-      register.add_endpoint(id: :group_users_index, type: :index, url: '/groups/{id}/users',
-                            model: Models::UserIndex)
-      register.add_endpoint(id: :group_chairs_index, type: :index, url: '/groups/{id}/chairs',
-                            model: Models::ChairIndex)
-      register.add_endpoint(id: :group_team_contacts_index, type: :index, url: '/groups/{id}/teamcontacts',
-                            model: Models::TeamContactIndex)
-      register.add_endpoint(id: :group_participations_index, type: :index, url: '/groups/{id}/participations',
-                            model: Models::ParticipationIndex)
-
-      # register.add_endpoint(id: :participation_index, type: :index, url: '/participations', model: Models::ParticipationIndex)
-      register.add_endpoint(id: :participation_resource, type: :resource, url: '/participations/{id}',
-                            model: Models::Participation)
-      register.add_endpoint(id: :participation_participants_index, type: :index, url: '/participations/{id}/participants',
-                            model: Models::ParticipantIndex)
-
-      register.add_endpoint(id: :serie_index, type: :index, url: '/specification-series', model: Models::SerieIndex)
-      register.add_endpoint(id: :serie_resource, type: :resource, url: '/specification-series/{shortname}',
-                            model: Models::Serie)
-
-      register.add_endpoint(id: :serie_specification_resource, type: :index,
-                            url: '/specification-series/{shortname}/specifications', model: Models::SpecificationIndex)
-
-      register.add_endpoint(id: :specification_index, type: :index, url: '/specifications',
-                            model: Models::SpecificationIndex)
-      register.add_endpoint(id: :specification_resource, type: :resource, url: '/specifications/{shortname}',
-                            model: Models::Specification)
-      register.add_endpoint(id: :specification_resource_version_index, type: :index, url: '/specifications/{shortname}/versions',
-                            model: Models::SpecVersionIndex)
+    private
 
+    # Common pagination query parameters
+    PAGINATION_PARAMS = { 'page' => '{page}',
+                          'items' => '{items}' }.freeze
+
+    # Helper method to add index endpoints with pagination
+    def add_index_endpoint(id, url, model, query_params = PAGINATION_PARAMS)
       register.add_endpoint(
-        id: :specification_resource_version_resource,
-        type: :resource,
-        url: '/specifications/{shortname}/versions/{version}',
-        model: Models::SpecVersion
-      )
-      register.add_endpoint(
-        id: :specification_version_predecessors_index,
+        id: id,
         type: :index,
-        url: '/specifications/{shortname}/versions/{version}/predecessors',
-        model: Models::SpecVersionIndex
+        url: url,
+        model: model,
+        query_params: query_params
       )
-      register.add_endpoint(
-        id: :specification_version_successors_index,
-        type: :index,
-        url: '/specifications/{shortname}/versions/{version}/successors',
-        model: Models::SpecVersionIndex
+    end
+
+    # Helper method to add resource endpoints
+    def add_resource_endpoint(id, url, model)
+      register.add_endpoint(id: id, type: :resource, url: url, model: model)
+    end
+
+    # Helper method to add nested index endpoints for a parent resource
+    def add_nested_index_endpoints(parent, parent_id_param, nested_configs)
+      nested_configs.each do |config|
+        # Convert plural parent to singular for endpoint naming
+        singular_parent = parent.end_with?('s') ? parent[0..-2] : parent
+        id = "#{singular_parent}_#{config[:name]}_index".to_sym
+        url = "/#{parent}/#{parent_id_param}/#{config[:path]}"
+        add_index_endpoint(id, url, config[:model])
+      end
+    end
+
+    def setup
+      # Affiliation endpoints
+      add_index_endpoint(
+        :affiliation_index,
+        '/affiliations',
+        Models::AffiliationIndex
       )
-      register.add_endpoint(
-        id: :specification_by_status_index,
-        type: :index,
-        url: '/specifications-by-status/{status}',
-        model: Models::SpecificationIndex
+      add_resource_endpoint(
+        :affiliation_resource,
+        '/affiliations/{id}',
+        Models::Affiliation
       )
-      register.add_endpoint(
-        id: :specification_supersedes_index,
-        type: :index,
-        url: '/specifications/{shortname}/supersedes',
-        model: Models::SpecificationIndex
+      add_index_endpoint(
+        :affiliation_participants_index,
+        '/affiliations/{id}/participants',
+        Models::ParticipantIndex
       )
-      register.add_endpoint(
-        id: :specification_superseded_by_index,
-        type: :index,
-        url: '/specifications/{shortname}/superseded',
-        model: Models::SpecificationIndex
+      add_index_endpoint(
+        :affiliation_participations_index,
+        '/affiliations/{id}/participations',
+        Models::ParticipationIndex
       )
-      register.add_endpoint(
-        id: :specification_version_editors_index,
-        type: :index,
-        url: '/specifications/{shortname}/version/{version}/editors',
-        model: Models::UserIndex
+
+      # register.add_endpoint(
+      #   id: :charter_resource,
+      #   type: :resource,
+      #   url: '/charters/{id}',
+      #   model: Models::Charter
+      # )
+
+      # Ecosystem endpoints
+      add_index_endpoint(
+        :ecosystem_index,
+        '/ecosystems',
+        Models::EcosystemIndex
       )
-      register.add_endpoint(
-        id: :specification_version_deliverers_index,
-        type: :index,
-        url: '/specifications/{shortname}/version/{version}/deliverers',
-        model: Models::UserIndex
+      add_resource_endpoint(
+        :ecosystem_resource,
+        '/ecosystems/{id}',
+        Models::Ecosystem
+      )
+      add_index_endpoint(
+        :ecosystem_evangelists_index,
+        '/ecosystems/{shortname}/evangelists',
+        Models::EvangelistIndex
+      )
+      add_index_endpoint(
+        :ecosystem_groups_index,
+        '/ecosystems/{shortname}/groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :ecosystem_member_organizations_index,
+        '/ecosystems/{shortname}/member-organizations',
+        Models::AffiliationIndex
+      )
+
+      # Group endpoints
+      add_index_endpoint(
+        :group_index,
+        '/groups',
+        Models::GroupIndex
+      )
+      add_resource_endpoint(
+        :group_resource,
+        '/groups/{id}',
+        Models::Group
+      )
+      add_nested_index_endpoints(
+        'groups',
+        '{id}', [
+          { name: 'specifications', path: 'specifications',
+            model: Models::SpecificationIndex },
+          { name: 'charters', path: 'charters',
+            model: Models::CharterIndex },
+          { name: 'users', path: 'users',
+            model: Models::UserIndex },
+          { name: 'chairs', path: 'chairs',
+            model: Models::ChairIndex },
+          { name: 'team_contacts', path: 'teamcontacts',
+            model: Models::TeamContactIndex },
+          { name: 'participations', path: 'participations',
+            model: Models::ParticipationIndex }
+        ]
+      )
+
+      # Participation endpoints
+      # register.add_endpoint(
+      #   id: :participation_index,
+      #   type: :index,
+      #   url: '/participations',
+      #   model: Models::ParticipationIndex
+      # )
+
+      add_resource_endpoint(
+        :participation_resource,
+        '/participations/{id}',
+        Models::Participation
+      )
+      add_index_endpoint(
+        :participation_participants_index,
+        '/participations/{id}/participants',
+        Models::ParticipantIndex
+      )
+
+      # Serie endpoints
+      add_index_endpoint(
+        :serie_index,
+        '/specification-series',
+        Models::SerieIndex
+      )
+      add_resource_endpoint(
+        :serie_resource,
+        '/specification-series/{shortname}',
+        Models::Serie
+      )
+      add_index_endpoint(
+        :serie_specification_resource,
+        '/specification-series/{shortname}/specifications',
+        Models::SpecificationIndex
+      )
+
+      # Specification endpoints
+      add_index_endpoint(
+        :specification_index,
+        '/specifications',
+        Models::SpecificationIndex
+      )
+      add_resource_endpoint(
+        :specification_resource,
+        '/specifications/{shortname}',
+        Models::Specification
+      )
+      add_index_endpoint(
+        :specification_resource_version_index,
+        '/specifications/{shortname}/versions',
+        Models::SpecVersionIndex
+      )
+      add_resource_endpoint(
+        :specification_resource_version_resource,
+        '/specifications/{shortname}/versions/{version}',
+        Models::SpecVersion
+      )
+      add_index_endpoint(
+        :specification_version_predecessors_index,
+        '/specifications/{shortname}/versions/{version}/predecessors',
+        Models::SpecVersionIndex
+      )
+      add_index_endpoint(
+        :specification_version_successors_index,
+        '/specifications/{shortname}/versions/{version}/successors',
+        Models::SpecVersionIndex
+      )
+      add_index_endpoint(
+        :specification_by_status_index,
+        '/specifications-by-status/{status}',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_supersedes_index,
+        '/specifications/{shortname}/supersedes',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_superseded_by_index,
+        '/specifications/{shortname}/superseded',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_version_editors_index,
+        '/specifications/{shortname}/version/{version}/editors',
+        Models::UserIndex
+      )
+      add_index_endpoint(
+        :specification_version_deliverers_index,
+        '/specifications/{shortname}/version/{version}/deliverers',
+        Models::UserIndex
       )
 
       # TODO: Why is this endpoint needed? There already is /specifications/{shortname}...
@@ -133,32 +247,48 @@ module W3cApi
       #   model: Models::SpecificationIndex
       # )
 
-      register.add_endpoint(id: :translation_index, type: :index, url: '/translations', model: Models::TranslationIndex)
-      register.add_endpoint(id: :translation_resource, type: :resource, url: '/translations/{id}',
-                            model: Models::Translation)
+      # Translation endpoints
+      add_index_endpoint(
+        :translation_index,
+        '/translations',
+        Models::TranslationIndex
+      )
+      add_resource_endpoint(
+        :translation_resource,
+        '/translations/{id}',
+        Models::Translation
+      )
 
+      # User endpoints
       # NOTE: This endpoint doesn't exist, just here for reference.
-      # register.add_endpoint(id: :user_index, type: :index, url: '/users', model: Models::UserIndex)
-
-      register.add_endpoint(id: :user_groups_index, type: :index, url: '/users/{hash}/groups',
-                            model: Models::GroupIndex)
-
-      register.add_endpoint(id: :user_resource, type: :resource, url: '/users/{hash}', model: Models::User)
-
-      register.add_endpoint(id: :user_affiliations_index, type: :index, url: '/users/{hash}/affiliations',
-                            model: Models::AffiliationIndex)
-
-      register.add_endpoint(id: :user_participations_index, type: :index, url: '/users/{hash}/participations',
-                            model: Models::ParticipationIndex)
-
-      register.add_endpoint(id: :user_chair_of_groups_index, type: :index, url: '/users/{hash}/chair-of-groups',
-                            model: Models::GroupIndex)
-
-      register.add_endpoint(id: :user_team_contact_of_groups_index, type: :index, url: '/users/{hash}/team-contact-of-groups',
-                            model: Models::GroupIndex)
-
-      register.add_endpoint(id: :user_specifications_index, type: :index, url: '/users/{hash}/specifications',
-                            model: Models::SpecificationIndex)
+      # register.add_endpoint(
+      #   id: :user_index,
+      #   type: :index,
+      #   url: '/users',
+      #   model: Models::UserIndex
+      # )
+      add_resource_endpoint(
+        :user_resource,
+        '/users/{hash}',
+        Models::User
+      )
+      add_nested_index_endpoints(
+        'users',
+        '{hash}', [
+          { name: 'groups', path: 'groups',
+            model: Models::GroupIndex },
+          { name: 'affiliations', path: 'affiliations',
+            model: Models::AffiliationIndex },
+          { name: 'participations', path: 'participations',
+            model: Models::ParticipationIndex },
+          { name: 'chair_of_groups', path: 'chair-of-groups',
+            model: Models::GroupIndex },
+          { name: 'team_contact_of_groups', path: 'team-contact-of-groups',
+            model: Models::GroupIndex },
+          { name: 'specifications', path: 'specifications',
+            model: Models::SpecificationIndex }
+        ]
+      )
     end
   end
 end

data/lib/w3c_api/models/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lutaml/hal'
 #         {
 #             "created": "2021-03-12T22:06:06+00:00",

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/photo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lutaml/model'
 
 #         "photos": [

data/lib/w3c_api/models/spec_version_index.rb

@@ -5,9 +5,10 @@ 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: 'SpecVersionIndex', collection: true
-      hal_link :successor_version, key: 'successor-version', realize_class: 'SpecVersionIndex', 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/specification_index.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'specification'
+
 module W3cApi
   module Models
     # SpecificationIndex class that models `/specifications`

data/lib/w3c_api/models/testimonial.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lutaml/hal'
 
 #     "testimonials": {

data/lib/w3c_api/models/translation_index.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'translation'
+
 # {
 #   "page"=>1,
 #   "limit"=>100,
@@ -9,7 +11,7 @@
 #     "translations"=>[
 #       {
 #         "href"=>"https://api.w3.org/translations/2",
-#         "title"=>"Vidéo : introduction à l’accessibilité web et aux standards du W3C",
+#         "title"=>"Vidéo : introduction à l'accessibilité web et aux standards du W3C",
 #         "language"=>"fr"
 #       },
 #       {

data/lib/w3c_api/models.rb

@@ -19,6 +19,7 @@ require_relative 'models/evangelist_index'
 require_relative 'models/extension'
 require_relative 'models/group'
 require_relative 'models/group_index'
+require_relative 'models/group_link_set'
 require_relative 'models/join_emails'
 require_relative 'models/participant_index'
 require_relative 'models/participation'

data/lib/w3c_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module W3cApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: w3c_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ribose Inc.
@@ -42,16 +42,16 @@ dependencies:
   name: lutaml-hal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - LICENSE.md
 - README.adoc
 - Rakefile
@@ -134,6 +136,7 @@ files:
 - lib/w3c_api/models/extension.rb
 - lib/w3c_api/models/group.rb
 - lib/w3c_api/models/group_index.rb
+- lib/w3c_api/models/group_link_set.rb
 - lib/w3c_api/models/join_emails.rb
 - lib/w3c_api/models/participant_index.rb
 - lib/w3c_api/models/participation.rb