w3c_api 0.1.0 → 0.1.2

data/lib/w3c_api/hal.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require_relative 'models'
+
+module W3cApi
+  class Hal
+    include Singleton
+
+    API_URL = 'https://api.w3.org/'
+
+    def initialize
+      setup
+    end
+
+    def client
+      @client ||= Lutaml::Hal::Client.new(api_url: API_URL)
+    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
+
+    private
+
+    # Common pagination query parameters
+    PAGINATION_PARAMS = { 'page' => '{page}',
+                          'items' => '{items}' }.freeze
+
+    # Helper method to add index endpoints with pagination
+    def add_index_endpoint(id, url, model, query_params = PAGINATION_PARAMS)
+      register.add_endpoint(
+        id: id,
+        type: :index,
+        url: url,
+        model: model,
+        query_params: query_params
+      )
+    end
+
+    # Helper method to add resource endpoints
+    def add_resource_endpoint(id, url, model)
+      register.add_endpoint(id: id, type: :resource, url: url, model: model)
+    end
+
+    # Helper method to add nested index endpoints for a parent resource
+    def add_nested_index_endpoints(parent, parent_id_param, nested_configs)
+      nested_configs.each do |config|
+        # Convert plural parent to singular for endpoint naming
+        singular_parent = parent.end_with?('s') ? parent[0..-2] : parent
+        id = "#{singular_parent}_#{config[:name]}_index".to_sym
+        url = "/#{parent}/#{parent_id_param}/#{config[:path]}"
+        add_index_endpoint(id, url, config[:model])
+      end
+    end
+
+    def setup
+      # Affiliation endpoints
+      add_index_endpoint(
+        :affiliation_index,
+        '/affiliations',
+        Models::AffiliationIndex
+      )
+      add_resource_endpoint(
+        :affiliation_resource,
+        '/affiliations/{id}',
+        Models::Affiliation
+      )
+      add_index_endpoint(
+        :affiliation_participants_index,
+        '/affiliations/{id}/participants',
+        Models::ParticipantIndex
+      )
+      add_index_endpoint(
+        :affiliation_participations_index,
+        '/affiliations/{id}/participations',
+        Models::ParticipationIndex
+      )
+
+      # register.add_endpoint(
+      #   id: :charter_resource,
+      #   type: :resource,
+      #   url: '/charters/{id}',
+      #   model: Models::Charter
+      # )
+
+      # Ecosystem endpoints
+      add_index_endpoint(
+        :ecosystem_index,
+        '/ecosystems',
+        Models::EcosystemIndex
+      )
+      add_resource_endpoint(
+        :ecosystem_resource,
+        '/ecosystems/{id}',
+        Models::Ecosystem
+      )
+      add_index_endpoint(
+        :ecosystem_evangelists_index,
+        '/ecosystems/{shortname}/evangelists',
+        Models::EvangelistIndex
+      )
+      add_index_endpoint(
+        :ecosystem_groups_index,
+        '/ecosystems/{shortname}/groups',
+        Models::GroupIndex
+      )
+      add_index_endpoint(
+        :ecosystem_member_organizations_index,
+        '/ecosystems/{shortname}/member-organizations',
+        Models::AffiliationIndex
+      )
+
+      # Group endpoints
+      add_index_endpoint(
+        :group_index,
+        '/groups',
+        Models::GroupIndex
+      )
+      add_resource_endpoint(
+        :group_resource,
+        '/groups/{id}',
+        Models::Group
+      )
+      add_nested_index_endpoints(
+        'groups',
+        '{id}', [
+          { name: 'specifications', path: 'specifications',
+            model: Models::SpecificationIndex },
+          { name: 'charters', path: 'charters',
+            model: Models::CharterIndex },
+          { name: 'users', path: 'users',
+            model: Models::UserIndex },
+          { name: 'chairs', path: 'chairs',
+            model: Models::ChairIndex },
+          { name: 'team_contacts', path: 'teamcontacts',
+            model: Models::TeamContactIndex },
+          { name: 'participations', path: 'participations',
+            model: Models::ParticipationIndex }
+        ]
+      )
+
+      # Participation endpoints
+      # register.add_endpoint(
+      #   id: :participation_index,
+      #   type: :index,
+      #   url: '/participations',
+      #   model: Models::ParticipationIndex
+      # )
+
+      add_resource_endpoint(
+        :participation_resource,
+        '/participations/{id}',
+        Models::Participation
+      )
+      add_index_endpoint(
+        :participation_participants_index,
+        '/participations/{id}/participants',
+        Models::ParticipantIndex
+      )
+
+      # Serie endpoints
+      add_index_endpoint(
+        :serie_index,
+        '/specification-series',
+        Models::SerieIndex
+      )
+      add_resource_endpoint(
+        :serie_resource,
+        '/specification-series/{shortname}',
+        Models::Serie
+      )
+      add_index_endpoint(
+        :serie_specification_resource,
+        '/specification-series/{shortname}/specifications',
+        Models::SpecificationIndex
+      )
+
+      # Specification endpoints
+      add_index_endpoint(
+        :specification_index,
+        '/specifications',
+        Models::SpecificationIndex
+      )
+      add_resource_endpoint(
+        :specification_resource,
+        '/specifications/{shortname}',
+        Models::Specification
+      )
+      add_index_endpoint(
+        :specification_resource_version_index,
+        '/specifications/{shortname}/versions',
+        Models::SpecVersionIndex
+      )
+      add_resource_endpoint(
+        :specification_resource_version_resource,
+        '/specifications/{shortname}/versions/{version}',
+        Models::SpecVersion
+      )
+      add_index_endpoint(
+        :specification_version_predecessors_index,
+        '/specifications/{shortname}/versions/{version}/predecessors',
+        Models::SpecVersionIndex
+      )
+      add_index_endpoint(
+        :specification_version_successors_index,
+        '/specifications/{shortname}/versions/{version}/successors',
+        Models::SpecVersionIndex
+      )
+      add_index_endpoint(
+        :specification_by_status_index,
+        '/specifications-by-status/{status}',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_supersedes_index,
+        '/specifications/{shortname}/supersedes',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_superseded_by_index,
+        '/specifications/{shortname}/superseded',
+        Models::SpecificationIndex
+      )
+      add_index_endpoint(
+        :specification_version_editors_index,
+        '/specifications/{shortname}/version/{version}/editors',
+        Models::UserIndex
+      )
+      add_index_endpoint(
+        :specification_version_deliverers_index,
+        '/specifications/{shortname}/version/{version}/deliverers',
+        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
+      # )
+
+      # Translation endpoints
+      add_index_endpoint(
+        :translation_index,
+        '/translations',
+        Models::TranslationIndex
+      )
+      add_resource_endpoint(
+        :translation_resource,
+        '/translations/{id}',
+        Models::Translation
+      )
+
+      # User endpoints
+      # NOTE: This endpoint doesn't exist, just here for reference.
+      # register.add_endpoint(
+      #   id: :user_index,
+      #   type: :index,
+      #   url: '/users',
+      #   model: Models::UserIndex
+      # )
+      add_resource_endpoint(
+        :user_resource,
+        '/users/{hash}',
+        Models::User
+      )
+      add_nested_index_endpoints(
+        'users',
+        '{hash}', [
+          { name: 'groups', path: 'groups',
+            model: Models::GroupIndex },
+          { name: 'affiliations', path: 'affiliations',
+            model: Models::AffiliationIndex },
+          { name: 'participations', path: 'participations',
+            model: Models::ParticipationIndex },
+          { name: 'chair_of_groups', path: 'chair-of-groups',
+            model: Models::GroupIndex },
+          { name: 'team_contact_of_groups', path: 'team-contact-of-groups',
+            model: Models::GroupIndex },
+          { name: 'specifications', path: 'specifications',
+            model: Models::SpecificationIndex }
+        ]
+      )
+    end
+  end
+end

data/lib/w3c_api/models/account.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+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