haveapi 0.29.1 → 0.29.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a287637726ecc5f44dc8c9f282b3ad68c0f1cdce4089d46eb218a0b0c7460ff1
-  data.tar.gz: f7b90d1523a79ad5b60df33afc3919f6620ebc29e616f3ff7f495f68a78dbb25
+  metadata.gz: 885ac3cc2e4b40ee6595f9beadad79e75f371d607dd0d49d02f67a01cece7d7f
+  data.tar.gz: 8c8b186ae1299655f952bedf5cd857042df97b060a0fda7e43ef6b9bc0ec6393
 SHA512:
-  metadata.gz: 6d55e32c20305fdca03ed9deb317b9a4ae0c873f0db3adfe30e85339f5560d42d9699c12dbbec61f9ff27100ce5e7b666d3818e216d657b407d29c4d3fd48a1e
-  data.tar.gz: 6c6b5b2b66a5f62f1013d972811a6df834a134c5238c920d6f4157442e3cb4b3aee67eb7a42864752b4bdda252a5295177dba77f26837df5c8f160e3521e21f6
+  metadata.gz: 8b3cd3b9dabb84f88119dde487b150ea6694ab76450d24df1c8f7ff9309b5fcb91638d58f4794db0236de5d8a81c01693c3a5adfc9665200bdb24915599d131e
+  data.tar.gz: c738c43d4cc3437124e9af50cd1ae70c84d3f5a91cb93f4c6d1b0966257e011f438f8ecf36639ba0da5044b0b06aa5c8b6072dce4793d4546df424ebdc50a1a9

data/README.md

@@ -328,6 +328,27 @@ cs:
         label: "Hostname"
 ```
 
+Choice labels declared through the `choices`/`include` validator use the same
+parameter metadata path with `choices.<value>.label` appended. If choices were
+declared as a value-to-label map, the declared label is used as the English
+fallback. If choices were declared as an array, untranslated self-description
+keeps the array form; a locale that supplies labels is returned as the existing
+HaveAPI `{value: label}` map form.
+
+```yaml
+cs:
+  my_api:
+    resources:
+      vps:
+        attributes:
+          state:
+            choices:
+              running:
+                label: "bezi"
+              stopped:
+                label: "vypnuto"
+```
+
 Metadata parameters fall back through resource and global metadata keys:
 
 ```yaml

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.1'
+  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