w3c_api 0.1.3 → 0.1.5

data/lib/w3c_api/commands/user.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,63 +10,75 @@ module W3cApi
     class User < Thor
       include OutputFormatter
 
-      desc 'fetch [OPTIONS]', 'Fetch a user by ID'
-      option :id, type: :string, required: true, desc: 'User ID (required)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "fetch [OPTIONS]", "Fetch a user by ID"
+      option :id, type: :string, required: true, desc: "User ID (required)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def fetch
         client = W3cApi::Client.new
         user = client.user(options[:id])
         output_results(user, options[:format])
       end
 
-      desc 'groups', 'Fetch groups a user is a member of'
-      option :id, type: :string, required: true, desc: 'User ID'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "groups", "Fetch groups a user is a member of"
+      option :id, type: :string, required: true, desc: "User ID"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def groups
         client = W3cApi::Client.new
         groups = client.user_groups(options[:id])
         output_results(groups, options[:format])
       end
 
-      desc 'specifications', 'Fetch specifications a user has contributed to'
-      option :id, type: :string, required: true, desc: 'User ID (string or numeric)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "specifications", "Fetch specifications a user has contributed to"
+      option :id, type: :string, required: true,
+                  desc: "User ID (string or numeric)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def specifications
         client = W3cApi::Client.new
         specifications = client.user_specifications(options[:id])
         output_results(specifications, options[:format])
       end
 
-      desc 'affiliations', 'Fetch affiliations of a user'
-      option :id, type: :string, required: true, desc: 'User ID (string or numeric)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "affiliations", "Fetch affiliations of a user"
+      option :id, type: :string, required: true,
+                  desc: "User ID (string or numeric)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def affiliations
         client = W3cApi::Client.new
         affiliations = client.user_affiliations(options[:id])
         output_results(affiliations, options[:format])
       end
 
-      desc 'participations', 'Fetch participations of a user'
-      option :id, type: :string, required: true, desc: 'User ID (string or numeric)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "participations", "Fetch participations of a user"
+      option :id, type: :string, required: true,
+                  desc: "User ID (string or numeric)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def participations
         client = W3cApi::Client.new
         participations = client.user_participations(options[:id])
         output_results(participations, options[:format])
       end
 
-      desc 'chair-of-groups', 'Fetch groups a user chairs'
-      option :id, type: :string, required: true, desc: 'User ID (string or numeric)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "chair-of-groups", "Fetch groups a user chairs"
+      option :id, type: :string, required: true,
+                  desc: "User ID (string or numeric)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def chair_of_groups
         client = W3cApi::Client.new
         groups = client.user_chair_of_groups(options[:id])
         output_results(groups, options[:format])
       end
 
-      desc 'team-contact-of-groups', 'Fetch groups a user is a team contact of'
-      option :id, type: :string, required: true, desc: 'User ID (string or numeric)'
-      option :format, type: :string, default: 'yaml', enum: %w[json yaml], desc: 'Output format'
+      desc "team-contact-of-groups", "Fetch groups a user is a team contact of"
+      option :id, type: :string, required: true,
+                  desc: "User ID (string or numeric)"
+      option :format, type: :string, default: "yaml", enum: %w[json yaml],
+                      desc: "Output format"
       def team_contact_of_groups
         client = W3cApi::Client.new
         groups = client.user_team_contact_of_groups(options[:id])

data/lib/w3c_api/embed.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module W3cApi
+  # Module for discovering and working with embed-supported endpoints
+  module Embed
+    class << self
+      # Get list of endpoints that support embed parameter
+      def supported_endpoints
+        W3cApi::Client.embed_supported_endpoints
+      end
+
+      # Check if a specific endpoint supports embed
+      def supports_embed?(endpoint_id)
+        supported_endpoints.include?(endpoint_id.to_sym)
+      end
+
+      # Get human-readable descriptions of embed-supported endpoints
+      def endpoint_descriptions
+        {
+          specification_index: "Specifications index with embedded specification details",
+          group_index: "Groups index with embedded group details",
+          serie_index: "Series index with embedded series details",
+        }
+      end
+
+      # Get comprehensive embed information
+      def embed_info
+        {
+          supported_endpoints: supported_endpoints,
+          descriptions: endpoint_descriptions,
+          usage_example: {
+            discovery: "W3cApi::Client.embed_supported_endpoints",
+            usage: "W3cApi::Client.new.specifications(embed: true, items: 2)",
+            automatic_realization: "spec_link.realize  # Uses embedded content automatically",
+          },
+        }
+      end
+    end
+  end
+end