haveapi 0.28.4 → 0.29.0

data/lib/haveapi/locales/cs.yml

@@ -0,0 +1,167 @@
+# This file is generated from i18n/haveapi.yml.
+# Do not edit it manually; manual changes will be overwritten.
+# Update i18n/haveapi.yml and run bundle exec rake i18n:update.
+---
+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}
+    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
+    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
+      server_error: Došlo k chybě serveru
+      unsupported_content_type: Nepodporovaný Content-Type
+    pagination:
+      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
+          label: Lze zrušit
+        created_at:
+          label: Vytvořeno
+        current:
+          label: Aktuální průběh
+        finished:
+          label: Dokončeno
+        label:
+          label: Popisek
+        poll:
+          current:
+            description: průběh, se kterým se porovnává při nastaveném update_in
+          status:
+            description: stav, se kterým se porovnává při nastaveném update_in
+          timeout:
+            description: v sekundách
+            label: Časový limit
+          total:
+            description: průběh, se kterým se porovnává při nastaveném 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
+        status:
+          description: Určuje, zda akce probíhá nebo selhává
+          label: Stav
+        total:
+          description: Akce je dokončena, když se aktuální průběh rovná celkovému
+          label: Celkem
+        unit:
+          description: Jednotka aktuálního a celkového průběhu
+          label: Jednotka
+        updated_at:
+          description: Kdy byl průběh naposledy aktualizován
+          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í.
+        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'.
+          label: Zahrnuté asociace
+        path_params:
+          description: Pole parametrů potřebných k přeložení URL na tento objekt
+          label: Parametry URL
+        resolved:
+          description: True, pokud je asociace přeložena
+          label: Přeloženo
+      authentication:
+        token:
+          interval:
+            description: Jak dlouho bude požadovaný token platný, 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
+            label: Životnost
+          password:
+            label: Heslo
+          scope:
+            label: Rozsah
+          user:
+            label: Uživatel
+      default:
+        count:
+          label: Vrátit počet všech položek
+        total_count:
+          label: Celkový počet všech položek
+      metadata:
+        'no':
+          label: Zakázat metadata
+      paginable:
+        from_id:
+          description: Vypsat objekty s větším/menším ID
+          label: Od ID
+        limit:
+          description: Počet objektů k načtení
+          label: Limit
+    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}
+    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}
+      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
+    validators:
+      acceptance:
+        accepted: musí být %{value}
+      confirmation:
+        different: musí být odlišné od %{parameter}
+        same: musí být stejné jako %{parameter}
+      exclusion:
+        excluded: "%{value} nelze použít"
+      format:
+        invalid: "%{value} nemá platný formát"
+      inclusion:
+        included: "%{value} nelze použít"
+      length:
+        equals: délka musí být %{equals}
+        max: délka může být nejvýše %{max}
+        min: délka musí být alespoň %{min}
+        range: délka musí být v rozsahu <%{min}, %{max}>
+      numericality:
+        composite: "%{requirements}"
+        even: 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}
+      presence:
+        non_empty: musí být vyplněno a neprázdné
+        present: musí být vyplněno

data/lib/haveapi/locales/en.yml

@@ -0,0 +1,168 @@
+# This file is generated from i18n/haveapi.yml.
+# Do not edit it manually; manual changes will be overwritten.
+# Update i18n/haveapi.yml and run bundle exec rake i18n:update.
+---
+en:
+  haveapi:
+    action_state:
+      cancellation_failed: cancellation failed
+      not_found: action state not found
+      timeout_max: timeout has to be maximally %{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
+    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
+    pagination:
+      limit_max: limit has to be maximally %{max}
+    parameters:
+      action_state:
+        can_cancel:
+          description: When true, execution of this action can be cancelled
+          label: Can cancel
+        created_at:
+          label: Created at
+        current:
+          label: Current progress
+        finished:
+          label: Finished
+        label:
+          label: Label
+        poll:
+          current:
+            description: progress to check with if update_in is set
+          status:
+            description: status to check with if update_in is set
+          timeout:
+            description: in seconds
+            label: Timeout
+          total:
+            description: progress to check with if update_in is set
+          update_in:
+            description: number of seconds after which the state is returned if the
+              progress has changed
+            label: Progress
+        status:
+          description: Determines whether the action is proceeding or failing
+          label: Status
+        total:
+          description: The action is finished when current equals to total
+          label: Total
+        unit:
+          description: Unit of current and total
+          label: Unit
+        updated_at:
+          description: When was the progress 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.
+        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'.
+          label: Included associations
+        path_params:
+          description: An array of parameters needed to resolve URL to this object
+          label: URL parameters
+        resolved:
+          description: True if the association is resolved
+          label: Resolved
+      authentication:
+        token:
+          interval:
+            description: How long will requested token 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
+            label: Lifetime
+          password:
+            label: Password
+          scope:
+            label: Scope
+          user:
+            label: User
+      default:
+        count:
+          label: Return the count of all items
+        total_count:
+          label: Total count of all items
+      metadata:
+        'no':
+          label: Disable metadata
+      paginable:
+        from_id:
+          description: List objects with greater/lesser ID
+          label: From ID
+        limit:
+          description: Number of objects to retrieve
+          label: Limit
+    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}
+    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}
+      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
+      resource_not_found: resource not found
+    validators:
+      acceptance:
+        accepted: has to be %{value}
+      confirmation:
+        different: must be different from %{parameter}
+        same: must be the same as %{parameter}
+      exclusion:
+        excluded: "%{value} cannot be used"
+      format:
+        invalid: "%{value} is not in a valid format"
+      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}>
+      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}
+      presence:
+        non_empty: must be present and non-empty
+        present: must be present

data/lib/haveapi/metadata.rb

@@ -45,12 +45,34 @@ module HaveAPI
         end
       end
 
-      def describe(context)
+      def describe(context, type:)
         {
-          input: @input && @input.describe(context),
-          output: @output && @output.describe(context, metadata: true)
+          input: @input && @input.describe(
+            context,
+            i18n_path: Params.metadata_i18n_path(context, type, :input)
+          ),
+          output: @output && @output.describe(
+            context,
+            metadata: true,
+            i18n_path: Params.metadata_i18n_path(context, type, :output)
+          )
         }
       end
+
+      def parameter_metadata_i18n_items(context, type:)
+        [
+          *@input&.parameter_metadata_i18n_items(
+            context,
+            i18n_path: Params.metadata_i18n_path(context, type, :input),
+            meta_type: type
+          ),
+          *@output&.parameter_metadata_i18n_items(
+            context,
+            i18n_path: Params.metadata_i18n_path(context, type, :output),
+            meta_type: type
+          )
+        ].compact
+      end
     end
   end
 end

data/lib/haveapi/model_adapters/active_record.rb

@@ -81,7 +81,10 @@ module HaveAPI::ModelAdapters
 
           if limit && limit > HaveAPI::Actions::Paginable::MAX_LIMIT
             error!(
-              "limit has to be maximally #{HaveAPI::Actions::Paginable::MAX_LIMIT}",
+              HaveAPI.message(
+                'haveapi.pagination.limit_max',
+                max: HaveAPI::Actions::Paginable::MAX_LIMIT
+              ),
               {},
               http_status: 400
             )
@@ -174,18 +177,18 @@ module HaveAPI::ModelAdapters
         if raw.nil?
           return nil if allow_null
 
-          raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+          raise invalid_id(original)
         end
 
         if raw.is_a?(Array) || raw.is_a?(Hash) || [true, false].include?(raw)
-          raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+          raise invalid_id(original)
         elsif raw.is_a?(String)
           stripped = raw.strip
 
           if stripped.empty?
             return nil if allow_null
 
-            raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+            raise invalid_id(original)
           end
 
           raw = stripped
@@ -193,7 +196,7 @@ module HaveAPI::ModelAdapters
 
         value = if integer_pk?(model)
                   id = coerce_integer_id(raw, original)
-                  raise HaveAPI::ValidationError, "not a valid id #{original.inspect}" if id < 0
+                  raise invalid_id(original) if id < 0
 
                   id
                 else
@@ -207,14 +210,14 @@ module HaveAPI::ModelAdapters
               end
 
         if ret.nil? && !allow_null
-          raise HaveAPI::ValidationError, 'resource not found'
+          raise resource_not_found
         end
 
         ret
       rescue ::ActiveRecord::RecordNotFound
-        raise HaveAPI::ValidationError, 'resource not found'
+        raise resource_not_found
       rescue ArgumentError, TypeError
-        raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+        raise invalid_id(original)
       end
 
       def self.integer_pk?(model)
@@ -232,7 +235,7 @@ module HaveAPI::ModelAdapters
           raw
         when Float
           unless raw.finite? && (raw % 1) == 0
-            raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+            raise invalid_id(original)
           end
 
           raw.to_i
@@ -240,23 +243,38 @@ module HaveAPI::ModelAdapters
           s = raw.strip
 
           if s.empty? || !s.match?(/\A[+-]?\d+\z/)
-            raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+            raise invalid_id(original)
           end
 
           Integer(s, 10)
         else
-          raise HaveAPI::ValidationError, "not a valid id #{original.inspect}"
+          raise invalid_id(original)
         end
       end
+
+      def self.invalid_id(original)
+        HaveAPI::ValidationError.new(
+          HaveAPI.message('haveapi.validation.invalid_id', value: original.inspect)
+        )
+      end
+
+      def self.resource_not_found
+        HaveAPI::ValidationError.new(
+          HaveAPI.message('haveapi.validation.resource_not_found')
+        )
+      end
     end
 
     class Output < ::HaveAPI::ModelAdapter::Output
       def self.used_by(action)
         action.meta(:object) do
           output do
-            custom :path_params, label: 'URL parameters',
-                                 desc: 'An array of parameters needed to resolve URL to this object'
-            bool :resolved, label: 'Resolved', desc: 'True if the association is resolved'
+            custom :path_params,
+                   label: HaveAPI.message('haveapi.parameters.active_record.path_params.label'),
+                   desc: HaveAPI.message('haveapi.parameters.active_record.path_params.description')
+            bool :resolved,
+                 label: HaveAPI.message('haveapi.parameters.active_record.resolved.label'),
+                 desc: HaveAPI.message('haveapi.parameters.active_record.resolved.description')
           end
         end
 
@@ -268,30 +286,26 @@ module HaveAPI::ModelAdapters
                    elsif raw.is_a?(Array)
                      raw
                    else
-                     raise HaveAPI::ValidationError, 'includes must be a string or array'
+                     raise HaveAPI::ValidationError,
+                           HaveAPI.message('haveapi.validation.includes_string_or_array')
                    end
 
           values.map do |value|
             unless value.is_a?(String)
-              raise HaveAPI::ValidationError, 'includes must contain only strings'
+              raise HaveAPI::ValidationError,
+                    HaveAPI.message('haveapi.validation.includes_only_strings')
             end
 
             value.strip
           end
         end
 
-        desc = <<~END
-          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'.
-        END
-
         action.meta(:global) do
           input do
-            custom :includes, label: 'Included associations',
-                              desc:, &clean
+            custom :includes,
+                   label: HaveAPI.message('haveapi.parameters.active_record.includes.label'),
+                   desc: HaveAPI.message('haveapi.parameters.active_record.includes.description'),
+                   &clean
           end
         end
 

data/lib/haveapi/output_formatter.rb

@@ -51,8 +51,8 @@ module HaveAPI
       ret.update({
         status:,
         response:,
-        message:,
-        errors:
+        message: HaveAPI.localize(message),
+        errors: HaveAPI.localize(errors)
       })
       ret
     end