w3c_api 0.1.0 → 0.1.1

data/lib/w3c_api/hal.rb

@@ -0,0 +1,164 @@
+require 'singleton'
+require_relative 'models'
+
+module W3cApi
+  class Hal
+    include Singleton
+
+    def initialize
+      setup
+    end
+
+    def client
+      @client ||= Lutaml::Hal::Client.new(api_url: 'https://api.w3.org/')
+    end
+
+    def register
+      return @register if @register
+
+      @register = Lutaml::Hal::ModelRegister.new(name: :w3c_api, client: client)
+      Lutaml::Hal::GlobalRegister.instance.register(:w3c_api, @register)
+      @register
+    end
+
+    def setup
+      register.add_endpoint(id: :affiliation_index, type: :index, url: '/affiliations', model: Models::AffiliationIndex)
+      register.add_endpoint(id: :affiliation_resource, type: :resource, url: '/affiliations/{id}',
+                            model: Models::Affiliation)
+      register.add_endpoint(id: :affiliation_participants_index, type: :index, url: '/affiliations/{id}/participants',
+                            model: Models::ParticipantIndex)
+      register.add_endpoint(id: :affiliation_participations_index, type: :index, url: '/affiliations/{id}/participations',
+                            model: Models::ParticipationIndex)
+
+      # register.add_endpoint(id: :charter_resource, type: :resource, url: '/charters/{id}', model: Models::Charter)
+
+      register.add_endpoint(id: :ecosystem_index, type: :index, url: '/ecosystems', model: Models::EcosystemIndex)
+      register.add_endpoint(id: :ecosystem_resource, type: :resource, url: '/ecosystems/{id}', model: Models::Ecosystem)
+      register.add_endpoint(id: :ecosystem_evangelists_index, type: :index, url: '/ecosystems/{shortname}/evangelists',
+                            model: Models::EvangelistIndex)
+      register.add_endpoint(id: :ecosystem_groups_index, type: :index, url: '/ecosystems/{shortname}/groups',
+                            model: Models::GroupIndex)
+      register.add_endpoint(id: :ecosystem_member_organizations_index, type: :index, url: '/ecosystems/{shortname}/member-organizations',
+                            model: Models::AffiliationIndex)
+
+      register.add_endpoint(id: :group_index, type: :index, url: '/groups', model: Models::GroupIndex)
+      register.add_endpoint(id: :group_resource, type: :resource, url: '/groups/{id}', model: Models::Group)
+      register.add_endpoint(id: :group_specifications_index, type: :index, url: '/groups/{id}/specifications',
+                            model: Models::SpecificationIndex)
+      register.add_endpoint(id: :group_charters_index, type: :index, url: '/groups/{id}/charters',
+                            model: Models::CharterIndex)
+      register.add_endpoint(id: :group_users_index, type: :index, url: '/groups/{id}/users',
+                            model: Models::UserIndex)
+      register.add_endpoint(id: :group_chairs_index, type: :index, url: '/groups/{id}/chairs',
+                            model: Models::ChairIndex)
+      register.add_endpoint(id: :group_team_contacts_index, type: :index, url: '/groups/{id}/teamcontacts',
+                            model: Models::TeamContactIndex)
+      register.add_endpoint(id: :group_participations_index, type: :index, url: '/groups/{id}/participations',
+                            model: Models::ParticipationIndex)
+
+      # register.add_endpoint(id: :participation_index, type: :index, url: '/participations', model: Models::ParticipationIndex)
+      register.add_endpoint(id: :participation_resource, type: :resource, url: '/participations/{id}',
+                            model: Models::Participation)
+      register.add_endpoint(id: :participation_participants_index, type: :index, url: '/participations/{id}/participants',
+                            model: Models::ParticipantIndex)
+
+      register.add_endpoint(id: :serie_index, type: :index, url: '/specification-series', model: Models::SerieIndex)
+      register.add_endpoint(id: :serie_resource, type: :resource, url: '/specification-series/{shortname}',
+                            model: Models::Serie)
+
+      register.add_endpoint(id: :serie_specification_resource, type: :index,
+                            url: '/specification-series/{shortname}/specifications', model: Models::SpecificationIndex)
+
+      register.add_endpoint(id: :specification_index, type: :index, url: '/specifications',
+                            model: Models::SpecificationIndex)
+      register.add_endpoint(id: :specification_resource, type: :resource, url: '/specifications/{shortname}',
+                            model: Models::Specification)
+      register.add_endpoint(id: :specification_resource_version_index, type: :index, url: '/specifications/{shortname}/versions',
+                            model: Models::SpecVersionIndex)
+
+      register.add_endpoint(
+        id: :specification_resource_version_resource,
+        type: :resource,
+        url: '/specifications/{shortname}/versions/{version}',
+        model: Models::SpecVersion
+      )
+      register.add_endpoint(
+        id: :specification_version_predecessors_index,
+        type: :index,
+        url: '/specifications/{shortname}/versions/{version}/predecessors',
+        model: Models::SpecVersionIndex
+      )
+      register.add_endpoint(
+        id: :specification_version_successors_index,
+        type: :index,
+        url: '/specifications/{shortname}/versions/{version}/successors',
+        model: Models::SpecVersionIndex
+      )
+      register.add_endpoint(
+        id: :specification_by_status_index,
+        type: :index,
+        url: '/specifications-by-status/{status}',
+        model: Models::SpecificationIndex
+      )
+      register.add_endpoint(
+        id: :specification_supersedes_index,
+        type: :index,
+        url: '/specifications/{shortname}/supersedes',
+        model: Models::SpecificationIndex
+      )
+      register.add_endpoint(
+        id: :specification_superseded_by_index,
+        type: :index,
+        url: '/specifications/{shortname}/superseded',
+        model: Models::SpecificationIndex
+      )
+      register.add_endpoint(
+        id: :specification_version_editors_index,
+        type: :index,
+        url: '/specifications/{shortname}/version/{version}/editors',
+        model: Models::UserIndex
+      )
+      register.add_endpoint(
+        id: :specification_version_deliverers_index,
+        type: :index,
+        url: '/specifications/{shortname}/version/{version}/deliverers',
+        model: Models::UserIndex
+      )
+
+      # TODO: Why is this endpoint needed? There already is /specifications/{shortname}...
+      # register.add_endpoint(
+      #   id: :specification_by_shortname_index,
+      #   type: :index,
+      #   url: '/specifications-by-shortname/{shortname}',
+      #   model: Models::SpecificationIndex
+      # )
+
+      register.add_endpoint(id: :translation_index, type: :index, url: '/translations', model: Models::TranslationIndex)
+      register.add_endpoint(id: :translation_resource, type: :resource, url: '/translations/{id}',
+                            model: Models::Translation)
+
+      # NOTE: This endpoint doesn't exist, just here for reference.
+      # register.add_endpoint(id: :user_index, type: :index, url: '/users', model: Models::UserIndex)
+
+      register.add_endpoint(id: :user_groups_index, type: :index, url: '/users/{hash}/groups',
+                            model: Models::GroupIndex)
+
+      register.add_endpoint(id: :user_resource, type: :resource, url: '/users/{hash}', model: Models::User)
+
+      register.add_endpoint(id: :user_affiliations_index, type: :index, url: '/users/{hash}/affiliations',
+                            model: Models::AffiliationIndex)
+
+      register.add_endpoint(id: :user_participations_index, type: :index, url: '/users/{hash}/participations',
+                            model: Models::ParticipationIndex)
+
+      register.add_endpoint(id: :user_chair_of_groups_index, type: :index, url: '/users/{hash}/chair-of-groups',
+                            model: Models::GroupIndex)
+
+      register.add_endpoint(id: :user_team_contact_of_groups_index, type: :index, url: '/users/{hash}/team-contact-of-groups',
+                            model: Models::GroupIndex)
+
+      register.add_endpoint(id: :user_specifications_index, type: :index, url: '/users/{hash}/specifications',
+                            model: Models::SpecificationIndex)
+    end
+  end
+end

data/lib/w3c_api/models/account.rb

@@ -0,0 +1,44 @@
+require 'lutaml/hal'
+#         {
+#             "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"
+#                 }
+#             }
+#         }
+
+module W3cApi
+  module Models
+    # User model representing a W3C user/participant
+    class Account < Lutaml::Hal::Resource
+      attribute :created, :date_time
+      attribute :updated, :date_time
+      attribute :identifier, :string
+      attribute :nickname, :string
+      attribute :service, :string
+      attribute :profile_picture, :string
+      attribute :href, :string
+
+      hal_link :user, key: 'user', realize_class: 'User'
+
+      key_value do
+        %i[
+          created
+          updated
+          identifier
+          nickname
+          service
+          profile_picture
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
+        end
+      end
+    end
+  end
+end

data/lib/w3c_api/models/affiliation.rb

@@ -1,27 +1,33 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-
-# Example affiliation response:
+# https://api.w3.org/affiliations/35662
 # {
-#   "id"=>48830,
-#   "name"=>"Postmedia",
-#   "discr"=>"organization",
-#   "is-member"=>false,
-#   "is-member-association"=>false,
-#   "is-partner-member"=>false,
-#   "_links"=>{
-#     "self"=>{
-#       "href"=>"https://api.w3.org/affiliations/48830"
-#     },
-#     "participants"=>{
-#       "href"=>"https://api.w3.org/affiliations/48830/participants"
+#     "id": 35662,
+#     "name": "Google LLC",
+#     "discr": "organization",
+#     "testimonials": {
+#         "en": "Google's mission is to organize the world’s information and make it universally accessible and useful."
 #     },
-#     "participations"=>{
-#       "href"=>"https://api.w3.org/affiliations/48830/participations"
+#     "is-member": true,
+#     "is-member-association": false,
+#     "is-partner-member": false,
+#     "_links": {
+#         "homepage": {
+#             "href": "http://www.google.com/"
+#         },
+#         "self": {
+#             "href": "https://api.w3.org/affiliations/35662"
+#         },
+#         "participants": {
+#             "href": "https://api.w3.org/affiliations/35662/participants"
+#         },
+#         "participations": {
+#             "href": "https://api.w3.org/affiliations/35662/participations"
+#         },
+#         "logo": {
+#             "href": "https://www.w3.org/thumbnails/250/logos/organizations/35662.png?x-version=1"
+#         }
 #     }
-#   }
 # }
 
 # Fetch index response:
@@ -30,57 +36,40 @@ require_relative 'link'
 #   "title"=>"Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)"
 # },
 
+require_relative 'testimonial'
 
 module W3cApi
-    module Models
-      class AffiliationLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :participants, Link
-        attribute :participations, Link
-      end
-
-      class Affiliation < Base
-        attribute :id, :integer
-        attribute :name, :string
-        attribute :href, :string
-        attribute :title, :string
-        attribute :descr, :string
-        attribute :is_member, :boolean
-        attribute :is_member_association, :boolean
-        attribute :is_partner_member, :boolean
-        attribute :_links, AffiliationLinks
-
-        # Get participants of this affiliation
-        def participants(client = nil)
-          return nil unless client && _links&.participants
-
-          client.affiliation_participants(id)
-        end
-
-        # Get participations of this affiliation
-        def participations(client = nil)
-          return nil unless client && _links&.participations
-
-          client.affiliation_participations(id)
-        end
+  module Models
+    class Affiliation < Lutaml::Hal::Resource
+      attribute :id, :integer
+      attribute :name, :string
+      attribute :href, :string
+      attribute :title, :string
+      attribute :discr, :string
+      attribute :testimonials, Testimonial
+      attribute :is_member, :boolean
+      attribute :is_member_association, :boolean
+      attribute :is_partner_member, :boolean
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'Affiliation'
+      hal_link :homepage, key: 'homepage', realize_class: 'String'
+      hal_link :participants, key: 'participants', realize_class: 'Participant'
+      hal_link :participations, key: 'participations', realize_class: 'Participation'
+      hal_link :logo, key: 'logo', realize_class: 'String'
 
-          affiliation = 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
-              affiliation._links = AffiliationLinks.new(links)
-            else
-              affiliation.send("#{key}=", value) if affiliation.respond_to?("#{key}=")
-            end
-          end
-          affiliation
+      key_value do
+        %i[
+          id
+          name
+          discr
+          testimonials
+          is_member
+          is_member_association
+          is_partner_member
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/affiliation_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'affiliation'
+
+module W3cApi
+  module Models
+    class AffiliationIndex < Lutaml::Hal::Page
+      hal_link :affiliations, key: 'affiliations', realize_class: 'Affiliation', collection: true
+    end
+  end
+end

data/lib/w3c_api/models/call_for_translation.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'base'
-require_relative 'link'
-require_relative 'spec_version_ref'
-
 # {
 #     "uri": "https://www.w3.org/WAI/videos/standards-and-benefits/"
 #     "title": "Video Introduction to Web Accessibility and W3C Standards"
@@ -18,42 +14,22 @@ require_relative 'spec_version_ref'
 # }
 
 module W3cApi
-    module Models
-      class CallForTranslationLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :translations, Link
-      end
-
-      class CallForTranslation < Base
-        attribute :uri, :string
-        attribute :title, :string
-        attribute :spec_version, SpecVersionRef
-        attribute :_links, CallForTranslationLinks
-
-        # Get translations for this call for translation
-        def translations(client = nil)
-          return nil unless client && _links&.translations
-
-          client.call_for_translation_translations(uri)
-        end
-
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
-
-          cft = 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
-              cft._links = CallForTranslationLinks.new(links)
-            else
-              cft.send("#{key}=", value) if cft.respond_to?("#{key}=")
-            end
-          end
-          cft
+  module Models
+    class CallForTranslation < Lutaml::Hal::Resource
+      attribute :uri, :string
+      attribute :title, :string
+
+      hal_link :self, key: 'self', realize_class: 'CallForTranslation'
+      hal_link :translations, key: 'translations', realize_class: 'TranslationIndex'
+
+      key_value do
+        %i[
+          uri
+          title
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/chair_index.rb

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

data/lib/w3c_api/models/charter.rb

@@ -1,110 +1,69 @@
 # frozen_string_literal: true
 
-require_relative 'base'
 require_relative 'extension'
-require_relative 'link'
 
-# Example charter response format - specific fields may vary by group:
+# https://api.w3.org/groups/109735/charters/361
 # {
-#     "end": "2025-10-31"
-#     "title": "Accessibility Guidelines Working Group Charter"
-#     "start": "1997-10-06"
-#     "initial_end": "1999-10-06"
-#     "uri": "https://www.w3.org/2022/05/accessibility-guidelines-wg-charter.html"
-#     "cfp_uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/..."
-#     "extensions": [...]
-#     "required_new_commitments": false
-#     "patent_policy": "pre-2020"
+#     "end": "2020-04-30",
+#     "doc-licenses": [],
+#     "start": "2018-09-24",
+#     "initial-end": "2020-03-01",
+#     "uri": "https://www.w3.org/2018/09/immersive-web-wg-charter.html",
+#     "cfp-uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/2018JulSep/0053.html",
+#     "extensions": [
+#         {
+#             "end": "2020-04-30",
+#             "announcement_uri": "https://lists.w3.org/Archives/Member/w3c-ac-members/2020JanMar/0028.html"
+#         }
+#     ],
+#     "required-new-commitments": true,
+#     "patent-policy": "https://www.w3.org/Consortium/Patent-Policy-20170801/",
 #     "_links": {
 #         "self": {
-#             "href": "https://api.w3.org/groups/wg/ag/charters/492"
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters/361"
 #         },
 #         "group": {
-#             "href": "https://api.w3.org/groups/wg/ag"
+#             "href": "https://api.w3.org/groups/wg/immersive-web",
+#             "title": "Immersive Web Working Group"
+#         },
+#         "next-charter": {
+#             "href": "https://api.w3.org/groups/wg/immersive-web/charters/405"
 #         }
 #     }
 # }
 
 module W3cApi
-    module Models
-      class CharterLinks < Lutaml::Model::Serializable
-        attribute :self, Link
-        attribute :group, Link
-      end
-
-      class Charter < Base
-        attribute :end, :string # Date-time format
-        attribute :href, :string
-        attribute :title, :string
-        attribute :start, :string # Date-time format
-        attribute :initial_end, :string # Date-time format
-        attribute :uri, :string, pattern: %r{https?://www\.w3\.org.*}
-        attribute :cfp_uri, :string, pattern: %r{https://lists\.w3\.org/Archives/Member/w3c-ac-members/.*}
-        attribute :extensions, Extension, collection: true
-        attribute :required_new_commitments, :boolean
-        attribute :patent_policy, :string
-        attribute :_links, CharterLinks
-
-        # Return the group this charter belongs to
-        def group(client = nil)
-          return nil unless client && _links&.group
-
-          group_href = _links.group.href
-          group_id = group_href.split('/').last
-
-          client.group(group_id)
-        end
-
-        # Parse date strings to Date objects
-        def end_date
-          Date.parse(self.end) if self.end
-        rescue Date::Error
-          nil
-        end
-
-        def start_date
-          Date.parse(start) if start
-        rescue Date::Error
-          nil
-        end
-
-        def initial_end_date
-          Date.parse(initial_end) if initial_end
-        rescue Date::Error
-          nil
-        end
-
-        # Check if this charter is active
-        def active?
-          start_date &&
-            (end_date.nil? || end_date >= Date.today) &&
-            start_date <= Date.today
-        rescue Date::Error
-          false
-        end
-
-        # Check if this charter has been extended
-        def extended?
-          !extensions.nil? && !extensions.empty?
-        end
+  module Models
+    class Charter < Lutaml::Hal::Resource
+      attribute :end, :date_time
+      attribute :doc_licenses, :string, collection: true
+      attribute :start, :date_time
+      attribute :initial_end, :date_time
+      attribute :uri, :string
+      attribute :cfp_uri, :string
+      attribute :extensions, Extension, collection: true
+      attribute :required_new_commitments, :boolean
+      attribute :patent_policy, :string
 
-        def self.from_response(response)
-          transformed_response = transform_keys(response)
+      hal_link :self, key: 'self', realize_class: 'Charter'
+      hal_link :group, key: 'group', realize_class: 'Group'
+      hal_link :next_charter, key: 'next-charter', realize_class: 'Charter'
 
-          charter = 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
-              charter._links = CharterLinks.new(links)
-            else
-              charter.send("#{key}=", value) if charter.respond_to?("#{key}=")
-            end
+      key_value do
+        %i[
           end
-          charter
+          doc_licenses
+          start
+          initial_end
+          uri
+          cfp_uri
+          extensions
+          required_new_commitments
+          patent_policy
+        ].each do |key|
+          map key.to_s.tr('_', '-'), to: key
         end
       end
     end
+  end
 end

data/lib/w3c_api/models/charter_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'charter'
+
+module W3cApi
+  module Models
+    class CharterIndex < Lutaml::Hal::Page
+      hal_link :charters, key: 'charters', realize_class: 'Charter', collection: true
+    end
+  end
+end