haveapi 0.29.1 → 0.29.3

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
@@ -48,6 +58,14 @@ describe HaveAPI::I18n do
             string :global_attr_label,
                    label: 'Global attribute fallback',
                    desc: 'Global attribute description fallback'
+            string :status, choices: %i[enabled disabled]
+            string :priority,
+                   choices: {
+                     values: {
+                       low: 'Low priority',
+                       high: 'High priority'
+                     }
+                   }
             string :code, length: {
               min: 3,
               message: HaveAPI.message('haveapi.validators.length.min', min: 3)
@@ -105,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
 
@@ -115,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
 
@@ -143,7 +161,15 @@ 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
+      header 'Accept', 'application/json'
+      options '/v1/things', method: 'POST'
+
+      choices = api_response[:input][:parameters][:status][:validators][:include]
+      expect(choices[:values]).to eq(%w[enabled disabled])
     end
 
     it 'localizes API metadata in OPTIONS responses' do
@@ -218,6 +244,18 @@ describe HaveAPI::I18n do
                     global_attr_label: {
                       label: 'Přesný globální popisek',
                       description: 'Přesný globální popis'
+                    },
+                    status: {
+                      choices: {
+                        enabled: { label: 'Zapnuto' },
+                        disabled: { label: 'Vypnuto' }
+                      }
+                    },
+                    priority: {
+                      choices: {
+                        low: { label: 'Nízká priorita' },
+                        high: { label: 'Vysoká priorita' }
+                      }
                     }
                   },
                   output: {
@@ -325,6 +363,14 @@ describe HaveAPI::I18n do
         label: 'Přesný globální popisek',
         description: 'Přesný globální popis'
       )
+      expect(input_params[:status][:validators][:include][:values]).to eq(
+        enabled: 'Zapnuto',
+        disabled: 'Vypnuto'
+      )
+      expect(input_params[:priority][:validators][:include][:values]).to eq(
+        low: 'Nízká priorita',
+        high: 'Vysoká priorita'
+      )
       expect(input_params[:count]).to include(
         label: 'Count',
         description: nil
@@ -357,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
@@ -423,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
@@ -456,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
@@ -489,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/params_spec.rb

@@ -258,6 +258,8 @@ describe HaveAPI::Params do
     p = described_class.new(:input, ParamsSpec::MyResource::Index)
     p.add_block(proc do
       string :hostname, label: 'Hostname', desc: 'VPS hostname'
+      string :state, choices: %i[queued running]
+      string :priority, choices: { values: { low: 'Low priority' } }
       string :framework,
              label: HaveAPI.message('haveapi.parameters.metadata.no.label')
     end)
@@ -274,6 +276,22 @@ describe HaveAPI::Params do
                                  params_spec.attributes.hostname.label
                                ])
     expect(items.none? { |item| item[:param] == 'framework' }).to be true
+
+    choice = items.detect do |item|
+      item[:param] == 'state' && item[:kind] == 'choices.queued.label'
+    end
+    expect(choice[:value]).to eq('queued')
+    expect(choice[:keys]).to eq(%w[
+                                  params_spec.resources.my_resource.actions.index.input.state.choices.queued.label
+                                  params_spec.resources.my_resource.input.state.choices.queued.label
+                                  params_spec.resources.my_resource.attributes.state.choices.queued.label
+                                  params_spec.attributes.state.choices.queued.label
+                                ])
+
+    choice = items.detect do |item|
+      item[:param] == 'priority' && item[:kind] == 'choices.low.label'
+    end
+    expect(choice[:value]).to eq('Low priority')
   end
 
   it 'does not parse meta resource path segments as metadata paths' do

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.1
+  version: 0.29.3
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.29.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.29.3
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement