w3c_api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5227c6f6b71312ce390dadc6053628d111cc387d1477e43ab7aa2473200e611
-  data.tar.gz: a6b3afb0ee859b549234c9fe0c55c64896c14d0d2ddc31d20d19040d2859772a
+  metadata.gz: a73c07f5e19155dfe22a5e7c772a6890867df6db2019c049fd17ce1c90dd6680
+  data.tar.gz: 58b57fedefa49eeb9a89f424fd966bc90e37fe6c8f5165a821de496e1a85109d
 SHA512:
-  metadata.gz: d9a9ffeb9cf9b32c35015b22f89c8d152e508098b14365b964ae12c21712371f1bd8c9793e634444a5e96539887d709b59a08540e65c80b72c357efa3e95fa22
-  data.tar.gz: cd5575a30e2c307de3fa1b679de2f10fb9c07ff340b9f76e76d3aa030ff68be73623f24b29bcb0dfde2926f0a31f6ba584e580ac1521c19b8f6bb210f6f33475
+  metadata.gz: 6e96e2292b9465203056c58e82c1d18b9b7afda181f62889a82d0a0cd2f4c46a1a713288308cf7d6fe131585c86613097d9d028066d043fe8ae1f69016a1ef58
+  data.tar.gz: 9fbd52b672aa7b2d4dd2d97e084549b4f098e7ba91cf7252f41128f8883c574f59288c738b9c9c36e1cc60369a28168088abefcc16f86d605720694f045ab93d

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-07-05 00:01:41 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: 47
+
+# Offense count: 48
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 370
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 274
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 218
+
+# Offense count: 32
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'test_editor_deliverer_functionality.rb'
+
+# Offense count: 10
+# 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

@@ -121,6 +121,67 @@ 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')
+
+# Navigate through version history with chained realization
+version = client.specification_version('html5', '20140429')
+
+# Get all predecessors and navigate through them
+predecessors = version.links.predecessor_versions.realize
+predecessors.links.predecessor_versions.each do |pred_link|
+  predecessor = pred_link.realize
+  puts "#{predecessor.title} - #{predecessor.date}"
+
+  # Each predecessor can have its own predecessors
+  if predecessor.links.predecessor_versions
+    pred_predecessors = predecessor.links.predecessor_versions.realize
+    # Continue navigation...
+  end
+end
+
+# Get all successors and navigate through them
+successors = version.links.successor_versions.realize
+successors.links.successor_versions.each do |succ_link|
+  successor = succ_link.realize
+  puts "#{successor.title} - #{successor.date}"
+
+  # Each successor can have its own successors
+  if successor.links.successor_versions
+    succ_successors = successor.links.successor_versions.realize
+    # Continue navigation...
+  end
+end
+
+# All client methods support comprehensive options including:
+
+# Pagination options
+specifications = client.specifications(page: 2, per_page: 50)
+groups = client.groups(page: 1, per_page: 10, limit: 25, offset: 100)
+
+# 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
@@ -255,6 +316,8 @@ By default, the output is in YAML format. You can specify the output format usin
 Commands:
   # Work with W3C specifications
   w3c_api specification SUBCOMMAND ...ARGS
+  # Work with W3C specification versions
+  w3c_api specification_version SUBCOMMAND ...ARGS
   # Work with W3C specification series
   w3c_api series SUBCOMMAND ...ARGS
   # Work with W3C groups
@@ -397,61 +460,65 @@ specifications:
 ----
 ====
 
-// === Specification version
-
-// TODO: This is not yet implemented!
-
-// ==== Editors
+=== Specification version
 
-// TODO: This is not yet implemented!
+==== Editors
 
-// This command provides access to editors of a specification version.
+This command provides access to editors of a specification version.
 
-// [source,shell]
-// ----
-// # Fetch editors of a specification version
-// $ w3c_api specification-version editors --shortname=webrtc --version=20241008
-// ----
-
-// [example]
-// ====
-// [source,shell]
-// ----
-// $ w3c_api specification-version editors --shortname=webrtc --version=20241008
-// ---
-// users:
-// - href: https://api.w3.org/users/p3dte6mpoj4sgw888w8kw4w4skwosck
-//   title: Cullen Jennings
-// - href: https://api.w3.org/users/kjqsxbe6kioko4s88s4wocws848kgw8
-//   title: Bernard Aboba
-// - href: https://api.w3.org/users/t9qq83owlzkck404w0o44so8owc00gg
-//   title: Jan-Ivar Bruaroey
-// ----
-// ====
+[source,shell]
+----
+# Fetch editors of a specification version
+$ w3c_api specification_version editors --shortname=webrtc --version=20241008
+----
 
-// ==== Deliverers
+[example]
+====
+[source,shell]
+----
+$ w3c_api specification_version editors --shortname=webrtc --version=20241008
+---
+_links:
+  editors:
+  - href: https://api.w3.org/users/bzb5w20eg68k40gc8w0wg0okk4k84os
+    title: Cullen Jennings
+    type: User
+  - href: https://api.w3.org/users/f521yr1m6g0kks880s8ocwsgwskgss4
+    title: Jan-Ivar Bruaroey
+    type: User
+  - href: https://api.w3.org/users/1dsgdsi4zrj4goo4k400c8scw4k4ggk
+    title: Henrik Boström
+    type: User
+  - href: https://api.w3.org/users/nlyfs3q8s2s0gk0owoggkco0sg0wwso
+    title: Florent Castelli
+    type: User
+----
+====
 
-// TODO: This is not yet implemented!
+==== Deliverers
 
-// This command provides access to deliverers (working groups) of a specification version.
+This command provides access to deliverers (working groups) of a specification
+version.
 
-// [source,shell]
-// ----
-// # Fetch deliverers of a specification version
-// $ w3c_api specification-version deliverers --shortname=webrtc --version=20241008
-// ----
+[source,shell]
+----
+# Fetch deliverers of a specification version
+$ w3c_api specification_version deliverers --shortname=webrtc --version=20241008
+----
 
-// [example]
-// ====
-// [source,shell]
-// ----
-// $ w3c_api specification-version deliverers --shortname=webrtc --version=20241008
-// ---
-// groups:
-// - href: https://api.w3.org/groups/wg/webrtc
-//   title: Web Real-Time Communications Working Group
-// ----
-// ====
+[example]
+====
+[source,shell]
+----
+$ w3c_api specification_version deliverers --shortname=webrtc --version=20241008
+---
+_links:
+  deliverers:
+  - href: https://api.w3.org/groups/wg/webrtc
+    title: Web Real-Time Communications Working Group
+    type: Group
+----
+====
 
 === Series
 
@@ -535,9 +602,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 +812,7 @@ participations:
 ----
 ====
 
-==== Chair of Groups
+==== Chair of groups
 
 Getting groups a user chairs.
 
@@ -996,34 +1066,35 @@ $ w3c_api group specifications --id=109735
 ----
 $ w3c_api group specifications --id=109735
 ---
+_links:
+  self:
+    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
+    type: SpecificationIndex
+  first:
+    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
+    type: SpecificationIndex
+  last:
+    href: https://api.w3.org/groups/109735/specifications?page=1&items=100
+    type: SpecificationIndex
+  up:
+    href: https://api.w3.org/groups/109735
+    type: SpecificationIndex
   specifications:
   - href: https://api.w3.org/specifications/webxr-lighting-estimation-1
     title: WebXR Lighting Estimation API Level 1
     type: Specification
-  - href: https://api.w3.org/specifications/webxr-ar-module-1
-    title: WebXR Augmented Reality Module - Level 1
-    type: Specification
   - href: https://api.w3.org/specifications/webxr-gamepads-module-1
     title: WebXR Gamepads Module - Level 1
     type: Specification
-  - href: https://api.w3.org/specifications/webxrlayers-1
-    title: WebXR Layers API Level 1
-    type: Specification
   - href: https://api.w3.org/specifications/webxr-hand-input-1
     title: WebXR Hand Input Module - Level 1
     type: Specification
   - href: https://api.w3.org/specifications/webxr-hit-test-1
     title: WebXR Hit Test Module
     type: Specification
-  - href: https://api.w3.org/specifications/webxr-depth-sensing-1
-    title: WebXR Depth Sensing Module
-    type: Specification
   - href: https://api.w3.org/specifications/webxr-dom-overlays-1
     title: WebXR DOM Overlays Module
     type: Specification
-  - href: https://api.w3.org/specifications/webxr
-    title: WebXR Device API
-    type: Specification
 ----
 ====
 
@@ -1043,6 +1114,19 @@ $ w3c_api group users --id=109735
 ----
 $ w3c_api group users --id=109735
 ---
+_links:
+  self:
+    href: https://api.w3.org/groups/109735/users?page=1&items=100
+    type: UserIndex
+  first:
+    href: https://api.w3.org/groups/109735/users?page=1&items=100
+    type: UserIndex
+  last:
+    href: https://api.w3.org/groups/109735/users?page=1&items=100
+    type: UserIndex
+  up:
+    href: https://api.w3.org/groups/109735
+    type: UserIndex
   users:
   - href: https://api.w3.org/users/9o1jsmhi8ysk088w0k4g00wsssk4c8c
     title: Muadh Al Kalbani
@@ -1075,6 +1159,19 @@ $ w3c_api group charters --id=109735
 ----
 $ w3c_api group charters --id=109735
 ---
+_links:
+  self:
+    href: https://api.w3.org/groups/109735/charters?page=1&items=100
+    type: W3cApi::Models::CharterIndex
+  first:
+    href: https://api.w3.org/groups/109735/charters?page=1&items=100
+    type: W3cApi::Models::CharterIndex
+  last:
+    href: https://api.w3.org/groups/109735/charters?page=1&items=100
+    type: W3cApi::Models::CharterIndex
+  up:
+    href: https://api.w3.org/groups/109735
+    type: W3cApi::Models::CharterIndex
   charters:
   - href: https://api.w3.org/groups/109735/charters/361
     title: 2018-09-24 -> 2020-03-01
@@ -1088,6 +1185,10 @@ $ w3c_api group charters --id=109735
   - href: https://api.w3.org/groups/109735/charters/514
     title: 2024-09-26 -> 2026-09-25
     type: Charter
+page: 1
+limit: 100
+pages: 1
+total: 4
 ----
 ====
 
@@ -1110,27 +1211,32 @@ $ w3c_api translation fetch [OPTIONS]
 ----
 $ w3c_api translation fetch
 ---
-    "translations": [
-      {
-        "href": "https://api.w3.org/translations/2",
-        "title": "Vidéo : introduction à l’accessibilité web et aux standards du W3C",
-        "language": "fr"
-      },
-      {
-        "href": "https://api.w3.org/translations/3",
-        "title": "Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C",
-        "language": "es"
-      },
-      {
-        "href": "https://api.w3.org/translations/4",
-        "title": "Video-introductie over Web-toegankelijkheid en W3C-standaarden",
-        "language": "nl"
-      },
-      {
-        "href": "https://api.w3.org/translations/5",
-        "title": "网页无障碍和W3C标准的介绍视频",
-        "language": "zh_Hans"
-      },...
+_links:
+  self:
+    href: https://api.w3.org/translations?page=1&items=100
+    type: TranslationIndex
+  next:
+    href: https://api.w3.org/translations?page=2&items=100
+    type: TranslationIndex
+  first:
+    href: https://api.w3.org/translations?page=1&items=100
+    type: TranslationIndex
+  last:
+    href: https://api.w3.org/translations?page=7&items=100
+    type: TranslationIndex
+  translations:
+  - href: https://api.w3.org/translations/2
+    title: 'Vidéo : introduction à l’accessibilité web et aux standards du W3C'
+    type: Translation
+  - href: https://api.w3.org/translations/3
+    title: Vídeo de Introducción a la Accesibilidad Web y Estándares del W3C
+    type: Translation
+  - href: https://api.w3.org/translations/4
+    title: Video-introductie over Web-toegankelijkheid en W3C-standaarden
+    type: Translation
+  - href: https://api.w3.org/translations/5
+    title: 网页无障碍和W3C标准的介绍视频
+    type: Translation
 ----
 ====
 
@@ -1252,6 +1358,10 @@ _links:
   - href: https://api.w3.org/ecosystems/data
     title: Data and knowledge
     type: Ecosystem
+page: 1
+limit: 100
+pages: 1
+total: 9
 ----
 ====
 
@@ -1287,7 +1397,7 @@ _links:
     type: GroupIndex
   member-organizations:
     href: https://api.w3.org/ecosystems/data/member-organizations
-    type: AffiliationIndex
+    type: W3cApi::Models::AffiliationIndex
 name: Data and knowledge
 shortname: data
 ----
@@ -1331,6 +1441,10 @@ _links:
   - href: https://api.w3.org/users/qdkk81rtp344c44g0osoocgwwc8o4ss
     title: Bobby Tung
     type: User
+page: 1
+limit: 100
+pages: 1
+total: 3
 ----
 ====
 
@@ -1350,7 +1464,6 @@ $ w3c_api ecosystem groups --shortname={shortname}
 ----
 $ w3c_api ecosystem groups --shortname=publishing
 ---
----
 _links:
   self:
     href: https://api.w3.org/ecosystems/publishing/groups?page=1&items=100
@@ -1368,9 +1481,6 @@ _links:
   - href: https://api.w3.org/groups/cg/a11y-discov-vocab
     title: Accessibility Discoverability Vocabulary for Schema.org Community Group
     type: Group
-  - href: https://api.w3.org/groups/cg/epub3
-    title: EPUB 3 Community Group
-    type: Group
   - href: https://api.w3.org/groups/bg/publishingbg
     title: Publishing Business Group
     type: Group
@@ -1380,6 +1490,10 @@ _links:
   - href: https://api.w3.org/groups/wg/pm
     title: Publishing Maintenance Working Group
     type: Group
+page: 1
+limit: 100
+pages: 1
+total: 4
 ----
 ====
 
@@ -1425,6 +1539,9 @@ _links:
   - href: https://api.w3.org/affiliations/43420
     title: Apache Software Foundation
     type: Affiliation
+  - href: https://api.w3.org/affiliations/1202
+    title: Apple Inc.
+    type: Affiliation
 ...
 ----
 ====
@@ -1521,6 +1638,10 @@ _links:
   - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
     title: Jean-Luc Chevillard
     type: User
+page: 1
+limit: 100
+pages: 1
+total: 1
 ----
 ====
 
@@ -1558,6 +1679,10 @@ _links:
   - href: https://api.w3.org/participations/32932
     title: XQuery and XSLT Extensions Community Group
     type: Participation
+page: 1
+limit: 100
+pages: 1
+total: 1
 ----
 ====
 
@@ -1633,6 +1758,10 @@ _links:
   - href: https://api.w3.org/users/j2d10std2l4ck448woccowg8cg8g8go
     title: Jean-Luc Chevillard
     type: User
+page: 1
+limit: 100
+pages: 1
+total: 1
 ----
 ====
 

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/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