haveapi 0.29.2 → 0.29.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de67ba481b9c0e88a56b07403e1979e24558ee8f52f3c1eb9d720faa442a62b
-  data.tar.gz: 1d3d0d435612eceeba75ec9973082f7eeca6fd8f7c5010197cb324edd606c843
+  metadata.gz: 885ac3cc2e4b40ee6595f9beadad79e75f371d607dd0d49d02f67a01cece7d7f
+  data.tar.gz: 8c8b186ae1299655f952bedf5cd857042df97b060a0fda7e43ef6b9bc0ec6393
 SHA512:
-  metadata.gz: 40fcf28b778528046eab97d60034de89210b41c3e7977f12d622c0b8248bc89c231663eb355b5284693db781a3f25887c719ec6ca76effbfb604a10a914762e2
-  data.tar.gz: 7cd757b4ff23dfdd3dbe5efd732ceb23c6adb1bc763ed117de84687ee5c23652a7e71332e7f8762b94eca198b5b5cdbd76a2cf2f5698b876b9032343b98e1fab
+  metadata.gz: 8b3cd3b9dabb84f88119dde487b150ea6694ab76450d24df1c8f7ff9309b5fcb91638d58f4794db0236de5d8a81c01693c3a5adfc9665200bdb24915599d131e
+  data.tar.gz: c738c43d4cc3437124e9af50cd1ae70c84d3f5a91cb93f4c6d1b0966257e011f438f8ecf36639ba0da5044b0b06aa5c8b6072dce4793d4546df424ebdc50a1a9

data/haveapi.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= #{File.read('../../.ruby-version').strip}"
 
   s.add_dependency 'activesupport', '>= 7.1'
-  s.add_dependency 'haveapi-client', '~> 0.29.2'
+  s.add_dependency 'haveapi-client', '~> 0.29.3'
   s.add_dependency 'i18n', '>= 1.6', '< 2'
   s.add_dependency 'json'
   s.add_dependency 'mail'

data/lib/haveapi/authentication/basic/provider.rb

@@ -38,8 +38,7 @@ module HaveAPI::Authentication
 
       def describe
         {
-          description: 'Authentication using HTTP basic. Username and password is passed ' \
-                       'via HTTP header. Its use is forbidden from web browsers.'
+          description: HaveAPI.message('haveapi.authentication.basic.description')
         }
       end
 

data/lib/haveapi/authentication/chain.rb

@@ -54,7 +54,7 @@ module HaveAPI::Authentication
       return ret unless @instances[context.version]
 
       @instances[context.version].each do |provider|
-        ret[provider.name] = provider.describe
+        ret[provider.name] = HaveAPI.localize(provider.describe)
 
         next unless provider.resource_module
 

data/lib/haveapi/authentication/oauth2/provider.rb

@@ -150,24 +150,8 @@ module HaveAPI::Authentication
       end
 
       def describe
-        desc = <<-END
-        OAuth2 authorization provider. While OAuth2 support in HaveAPI clients
-        is limited, it is possible to use your API as an authentication source
-        and to use OAuth2 tokens to access the API.
-
-        HaveAPI partially implements RFC 6749: authorization response type "code"
-        and token grant types "authorization_code" and "refresh_token". Other
-        response and grant types are not supported at this time.
-
-        The access token can be passed as bearer token according to RFC 6750,
-        or using a custom HTTP header when the Authorization header is not
-        practical.
-
-        The access and refresh tokens can be revoked as per RFC 7009.
-        END
-
         {
-          description: desc,
+          description: HaveAPI.message('haveapi.authentication.oauth2.description'),
           http_header: config.http_header,
           authorize_url: @authorize_url,
           authorize_path: @authorize_path,

data/lib/haveapi/authentication/token/provider.rb

@@ -185,7 +185,7 @@ module HaveAPI::Authentication
         {
           http_header: config.class.http_header,
           query_parameter: config.class.query_parameter,
-          description: 'The client authenticates with credentials, usually username and password, and gets a token. From this point, the credentials can be forgotten and the token is used instead. Tokens can have different lifetimes, can be renewed and revoked. The token is passed either via HTTP header or query parameter.'
+          description: HaveAPI.message('haveapi.authentication.token.description')
         }
       end
 
@@ -203,12 +203,16 @@ module HaveAPI::Authentication
         provider = self
 
         HaveAPI::Resource.define_resource(:Token) do
+          desc HaveAPI.message('haveapi.authentication.token.resource.description')
+
           define_singleton_method(:token_instance) { provider }
 
           auth false
           version :all
 
           define_action(:Request) do
+            desc HaveAPI.message('haveapi.authentication.token.actions.request.description')
+
             route ''
             http_method :post
 
@@ -275,6 +279,8 @@ module HaveAPI::Authentication
           end
 
           define_action(:Revoke) do
+            desc HaveAPI.message('haveapi.authentication.token.actions.revoke.description')
+
             http_method :post
             auth true
 
@@ -318,6 +324,8 @@ module HaveAPI::Authentication
           end
 
           define_action(:Renew) do
+            desc HaveAPI.message('haveapi.authentication.token.actions.renew.description')
+
             http_method :post
             auth true
 

data/lib/haveapi/locales/cs.yml

@@ -5,33 +5,57 @@
 cs:
   haveapi:
     action_state:
-      cancellation_failed: zrušení selhalo
-      not_found: stav akce nebyl nalezen
-      timeout_max: timeout může být nejvýše %{max}
+      cancellation_failed: Zrušení akce se nezdařilo
+      not_found: Stav akce nebyl nalezen
+      timeout_max: Časový limit může být nejvýše %{max}
     authentication:
-      failed: přihlášení selhalo
-      invalid_credentials: neplatné přihlašovací údaje
-      multiple_oauth2_tokens: Bylo poskytnuto více OAuth2 tokenů
-      multiple_tokens: Bylo poskytnuto více ověřovacích tokenů
-      renew_failed: obnovení selhalo
-      required: Akce vyžaduje přihlášení uživatele
-      revoke_failed: zrušení selhalo
-      token_required: Akce vyžaduje přihlášení uživatele tokenem
+      basic:
+        description: |-
+          Autentizace pomocí HTTP Basic. Uživatelské jméno a heslo se předávají v HTTP hlavičce.
+          Tato metoda se nesmí používat z webových prohlížečů.
+      failed: Přihlášení se nezdařilo
+      invalid_credentials: Neplatné přihlašovací údaje
+      multiple_oauth2_tokens: Bylo zadáno více OAuth2 tokenů
+      multiple_tokens: Bylo zadáno více autentizačních tokenů
+      oauth2:
+        description: |-
+          OAuth2 autorizační provider.
+          Podpora OAuth2 v klientech HaveAPI je omezená, ale API lze použít jako zdroj autentizace a k přístupu k API lze používat OAuth2 tokeny. HaveAPI částečně implementuje RFC 6749: autorizační response type "code" a token grant types "authorization_code" a "refresh_token". Ostatní response a grant types momentálně nejsou podporovány. Přístupový token lze předat jako bearer token podle RFC 6750 nebo vlastní HTTP hlavičkou, pokud není praktické použít hlavičku Authorization.
+          Přístupové a refresh tokeny lze zneplatnit podle RFC 7009.
+      renew_failed: Obnovení tokenu se nezdařilo
+      required: Tato akce vyžaduje přihlášení
+      revoke_failed: Zneplatnění tokenu se nezdařilo
+      token:
+        actions:
+          renew:
+            description: Obnovit aktuální autentizační token
+          request:
+            description: Vyžádat autentizační token
+          revoke:
+            description: Zneplatnit aktuální autentizační token
+        description: Klient se autentizuje přihlašovacími údaji, obvykle uživatelským
+          jménem a heslem, a získá token. Od té chvíle už přihlašovací údaje nepotřebuje
+          a používá místo nich token. Tokeny mohou mít různou dobu platnosti a lze
+          je obnovovat nebo zneplatňovat. Token se předává buď v HTTP hlavičce, nebo
+          jako parametr dotazu.
+        resource:
+          description: Spravovat autentizační tokeny
+      token_required: Tato akce vyžaduje autentizaci tokenem
     authorization:
       insufficient_permissions: Přístup odepřen. Nedostatečná oprávnění.
     errors:
       action_not_found: Akce nebyla nalezena
-      bad_accept_header: Chybná hlavička Accept
-      bad_json_syntax: Chybná syntaxe JSON
-      json_body_object: Tělo JSON musí být objekt
+      bad_accept_header: Neplatná hlavička Accept
+      bad_json_syntax: Neplatná syntaxe JSON
+      json_body_object: Tělo JSON požadavku musí být objekt
       server_error: Došlo k chybě serveru
-      unsupported_content_type: Nepodporovaný Content-Type
+      unsupported_content_type: Nepodporovaná hlavička Content-Type
     pagination:
-      limit_max: limit může být nejvýše %{max}
+      limit_max: Limit může být nejvýše %{max}
     parameters:
       action_state:
         can_cancel:
-          description: Je-li true, spuštění této akce lze zrušit
+          description: Je-li hodnota true, lze běh této akce zrušit
           label: Lze zrušit
         created_at:
           label: Vytvořeno
@@ -43,98 +67,111 @@ cs:
           label: Popisek
         poll:
           current:
-            description: průběh, se kterým se porovnává při nastaveném update_in
+            description: Aktuální průběh pro porovnání, je-li nastaveno update_in
           status:
-            description: stav, se kterým se porovnává při nastaveném update_in
+            description: Stav pro porovnání, je-li nastaveno update_in
           timeout:
-            description: v sekundách
+            description: Časový limit v sekundách
             label: Časový limit
           total:
-            description: průběh, se kterým se porovnává při nastaveném update_in
+            description: Celkový průběh pro porovnání, je-li nastaveno update_in
           update_in:
-            description: počet sekund, po kterém se stav vrátí, pokud se průběh změnil
-            label: Průběh
+            description: Vrátit stav dříve, pokud se změní status, current nebo total;
+              hodnota se předává implementacím pollingu v API
+            label: Čekat na změnu
         status:
-          description: Určuje, zda akce probíhá nebo selhává
+          description: Určuje, zda akce probíhá úspěšně nebo selhala
           label: Stav
         total:
-          description: Akce je dokončena, když se aktuální průběh rovná celkovému
+          description: Akce je dokončena, když aktuální průběh dosáhne celkového
           label: Celkem
         unit:
-          description: Jednotka aktuálního a celkového průběhu
+          description: Jednotka hodnot current a total
           label: Jednotka
         updated_at:
-          description: Kdy byl průběh naposledy aktualizován
+          description: Čas poslední aktualizace průběhu
           label: Aktualizováno
       action_state_id:
-        description: ID objektu ActionState pro dotazování stavu. Pokud je null, akce
-          není pro aktuální volání blokující.
+        description: |-
+          ID objektu ActionState pro dotazování na stav.
+          Pokud je hodnota null, akce v aktuálním volání neblokuje.
         label: ID stavu akce
       active_record:
         includes:
-          description: |-
-            Seznam názvů asociovaných prostředků oddělených čárkou.
-            Vnořené asociace se zapisují pomocí '__' mezi názvy prostředků.
-            Například 'user,node' přeloží tyto dvě asociace.
-            Pro přeložení dalších asociací uzlu použijte např. 'user,node__location',
-            pro ještě hlubší úroveň např. 'user,node__location__environment'.
+          description: Seznam názvů asociovaných zdrojů oddělených čárkou. Vnořené
+            asociace se zapisují pomocí '__' mezi názvy zdrojů. Například 'user,node'
+            načte tyto dvě asociace. Pro načtení dalších asociací zdroje node použijte
+            např. 'user,node__location'; pro ještě hlubší úroveň např. 'user,node__location__environment'.
           label: Zahrnuté asociace
         path_params:
-          description: Pole parametrů potřebných k přeložení URL na tento objekt
+          description: Pole parametrů potřebných k sestavení URL k tomuto objektu
           label: Parametry URL
         resolved:
-          description: True, pokud je asociace přeložena
-          label: Přeloženo
+          description: True, pokud je asociace načtena
+          label: Načteno
       authentication:
         token:
           interval:
-            description: Jak dlouho bude požadovaný token platný, v sekundách.
+            description: Doba platnosti požadovaného tokenu v sekundách.
             label: Interval
           lifetime:
             description: |-
               fixed - token má pevnou dobu platnosti a nelze ho obnovit
-              renewable_manual - token lze obnovit, ale musí se obnovit ručně akcí renew
-              renewable_auto - token se při každém použití automaticky obnoví na now+interval
-              permanent - token bude platný navždy, dokud nebude smazán
+              renewable_manual - platnost tokenu lze prodloužit, ale pouze ručně akcí renew
+              renewable_auto - platnost tokenu se při každém použití automaticky prodlouží na now + interval
+              permanent - token je platný trvale, dokud není smazán
             label: Životnost
           password:
             label: Heslo
           scope:
-            label: Rozsah
+            label: Scope
           user:
             label: Uživatel
       default:
         count:
-          label: Vrátit počet všech položek
+          label: Vrátit celkový počet položek
         total_count:
-          label: Celkový počet všech položek
+          label: Celkový počet položek
       metadata:
         'no':
-          label: Zakázat metadata
+          label: Vypnout metadata
       paginable:
         from_id:
-          description: Vypsat objekty s větším/menším ID
+          description: Vypsat objekty s ID větším/menším než zadaná hodnota
           label: Od ID
         limit:
           description: Počet objektů k načtení
           label: Limit
+    resources:
+      action_state:
+        actions:
+          cancel:
+            description: Zrušit čekající akci
+          index:
+            description: Vypsat stavy čekajících akcí
+          poll:
+            description: Vrátit stav po dokončení akce, změně průběhu nebo vypršení
+              časového limitu
+          show:
+            description: Zobrazit stav čekající akce
+        description: Procházet stavy blokujících akcí
     types:
-      invalid_boolean: neplatná pravdivostní hodnota %{value}
-      invalid_datetime: není ve formátu ISO 8601 '%{value}'
-      invalid_float: neplatné desetinné číslo %{value}
-      invalid_integer: neplatné celé číslo %{value}
-      invalid_string: neplatný řetězec %{value}
+      invalid_boolean: 'není platná pravdivostní hodnota: %{value}'
+      invalid_datetime: 'není ve formátu ISO 8601: ''%{value}'''
+      invalid_float: 'není platné desetinné číslo: %{value}'
+      invalid_integer: 'není platné celé číslo: %{value}'
+      invalid_string: 'není platný řetězec: %{value}'
     validation:
       cannot_be_null: nesmí být null
       includes_only_strings: includes musí obsahovat jen řetězce
       includes_string_or_array: includes musí být řetězec nebo pole
-      input_parameters_not_valid: vstupní parametry nejsou platné
-      invalid_id: neplatné ID %{value}
+      input_parameters_not_valid: vstupní parametry jsou neplatné
+      invalid_id: 'není platné ID: %{value}'
       invalid_input_layout: neplatná struktura vstupu
       invalid_path_parameter_encoding: neplatné kódování parametru cesty
       invalid_string_encoding: neplatné kódování řetězce
-      required_parameter_missing: povinný parametr chybí
-      resource_not_found: prostředek nebyl nalezen
+      required_parameter_missing: chybí povinný parametr
+      resource_not_found: zdroj nebyl nalezen
     validators:
       acceptance:
         accepted: musí být %{value}
@@ -149,19 +186,19 @@ cs:
         included: "%{value} nelze použít"
       length:
         equals: délka musí být %{equals}
-        max: délka může být nejvýše %{max}
+        max: délka musí být nejvýše %{max}
         min: délka musí být alespoň %{min}
-        range: délka musí být v rozsahu <%{min}, %{max}>
+        range: délka musí být v rozsahu %{min}–%{max}
       numericality:
         composite: "%{requirements}"
-        even: sudé číslo
+        even: musí být sudé číslo
         max: musí být nejvýše %{max}
         min: musí být alespoň %{min}
         mod: zbytek po dělení %{mod} musí být nula
         number: musí být číslo
-        odd: liché číslo
-        range: musí být v rozsahu <%{min}, %{max}>
-        step: v krocích po %{step}
+        odd: musí být liché číslo
+        range: musí být v rozsahu %{min}–%{max}
+        step: musí být v krocích po %{step}
       presence:
-        non_empty: musí být vyplněno a neprázdné
+        non_empty: musí být vyplněno a nesmí být prázdné
         present: musí být vyplněno

data/lib/haveapi/locales/en.yml

@@ -5,33 +5,57 @@
 en:
   haveapi:
     action_state:
-      cancellation_failed: cancellation failed
-      not_found: action state not found
-      timeout_max: timeout has to be maximally %{max}
+      cancellation_failed: Action cancellation failed
+      not_found: Action state not found
+      timeout_max: timeout must be at most %{max}
     authentication:
-      failed: authentication failed
-      invalid_credentials: invalid authentication credentials
-      multiple_oauth2_tokens: Multiple OAuth2 tokens provided
-      multiple_tokens: Multiple authentication tokens provided
-      renew_failed: renew failed
-      required: Action requires user to authenticate
-      revoke_failed: revoke failed
-      token_required: Action requires user to authenticate with a token
+      basic:
+        description: |-
+          Authentication using HTTP Basic. The username and password are passed in an HTTP header.
+          This method must not be used from web browsers.
+      failed: Authentication failed
+      invalid_credentials: Invalid authentication credentials
+      multiple_oauth2_tokens: Multiple OAuth2 tokens were provided
+      multiple_tokens: Multiple authentication tokens were provided
+      oauth2:
+        description: |-
+          OAuth2 authorization provider.
+          HaveAPI clients have limited OAuth2 support, but the API can be used as an authentication source and OAuth2 tokens can be used to access it. HaveAPI partially implements RFC 6749: authorization response type "code" and token grant types "authorization_code" and "refresh_token". Other response and grant types are not supported at this time. The access token can be passed as a bearer token according to RFC 6750, or using a custom HTTP header when the Authorization header is not practical.
+          Access and refresh tokens can be revoked according to RFC 7009.
+      renew_failed: Token renewal failed
+      required: This action requires authentication
+      revoke_failed: Token revocation failed
+      token:
+        actions:
+          renew:
+            description: Renew the current authentication token
+          request:
+            description: Request an authentication token
+          revoke:
+            description: Revoke the current authentication token
+        description: The client authenticates with credentials, usually a username
+          and password, and receives a token. From that point on, the credentials
+          can be forgotten and the token is used instead. Tokens can have different
+          lifetimes and can be renewed or revoked. The token is passed either in an
+          HTTP header or as a query parameter.
+        resource:
+          description: Manage authentication tokens
+      token_required: This action requires token authentication
     authorization:
       insufficient_permissions: Access denied. Insufficient permissions.
     errors:
       action_not_found: Action not found
-      bad_accept_header: Bad Accept header
-      bad_json_syntax: Bad JSON syntax
-      json_body_object: JSON body must be an object
-      server_error: Server error occurred
-      unsupported_content_type: Unsupported Content-Type
+      bad_accept_header: Invalid Accept header
+      bad_json_syntax: Invalid JSON syntax
+      json_body_object: The JSON request body must be an object
+      server_error: A server error occurred
+      unsupported_content_type: Unsupported Content-Type header
     pagination:
-      limit_max: limit has to be maximally %{max}
+      limit_max: limit must be at most %{max}
     parameters:
       action_state:
         can_cancel:
-          description: When true, execution of this action can be cancelled
+          description: When true, this action can be cancelled
           label: Can cancel
         created_at:
           label: Created at
@@ -43,60 +67,59 @@ en:
           label: Label
         poll:
           current:
-            description: progress to check with if update_in is set
+            description: Current progress value to compare when update_in is set
           status:
-            description: status to check with if update_in is set
+            description: Status value to compare when update_in is set
           timeout:
-            description: in seconds
+            description: Timeout in seconds
             label: Timeout
           total:
-            description: progress to check with if update_in is set
+            description: Total progress value to compare when update_in is set
           update_in:
-            description: number of seconds after which the state is returned if the
-              progress has changed
-            label: Progress
+            description: Return early when status, current, or total changes; the
+              value is passed to API-specific polling implementations
+            label: Update in
         status:
-          description: Determines whether the action is proceeding or failing
+          description: Whether the action is proceeding successfully or has failed
           label: Status
         total:
-          description: The action is finished when current equals to total
+          description: The action is finished when current reaches total
           label: Total
         unit:
           description: Unit of current and total
           label: Unit
         updated_at:
-          description: When was the progress last updated
+          description: When the progress was last updated
           label: Updated at
       action_state_id:
-        description: ID of ActionState object for state querying. When null, the action
-          is not blocking for the current invocation.
+        description: |-
+          ID of the ActionState object for state polling.
+          When null, the action is not blocking for the current invocation.
         label: Action state ID
       active_record:
         includes:
-          description: |-
-            A list of names of associated resources separated by a comma.
-            Nested associations are declared with '__' between resource names.
-            For example, 'user,node' will resolve the two associations.
-            To resolve further associations of node, use e.g. 'user,node__location',
-            to go even deeper, use e.g. 'user,node__location__environment'.
+          description: A comma-separated list of associated resource names. Nested
+            associations are declared with '__' between resource names. For example,
+            'user,node' includes these two associations. To include further associations
+            of node, use e.g. 'user,node__location'; to go even deeper, use e.g. 'user,node__location__environment'.
           label: Included associations
         path_params:
-          description: An array of parameters needed to resolve URL to this object
+          description: An array of parameters needed to build the URL for this object
           label: URL parameters
         resolved:
-          description: True if the association is resolved
+          description: True if the association has been loaded
           label: Resolved
       authentication:
         token:
           interval:
-            description: How long will requested token be valid, in seconds.
+            description: How long the requested token will be valid, in seconds.
             label: Interval
           lifetime:
             description: |-
-              fixed - the token has a fixed validity period, it cannot be renewed
-              renewable_manual - the token can be renewed, but it must be done manually via renew action
-              renewable_auto - the token is renewed automatically to now+interval every time it is used
-              permanent - the token will be valid forever, unless deleted
+              fixed - the token has a fixed validity period and cannot be renewed
+              renewable_manual - the token can be renewed, but only manually using the renew action
+              renewable_auto - the token is renewed automatically to now + interval whenever it is used
+              permanent - the token is valid forever unless deleted
             label: Lifetime
           password:
             label: Password
@@ -106,39 +129,52 @@ en:
             label: User
       default:
         count:
-          label: Return the count of all items
+          label: Return total count
         total_count:
-          label: Total count of all items
+          label: Total item count
       metadata:
         'no':
           label: Disable metadata
       paginable:
         from_id:
-          description: List objects with greater/lesser ID
+          description: List objects with IDs greater or lower than this value
           label: From ID
         limit:
           description: Number of objects to retrieve
           label: Limit
+    resources:
+      action_state:
+        actions:
+          cancel:
+            description: Cancel a pending action
+          index:
+            description: List pending action states
+          poll:
+            description: Return when the action is completed, its progress changes,
+              or a timeout occurs
+          show:
+            description: Show the state of a pending action
+        description: Browse states of blocking actions
     types:
-      invalid_boolean: not a valid boolean %{value}
-      invalid_datetime: not in ISO 8601 format '%{value}'
-      invalid_float: not a valid float %{value}
-      invalid_integer: not a valid integer %{value}
-      invalid_string: not a valid string %{value}
+      invalid_boolean: 'not a valid boolean: %{value}'
+      invalid_datetime: 'not in ISO 8601 format: ''%{value}'''
+      invalid_float: 'not a valid float: %{value}'
+      invalid_integer: 'not a valid integer: %{value}'
+      invalid_string: 'not a valid string: %{value}'
     validation:
       cannot_be_null: cannot be null
       includes_only_strings: includes must contain only strings
       includes_string_or_array: includes must be a string or array
-      input_parameters_not_valid: input parameters not valid
-      invalid_id: not a valid id %{value}
+      input_parameters_not_valid: input parameters are not valid
+      invalid_id: 'not a valid ID: %{value}'
       invalid_input_layout: invalid input layout
       invalid_path_parameter_encoding: invalid path parameter encoding
       invalid_string_encoding: invalid string encoding
-      required_parameter_missing: required parameter missing
+      required_parameter_missing: required parameter is missing
       resource_not_found: resource not found
     validators:
       acceptance:
-        accepted: has to be %{value}
+        accepted: must be %{value}
       confirmation:
         different: must be different from %{parameter}
         same: must be the same as %{parameter}
@@ -149,20 +185,20 @@ en:
       inclusion:
         included: "%{value} cannot be used"
       length:
-        equals: length has to be %{equals}
-        max: length has to be maximally %{max}
-        min: length has to be minimally %{min}
-        range: length has to be in range <%{min}, %{max}>
+        equals: length must be %{equals}
+        max: length must be at most %{max}
+        min: length must be at least %{min}
+        range: length must be between %{min} and %{max}
       numericality:
         composite: "%{requirements}"
-        even: even
-        max: has to be maximally %{max}
-        min: has to be minimally %{min}
-        mod: mod %{mod} must equal zero
-        number: has to be a number
-        odd: odd
-        range: has to be in range <%{min}, %{max}>
-        step: in steps of %{step}
+        even: must be even
+        max: must be at most %{max}
+        min: must be at least %{min}
+        mod: remainder after division by %{mod} must be zero
+        number: must be a number
+        odd: must be odd
+        range: must be between %{min} and %{max}
+        step: must be in steps of %{step}
       presence:
         non_empty: must be present and non-empty
         present: must be present

data/lib/haveapi/resources/action_state.rb

@@ -2,7 +2,7 @@ require 'haveapi/resource'
 
 module HaveAPI::Resources
   class ActionState < HaveAPI::Resource
-    desc 'Browse states of blocking actions'
+    desc HaveAPI.message('haveapi.resources.action_state.description')
     auth false
     version :all
 
@@ -54,7 +54,7 @@ module HaveAPI::Resources
     class Index < HaveAPI::Actions::Default::Index
       include Mixin
 
-      desc 'List states of pending actions'
+      desc HaveAPI.message('haveapi.resources.action_state.actions.index.description')
 
       input(:hash) do
         string :order, choices: %w[newest oldest], default: 'newest', fill: true
@@ -85,7 +85,7 @@ module HaveAPI::Resources
 
       MAX_TIMEOUT = 30
 
-      desc 'Returns when the action is completed or timeout occurs'
+      desc HaveAPI.message('haveapi.resources.action_state.actions.poll.description')
       http_method :get
       route '{%{resource}_id}/poll'
 
@@ -157,7 +157,7 @@ module HaveAPI::Resources
     class Show < HaveAPI::Actions::Default::Show
       include Mixin
 
-      desc 'Show state of a pending action'
+      desc HaveAPI.message('haveapi.resources.action_state.actions.show.description')
 
       output(:hash) do
         use :all
@@ -178,6 +178,8 @@ module HaveAPI::Resources
     end
 
     class Cancel < HaveAPI::Action
+      desc HaveAPI.message('haveapi.resources.action_state.actions.cancel.description')
+
       http_method :post
       route '{%{resource}_id}/cancel'
       blocking true

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.29.2'.freeze
+  VERSION = '0.29.3'.freeze
 end

data/spec/action/runtime_spec.rb

@@ -638,7 +638,7 @@ describe HaveAPI::Action do
 
       expect(last_response.status).to eq(200)
       expect(api_response).not_to be_ok
-      expect(api_response.errors[:confirmed]).to include('required parameter missing')
+      expect(api_response.errors[:confirmed]).to include('required parameter is missing')
 
       call_api([:Test], :batch, { tests: [{ label: 'one' }], _meta: { confirmed: 'maybe' } })
 

data/spec/action/validation_http_status_spec.rb

@@ -33,7 +33,7 @@ describe HaveAPI::Action do
 
         expect(last_response.status).to eq(200)
         expect(api_response).not_to be_ok
-        expect(api_response.errors[:name]).to include('required parameter missing')
+        expect(api_response.errors[:name]).to include('required parameter is missing')
       end
     end
 
@@ -69,7 +69,7 @@ describe HaveAPI::Action do
 
         expect(last_response.status).to eq(400)
         expect(api_response).not_to be_ok
-        expect(api_response.errors[:name]).to include('required parameter missing')
+        expect(api_response.errors[:name]).to include('required parameter is missing')
       end
     end
   end

data/spec/action_state_spec.rb

@@ -184,7 +184,7 @@ describe HaveAPI::Resources::ActionState do
       get_action '/v1/action_states/999'
 
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('action state not found')
+      expect(api_response.message).to eq('Action state not found')
     end
 
     it 'poll returns immediately if finished' do
@@ -227,7 +227,7 @@ describe HaveAPI::Resources::ActionState do
 
       expect(last_response.status).to eq(200)
       expect(api_response).not_to be_ok
-      expect(api_response.errors[:timeout].first).to include('range <0, 30>')
+      expect(api_response.errors[:timeout].first).to include('between 0 and 30')
     end
 
     it 'poll returns immediately when update_in check mismatches' do
@@ -274,7 +274,7 @@ describe HaveAPI::Resources::ActionState do
       get_action '/v1/action_states/999/poll', action_state: { timeout: 0 }
 
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('action state not found')
+      expect(api_response.message).to eq('Action state not found')
     end
 
     it 'cancel returns ok for true' do
@@ -303,7 +303,7 @@ describe HaveAPI::Resources::ActionState do
       call_api(:post, '/v1/action_states/1/cancel', {})
 
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('cancellation failed')
+      expect(api_response.message).to eq('Action cancellation failed')
     end
 
     it 'cancel returns error for NotImplementedError' do

data/spec/authentication/basic_spec.rb

@@ -73,7 +73,7 @@ describe HaveAPI::Authentication::Basic::Provider do
     expect(last_response.headers['www-authenticate']).to include('Basic realm=')
 
     expect(api_response).to be_failed
-    expect(api_response.message).to include('authenticate')
+    expect(api_response.message).to eq('This action requires authentication')
     expect(seen_users.last).to be_nil
   end
 
@@ -123,7 +123,7 @@ describe HaveAPI::Authentication::Basic::Provider do
     expect(last_response.status).to eq(401)
     expect(last_response.headers['www-authenticate']).to include('Basic realm=')
     expect(api_response).to be_failed
-    expect(api_response.message).to include('authenticate')
+    expect(api_response.message).to eq('This action requires authentication')
   end
 
   it 'returns an authentication error envelope from _logout' do
@@ -132,6 +132,6 @@ describe HaveAPI::Authentication::Basic::Provider do
     expect(last_response.status).to eq(401)
     expect(last_response.headers['www-authenticate']).to include('Basic realm=')
     expect(api_response).to be_failed
-    expect(api_response.message).to include('authenticate')
+    expect(api_response.message).to eq('This action requires authentication')
   end
 end

data/spec/authentication/oauth2_spec.rb

@@ -225,7 +225,7 @@ describe HaveAPI::Authentication::OAuth2 do
 
       expect(last_response.status).to eq(400)
       expect(api_response).to be_failed
-      expect(api_response.message).to eq('Bylo poskytnuto více OAuth2 tokenů')
+      expect(api_response.message).to eq('Bylo zadáno více OAuth2 tokenů')
     end
 
     it 'ignores structured access_token query values before backend lookup' do
@@ -248,6 +248,7 @@ describe HaveAPI::Authentication::OAuth2 do
     end
 
     it 'exposes oauth2 provider in version description' do
+      header 'Accept-Language', 'cs'
       call_api(:options, '/v1/')
 
       expect(last_response.status).to eq(200)
@@ -257,6 +258,7 @@ describe HaveAPI::Authentication::OAuth2 do
       expect(auth).to have_key(:oauth2)
 
       desc = auth[:oauth2]
+      expect(desc[:description]).to start_with('OAuth2 autorizační provider')
       expect(desc).to have_key(:http_header)
       expect(desc[:http_header]).to eq('X-HaveAPI-OAuth2-Token')
 

data/spec/authentication/token_spec.rb

@@ -290,6 +290,7 @@ describe HaveAPI::Authentication::Token do
   end
 
   it 'exposes token provider in version description' do
+    header 'Accept-Language', 'cs'
     call_api(:options, '/v1/')
 
     expect(last_response.status).to eq(200)
@@ -297,11 +298,18 @@ describe HaveAPI::Authentication::Token do
 
     auth = api_response[:authentication]
     expect(auth).to have_key(:token)
+    expect(auth[:token][:description]).to start_with('Klient se autentizuje')
     expect(auth[:token][:http_header]).to eq(AuthSpecToken::Config.http_header)
     expect(auth[:token][:query_parameter]).to eq(AuthSpecToken::Config.query_parameter.to_s)
 
     expect(auth[:token]).to have_key(:resources)
     expect(auth[:token][:resources]).to have_key(:token)
+
+    resource = auth[:token][:resources][:token]
+    expect(resource[:description]).to eq('Spravovat autentizační tokeny')
+    expect(resource[:actions][:request][:description]).to eq('Vyžádat autentizační token')
+    expect(resource[:actions][:revoke][:description]).to eq('Zneplatnit aktuální autentizační token')
+    expect(resource[:actions][:renew][:description]).to eq('Obnovit aktuální autentizační token')
   end
 end
 

data/spec/extensions/exception_mailer_spec.rb

@@ -113,7 +113,7 @@ describe HaveAPI::Extensions::ExceptionMailer do
 
     expect(last_response.status).to eq(500)
     expect(api_response).not_to be_ok
-    expect(api_response.message).to eq('Server error occurred')
+    expect(api_response.message).to eq('A server error occurred')
 
     expect(calls.size).to eq(1)
     context, exception, body = calls.first
@@ -190,6 +190,6 @@ describe HaveAPI::Extensions::ExceptionMailer do
 
     expect(last_response.status).to eq(500)
     expect(api_response).not_to be_ok
-    expect(api_response.message).to eq('Server error occurred')
+    expect(api_response.message).to eq('A server error occurred')
   end
 end

data/spec/i18n_spec.rb

@@ -10,6 +10,16 @@ module I18nSpec
       User.new(:cs) if username == 'user' && password == 'pass'
     end
   end
+
+  module ActionStateBackend
+    def self.list_pending(*)
+      []
+    end
+
+    def self.new(*)
+      nil
+    end
+  end
 end
 
 describe HaveAPI::I18n do
@@ -113,8 +123,8 @@ describe HaveAPI::I18n do
       header 'Accept', 'application/json'
       call_api(:post, '/v1/things', thing: {})
 
-      expect(api_response.message).to eq('input parameters not valid')
-      expect(api_response.errors[:name]).to include('required parameter missing')
+      expect(api_response.message).to eq('input parameters are not valid')
+      expect(api_response.errors[:name]).to include('required parameter is missing')
       expect(last_response.headers['Vary']).to include('Accept-Language')
     end
 
@@ -123,9 +133,9 @@ describe HaveAPI::I18n do
       header 'Accept-Language', 'cs'
       call_api(:post, '/v1/things', thing: { count: 'nope' })
 
-      expect(api_response.message).to eq('vstupní parametry nejsou platné')
-      expect(api_response.errors[:name]).to include('povinný parametr chybí')
-      expect(api_response.errors[:count].first).to include('neplatné celé číslo')
+      expect(api_response.message).to eq('vstupní parametry jsou neplatné')
+      expect(api_response.errors[:name]).to include('chybí povinný parametr')
+      expect(api_response.errors[:count].first).to include('není platné celé číslo')
       expect(last_response.headers['Vary']).to include('Accept-Language')
     end
 
@@ -151,7 +161,7 @@ describe HaveAPI::I18n do
       options '/v1/things', method: 'POST'
 
       length = api_response[:input][:parameters][:name][:validators][:length]
-      expect(length[:message]).to eq('délka musí být v rozsahu <3, 5>')
+      expect(length[:message]).to eq('délka musí být v rozsahu 3–5')
     end
 
     it 'keeps untranslated array choices unchanged in OPTIONS responses' do
@@ -393,7 +403,7 @@ describe HaveAPI::I18n do
       create = api_response[:resources][:thing][:actions][:create]
       no_meta = create[:meta][:global][:input][:parameters][:no]
 
-      expect(no_meta[:label]).to eq('Zakázat metadata')
+      expect(no_meta[:label]).to eq('Vypnout metadata')
     end
 
     it 'localizes application-supplied lazy validator messages' do
@@ -459,7 +469,7 @@ describe HaveAPI::I18n do
       expect(HaveAPI.localize(data)).to eq({
                                              message: 'Akce nebyla nalezena',
                                              errors: {
-                                               name: ['povinný parametr chybí']
+                                               name: ['chybí povinný parametr']
                                              }
                                            })
     ensure
@@ -492,6 +502,39 @@ describe HaveAPI::I18n do
     end
   end
 
+  context 'with localized framework self-description' do
+    empty_api
+    use_version 1
+    default_version 1
+    auth_chain I18nSpec::Provider
+    action_state I18nSpec::ActionStateBackend
+
+    before do
+      header 'Accept', 'application/json'
+      header 'Accept-Language', 'cs'
+    end
+
+    it 'localizes authentication provider descriptions' do
+      call_api(:options, '/?describe=default')
+
+      description = api_response[:authentication][:basic][:description]
+      expect(description).to start_with('Autentizace pomocí HTTP Basic')
+    end
+
+    it 'localizes ActionState resource and action descriptions' do
+      call_api(:options, '/?describe=default')
+
+      action_state = api_response[:resources][:action_state]
+      expect(action_state[:description]).to eq('Procházet stavy blokujících akcí')
+      expect(action_state[:actions][:index][:description]).to eq('Vypsat stavy čekajících akcí')
+      expect(action_state[:actions][:poll][:description]).to eq(
+        'Vrátit stav po dokončení akce, změně průběhu nebo vypršení časového limitu'
+      )
+      expect(action_state[:actions][:show][:description]).to eq('Zobrazit stav čekající akce')
+      expect(action_state[:actions][:cancel][:description]).to eq('Zrušit čekající akci')
+    end
+  end
+
   context 'with an authenticated locale resolver' do
     api do
       define_resource(:Thing) do
@@ -525,7 +568,7 @@ describe HaveAPI::I18n do
 
       action = api_response[:resources][:thing][:actions][:create]
       length = action.dig(:input, :parameters, :name, :validators, :length)
-      expect(length[:message]).to eq('délka musí být v rozsahu <3, 5>')
+      expect(length[:message]).to eq('délka musí být v rozsahu 3–5')
     end
   end
 

data/spec/model_adapters/active_record_spec.rb

@@ -869,23 +869,23 @@ describe HaveAPI::ModelAdapters::ActiveRecord do
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, 'abc', {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, '', {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, 1.2, {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, false, {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, true, {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::Environment, 9999, {})
@@ -913,11 +913,11 @@ describe HaveAPI::ModelAdapters::ActiveRecord do
 
     expect do
       described_class::Input.clean(ARAdapterSpec::StringAccount, %w[acct-alpha acct-beta], {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
 
     expect do
       described_class::Input.clean(ARAdapterSpec::StringAccount, { id: 'acct-alpha' }, {})
-    end.to raise_error(HaveAPI::ValidationError, /not a valid id/)
+    end.to raise_error(HaveAPI::ValidationError, /not a valid ID/)
   end
 
   it 'rejects non-string includes metadata entries' do
@@ -957,7 +957,7 @@ describe HaveAPI::ModelAdapters::ActiveRecord do
     expect(last_response.status).to eq(200)
     expect(api_response).not_to be_ok
     expect(api_response.errors[:limit].first).to include(
-      "range <0, #{HaveAPI::Actions::Paginable::MAX_LIMIT}>"
+      "between 0 and #{HaveAPI::Actions::Paginable::MAX_LIMIT}"
     )
   end
 

data/spec/server/integration_spec.rb

@@ -97,7 +97,7 @@ describe HaveAPI::Server do
 
       expect(last_response.status).to eq(400)
       expect(api_response).not_to be_ok
-      expect(api_response.message).to match(/Bad JSON syntax/)
+      expect(api_response.message).to match(/Invalid JSON syntax/)
     end
 
     it 'returns 400 for non-object JSON bodies' do
@@ -109,7 +109,7 @@ describe HaveAPI::Server do
 
         expect(last_response.status).to eq(400)
         expect(api_response).not_to be_ok
-        expect(api_response.message).to eq('JSON body must be an object')
+        expect(api_response.message).to eq('The JSON request body must be an object')
       end
     end
 
@@ -132,7 +132,7 @@ describe HaveAPI::Server do
 
       expect(last_response.status).to eq(415)
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('Unsupported Content-Type')
+      expect(api_response.message).to eq('Unsupported Content-Type header')
       expect(ServerIntegrationSpec::State.writes).to be_empty
     end
 
@@ -145,7 +145,7 @@ describe HaveAPI::Server do
 
       expect(last_response.status).to eq(400)
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('Bad Accept header')
+      expect(api_response.message).to eq('Invalid Accept header')
     end
 
     it 'returns JSON envelope for unknown route' do
@@ -169,7 +169,7 @@ describe HaveAPI::Server do
 
       expect(last_response.status).to eq(500)
       expect(api_response).not_to be_ok
-      expect(api_response.message).to eq('Server error occurred')
+      expect(api_response.message).to eq('A server error occurred')
 
       expect(calls.size).to eq(1)
       context, exception = calls.first

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.29.2
+  version: 0.29.3
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.29.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.2
+        version: 0.29.3
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement