w3c_api 0.1.0

data/lib/w3c_api/models/spec_version.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'link'
+
+# Example spec version response format:
+# {
+#   "date": "2023-09-21"
+#   "status": "REC"
+#   "rec_track": true
+#   "editor-draft": "https://w3c.github.io/example-draft/"
+#   "uri": "https://www.w3.org/TR/2023/REC-example-20230921/"
+#   "title": "Example Specification"
+#   "shortlink": "https://www.w3.org/TR/example/"
+#   "process-rules": "2021"
+#   "_links": {
+#     "self": {
+#       "href": "https://api.w3.org/specifications/example/versions/20230921"
+#     },
+#     "specification": {
+#       "href": "https://api.w3.org/specifications/example"
+#     }
+#   }
+# }
+
+module W3cApi
+    module Models
+      class SpecVersionLinks < Lutaml::Model::Serializable
+        attribute :self, Link
+        attribute :specification, Link
+      end
+
+      class SpecVersion < Base
+        attribute :status, :string
+        attribute :rec_track, :boolean
+        attribute :editor_draft, :string
+        attribute :uri, :string, pattern: %r{https://www\.w3\.org/.*}
+        attribute :date, :date_time # Date-time format
+        attribute :last_call_feedback_due, :date_time # Date-time format
+        attribute :pr_reviews_date, :date_time # Date-time format
+        attribute :implementation_feedback_due, :date_time # Date-time format
+        attribute :per_reviews_due, :date_time # Date-time format
+        attribute :informative, :boolean
+        attribute :title, :string
+        attribute :href, :string
+        attribute :shortlink, :string, pattern: %r{https://www\.w3\.org/.*}
+        attribute :translation, :string
+        attribute :errata, :string
+        attribute :process_rules, :string
+        attribute :_links, SpecVersionLinks
+
+        # Return the specification this version belongs to
+        def specification(client = nil)
+          return nil unless client && _links&.specification
+
+          spec_href = _links.specification.href
+          spec_shortname = spec_href.split('/').last
+
+          client.specification(spec_shortname)
+        end
+
+        # Check if this spec version is a Recommendation
+        def recommendation?
+          status == 'REC'
+        end
+
+        # Check if this spec version is a Working Draft
+        def working_draft?
+          status == 'WD'
+        end
+
+        # Check if this spec version is a Candidate Recommendation
+        def candidate_recommendation?
+          status == 'CR'
+        end
+
+        def self.from_response(response)
+          transformed_response = transform_keys(response)
+
+          spec_version = new
+          transformed_response.each do |key, value|
+            case key
+            when :_links
+              links = value.each_with_object({}) do |(link_name, link_data), acc|
+                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
+              end
+              spec_version._links = SpecVersionLinks.new(links)
+            else
+              spec_version.send("#{key}=", value) if spec_version.respond_to?("#{key}=")
+            end
+          end
+          spec_version
+        end
+      end
+    end
+end

data/lib/w3c_api/models/spec_version_ref.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+
+module W3cApi
+    module Models
+      class SpecVersionRef < Lutaml::Model::Serializable
+        attribute :status, :string
+        attribute :rec_track, :boolean
+        attribute :editor_draft, :string
+        attribute :uri, :string
+        attribute :date, :string
+        attribute :title, :string
+        attribute :shortlink, :string
+        attribute :process_rules, :string
+      end
+    end
+end

data/lib/w3c_api/models/spec_versions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'spec_version'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+module W3cApi
+    module Models
+      class SpecVersions < CollectionBase
+        attribute :spec_versions, SpecVersion, collection: true
+
+        delegate_enumerable :spec_versions
+        collection_instance_class SpecVersion, :spec_versions
+      end
+    end
+end

data/lib/w3c_api/models/specification.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'link'
+
+# {
+#   "shortlink"=>"https://www.w3.org/TR/PNG/",
+#   "description"=>"<p>This document describes PNG (Portable Network Graphics), an extensible file format for the lossless, portable, well-compressed storage of raster images. PNG provides a patent-free replacement for GIF and can also replace many common uses of TIFF. Indexed-color, grayscale, and truecolor images are supported, plus an optional alpha channel. Sample depths range from 1 to 16 bits.</p>\r\n<p>PNG is designed to work well in online viewing applications, such as the World Wide Web, so it is fully streamable with a progressive display option. PNG is robust, providing both full file integrity checking and simple detection of common transmission errors. Also, PNG can store gamma and chromaticity data for improved color matching on heterogeneous platforms.</p>\r\n<p>This specification defines an Internet Media Type image/png.</p>",
+#   "title"=>"Portable Network Graphics (PNG) Specification (Second Edition)",
+#   "shortname"=>"png-2",
+#   "editor-draft"=>"https://w3c.github.io/png/",
+#   "_links"=>{
+#     "self"=>{
+#       "href"=>"https://api.w3.org/specifications/png-2"
+#     },
+#     "version-history"=>{
+#       "href"=>"https://api.w3.org/specifications/png-2/versions"
+#     },
+#     "first-version"=>{
+#       "href"=>"https://api.w3.org/specifications/png-2/versions/20030520",
+#       "title"=>"Proposed Recommendation"
+#     },
+#     "latest-version"=>{
+#       "href"=>"https://api.w3.org/specifications/png-2/versions/20031110",
+#       "title"=>"Recommendation"
+#     },
+#     "series"=>{
+#       "href"=>"https://api.w3.org/specification-series/png"
+#     }
+#   }
+# }
+
+module W3cApi
+    module Models
+      class SpecificationLinks < Lutaml::Model::Serializable
+        attribute :self, Link
+        attribute :version_history, Link
+        attribute :first_version, Link
+        attribute :latest_version, Link
+        attribute :series, Link
+      end
+
+      class Specification < Base
+        attribute :shortlink, :string
+        attribute :description, :string
+        attribute :title, :string
+        attribute :href, :string
+        attribute :shortname, :string
+        attribute :editor_draft, :string
+        attribute :series_version, :string
+        attribute :_links, SpecificationLinks
+
+        # Return versions of this specification
+        def versions(client = nil)
+          return nil unless client && shortname
+
+          client.specification_versions(shortname)
+        end
+
+        def self.from_response(response)
+          transformed_response = transform_keys(response)
+
+          spec = new
+          transformed_response.each do |key, value|
+            case key
+            when :_links
+              links = value.each_with_object({}) do |(link_name, link_data), acc|
+                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
+              end
+              spec._links = SpecificationLinks.new(links)
+            else
+              spec.send("#{key}=", value) if spec.respond_to?("#{key}=")
+            end
+          end
+          spec
+        end
+      end
+    end
+end

data/lib/w3c_api/models/specifications.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'specification'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+module W3cApi
+    module Models
+      class Specifications < CollectionBase
+        attribute :specifications, Specification, collection: true
+
+        delegate_enumerable :specifications
+        collection_instance_class Specification, :specifications
+      end
+    end
+end

data/lib/w3c_api/models/translation.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'call_for_translation_ref'
+require_relative 'link'
+require_relative 'user'
+
+# {
+#   "states"=>[
+#     "review"
+#   ],
+#   "uri"=>"https://github.com/w3c/wai-video-standards-and-benefits/blob/master/index.fr.md",
+#   "title"=>"Vidéo : introduction à l’accessibilité web et aux standards du W3C",
+#   "language"=>"fr",
+#   "translators"=>[
+#     {
+#       "id"=>40757,
+#       "name"=>"Stéphane Deschamps",
+#       "given"=>"Stéphane",
+#       "family"=>"Deschamps",
+#       "work-title"=>"Mr.",
+#       "biography"=>"I love accessibility and standards. Don't we all.",
+#       "country-code"=>"FR",
+#       "city"=>"Arcueil Cedex",
+#       "connected-accounts"=>[],   #<<<< TODO THIS IS NOT DONE
+#       "discr"=>"user",
+#       "_links"=>{
+#         "self"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008"
+#         },
+#         "affiliations"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/affiliations"
+#         },
+#         "groups"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/groups"
+#         },
+#         "specifications"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/specifications"
+#         },
+#         "photos"=>[
+#           {
+#             "href"=>"https://www.w3.org/thumbnails/360/avatar-images/56nw1z8a5uo0sscsgk4kso8g0004008.webp?x-version=1",
+#             "name"=>"large"
+#           },
+#           {
+#             "href"=>"https://www.w3.org/thumbnails/100/avatar-images/56nw1z8a5uo0sscsgk4kso8g0004008.webp?x-version=1",
+#             "name"=>"thumbnail"
+#           },
+#           {
+#             "href"=>"https://www.w3.org/thumbnails/48/avatar-images/56nw1z8a5uo0sscsgk4kso8g0004008.webp?x-version=1",
+#             "name"=>"tiny"
+#           }
+#         ],
+#         "participations"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/participations"
+#         },
+#         "chair_of_groups"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/chair-of-groups"
+#         },
+#         "team_contact_of_groups"=>{
+#           "href"=>"https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/team-contact-of-groups"
+#         }
+#       }
+#     }
+#   ],
+#   "authorized"=>false,
+#   "call-for-translation"=>{
+#     "uri"=>"https://www.w3.org/WAI/videos/standards-and-benefits/",
+#     "title"=>"Video Introduction to Web Accessibility and W3C Standards",
+#     "_links"=>{
+#       "self"=>{
+#         "href"=>"https://api.w3.org/callsfortranslation/5"
+#       },
+#       "translations"=>{
+#         "href"=>"https://api.w3.org/callsfortranslation/5/translations"
+#       }
+#     }
+#   },
+#   "comments"=>"Needs updating. Requested on 22 Feb 2019.",
+#   "_links"=>{
+#     "self"=>{
+#       "href"=>"https://api.w3.org/translations/2"
+#     }
+#   }
+# }
+
+module W3cApi
+    module Models
+      class TranslationLinks < Lutaml::Model::Serializable
+        attribute :self, Link
+      end
+
+      class Translation < Base
+        attribute :uri, :string
+        attribute :title, :string
+        attribute :href, :string
+        attribute :language, :string
+        attribute :published, :string # Date-time format
+        attribute :updated, :string # Date-time format
+        attribute :authorized, :boolean
+        attribute :lto_name, :string
+        attribute :call_for_translation, CallForTranslationRef
+        attribute :comments, :string
+        attribute :states, :string, collection: true
+        attribute :translators, User, collection: true
+        attribute :_links, TranslationLinks
+
+        # Parse date strings to Date objects
+        def published_date
+          Date.parse(published) if published
+        rescue Date::Error
+          nil
+        end
+
+        def updated_date
+          Date.parse(updated) if updated
+        rescue Date::Error
+          nil
+        end
+
+        # Get the call for translation as a CallForTranslation object
+        def call_for_translation_object
+          return nil unless call_for_translation
+
+          Models::CallForTranslation.new(call_for_translation)
+        end
+
+        # Get the specification version associated with this translation
+        def specification_version(client = nil)
+          return nil unless call_for_translation&.spec_version
+
+          call_for_translation.spec_version
+        end
+
+        def self.from_response(response)
+          transformed_response = transform_keys(response)
+
+          translation = new
+          transformed_response.each do |key, value|
+            case key
+            when :_links
+              links = value.each_with_object({}) do |(link_name, link_data), acc|
+                acc[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
+              end
+              translation._links = TranslationLinks.new(links)
+            when :call_for_translation
+              translation.call_for_translation = CallForTranslationRef.new(value)
+            when :translators
+              # Handle translators as User objects if present
+              if value.is_a?(Array)
+                users = value.map { |user_data| User.from_response(user_data) }
+                translation.translators = users
+              end
+            else
+              translation.send("#{key}=", value) if translation.respond_to?("#{key}=")
+            end
+          end
+          translation
+        end
+      end
+    end
+end

data/lib/w3c_api/models/translations.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'translation'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+# {
+#   "page"=>1,
+#   "limit"=>100,
+#   "pages"=>7,
+#   "total"=>631,
+#   "_links"=>{
+#     "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"
+#       },
+
+module W3cApi
+    module Models
+      class Translations < CollectionBase
+        attribute :translations, Translation, collection: true
+
+        delegate_enumerable :translations
+        collection_instance_class Translation, :translations
+      end
+    end
+end

data/lib/w3c_api/models/user.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+require_relative 'connected_account'
+require_relative 'link'
+
+# {
+#   "id"=>58291,
+#   "name"=>"David Grogan",
+#   "given"=>"David",
+#   "family"=>"Grogan",
+#   "work-title"=>"Software Engineer",
+#   "connected-accounts"=>[
+#     {
+#       "created"=>"2019-07-18T21:28:31+00:00",
+#       "updated"=>"2021-01-21T10:49:57+00:00",
+#       "service"=>"github",
+#       "identifier"=>"1801875",
+#       "nickname"=>"davidsgrogan",
+#       "profile-picture"=>"https://avatars.githubusercontent.com/u/1801875?v=4",
+#       "href"=>"https://github.com/davidsgrogan",
+#       "_links"=>{
+#         "user"=>{
+#           "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8"
+#         }
+#       }
+#     }
+#   ],
+#   "discr"=>"user",
+#   "_links"=>{
+#     "self"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8"
+#     },
+#     "affiliations"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/affiliations"
+#     },
+#     "groups"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/groups"
+#     },
+#     "specifications"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/specifications"
+#     },
+#     "participations"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/participations"
+#     },
+#     "chair_of_groups"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/chair-of-groups"
+#     },
+#     "team_contact_of_groups"=>{
+#       "href"=>"https://api.w3.org/users/c2yerd5euz48gcw08s44oww8g4oo8w8/team-contact-of-groups"
+#     }
+#   }
+# }
+
+# {
+#   "id": 40757,
+#   "name": "Stéphane Deschamps",
+#   "given": "Stéphane",
+#   "family": "Deschamps",
+#   "work_title": "Mr.",
+#   "discr": "user",
+#   "biography": "I love accessibility and standards. Don't we all.",
+#   "country_code": "FR",
+#   "city": "Arcueil Cedex",
+#   "_links": {
+#     "self": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008"
+#     },
+#     "affiliations": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/affiliations"
+#     },
+#     "groups": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/groups"
+#     },
+#     "specifications": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/specifications"
+#     },
+#     "participations": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/participations"
+#     },
+#     "chair_of_groups": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/chair-of-groups"
+#     },
+#     "team_contact_of_groups": {
+#       "href": "https://api.w3.org/users/56nw1z8a5uo0sscsgk4kso8g0004008/team-contact-of-groups"
+#     }
+#   }
+# }
+
+module W3cApi
+    module Models
+      class UserPhoto < Lutaml::Model::Serializable
+        attribute :href, :string
+        attribute :name, :string
+      end
+
+      class UserLinks < Lutaml::Model::Serializable
+        attribute :self, Link
+        attribute :affiliations, Link
+        attribute :groups, Link
+        attribute :specifications, Link
+        attribute :participations, Link
+        attribute :chair_of_groups, Link
+        attribute :team_contact_of_groups, Link
+      end
+
+      class User < Base
+        attribute :id, :integer
+        attribute :href, :string
+        attribute :title, :string
+        attribute :name, :string
+        attribute :email, :string
+        attribute :given, :string
+        attribute :family, :string
+        attribute :work_title, :string
+        attribute :discr, :string
+        attribute :biography, :string
+        attribute :phone, :string
+        attribute :country_code, :string
+        attribute :country_division, :string
+        attribute :city, :string
+        attribute :connected_accounts, ConnectedAccount, collection: true
+        attribute :_links, UserLinks
+
+        # Return groups this user is a member of
+        def groups(client = nil)
+          return nil unless client && _links&.groups
+
+          client.user_groups(id)
+        end
+
+        # Return specifications this user has contributed to
+        def specifications(client = nil)
+          return nil unless client && _links&.specifications
+
+          client.user_specifications(id)
+        end
+
+        def self.from_response(response)
+          transformed_response = transform_keys(response)
+
+          user = new
+          transformed_response.each do |key, value|
+            case key
+            when :connected_accounts
+              user.connected_accounts = value.map do |account|
+                ConnectedAccount.from_response(account)
+              end
+            when :_links
+              links_data = {}
+
+              # Handle all standard links
+              value.each do |link_name, link_data|
+                next if link_name == :photos
+
+                # Handle photos array separately
+
+                links_data[link_name] = Link.new(href: link_data[:href], title: link_data[:title])
+              end
+
+              # Handle photos if present
+              if value[:photos]
+                photos = value[:photos].map do |photo|
+                  UserPhoto.new(href: photo[:href], name: photo[:name])
+                end
+                links_data[:photos] = photos
+              end
+
+              user._links = UserLinks.new(links_data)
+            else
+              user.send("#{key}=", value) if user.respond_to?("#{key}=")
+            end
+          end
+          user
+        end
+      end
+    end
+end

data/lib/w3c_api/models/users.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'lutaml/model'
+require_relative 'user'
+require_relative 'delegate_enumerable'
+require_relative 'collection_base'
+
+# {
+# "page"=>1,
+# "limit"=>100,
+# "pages"=>8,
+# "total"=>709,
+# "_links"=>{
+#   "up"=>{
+#     "href"=>"https://api.w3.org/affiliations/35662"
+#   },
+#   "participants"=>[
+#     {
+#       "href"=>"https://api.w3.org/users/p3dte6mpoj4sgw888w8kw4w4skwosck",
+#       "title"=>"Tab Atkins Jr."
+#     },
+#     {
+#       "href"=>"https://api.w3.org/users/l88ca27n2b4sk00cogosk0skw4s8osc",
+#       "title"=>"Chris Wilson"
+#     },
+#     {
+#       "href"=>"https://api.w3.org/users/kjqsxbe6kioko4s88s4wocws848kgw8",
+#       "title"=>"David Baron"
+#     },
+#     {
+#       "href"=>"https://api.w3.org/users/t9qq83owlzkck404w0o44so8owc00gg",
+#       "title"=>"Rune Lillesveen"
+#     },
+
+module W3cApi
+    module Models
+      class Users < CollectionBase
+        attribute :users, User, collection: true
+
+        delegate_enumerable :users
+        collection_instance_class User, :users
+      end
+    end
+end

data/lib/w3c_api/models.rb

@@ -0,0 +1,15 @@
+module W3cApi
+    module Models
+    end
+end
+
+require_relative 'models/specifications'
+require_relative 'models/spec_versions'
+require_relative 'models/users'
+require_relative 'models/charters'
+require_relative 'models/translations'
+require_relative 'models/series_collection'
+require_relative 'models/affiliations'
+require_relative 'models/participations'
+require_relative 'models/groups'
+require_relative 'models/ecosystems'

data/lib/w3c_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module W3cApi
+    VERSION = "0.1.0"
+end