w3c_api 0.1.2 → 0.1.3

data/lib/w3c_api/cli.rb

@@ -2,6 +2,7 @@
 
 require 'thor'
 require_relative 'commands/specification'
+require_relative 'commands/specification_version'
 require_relative 'commands/group'
 require_relative 'commands/user'
 require_relative 'commands/translation'
@@ -17,6 +18,9 @@ module W3cApi
     desc 'specification SUBCOMMAND ...ARGS', 'Work with W3C specifications'
     subcommand 'specification', Commands::Specification
 
+    desc 'specification_version SUBCOMMAND ...ARGS', 'Work with W3C specification versions'
+    subcommand 'specification_version', Commands::SpecificationVersion
+
     desc 'group SUBCOMMAND ...ARGS', 'Work with W3C groups'
     subcommand 'group', Commands::Group
 

data/lib/w3c_api/client.rb

@@ -22,8 +22,12 @@ module W3cApi
     end
 
     def specification_version(shortname, version, options = {})
-      fetch_resource(:specification_resource_version_resource,
-                     shortname: shortname, version: version, **options)
+      fetch_resource(
+        :specification_resource_version_resource,
+        shortname: shortname,
+        version: version,
+        **options
+      )
     end
 
     def specifications_by_status(status, options = {})
@@ -37,6 +41,16 @@ module W3cApi
       end
     end
 
+    def specification_version_editors(shortname, version, options = {})
+      fetch_resource(:specification_version_editors_index,
+                     shortname: shortname, version: version, **options)
+    end
+
+    def specification_version_deliverers(shortname, version, options = {})
+      fetch_resource(:specification_version_deliverers_index,
+                     shortname: shortname, version: version, **options)
+    end
+
     # Series methods
     def series(options = {})
       fetch_resource(:serie_index, **options)
@@ -51,6 +65,11 @@ module W3cApi
                      shortname: shortname, **options)
     end
 
+    def series_current_specification(shortname, options = {})
+      fetch_resource(:serie_current_specification_resource,
+                     shortname: shortname, **options)
+    end
+
     # Group methods
     def groups(options = {})
       fetch_resource(:group_index, **options)
@@ -107,8 +126,8 @@ module W3cApi
       fetch_resource(:ecosystem_index, **options)
     end
 
-    def ecosystem(id, options = {})
-      fetch_resource(:ecosystem_resource, id: id, **options)
+    def ecosystem(shortname, options = {})
+      fetch_resource(:ecosystem_resource, shortname: shortname, **options)
     end
 
     %w[groups evangelists member_organizations].each do |resource|

data/lib/w3c_api/commands/specification_version.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'output_formatter'
+
+module W3cApi
+  module Commands
+    class SpecificationVersion < Thor
+      include OutputFormatter
+
+      desc 'editors', 'Fetch editors of a specification version'
+      option :shortname, type: :string, required: true, desc: 'Specification shortname'
+      option :version, type: :string, required: true, desc: 'Specification version'
+      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      def editors
+        client = W3cApi::Client.new
+        result = client.specification_version_editors(options[:shortname], options[:version])
+        output_results(result, options[:format])
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+
+      desc 'deliverers', 'Fetch deliverers (working groups) of a specification version'
+      option :shortname, type: :string, required: true, desc: 'Specification shortname'
+      option :version, type: :string, required: true, desc: 'Specification version'
+      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      def deliverers
+        client = W3cApi::Client.new
+        result = client.specification_version_deliverers(options[:shortname], options[:version])
+        output_results(result, options[:format])
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+    end
+  end
+end

data/lib/w3c_api/hal.rb

@@ -30,8 +30,10 @@ module W3cApi
     private
 
     # Common pagination query parameters
-    PAGINATION_PARAMS = { 'page' => '{page}',
-                          'items' => '{items}' }.freeze
+    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)
@@ -46,126 +48,107 @@ module W3cApi
 
     # Helper method to add resource endpoints
     def add_resource_endpoint(id, url, model)
-      register.add_endpoint(id: id, type: :resource, url: url, model: 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])
+    # 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
+      )
+    end
+
     def setup
-      # Affiliation endpoints
+      # Specification endpoints
       add_index_endpoint(
-        :affiliation_index,
-        '/affiliations',
-        Models::AffiliationIndex
+        :specification_index,
+        '/specifications',
+        Models::SpecificationIndex
       )
       add_resource_endpoint(
-        :affiliation_resource,
-        '/affiliations/{id}',
-        Models::Affiliation
-      )
-      add_index_endpoint(
-        :affiliation_participants_index,
-        '/affiliations/{id}/participants',
-        Models::ParticipantIndex
+        :specification_resource,
+        '/specifications/{shortname}',
+        Models::Specification
       )
       add_index_endpoint(
-        :affiliation_participations_index,
-        '/affiliations/{id}/participations',
-        Models::ParticipationIndex
+        :specification_by_status_index,
+        '/specifications',
+        Models::SpecificationIndex,
+        { 'status' => '{status}', **PAGINATION_PARAMS }
       )
 
-      # register.add_endpoint(
-      #   id: :charter_resource,
-      #   type: :resource,
-      #   url: '/charters/{id}',
-      #   model: Models::Charter
-      # )
-
-      # Ecosystem endpoints
+      # Specification version endpoints
       add_index_endpoint(
-        :ecosystem_index,
-        '/ecosystems',
-        Models::EcosystemIndex
+        :specification_resource_version_index,
+        '/specifications/{shortname}/versions',
+        Models::SpecVersionIndex
       )
       add_resource_endpoint(
-        :ecosystem_resource,
-        '/ecosystems/{id}',
-        Models::Ecosystem
-      )
-      add_index_endpoint(
-        :ecosystem_evangelists_index,
-        '/ecosystems/{shortname}/evangelists',
-        Models::EvangelistIndex
+        :specification_resource_version_resource,
+        '/specifications/{shortname}/versions/{version}',
+        Models::SpecVersion
       )
+
+      # Specification version editors and deliverers
       add_index_endpoint(
-        :ecosystem_groups_index,
-        '/ecosystems/{shortname}/groups',
-        Models::GroupIndex
+        :specification_version_editors_index,
+        '/specifications/{shortname}/versions/{version}/editors',
+        Models::EditorIndex
       )
       add_index_endpoint(
-        :ecosystem_member_organizations_index,
-        '/ecosystems/{shortname}/member-organizations',
-        Models::AffiliationIndex
+        :specification_version_deliverers_index,
+        '/specifications/{shortname}/versions/{version}/deliverers',
+        Models::DelivererIndex
       )
 
-      # Group endpoints
+      # Specification version predecessors and successors
       add_index_endpoint(
-        :group_index,
-        '/groups',
-        Models::GroupIndex
-      )
-      add_resource_endpoint(
-        :group_resource,
-        '/groups/{id}',
-        Models::Group
+        :specification_version_predecessors_index,
+        '/specifications/{shortname}/versions/{version}/predecessors',
+        Models::SpecVersionPredecessorIndex
       )
-      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 }
-        ]
+      add_index_endpoint(
+        :specification_version_successors_index,
+        '/specifications/{shortname}/versions/{version}/successors',
+        Models::SpecVersionSuccessorIndex
       )
 
-      # Participation endpoints
+      # 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: :participation_index,
+      #   id: :specification_by_shortname_index,
       #   type: :index,
-      #   url: '/participations',
-      #   model: Models::ParticipationIndex
+      #   url: '/specifications-by-shortname/{shortname}',
+      #   model: Models::SpecificationIndex
       # )
 
-      add_resource_endpoint(
-        :participation_resource,
-        '/participations/{id}',
-        Models::Participation
-      )
-      add_index_endpoint(
-        :participation_participants_index,
-        '/participations/{id}/participants',
-        Models::ParticipantIndex
-      )
-
-      # Serie endpoints
+      # Series endpoints
       add_index_endpoint(
         :serie_index,
         '/specification-series',
@@ -182,71 +165,59 @@ module W3cApi
         Models::SpecificationIndex
       )
 
-      # Specification endpoints
+      # Group endpoints
       add_index_endpoint(
-        :specification_index,
-        '/specifications',
-        Models::SpecificationIndex
+        :group_index,
+        '/groups',
+        Models::GroupIndex
       )
       add_resource_endpoint(
-        :specification_resource,
-        '/specifications/{shortname}',
-        Models::Specification
-      )
-      add_index_endpoint(
-        :specification_resource_version_index,
-        '/specifications/{shortname}/versions',
-        Models::SpecVersionIndex
+        :group_resource,
+        '/groups/{id}',
+        Models::Group
       )
       add_resource_endpoint(
-        :specification_resource_version_resource,
-        '/specifications/{shortname}/versions/{version}',
-        Models::SpecVersion
+        :group_by_type_shortname_resource,
+        '/groups/{type}/{shortname}',
+        Models::Group
       )
       add_index_endpoint(
-        :specification_version_predecessors_index,
-        '/specifications/{shortname}/versions/{version}/predecessors',
-        Models::SpecVersionIndex
+        :group_by_type_index,
+        '/groups/{type}',
+        Models::GroupIndex
       )
+      # Group nested endpoints
       add_index_endpoint(
-        :specification_version_successors_index,
-        '/specifications/{shortname}/versions/{version}/successors',
-        Models::SpecVersionIndex
+        :group_specifications_index,
+        '/groups/{id}/specifications',
+        Models::SpecificationIndex
       )
       add_index_endpoint(
-        :specification_by_status_index,
-        '/specifications-by-status/{status}',
-        Models::SpecificationIndex
+        :group_users_index,
+        '/groups/{id}/users',
+        Models::UserIndex
       )
       add_index_endpoint(
-        :specification_supersedes_index,
-        '/specifications/{shortname}/supersedes',
-        Models::SpecificationIndex
+        :group_charters_index,
+        '/groups/{id}/charters',
+        Models::CharterIndex
       )
       add_index_endpoint(
-        :specification_superseded_by_index,
-        '/specifications/{shortname}/superseded',
-        Models::SpecificationIndex
+        :group_chairs_index,
+        '/groups/{id}/chairs',
+        Models::ChairIndex
       )
       add_index_endpoint(
-        :specification_version_editors_index,
-        '/specifications/{shortname}/version/{version}/editors',
-        Models::UserIndex
+        :group_team_contacts_index,
+        '/groups/{id}/teamcontacts',
+        Models::TeamContactIndex
       )
       add_index_endpoint(
-        :specification_version_deliverers_index,
-        '/specifications/{shortname}/version/{version}/deliverers',
-        Models::UserIndex
+        :group_participations_index,
+        '/groups/{id}/participations',
+        Models::ParticipationIndex
       )
 
-      # TODO: Why is this endpoint needed? There already is /specifications/{shortname}...
-      # register.add_endpoint(
-      #   id: :specification_by_shortname_index,
-      #   type: :index,
-      #   url: '/specifications-by-shortname/{shortname}',
-      #   model: Models::SpecificationIndex
-      # )
-
       # Translation endpoints
       add_index_endpoint(
         :translation_index,
@@ -272,22 +243,102 @@ module W3cApi
         '/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 }
-        ]
+
+      # 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
+      )
+
+      # Affiliation endpoints
+      add_index_endpoint(
+        :affiliation_index,
+        '/affiliations',
+        Models::AffiliationIndex
+      )
+      add_resource_endpoint(
+        :affiliation_resource,
+        '/affiliations/{id}',
+        Models::Affiliation
+      )
+
+      # 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
+      )
+
+      # Ecosystem endpoints
+      add_index_endpoint(
+        :ecosystem_index,
+        '/ecosystems',
+        Models::EcosystemIndex
+      )
+      add_resource_endpoint(
+        :ecosystem_resource,
+        '/ecosystems/{shortname}',
+        Models::Ecosystem
+      )
+
+      # 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
+      )
+
+      # Participation endpoints
+      add_resource_endpoint(
+        :participation_resource,
+        '/participations/{id}',
+        Models::Participation
+      )
+      add_index_endpoint(
+        :participation_participants_index,
+        '/participations/{id}/participants',
+        Models::ParticipantIndex
       )
     end
   end

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