w3c_api 0.1.4 → 0.1.5

data/lib/w3c_api/hal.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require 'lutaml/hal'
-require_relative 'models'
+require "singleton"
+require "lutaml/hal"
+require_relative "models"
 
 module W3cApi
   # Simple parameter class to satisfy lutaml-hal validation requirements
@@ -18,7 +18,10 @@ module W3cApi
 
     def validate!
       # Simple validation - just ensure name is present
-      raise ArgumentError, 'Parameter name cannot be empty' if @name.nil? || @name.empty?
+      if @name.nil? || @name.empty?
+        raise ArgumentError,
+              "Parameter name cannot be empty"
+      end
     end
 
     def path_parameter?
@@ -38,14 +41,45 @@ module W3cApi
   class Hal
     include Singleton
 
-    API_URL = 'https://api.w3.org/'
+    API_URL = "https://api.w3.org/"
 
     def initialize
       # Don't call setup here - it will be called when register is first accessed
     end
 
     def client
-      @client ||= Lutaml::Hal::Client.new(api_url: API_URL)
+      @client ||= Lutaml::Hal::Client.new(
+        api_url: API_URL,
+        rate_limiting: rate_limiting_options,
+      )
+    end
+
+    # Configure rate limiting options
+    def rate_limiting_options
+      @rate_limiting_options ||= {
+        enabled: true,
+        max_retries: 3,
+        base_delay: 1.0,
+        max_delay: 60.0,
+        backoff_factor: 2.0,
+      }
+    end
+
+    # Set rate limiting options
+    def configure_rate_limiting(options = {})
+      @rate_limiting_options = rate_limiting_options.merge(options)
+      # Reset client to pick up new options
+      @client = nil
+    end
+
+    # Disable rate limiting
+    def disable_rate_limiting
+      configure_rate_limiting(enabled: false)
+    end
+
+    # Enable rate limiting
+    def enable_rate_limiting
+      configure_rate_limiting(enabled: true)
     end
 
     def register
@@ -69,15 +103,15 @@ module W3cApi
     # Common pagination parameters (simplified without EndpointParameter)
     def pagination_parameters
       [
-        SimpleParameter.new('page', location: :query),
-        SimpleParameter.new('items', location: :query)
+        SimpleParameter.new("page", location: :query),
+        SimpleParameter.new("items", location: :query),
       ]
     end
 
     # Parameters for endpoints with embed support (simplified without EndpointParameter)
     def embed_parameters
       [
-        SimpleParameter.new('embed', location: :query)
+        SimpleParameter.new("embed", location: :query),
       ] + pagination_parameters
     end
 
@@ -101,7 +135,7 @@ module W3cApi
         type: :index,
         url: url,
         model: model,
-        parameters: parameters
+        parameters: parameters,
       )
     end
 
@@ -112,19 +146,20 @@ module W3cApi
         type: :resource,
         url: url,
         model: model,
-        parameters: parameters
+        parameters: parameters,
       )
     end
 
     # Helper method to add endpoints with path parameters
-    def add_endpoint_with_path_params(id, type, url, model, path_params = [], query_params = [])
+    def add_endpoint_with_path_params(id, type, url, model, path_params = [],
+query_params = [])
       parameters = (path_params + query_params).compact
       register.add_endpoint(
         id: id,
         type: type,
         url: url,
         model: model,
-        parameters: parameters
+        parameters: parameters,
       )
     end
 
@@ -132,94 +167,94 @@ module W3cApi
       # Specification endpoints with embed support
       add_index_endpoint(
         :specification_index,
-        '/specifications',
+        "/specifications",
         Models::SpecificationIndex,
-        embed_parameters
+        embed_parameters,
       )
 
       # Specification by status endpoint
       add_endpoint_with_path_params(
         :specification_by_status_index,
         :index,
-        '/specifications',
+        "/specifications",
         Models::SpecificationIndex,
         [],
-        [string_query_param('status', required: true)] + pagination_parameters
+        [string_query_param("status", required: true)] + pagination_parameters,
       )
       add_endpoint_with_path_params(
         :specification_resource,
         :resource,
-        '/specifications/{shortname}',
+        "/specifications/{shortname}",
         Models::Specification,
-        [string_path_param('shortname')]
+        [string_path_param("shortname")],
       )
 
       # Specification version endpoints
       add_endpoint_with_path_params(
         :specification_resource_version_index,
         :index,
-        '/specifications/{shortname}/versions',
+        "/specifications/{shortname}/versions",
         Models::SpecVersionIndex,
-        [string_path_param('shortname')],
-        pagination_parameters
+        [string_path_param("shortname")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :specification_resource_version_resource,
         :resource,
-        '/specifications/{shortname}/versions/{version}',
+        "/specifications/{shortname}/versions/{version}",
         Models::SpecVersion,
         [
-          string_path_param('shortname'),
-          string_path_param('version')
-        ]
+          string_path_param("shortname"),
+          string_path_param("version"),
+        ],
       )
 
       # Specification version editors and deliverers
       add_endpoint_with_path_params(
         :specification_version_editors_index,
         :index,
-        '/specifications/{shortname}/versions/{version}/editors',
+        "/specifications/{shortname}/versions/{version}/editors",
         Models::EditorIndex,
         [
-          string_path_param('shortname'),
-          string_path_param('version')
+          string_path_param("shortname"),
+          string_path_param("version"),
         ],
-        pagination_parameters
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :specification_version_deliverers_index,
         :index,
-        '/specifications/{shortname}/versions/{version}/deliverers',
+        "/specifications/{shortname}/versions/{version}/deliverers",
         Models::DelivererIndex,
         [
-          string_path_param('shortname'),
-          string_path_param('version')
+          string_path_param("shortname"),
+          string_path_param("version"),
         ],
-        pagination_parameters
+        pagination_parameters,
       )
 
       # Specification version predecessors and successors
       add_endpoint_with_path_params(
         :specification_version_predecessors_index,
         :index,
-        '/specifications/{shortname}/versions/{version}/predecessors',
+        "/specifications/{shortname}/versions/{version}/predecessors",
         Models::SpecVersionPredecessorIndex,
         [
-          string_path_param('shortname'),
-          string_path_param('version')
+          string_path_param("shortname"),
+          string_path_param("version"),
         ],
-        pagination_parameters
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :specification_version_successors_index,
         :index,
-        '/specifications/{shortname}/versions/{version}/successors',
+        "/specifications/{shortname}/versions/{version}/successors",
         Models::SpecVersionSuccessorIndex,
         [
-          string_path_param('shortname'),
-          string_path_param('version')
+          string_path_param("shortname"),
+          string_path_param("version"),
         ],
-        pagination_parameters
+        pagination_parameters,
       )
 
       # Specification related endpoints
@@ -228,9 +263,9 @@ module W3cApi
           :"specification_#{relation}_index",
           :index,
           "/specifications/{shortname}/#{relation.tr('_', '-')}",
-          relation.include?('editor') ? Models::UserIndex : Models::GroupIndex,
-          [string_path_param('shortname')],
-          pagination_parameters
+          relation.include?("editor") ? Models::UserIndex : Models::GroupIndex,
+          [string_path_param("shortname")],
+          pagination_parameters,
         )
       end
 
@@ -245,120 +280,120 @@ module W3cApi
       # Series endpoints with embed support
       add_index_endpoint(
         :serie_index,
-        '/specification-series',
+        "/specification-series",
         Models::SerieIndex,
-        embed_parameters
+        embed_parameters,
       )
       add_endpoint_with_path_params(
         :serie_resource,
         :resource,
-        '/specification-series/{shortname}',
+        "/specification-series/{shortname}",
         Models::Serie,
-        [string_path_param('shortname')]
+        [string_path_param("shortname")],
       )
       add_endpoint_with_path_params(
         :serie_specification_resource,
         :index,
-        '/specification-series/{shortname}/specifications',
+        "/specification-series/{shortname}/specifications",
         Models::SpecificationIndex,
-        [string_path_param('shortname')],
-        pagination_parameters
+        [string_path_param("shortname")],
+        pagination_parameters,
       )
 
       # Group endpoints with embed support
       add_index_endpoint(
         :group_index,
-        '/groups',
+        "/groups",
         Models::GroupIndex,
-        embed_parameters
+        embed_parameters,
       )
       add_endpoint_with_path_params(
         :group_resource,
         :resource,
-        '/groups/{id}',
+        "/groups/{id}",
         Models::Group,
-        [integer_path_param('id')]
+        [integer_path_param("id")],
       )
       add_endpoint_with_path_params(
         :group_by_type_shortname_resource,
         :resource,
-        '/groups/{type}/{shortname}',
+        "/groups/{type}/{shortname}",
         Models::Group,
         [
-          string_path_param('type'),
-          string_path_param('shortname')
-        ]
+          string_path_param("type"),
+          string_path_param("shortname"),
+        ],
       )
       add_endpoint_with_path_params(
         :group_by_type_index,
         :index,
-        '/groups/{type}',
+        "/groups/{type}",
         Models::GroupIndex,
-        [string_path_param('type')],
-        pagination_parameters
+        [string_path_param("type")],
+        pagination_parameters,
       )
       # Group nested endpoints
       add_endpoint_with_path_params(
         :group_specifications_index,
         :index,
-        '/groups/{id}/specifications',
+        "/groups/{id}/specifications",
         Models::SpecificationIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :group_users_index,
         :index,
-        '/groups/{id}/users',
+        "/groups/{id}/users",
         Models::UserIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :group_charters_index,
         :index,
-        '/groups/{id}/charters',
+        "/groups/{id}/charters",
         Models::CharterIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :group_chairs_index,
         :index,
-        '/groups/{id}/chairs',
+        "/groups/{id}/chairs",
         Models::ChairIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :group_team_contacts_index,
         :index,
-        '/groups/{id}/teamcontacts',
+        "/groups/{id}/teamcontacts",
         Models::TeamContactIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :group_participations_index,
         :index,
-        '/groups/{id}/participations',
+        "/groups/{id}/participations",
         Models::ParticipationIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
 
       # Translation endpoints
       add_index_endpoint(
         :translation_index,
-        '/translations',
-        Models::TranslationIndex
+        "/translations",
+        Models::TranslationIndex,
       )
       add_endpoint_with_path_params(
         :translation_resource,
         :resource,
-        '/translations/{id}',
+        "/translations/{id}",
         Models::Translation,
-        [integer_path_param('id')]
+        [integer_path_param("id")],
       )
 
       # User endpoints
@@ -372,148 +407,148 @@ module W3cApi
       add_endpoint_with_path_params(
         :user_resource,
         :resource,
-        '/users/{hash}',
+        "/users/{hash}",
         Models::User,
-        [string_path_param('hash')]
+        [string_path_param("hash")],
       )
 
       # User nested endpoints
       add_endpoint_with_path_params(
         :user_groups_index,
         :index,
-        '/users/{hash}/groups',
+        "/users/{hash}/groups",
         Models::GroupIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :user_affiliations_index,
         :index,
-        '/users/{hash}/affiliations',
+        "/users/{hash}/affiliations",
         Models::AffiliationIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :user_participations_index,
         :index,
-        '/users/{hash}/participations',
+        "/users/{hash}/participations",
         Models::ParticipationIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :user_chair_of_groups_index,
         :index,
-        '/users/{hash}/chair-of-groups',
+        "/users/{hash}/chair-of-groups",
         Models::GroupIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :user_team_contact_of_groups_index,
         :index,
-        '/users/{hash}/team-contact-of-groups',
+        "/users/{hash}/team-contact-of-groups",
         Models::GroupIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :user_specifications_index,
         :index,
-        '/users/{hash}/specifications',
+        "/users/{hash}/specifications",
         Models::SpecificationIndex,
-        [string_path_param('hash')],
-        pagination_parameters
+        [string_path_param("hash")],
+        pagination_parameters,
       )
 
       # Affiliation endpoints
       add_index_endpoint(
         :affiliation_index,
-        '/affiliations',
-        Models::AffiliationIndex
+        "/affiliations",
+        Models::AffiliationIndex,
       )
       add_endpoint_with_path_params(
         :affiliation_resource,
         :resource,
-        '/affiliations/{id}',
+        "/affiliations/{id}",
         Models::Affiliation,
-        [integer_path_param('id')]
+        [integer_path_param("id")],
       )
 
       # Affiliation nested endpoints
       add_endpoint_with_path_params(
         :affiliation_participants_index,
         :index,
-        '/affiliations/{id}/participants',
+        "/affiliations/{id}/participants",
         Models::ParticipantIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :affiliation_participations_index,
         :index,
-        '/affiliations/{id}/participations',
+        "/affiliations/{id}/participations",
         Models::ParticipationIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
 
       # Ecosystem endpoints
       add_index_endpoint(
         :ecosystem_index,
-        '/ecosystems',
-        Models::EcosystemIndex
+        "/ecosystems",
+        Models::EcosystemIndex,
       )
       add_endpoint_with_path_params(
         :ecosystem_resource,
         :resource,
-        '/ecosystems/{shortname}',
+        "/ecosystems/{shortname}",
         Models::Ecosystem,
-        [string_path_param('shortname')]
+        [string_path_param("shortname")],
       )
 
       # Ecosystem nested endpoints
       add_endpoint_with_path_params(
         :ecosystem_groups_index,
         :index,
-        '/ecosystems/{shortname}/groups',
+        "/ecosystems/{shortname}/groups",
         Models::GroupIndex,
-        [string_path_param('shortname')],
-        pagination_parameters
+        [string_path_param("shortname")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :ecosystem_evangelists_index,
         :index,
-        '/ecosystems/{shortname}/evangelists',
+        "/ecosystems/{shortname}/evangelists",
         Models::EvangelistIndex,
-        [string_path_param('shortname')],
-        pagination_parameters
+        [string_path_param("shortname")],
+        pagination_parameters,
       )
       add_endpoint_with_path_params(
         :ecosystem_member_organizations_index,
         :index,
-        '/ecosystems/{shortname}/member-organizations',
+        "/ecosystems/{shortname}/member-organizations",
         Models::AffiliationIndex,
-        [string_path_param('shortname')],
-        pagination_parameters
+        [string_path_param("shortname")],
+        pagination_parameters,
       )
 
       # Participation endpoints
       add_endpoint_with_path_params(
         :participation_resource,
         :resource,
-        '/participations/{id}',
+        "/participations/{id}",
         Models::Participation,
-        [integer_path_param('id')]
+        [integer_path_param("id")],
       )
       add_endpoint_with_path_params(
         :participation_participants_index,
         :index,
-        '/participations/{id}/participants',
+        "/participations/{id}/participants",
         Models::ParticipantIndex,
-        [integer_path_param('id')],
-        pagination_parameters
+        [integer_path_param("id")],
+        pagination_parameters,
       )
     end
   end

data/lib/w3c_api/models/account.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'lutaml/hal'
+require "lutaml/hal"
 #         {
 #             "created": "2021-03-12T22:06:06+00:00",
 #             "service": "github",
@@ -27,7 +27,7 @@ module W3cApi
       attribute :profile_picture, :string
       attribute :href, :string
 
-      hal_link :user, key: 'user', realize_class: 'User'
+      hal_link :user, key: "user", realize_class: "User"
 
       key_value do
         %i[
@@ -38,7 +38,7 @@ module W3cApi
           service
           profile_picture
         ].each do |key|
-          map key.to_s.tr('_', '-'), to: key
+          map key.to_s.tr("_", "-"), to: key
         end
       end
     end

data/lib/w3c_api/models/affiliation.rb

@@ -36,7 +36,7 @@
 #   "title"=>"Framkom (Forskningsaktiebolaget Medie-och Kommunikationsteknik)"
 # },
 
-require_relative 'testimonial'
+require_relative "testimonial"
 
 module W3cApi
   module Models
@@ -51,11 +51,12 @@ module W3cApi
       attribute :is_member_association, :boolean
       attribute :is_partner_member, :boolean
 
-      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'
+      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"
 
       key_value do
         %i[
@@ -67,7 +68,7 @@ module W3cApi
           is_member_association
           is_partner_member
         ].each do |key|
-          map key.to_s.tr('_', '-'), to: key
+          map key.to_s.tr("_", "-"), to: key
         end
       end