w3c_api 0.1.1 → 0.1.3

data/lib/w3c_api/hal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require_relative 'models'
 
@@ -5,126 +7,139 @@ 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
       )
+    end
+
+    # Helper method to add resource endpoints
+    def add_resource_endpoint(id, url, model)
       register.add_endpoint(
-        id: :specification_version_successors_index,
-        type: :index,
-        url: '/specifications/{shortname}/versions/{version}/successors',
-        model: Models::SpecVersionIndex
+        id: id,
+        type: :resource,
+        url: url,
+        model: model
       )
-      register.add_endpoint(
-        id: :specification_by_status_index,
-        type: :index,
-        url: '/specifications-by-status/{status}',
-        model: Models::SpecificationIndex
+    end
+
+    # Helper method to add nested index endpoints
+    def add_nested_index_endpoints(parent_resource, parent_id_param, endpoints)
+      endpoints.each do |endpoint|
+        add_index_endpoint(
+          :"#{parent_resource}_#{endpoint[:name]}_index",
+          "/#{parent_resource}/#{parent_id_param}/#{endpoint[:path]}",
+          endpoint[:model]
+        )
+      end
+    end
+
+    # Helper method to add individual nested endpoints
+    def add_nested_endpoint(parent_resource, parent_id_param, endpoint_name, endpoint_path, model)
+      add_index_endpoint(
+        :"#{parent_resource}_#{endpoint_name}_index",
+        "/#{parent_resource}/#{parent_id_param}/#{endpoint_path}",
+        model
       )
-      register.add_endpoint(
-        id: :specification_supersedes_index,
-        type: :index,
-        url: '/specifications/{shortname}/supersedes',
-        model: Models::SpecificationIndex
+    end
+
+    def setup
+      # Specification endpoints
+      add_index_endpoint(
+        :specification_index,
+        '/specifications',
+        Models::SpecificationIndex
       )
-      register.add_endpoint(
-        id: :specification_superseded_by_index,
-        type: :index,
-        url: '/specifications/{shortname}/superseded',
-        model: Models::SpecificationIndex
+      add_resource_endpoint(
+        :specification_resource,
+        '/specifications/{shortname}',
+        Models::Specification
       )
-      register.add_endpoint(
-        id: :specification_version_editors_index,
-        type: :index,
-        url: '/specifications/{shortname}/version/{version}/editors',
-        model: Models::UserIndex
+      add_index_endpoint(
+        :specification_by_status_index,
+        '/specifications',
+        Models::SpecificationIndex,
+        { 'status' => '{status}', **PAGINATION_PARAMS }
       )
-      register.add_endpoint(
-        id: :specification_version_deliverers_index,
-        type: :index,
-        url: '/specifications/{shortname}/version/{version}/deliverers',
-        model: Models::UserIndex
+
+      # Specification version endpoints
+      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
       )
 
+      # Specification version editors and deliverers
+      add_index_endpoint(
+        :specification_version_editors_index,
+        '/specifications/{shortname}/versions/{version}/editors',
+        Models::EditorIndex
+      )
+      add_index_endpoint(
+        :specification_version_deliverers_index,
+        '/specifications/{shortname}/versions/{version}/deliverers',
+        Models::DelivererIndex
+      )
+
+      # Specification version predecessors and successors
+      add_index_endpoint(
+        :specification_version_predecessors_index,
+        '/specifications/{shortname}/versions/{version}/predecessors',
+        Models::SpecVersionPredecessorIndex
+      )
+      add_index_endpoint(
+        :specification_version_successors_index,
+        '/specifications/{shortname}/versions/{version}/successors',
+        Models::SpecVersionSuccessorIndex
+      )
+
+      # Specification related endpoints
+      %w[supersedes superseded_by editors deliverers].each do |relation|
+        add_index_endpoint(
+          :"specification_#{relation}_index",
+          "/specifications/{shortname}/#{relation.tr('_', '-')}",
+          relation.include?('editor') ? Models::UserIndex : Models::GroupIndex
+        )
+      end
+
       # TODO: Why is this endpoint needed? There already is /specifications/{shortname}...
       # register.add_endpoint(
       #   id: :specification_by_shortname_index,
@@ -133,32 +148,198 @@ 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)
+      # Series 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
+      )
 
-      # NOTE: This endpoint doesn't exist, just here for reference.
-      # register.add_endpoint(id: :user_index, type: :index, url: '/users', model: Models::UserIndex)
+      # Group endpoints
+      add_index_endpoint(
+        :group_index,
+        '/groups',
+        Models::GroupIndex
+      )
+      add_resource_endpoint(
+        :group_resource,
+        '/groups/{id}',
+        Models::Group
+      )
+      add_resource_endpoint(
+        :group_by_type_shortname_resource,
+        '/groups/{type}/{shortname}',
+        Models::Group
+      )
+      add_index_endpoint(
+        :group_by_type_index,
+        '/groups/{type}',
+        Models::GroupIndex
+      )
+      # Group nested endpoints
+      add_index_endpoint(
+        :group_specifications_index,
+        '/groups/{id}/specifications',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :group_users_index,
+        '/groups/{id}/users',
+        Models::UserIndex
+      )
+      add_index_endpoint(
+        :group_charters_index,
+        '/groups/{id}/charters',
+        Models::CharterIndex
+      )
+      add_index_endpoint(
+        :group_chairs_index,
+        '/groups/{id}/chairs',
+        Models::ChairIndex
+      )
+      add_index_endpoint(
+        :group_team_contacts_index,
+        '/groups/{id}/teamcontacts',
+        Models::TeamContactIndex
+      )
+      add_index_endpoint(
+        :group_participations_index,
+        '/groups/{id}/participations',
+        Models::ParticipationIndex
+      )
 
-      register.add_endpoint(id: :user_groups_index, type: :index, url: '/users/{hash}/groups',
-                            model: Models::GroupIndex)
+      # 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
+      # )
+      add_resource_endpoint(
+        :user_resource,
+        '/users/{hash}',
+        Models::User
+      )
 
-      register.add_endpoint(id: :user_resource, type: :resource, url: '/users/{hash}', model: Models::User)
+      # User nested endpoints
+      add_index_endpoint(
+        :user_groups_index,
+        '/users/{hash}/groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :user_affiliations_index,
+        '/users/{hash}/affiliations',
+        Models::AffiliationIndex
+      )
+      add_index_endpoint(
+        :user_participations_index,
+        '/users/{hash}/participations',
+        Models::ParticipationIndex
+      )
+      add_index_endpoint(
+        :user_chair_of_groups_index,
+        '/users/{hash}/chair-of-groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :user_team_contact_of_groups_index,
+        '/users/{hash}/team-contact-of-groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :user_specifications_index,
+        '/users/{hash}/specifications',
+        Models::SpecificationIndex
+      )
 
-      register.add_endpoint(id: :user_affiliations_index, type: :index, url: '/users/{hash}/affiliations',
-                            model: Models::AffiliationIndex)
+      # Affiliation endpoints
+      add_index_endpoint(
+        :affiliation_index,
+        '/affiliations',
+        Models::AffiliationIndex
+      )
+      add_resource_endpoint(
+        :affiliation_resource,
+        '/affiliations/{id}',
+        Models::Affiliation
+      )
 
-      register.add_endpoint(id: :user_participations_index, type: :index, url: '/users/{hash}/participations',
-                            model: Models::ParticipationIndex)
+      # Affiliation nested endpoints
+      add_index_endpoint(
+        :affiliation_participants_index,
+        '/affiliations/{id}/participants',
+        Models::ParticipantIndex
+      )
+      add_index_endpoint(
+        :affiliation_participations_index,
+        '/affiliations/{id}/participations',
+        Models::ParticipationIndex
+      )
 
-      register.add_endpoint(id: :user_chair_of_groups_index, type: :index, url: '/users/{hash}/chair-of-groups',
-                            model: Models::GroupIndex)
+      # Ecosystem endpoints
+      add_index_endpoint(
+        :ecosystem_index,
+        '/ecosystems',
+        Models::EcosystemIndex
+      )
+      add_resource_endpoint(
+        :ecosystem_resource,
+        '/ecosystems/{shortname}',
+        Models::Ecosystem
+      )
 
-      register.add_endpoint(id: :user_team_contact_of_groups_index, type: :index, url: '/users/{hash}/team-contact-of-groups',
-                            model: Models::GroupIndex)
+      # Ecosystem nested endpoints
+      add_index_endpoint(
+        :ecosystem_groups_index,
+        '/ecosystems/{shortname}/groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :ecosystem_evangelists_index,
+        '/ecosystems/{shortname}/evangelists',
+        Models::EvangelistIndex
+      )
+      add_index_endpoint(
+        :ecosystem_member_organizations_index,
+        '/ecosystems/{shortname}/member-organizations',
+        Models::AffiliationIndex
+      )
 
-      register.add_endpoint(id: :user_specifications_index, type: :index, url: '/users/{hash}/specifications',
-                            model: Models::SpecificationIndex)
+      # Participation endpoints
+      add_resource_endpoint(
+        :participation_resource,
+        '/participations/{id}',
+        Models::Participation
+      )
+      add_index_endpoint(
+        :participation_participants_index,
+        '/participations/{id}/participants',
+        Models::ParticipantIndex
+      )
     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/affiliation.rb

@@ -70,6 +70,18 @@ module W3cApi
           map key.to_s.tr('_', '-'), to: key
         end
       end
+
+      def participants(client = nil)
+        return nil unless client
+
+        client.affiliation_participants(id)
+      end
+
+      def participations(client = nil)
+        return nil unless client
+
+        client.affiliation_participations(id)
+      end
     end
   end
 end

data/lib/w3c_api/models/affiliation_index.rb

@@ -4,6 +4,7 @@ require_relative 'affiliation'
 
 module W3cApi
   module Models
+    # Represents a collection of W3C affiliations.
     class AffiliationIndex < Lutaml::Hal::Page
       hal_link :affiliations, key: 'affiliations', realize_class: 'Affiliation', collection: true
     end

data/lib/w3c_api/models/deliverer_index.rb

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

data/lib/w3c_api/models/editor_index.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'user'
+
+module W3cApi
+  module Models
+    # Collection of editors
+    class EditorIndex < Lutaml::Hal::Page
+      hal_link :editors, key: 'editors', realize_class: 'User', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/group.rb

@@ -55,7 +55,7 @@ module W3cApi
   module Models
     # Group model representing a W3C working group
     class Group < Lutaml::Hal::Resource
-      attribute :id, :string
+      attribute :id, :integer
       attribute :type, :string
       attribute :name, :string
       attribute :is_closed, :boolean
@@ -89,6 +89,30 @@ module W3cApi
           map key.to_s.tr('_', '-'), to: key
         end
       end
+
+      def users(client = nil)
+        return nil unless client
+
+        client.group_users(id)
+      end
+
+      def specifications(client = nil)
+        return nil unless client
+
+        client.group_specifications(id)
+      end
+
+      def chairs(client = nil)
+        return nil unless client
+
+        client.group_chairs(id)
+      end
+
+      def team_contacts(client = nil)
+        return nil unless client
+
+        client.group_team_contacts(id)
+      end
     end
   end
 end

data/lib/w3c_api/models/groups.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module W3cApi
+  module Models
+    # Collection wrapper for groups
+    class Groups
+      include Enumerable
+
+      attr_accessor :groups
+
+      def initialize(groups = [])
+        @groups = groups
+      end
+
+      def each(&block)
+        @groups.each(&block)
+      end
+
+      def first
+        @groups.first
+      end
+
+      def size
+        @groups.size
+      end
+
+      def empty?
+        @groups.empty?
+      end
+    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/serie.rb

@@ -53,6 +53,18 @@ module W3cApi
           map key.to_s.tr('_', '-'), to: key
         end
       end
+
+      def specifications(client = nil)
+        return nil unless client
+
+        client.series_specifications(shortname)
+      end
+
+      def current_specification(client = nil)
+        return nil unless client
+
+        client.specification(shortname)
+      end
     end
   end
 end

data/lib/w3c_api/models/spec_version.rb

@@ -49,11 +49,11 @@ module W3cApi
       attribute :process_rules, :string
 
       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 :editors, key: 'editors', realize_class: 'EditorIndex'
+      hal_link :deliverers, key: 'deliverers', realize_class: 'DelivererIndex'
       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'
+      hal_link :predecessor_versions, key: 'predecessor-version', realize_class: 'SpecVersionPredecessorIndex'
+      hal_link :successor_versions, key: 'successor-version', realize_class: 'SpecVersionSuccessorIndex'
 
       key_value do
         %i[

data/lib/w3c_api/models/spec_version_index.rb

@@ -6,8 +6,6 @@ module W3cApi
   module Models
     class SpecVersionIndex < Lutaml::Hal::Page
       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
     end
   end
 end

data/lib/w3c_api/models/spec_version_predecessor_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'spec_version'
+
+module W3cApi
+  module Models
+    class SpecVersionPredecessorIndex < Lutaml::Hal::Page
+      hal_link :predecessor_versions, key: 'predecessor-version', realize_class: 'SpecVersion', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/spec_version_successor_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'spec_version'
+
+module W3cApi
+  module Models
+    class SpecVersionSuccessorIndex < Lutaml::Hal::Page
+      hal_link :successor_versions, key: 'successor-version', realize_class: 'SpecVersion', collection: true
+    end
+  end
+end