w3c_api 0.1.0 → 0.1.2

data/lib/w3c_api/models/specification.rb

@@ -1,79 +1,67 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
+# https://api.w3.org/specifications/html5
 # {
-#   "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"
+#     "shortlink": "https://www.w3.org/TR/html5/",
+#     "description": "<p>This specification defines the 5th major revision of the core language of the World Wide Web: the Hypertext Markup Language (HTML). In this version, new features are introduced to help Web application authors, new elements are introduced based on research into prevailing authoring practices, and special attention has been given to defining clear conformance criteria for user agents in an effort to improve interoperability.</p>",
+#     "title": "HTML5",
+#     "shortname": "html5",
+#     "series-version": "5",
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/specifications/html5"
+#         },
+#         "version-history": {
+#             "href": "https://api.w3.org/specifications/html5/versions"
+#         },
+#         "first-version": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20080122",
+#             "title": "Working Draft"
+#         },
+#         "latest-version": {
+#             "href": "https://api.w3.org/specifications/html5/versions/20180327",
+#             "title": "Retired"
+#         },
+#         "supersedes": {
+#             "href": "https://api.w3.org/specifications/html5/supersedes"
+#         },
+#         "series": {
+#             "href": "https://api.w3.org/specification-series/html"
+#         }
 #     }
-#   }
 # }
 
 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
+  module Models
+    class Specification < Lutaml::Hal::Resource
+      attribute :shortlink, :string
+      attribute :description, :string
+      attribute :title, :string
+      attribute :href, :string
+      attribute :shortname, :string
+      attribute :editor_draft, :string
+      attribute :series_version, :string
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'Specification'
+      hal_link :version_history, key: 'version-history', realize_class: 'SpecVersionIndex'
+      hal_link :first_version, key: 'first-version', realize_class: 'SpecVersion'
+      hal_link :latest_version, key: 'latest-version', realize_class: 'SpecVersion'
+      hal_link :supersedes, key: 'supersedes', realize_class: 'SpecificationIndex', collection: true
+      hal_link :series, key: 'series', realize_class: 'Serie'
 
-          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
+      key_value do
+        %i[
+          shortlink
+          description
+          title
+          href
+          shortname
+          editor_draft
+          series_version
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/specification_index.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'specification'
+
+module W3cApi
+  module Models
+    # SpecificationIndex class that models `/specifications`
+    class SpecificationIndex < Lutaml::Hal::Page
+      hal_link :specifications, key: 'specifications', realize_class: 'Specification', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/team_contact_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'user'
+
+module W3cApi
+  module Models
+    class TeamContactIndex < Lutaml::Hal::Page
+      hal_link :team_contacts, key: 'team-contacts', realize_class: 'User', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/testimonial.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'lutaml/hal'
+
+#     "testimonials": {
+#         "en": "Google's mission is to organize the world’s information and make it universally accessible and useful."
+#     },
+
+module W3cApi
+  module Models
+    class Testimonial < Lutaml::Hal::Resource
+      attribute :en, :string
+
+      key_value do
+        map 'en', to: :en
+      end
+    end
+  end
+end

data/lib/w3c_api/models/translation.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'call_for_translation_ref'
-require_relative 'link'
+require_relative 'call_for_translation'
 require_relative 'user'
 
 # {
@@ -85,78 +83,41 @@ require_relative 'user'
 # }
 
 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
+  module Models
+    class Translation < Lutaml::Hal::Resource
+      attribute :uri, :string
+      attribute :title, :string
+      attribute :href, :string
+      attribute :language, :string
+      attribute :published, :date_time
+      attribute :updated, :date_time
+      attribute :authorized, :boolean
+      attribute :lto_name, :string
+      attribute :call_for_translation, CallForTranslation
+      attribute :comments, :string
+      attribute :states, :string, collection: true
+      attribute :translators, User, collection: true
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'Translation'
 
-          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
+      key_value do
+        %i[
+          uri
+          title
+          href
+          language
+          published
+          updated
+          authorized
+          lto_name
+          call_for_translation
+          comments
+          states
+          translators
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/{translations.rb → translation_index.rb}

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
 require_relative 'translation'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
 
 # {
 #   "page"=>1,
@@ -14,7 +11,7 @@ require_relative 'collection_base'
 #     "translations"=>[
 #       {
 #         "href"=>"https://api.w3.org/translations/2",
-#         "title"=>"Vidéo : introduction à l’accessibilité web et aux standards du W3C",
+#         "title"=>"Vidéo : introduction à l'accessibilité web et aux standards du W3C",
 #         "language"=>"fr"
 #       },
 #       {
@@ -29,12 +26,9 @@ require_relative 'collection_base'
 #       },
 
 module W3cApi
-    module Models
-      class Translations < CollectionBase
-        attribute :translations, Translation, collection: true
-
-        delegate_enumerable :translations
-        collection_instance_class Translation, :translations
-      end
+  module Models
+    class TranslationIndex < Lutaml::Hal::Page
+      hal_link :translations, key: 'translations', realize_class: 'Translation', collection: true
     end
+  end
 end

data/lib/w3c_api/models/user.rb

@@ -1,178 +1,108 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'connected_account'
-require_relative 'link'
-
+# https://api.w3.org/users/f1of1ovb5rydm8s0go04oco0cgk0sow44w
 # {
-#   "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"
+#     "id": 128112,
+#     "name": "Jennifer Strickland",
+#     "given": "Jennifer",
+#     "family": "Strickland",
+#     "country-code": "US",
+#     "connected-accounts": [
+#         {
+#             "created": "2021-03-12T22:06:06+00:00",
+#             "service": "github",
+#             "identifier": "57469",
+#             "nickname": "jenstrickland",
+#             "profile-picture": "https://avatars.githubusercontent.com/u/57469?v=4",
+#             "href": "https://github.com/jenstrickland",
+#             "_links": {
+#                 "user": {
+#                     "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w"
+#                 }
+#             }
+#         }
+#     ],
+#     "discr": "user",
+#     "_links": {
+#         "self": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w"
+#         },
+#         "affiliations": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/affiliations"
+#         },
+#         "groups": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/groups"
+#         },
+#         "specifications": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/specifications"
+#         },
+#         "photos": [
+#             {
+#                 "href": "https://www.w3.org/thumbnails/360/avatar-images/f1ovb5rydm8s0go04oco0cgk0sow44w.webp?x-version=3",
+#                 "name": "large"
+#             },
+#             {
+#                 "href": "https://www.w3.org/thumbnails/100/avatar-images/f1ovb5rydm8s0go04oco0cgk0sow44w.webp?x-version=3",
+#                 "name": "thumbnail"
+#             },
+#             {
+#                 "href": "https://www.w3.org/thumbnails/48/avatar-images/f1ovb5rydm8s0go04oco0cgk0sow44w.webp?x-version=3",
+#                 "name": "tiny"
+#             }
+#         ],
+#         "participations": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/participations"
+#         },
+#         "chair_of_groups": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/chair-of-groups"
+#         },
+#         "team_contact_of_groups": {
+#             "href": "https://api.w3.org/users/f1ovb5rydm8s0go04oco0cgk0sow44w/team-contact-of-groups"
 #         }
-#       }
-#     }
-#   ],
-#   "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"
-#     }
-#   }
-# }
+require_relative 'account'
+require_relative 'photo'
 
 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
+  module Models
+    # User model representing a W3C user/participant
+    class User < Lutaml::Hal::Resource
+      attribute :id, :string
+      attribute :name, :string
+      attribute :link, :string
+      attribute :given, :string
+      attribute :family, :string
+      attribute :discr, :string
+      attribute :country_code, :string
+      attribute :connected_accounts, Account, collection: true
+      attribute :photos, Photo, collection: true
+
+      hal_link :self, key: 'self', realize_class: 'User'
+      hal_link :affiliations, key: 'affiliations', realize_class: 'AffiliationIndex'
+      hal_link :groups, key: 'groups', realize_class: 'GroupIndex'
+      hal_link :specifications, key: 'specifications', realize_class: 'SpecificationIndex'
+      hal_link :participations, key: 'participations', realize_class: 'ParticipationIndex'
+      hal_link :chair_of_groups, key: 'chair-of-groups', realize_class: 'GroupIndex'
+      hal_link :team_contact_of_groups, key: 'team-contact-of-groups', realize_class: 'GroupIndex'
+      hal_link :photos, key: 'photos', realize_class: 'Photo', collection: true
+
+      key_value do
+        %i[
+          id
+          name
+          link
+          given
+          family
+          discr
+          country_code
+          connected_accounts
+          photos
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/user_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'user'
+
+module W3cApi
+  module Models
+    class UserIndex < Lutaml::Hal::Page
+      hal_link :users, key: 'users', realize_class: 'User', collection: true
+    end
+  end
+end