w3c_api 0.1.0 → 0.1.1

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

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'lutaml/model'
-require_relative 'translation'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
-
 # {
 #   "page"=>1,
 #   "limit"=>100,
@@ -29,12 +24,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

data/lib/w3c_api/models.rb

@@ -1,15 +1,38 @@
+# frozen_string_literal: true
+
 module W3cApi
-    module Models
-    end
+  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'
+# Load specific model implementations
+require_relative 'models/affiliation'
+require_relative 'models/affiliation_index'
+require_relative 'models/call_for_translation'
+require_relative 'models/charter'
+require_relative 'models/charter_index'
+require_relative 'models/chair_index'
+require_relative 'models/connected_account'
+require_relative 'models/ecosystem'
+require_relative 'models/ecosystem_index'
+require_relative 'models/evangelist_index'
+require_relative 'models/extension'
+require_relative 'models/group'
+require_relative 'models/group_index'
+require_relative 'models/join_emails'
+require_relative 'models/participant_index'
+require_relative 'models/participation'
+require_relative 'models/participation_index'
+require_relative 'models/serie'
+require_relative 'models/serie_index'
+require_relative 'models/spec_version'
+require_relative 'models/spec_version_index'
+require_relative 'models/spec_version_ref'
+require_relative 'models/specification'
+require_relative 'models/specification_index'
+require_relative 'models/team_contact_index'
+require_relative 'models/testimonial'
+require_relative 'models/translation'
+require_relative 'models/translation_index'
+require_relative 'models/user'
+require_relative 'models/user_index'

data/lib/w3c_api/version.rb

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

data/lib/w3c_api.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-module W3cApi
-end
+require 'lutaml/model'
+require 'lutaml/hal'
 
 require_relative 'w3c_api/version'
+require_relative 'w3c_api/hal'
 require_relative 'w3c_api/models'
 require_relative 'w3c_api/client'
 require_relative 'w3c_api/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: w3c_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-hal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: lutaml-model
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -104,38 +118,40 @@ files:
 - lib/w3c_api/commands/specification.rb
 - lib/w3c_api/commands/translation.rb
 - lib/w3c_api/commands/user.rb
+- lib/w3c_api/hal.rb
 - lib/w3c_api/models.rb
+- lib/w3c_api/models/account.rb
 - lib/w3c_api/models/affiliation.rb
-- lib/w3c_api/models/affiliations.rb
-- lib/w3c_api/models/base.rb
+- lib/w3c_api/models/affiliation_index.rb
 - lib/w3c_api/models/call_for_translation.rb
-- lib/w3c_api/models/call_for_translation_ref.rb
+- lib/w3c_api/models/chair_index.rb
 - lib/w3c_api/models/charter.rb
-- lib/w3c_api/models/charters.rb
-- lib/w3c_api/models/collection_base.rb
+- lib/w3c_api/models/charter_index.rb
 - lib/w3c_api/models/connected_account.rb
-- lib/w3c_api/models/delegate_enumerable.rb
 - lib/w3c_api/models/ecosystem.rb
-- lib/w3c_api/models/ecosystems.rb
+- lib/w3c_api/models/ecosystem_index.rb
+- lib/w3c_api/models/evangelist_index.rb
 - lib/w3c_api/models/extension.rb
 - lib/w3c_api/models/group.rb
-- lib/w3c_api/models/groups.rb
+- lib/w3c_api/models/group_index.rb
 - lib/w3c_api/models/join_emails.rb
-- lib/w3c_api/models/link.rb
+- lib/w3c_api/models/participant_index.rb
 - lib/w3c_api/models/participation.rb
-- lib/w3c_api/models/participations.rb
+- lib/w3c_api/models/participation_index.rb
+- lib/w3c_api/models/photo.rb
 - lib/w3c_api/models/serie.rb
-- lib/w3c_api/models/series.rb
-- lib/w3c_api/models/series_collection.rb
+- lib/w3c_api/models/serie_index.rb
 - lib/w3c_api/models/spec_version.rb
+- lib/w3c_api/models/spec_version_index.rb
 - lib/w3c_api/models/spec_version_ref.rb
-- lib/w3c_api/models/spec_versions.rb
 - lib/w3c_api/models/specification.rb
-- lib/w3c_api/models/specifications.rb
+- lib/w3c_api/models/specification_index.rb
+- lib/w3c_api/models/team_contact_index.rb
+- lib/w3c_api/models/testimonial.rb
 - lib/w3c_api/models/translation.rb
-- lib/w3c_api/models/translations.rb
+- lib/w3c_api/models/translation_index.rb
 - lib/w3c_api/models/user.rb
-- lib/w3c_api/models/users.rb
+- lib/w3c_api/models/user_index.rb
 - lib/w3c_api/version.rb
 homepage: https://github.com/relaton/w3c-api
 licenses:

data/lib/w3c_api/models/affiliations.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'lutaml/model'
-require_relative 'affiliation'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
-
-# {
-#   "page"=>1,
-#   "limit"=>1000,
-#   "pages"=>16,
-#   "total"=>15918,
-#   "_links"=>{
-#     "affiliations"=>[
-#       {
-#         "href"=>"https://api.w3.org/affiliations/1001",
-#         "title"=>"Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)"
-#       },
-#       {
-#         "href"=>"https://api.w3.org/affiliations/1003",
-#         "title"=>"BackWeb Technologies, Inc."
-#       },
-
-module W3cApi
-    module Models
-      class Affiliations < CollectionBase
-        attribute :affiliations, Affiliation, collection: true
-
-        delegate_enumerable :affiliations
-        collection_instance_class Affiliation, :affiliations
-      end
-    end
-end

data/lib/w3c_api/models/base.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'lutaml/model'
-require 'json'
-require 'yaml'
-
-module W3cApi
-  module Models
-    class Base < Lutaml::Model::Serializable
-      # Common methods for all W3C API models
-
-      # Create a model instance from a JSON hash
-      def self.from_response(data)
-        # Convert keys with hyphens to snake_case for Ruby
-        transformed_data = transform_keys(data)
-
-        # Create model instance
-        new(transformed_data)
-      end
-
-      # Utility function to transform kebab-case to snake_case
-      def self.transform_keys(data)
-        case data
-        when Hash
-          result = {}
-          data.each do |key, value|
-            snake_key = key.to_s.tr('-', '_').to_sym
-            result[snake_key] = transform_keys(value)
-          end
-          result
-        when Array
-          data.map { |item| transform_keys(item) }
-        else
-          data
-        end
-      end
-    end
-  end
-end

data/lib/w3c_api/models/call_for_translation_ref.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'lutaml/model'
-require_relative 'spec_version_ref'
-
-module W3cApi
-    module Models
-      class CallForTranslationRef < Lutaml::Model::Serializable
-        attribute :uri, :string
-        attribute :title, :string
-        attribute :comments, :string
-        attribute :spec_version, SpecVersionRef
-      end
-    end
-end

data/lib/w3c_api/models/charters.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'lutaml/model'
-require_relative 'charter'
-require_relative 'delegate_enumerable'
-require_relative 'collection_base'
-
-module W3cApi
-    module Models
-      class Charters < CollectionBase
-        attribute :charters, Charter, collection: true
-
-        delegate_enumerable :charters
-        collection_instance_class Charter, :charters
-      end
-    end
-end