w3c_api 0.1.3 → 0.1.5

data/lib/w3c_api/client.rb

@@ -1,14 +1,36 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'rainbow'
-require 'pp'
-require_relative 'hal'
+require "json"
+require "rainbow"
+require "pp"
+require_relative "hal"
 
 module W3cApi
   class Client
+    # Class method to list endpoints that support embed parameter
+    def self.embed_supported_endpoints
+      hal_instance = W3cApi::Hal.instance
+      endpoints_with_embed = []
+
+      hal_instance.register.models.each do |endpoint_id, endpoint_config|
+        # Check if this endpoint has embed parameter support
+        has_embed = endpoint_config[:parameters].any? do |param|
+          param.name == "embed" && param.location == :query
+        end
+
+        endpoints_with_embed << endpoint_id if has_embed
+      end
+
+      endpoints_with_embed.sort
+    end
+
+    # Instance method to check if a specific endpoint supports embed
+    def embed_supported?(endpoint_id)
+      self.class.embed_supported_endpoints.include?(endpoint_id)
+    end
+
     # Specification methods
-    def specifications(options = nil)
+    def specifications(options = {})
       fetch_resource(:specification_index, **(options || {}))
     end
 
@@ -26,7 +48,7 @@ module W3cApi
         :specification_resource_version_resource,
         shortname: shortname,
         version: version,
-        **options
+        **options,
       )
     end
 
@@ -79,7 +101,8 @@ module W3cApi
       fetch_resource(:group_resource, id: id, **options)
     end
 
-    %w[specifications users charters chairs team_contacts participations].each do |resource|
+    %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

data/lib/w3c_api/commands/affiliation.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,9 +10,10 @@ module W3cApi
     class Affiliation < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch affiliations'
-      option :id, type: :numeric, desc: 'Affiliation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch affiliations"
+      option :id, type: :numeric, desc: "Affiliation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
 
@@ -26,18 +27,20 @@ module W3cApi
         output_results(affiliations, options[:format])
       end
 
-      desc 'participants', 'Fetch participants of an affiliation'
-      option :id, type: :numeric, required: true, desc: 'Affiliation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "participants", "Fetch participants of an affiliation"
+      option :id, type: :numeric, required: true, desc: "Affiliation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def participants
         client = W3cApi::Client.new
         participants = client.affiliation_participants(options[:id])
         output_results(participants, options[:format])
       end
 
-      desc 'participations', 'Fetch participations of an affiliation'
-      option :id, type: :numeric, required: true, desc: 'Affiliation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "participations", "Fetch participations of an affiliation"
+      option :id, type: :numeric, required: true, desc: "Affiliation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def participations
         client = W3cApi::Client.new
         participations = client.affiliation_participations(options[:id])

data/lib/w3c_api/commands/ecosystem.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,9 +10,10 @@ module W3cApi
     class Ecosystem < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch ecosystems'
-      option :shortname, type: :string, desc: 'Ecosystem shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch ecosystems"
+      option :shortname, type: :string, desc: "Ecosystem shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
 
@@ -26,27 +27,33 @@ module W3cApi
         output_results(ecosystems, options[:format])
       end
 
-      desc 'groups', 'Fetch groups in an ecosystem'
-      option :shortname, type: :string, required: true, desc: 'Ecosystem shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "groups", "Fetch groups in an ecosystem"
+      option :shortname, type: :string, required: true,
+                         desc: "Ecosystem shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def groups
         client = W3cApi::Client.new
         groups = client.ecosystem_groups(options[:shortname])
         output_results(groups, options[:format])
       end
 
-      desc 'evangelists', 'Fetch evangelists of an ecosystem'
-      option :shortname, type: :string, required: true, desc: 'Ecosystem shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "evangelists", "Fetch evangelists of an ecosystem"
+      option :shortname, type: :string, required: true,
+                         desc: "Ecosystem shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def evangelists
         client = W3cApi::Client.new
         evangelists = client.ecosystem_evangelists(options[:shortname])
         output_results(evangelists, options[:format])
       end
 
-      desc 'member-organizations', 'Fetch member organizations of an ecosystem'
-      option :shortname, type: :string, required: true, desc: 'Ecosystem shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "member-organizations", "Fetch member organizations of an ecosystem"
+      option :shortname, type: :string, required: true,
+                         desc: "Ecosystem shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def member_organizations
         client = W3cApi::Client.new
         organizations = client.ecosystem_member_organizations(options[:shortname])

data/lib/w3c_api/commands/group.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,10 +10,11 @@ module W3cApi
     class Group < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch groups'
-      option :id, type: :string, desc: 'Group ID'
-      option :type, type: :string, desc: 'Group type'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch groups"
+      option :id, type: :string, desc: "Group ID"
+      option :type, type: :string, desc: "Group type"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
 
@@ -29,54 +30,60 @@ module W3cApi
         output_results(groups, options[:format])
       end
 
-      desc 'users', 'Fetch users in a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "users", "Fetch users in a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def users
         client = W3cApi::Client.new
         users = client.group_users(options[:id])
         output_results(users, options[:format])
       end
 
-      desc 'specifications', 'Fetch specifications produced by a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "specifications", "Fetch specifications produced by a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def specifications
         client = W3cApi::Client.new
         specifications = client.group_specifications(options[:id])
         output_results(specifications, options[:format])
       end
 
-      desc 'charters', 'Fetch charters of a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "charters", "Fetch charters of a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def charters
         client = W3cApi::Client.new
         charters = client.group_charters(options[:id])
         output_results(charters, options[:format])
       end
 
-      desc 'chairs', 'Fetch chairs of a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "chairs", "Fetch chairs of a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def chairs
         client = W3cApi::Client.new
         chairs = client.group_chairs(options[:id])
         output_results(chairs, options[:format])
       end
 
-      desc 'team-contacts', 'Fetch team contacts of a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "team-contacts", "Fetch team contacts of a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def team_contacts
         client = W3cApi::Client.new
         team_contacts = client.group_team_contacts(options[:id])
         output_results(team_contacts, options[:format])
       end
 
-      desc 'participations', 'Fetch participations in a group'
-      option :id, type: :numeric, required: true, desc: 'Group ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "participations", "Fetch participations in a group"
+      option :id, type: :numeric, required: true, desc: "Group ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def participations
         client = W3cApi::Client.new
         participations = client.group_participations(options[:id])

data/lib/w3c_api/commands/output_formatter.rb

@@ -6,7 +6,7 @@ module W3cApi
       # Format and output results based on the specified format
       def output_results(results, format)
         case format
-        when 'yaml'
+        when "yaml"
           puts results.to_yaml
         else
           # Default to JSON if format is not recognized

data/lib/w3c_api/commands/participation.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,18 +10,20 @@ module W3cApi
     class Participation < Thor
       include OutputFormatter
 
-      desc 'fetch', 'Fetch a participation by ID'
-      option :id, type: :numeric, required: true, desc: 'Participation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch", "Fetch a participation by ID"
+      option :id, type: :numeric, required: true, desc: "Participation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
         participation = client.participation(options[:id])
         output_results(participation, options[:format])
       end
 
-      desc 'participants', 'Fetch participants in a participation'
-      option :id, type: :numeric, required: true, desc: 'Participation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "participants", "Fetch participants in a participation"
+      option :id, type: :numeric, required: true, desc: "Participation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def participants
         client = W3cApi::Client.new
         participants = client.participation_participants(options[:id])

data/lib/w3c_api/commands/series.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,9 +10,10 @@ module W3cApi
     class Series < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch specification series'
-      option :shortname, type: :string, desc: 'Series shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch specification series"
+      option :shortname, type: :string, desc: "Series shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
 
@@ -27,9 +28,10 @@ module W3cApi
         output_results(series, options[:format])
       end
 
-      desc 'specifications', 'Fetch specifications in a series'
-      option :shortname, type: :string, required: true, desc: 'Series shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "specifications", "Fetch specifications in a series"
+      option :shortname, type: :string, required: true, desc: "Series shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def specifications
         client = W3cApi::Client.new
         specifications = client.series_specifications(options[:shortname])

data/lib/w3c_api/commands/specification.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,50 +10,39 @@ module W3cApi
     class Specification < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch specifications'
-      option :shortname, type: :string, desc: 'Filter by shortname'
-      option :version, type: :string, desc: 'Specific version of the specification'
-      option :status, type: :string, desc: 'Filter by status'
-      option :resolve, type: :array, desc: 'Links to resolve (e.g. version-history, latest-version, series)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch specifications"
+      option :shortname, type: :string, desc: "Filter by shortname"
+      option :version, type: :string,
+                       desc: "Specific version of the specification"
+      option :status, type: :string, desc: "Filter by status"
+      option :resolve, type: :array,
+                       desc: "Links to resolve (e.g. version-history, latest-version, series)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
-
-        specifications = if options[:shortname] && options[:version]
-                           # Single specification version
-                           client.specification_version(options[:shortname], options[:version])
-                         elsif options[:shortname]
-                           # Single specification
-                           client.specification(options[:shortname])
-                         elsif options[:status]
-                           # Specifications by status
-                           client.specifications_by_status(options[:status])
-                         else
-                           # All specifications
-                           client.specifications
-                         end
-
-        # # Resolve links if specified
-        # if options[:resolve] && specifications.respond_to?(:realize_links)
-        #   specifications.realize_links(options[:resolve], client)
-        # end
-
+        specifications = fetch_specifications(client)
         output_results(specifications, options[:format])
       end
 
-      desc 'versions', 'Fetch versions of a specification'
-      option :shortname, type: :string, required: true, desc: 'Specification shortname'
-      option :resolve, type: :array, desc: 'Links to resolve on each version'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "versions", "Fetch versions of a specification"
+      option :shortname, type: :string, required: true,
+                         desc: "Specification shortname"
+      option :resolve, type: :array, desc: "Links to resolve on each version"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def versions
         client = W3cApi::Client.new
         versions = client.specification_versions(options[:shortname])
         output_results(versions, options[:format])
       end
 
-      desc 'supersedes', 'Fetch specifications that this specification supersedes'
-      option :shortname, type: :string, required: true, desc: 'Specification shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "supersedes",
+           "Fetch specifications that this specification supersedes"
+      option :shortname, type: :string, required: true,
+                         desc: "Specification shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def supersedes
         # We need to add client.specification_supersedes method in the client
         client = W3cApi::Client.new
@@ -61,9 +50,12 @@ module W3cApi
         output_results(specifications, options[:format])
       end
 
-      desc 'superseded-by', 'Fetch specifications that supersede this specification'
-      option :shortname, type: :string, required: true, desc: 'Specification shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "superseded-by",
+           "Fetch specifications that supersede this specification"
+      option :shortname, type: :string, required: true,
+                         desc: "Specification shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def superseded_by
         # We need to add client.specification_superseded_by method in the client
         client = W3cApi::Client.new
@@ -71,23 +63,45 @@ module W3cApi
         output_results(specifications, options[:format])
       end
 
-      desc 'editors', 'Fetch editors of a specification'
-      option :shortname, type: :string, required: true, desc: 'Specification shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "editors", "Fetch editors of a specification"
+      option :shortname, type: :string, required: true,
+                         desc: "Specification shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def editors
         client = W3cApi::Client.new
         editors = client.specification_editors(options[:shortname])
         output_results(editors, options[:format])
       end
 
-      desc 'deliverers', 'Fetch deliverers (working groups) of a specification'
-      option :shortname, type: :string, required: true, desc: 'Specification shortname'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "deliverers", "Fetch deliverers (working groups) of a specification"
+      option :shortname, type: :string, required: true,
+                         desc: "Specification shortname"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def deliverers
         client = W3cApi::Client.new
         deliverers = client.specification_deliverers(options[:shortname])
         output_results(deliverers, options[:format])
       end
+
+      private
+
+      def fetch_specifications(client)
+        if options[:shortname] && options[:version]
+          # Single specification version
+          client.specification_version(options[:shortname], options[:version])
+        elsif options[:shortname]
+          # Single specification
+          client.specification(options[:shortname])
+        elsif options[:status]
+          # Specifications by status
+          client.specifications_by_status(options[:status])
+        else
+          # All specifications
+          client.specifications
+        end
+      end
     end
   end
 end

data/lib/w3c_api/commands/specification_version.rb

@@ -1,33 +1,42 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
+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'
+      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])
+        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'
+      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])
+        result = client.specification_version_deliverers(options[:shortname],
+                                                         options[:version])
         output_results(result, options[:format])
       rescue StandardError => e
         puts "Error: #{e.message}"

data/lib/w3c_api/commands/translation.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'output_formatter'
-require_relative '../client'
+require "thor"
+require_relative "output_formatter"
+require_relative "../client"
 
 module W3cApi
   module Commands
@@ -10,9 +10,10 @@ module W3cApi
     class Translation < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch a translation by ID'
-      option :id, type: :string, desc: 'Translation ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch a translation by ID"
+      option :id, type: :string, desc: "Translation ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new