haveapi 0.28.3 → 0.29.0

data/lib/haveapi/params.rb

@@ -3,11 +3,22 @@ module HaveAPI
   end
 
   class ValidationError < StandardError
+    attr_reader :message_value
+
     def initialize(msg, errors = {})
+      @message_value = msg
       super(msg)
       @errors = errors
     end
 
+    def message
+      HaveAPI.localize(@message_value)
+    end
+
+    def to_s
+      message
+    end
+
     def to_hash
       @errors
     end
@@ -17,6 +28,45 @@ module HaveAPI
     attr_reader :params
     attr_accessor :action
 
+    class << self
+      def action_i18n_path(context, direction)
+        prefix = action_i18n_prefix(context)
+        return unless prefix
+
+        "#{prefix}.#{i18n_segment(direction)}"
+      end
+
+      def metadata_i18n_path(context, type, direction)
+        prefix = action_i18n_prefix(context)
+        return unless prefix
+
+        [
+          prefix,
+          'meta',
+          i18n_segment(type),
+          i18n_segment(direction)
+        ].join('.')
+      end
+
+      def i18n_segment(value)
+        value.to_s.underscore.downcase.gsub(/[^a-z0-9_]+/, '_').gsub(/\A_+|_+\z/, '')
+      end
+
+      private
+
+      def action_i18n_prefix(context)
+        return unless context.respond_to?(:resource_path) && context.resource_path
+        return unless context.respond_to?(:action) && context.action
+
+        [
+          'resources',
+          *context.resource_path.map { |segment| i18n_segment(segment) },
+          'actions',
+          i18n_segment(context.action.action_name)
+        ].join('.')
+      end
+    end
+
     def initialize(direction, action)
       @direction = direction
       @params = []
@@ -171,7 +221,7 @@ module HaveAPI
       add_param(name, apply(kwargs, type: Custom, clean: block, symbolize_keys:))
     end
 
-    def describe(context, metadata: false)
+    def describe(context, metadata: false, i18n_path: nil)
       context.layout = layout
 
       ret = { parameters: {} }
@@ -179,8 +229,10 @@ module HaveAPI
       ret[:namespace] = namespace
       ret[:format] = @structure if @structure
 
+      i18n_path ||= self.class.action_i18n_path(context, @direction)
+
       @params.each do |p|
-        ret[:parameters][p.name] = p.describe(context)
+        ret[:parameters][p.name] = p.describe(context, i18n_path:)
       end
 
       ret[:parameters] = filtered_description_parameters(context, ret, metadata)
@@ -188,6 +240,23 @@ module HaveAPI
       ret
     end
 
+    def parameter_metadata_i18n_items(context, i18n_path: nil, meta_type: nil)
+      i18n_path ||= self.class.action_i18n_path(context, @direction)
+
+      @params.flat_map do |param|
+        next [] unless param.respond_to?(:metadata_i18n_catalog_items)
+
+        param.metadata_i18n_catalog_items(context, i18n_path).map do |item|
+          item.merge(
+            resource_path: Array(context.resource_path).map { |v| self.class.i18n_segment(v) },
+            action: self.class.i18n_segment(context.action.action_name),
+            direction: self.class.i18n_segment(@direction),
+            meta_type: meta_type && self.class.i18n_segment(meta_type)
+          )
+        end
+      end
+    end
+
     def validate_build
       m = :"validate_build_#{@direction}"
 
@@ -202,10 +271,10 @@ module HaveAPI
       value = namespace ? params[namespace] : params
 
       if value.nil?
-        raise ValidationError.new('invalid input layout', {}) if any_required_params?
+        raise ValidationError.new(HaveAPI.message('haveapi.validation.invalid_input_layout'), {}) if any_required_params?
 
       elsif !valid_layout?(value)
-        raise ValidationError.new('invalid input layout', {})
+        raise ValidationError.new(HaveAPI.message('haveapi.validation.invalid_input_layout'), {})
       end
 
       return unless namespace
@@ -231,7 +300,7 @@ module HaveAPI
           next if permitted && !permitted.include?(p.name)
 
           if p.required? && input[p.name].nil?
-            errors[p.name] = ['required parameter missing']
+            errors[p.name] = [HaveAPI.message('haveapi.validation.required_parameter_missing')]
             next
           end
 
@@ -248,7 +317,7 @@ module HaveAPI
                       end
           rescue ValidationError => e
             errors[p.name] ||= []
-            errors[p.name] << e.message
+            errors[p.name] << e.message_value
             next
           end
 
@@ -271,7 +340,7 @@ module HaveAPI
       end
 
       unless errors.empty?
-        raise ValidationError.new('input parameters not valid', errors)
+        raise ValidationError.new(HaveAPI.message('haveapi.validation.input_parameters_not_valid'), errors)
       end
 
       params

data/lib/haveapi/resource.rb

@@ -80,7 +80,7 @@ module HaveAPI
     end
 
     def self.describe(hash, context)
-      ret = { description: desc, actions: {}, resources: {} }
+      ret = { description: HaveAPI.localize(desc), actions: {}, resources: {} }
 
       context.resource = self
 

data/lib/haveapi/resources/action_state.rb

@@ -8,19 +8,25 @@ module HaveAPI::Resources
 
     params(:all) do
       id :id
-      string :label, label: 'Label'
-      bool :finished, label: 'Finished'
-      bool :status, label: 'Status',
-                    desc: 'Determines whether the action is proceeding or failing'
-      integer :current, label: 'Current progress'
-      integer :total, label: 'Total',
-                      desc: 'The action is finished when current equals to total'
-      string :unit, label: 'Unit', desc: 'Unit of current and total'
-      bool :can_cancel, label: 'Can cancel',
-                        desc: 'When true, execution of this action can be cancelled'
-      datetime :created_at, label: 'Created at'
-      datetime :updated_at, label: 'Updated at',
-                            desc: 'When was the progress last updated'
+      string :label, label: HaveAPI.message('haveapi.parameters.action_state.label.label')
+      bool :finished, label: HaveAPI.message('haveapi.parameters.action_state.finished.label')
+      bool :status,
+           label: HaveAPI.message('haveapi.parameters.action_state.status.label'),
+           desc: HaveAPI.message('haveapi.parameters.action_state.status.description')
+      integer :current, label: HaveAPI.message('haveapi.parameters.action_state.current.label')
+      integer :total,
+              label: HaveAPI.message('haveapi.parameters.action_state.total.label'),
+              desc: HaveAPI.message('haveapi.parameters.action_state.total.description')
+      string :unit,
+             label: HaveAPI.message('haveapi.parameters.action_state.unit.label'),
+             desc: HaveAPI.message('haveapi.parameters.action_state.unit.description')
+      bool :can_cancel,
+           label: HaveAPI.message('haveapi.parameters.action_state.can_cancel.label'),
+           desc: HaveAPI.message('haveapi.parameters.action_state.can_cancel.description')
+      datetime :created_at, label: HaveAPI.message('haveapi.parameters.action_state.created_at.label')
+      datetime :updated_at,
+               label: HaveAPI.message('haveapi.parameters.action_state.updated_at.label'),
+               desc: HaveAPI.message('haveapi.parameters.action_state.updated_at.description')
     end
 
     module Mixin
@@ -84,15 +90,25 @@ module HaveAPI::Resources
       route '{%{resource}_id}/poll'
 
       input(:hash) do
-        float :timeout, label: 'Timeout', desc: 'in seconds', default: 15, fill: true,
-                        number: { min: 0, max: MAX_TIMEOUT }
-        float :update_in, label: 'Progress',
-                          desc: 'number of seconds after which the state is returned if the progress ' \
-                                'has changed',
-                          nullable: true
-        bool :status, desc: 'status to check with if update_in is set', nullable: true
-        integer :current, desc: 'progress to check with if update_in is set', nullable: true
-        integer :total, desc: 'progress to check with if update_in is set', nullable: true
+        float :timeout,
+              label: HaveAPI.message('haveapi.parameters.action_state.poll.timeout.label'),
+              desc: HaveAPI.message('haveapi.parameters.action_state.poll.timeout.description'),
+              default: 15,
+              fill: true,
+              number: { min: 0, max: MAX_TIMEOUT }
+        float :update_in,
+              label: HaveAPI.message('haveapi.parameters.action_state.poll.update_in.label'),
+              desc: HaveAPI.message('haveapi.parameters.action_state.poll.update_in.description'),
+              nullable: true
+        bool :status,
+             desc: HaveAPI.message('haveapi.parameters.action_state.poll.status.description'),
+             nullable: true
+        integer :current,
+                desc: HaveAPI.message('haveapi.parameters.action_state.poll.current.description'),
+                nullable: true
+        integer :total,
+                desc: HaveAPI.message('haveapi.parameters.action_state.poll.total.description'),
+                nullable: true
       end
 
       output(:hash) do
@@ -103,7 +119,11 @@ module HaveAPI::Resources
 
       def exec
         if input[:timeout] > MAX_TIMEOUT
-          error!("timeout has to be maximally #{MAX_TIMEOUT}", {}, http_status: 400)
+          error!(
+            HaveAPI.message('haveapi.action_state.timeout_max', max: MAX_TIMEOUT),
+            {},
+            http_status: 400
+          )
         end
 
         t = Time.now
@@ -114,7 +134,7 @@ module HaveAPI::Resources
             id: path_params['action_state_id']
           )
 
-          error!('action state not found') unless state.valid?
+          error!(HaveAPI.message('haveapi.action_state.not_found')) unless state.valid?
 
           if state.finished? || (Time.now - t) >= input[:timeout]
             return state_to_hash(state)
@@ -153,7 +173,7 @@ module HaveAPI::Resources
 
         return state_to_hash(state) if state.valid?
 
-        error!('action state not found')
+        error!(HaveAPI.message('haveapi.action_state.not_found'))
       end
     end
 
@@ -172,7 +192,7 @@ module HaveAPI::Resources
           id: path_params['action_state_id']
         )
 
-        error!('action state not found') unless state.valid?
+        error!(HaveAPI.message('haveapi.action_state.not_found')) unless state.valid?
 
         ret = state.cancel
 
@@ -183,7 +203,7 @@ module HaveAPI::Resources
           ok!
 
         else
-          error!('cancellation failed')
+          error!(HaveAPI.message('haveapi.action_state.cancellation_failed'))
         end
       rescue RuntimeError, NotImplementedError => e
         error!(e.message)