haveapi-client 0.29.4 → 0.29.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd152485887e7737693110495d6bdd627db3d43aa5cb81ffb96619d59473f704
-  data.tar.gz: 9914768b6f5b145929fe6c257de001b9c6f26a9d8fabac689790f5037092a621
+  metadata.gz: b2a413b63db6d6f00c9664d93b6a2bb7d6958f7cbe5375206173ad1449b35123
+  data.tar.gz: ea5a9393d531ee3503b6ce0274926aae67d9419c8c98d3c85ed2b1fe83d23499
 SHA512:
-  metadata.gz: db8e0e7a6c327e7b9ad96350051fc62d0bf89bd26a5c38ffb7551ec36daac13b34b349e3c03dd209511da015bd5042ad8bcfc4ae9fa75617f3e8c9e2038258df
-  data.tar.gz: dedb09777b253bb7076c46660c3399bc1a352184fc9956bc41ae8168173fe415acc3566ae0af177bbc8ee45e4a3450c4a6157f45d5ca5a2c0f16ac214aa219dd
+  metadata.gz: 947f1336247d07ad353055d7fc5cc68708b4a698927a789b80e91878526dc04b33a9ab2a1ab509e4c8ba2846bcde5cb9710a18b05e61f243c2c82d311b93cc68
+  data.tar.gz: 8bf5a0cae801ca319dcb18fd441a3b03d3fad11de8eda64b483a078886f72d9fbbe81187aada825b6abcf4e81e2d788b9777ed96faab76439eaaa28310df18ae

data/README.md

@@ -120,6 +120,14 @@ client-side validation errors:
 api = HaveAPI::Client::Client.new('https://your.api.tld', language: 'cs')
 ```
 
+Change the request language on an existing client with `set_opts`. Read the
+configured value through `opts`:
+
+```ruby
+api.set_opts(language: 'en')
+p api.opts[:language]
+```
+
 The value is sent in `Accept-Language` by default. Use `language_header` when
 the API is configured with a custom language header. Set the language before
 the client fetches the API description so translated validator descriptions

data/lib/haveapi/client/client.rb

@@ -90,24 +90,8 @@ class HaveAPI::Client::Client
   # @param opts [Hash] options
   def set_opts(opts)
     @opts.update(opts)
-    self.language = opts[:language] if opts.has_key?(:language)
-    self.language_header = opts[:language_header] if opts.has_key?(:language_header)
-  end
-
-  def language
-    @api.language
-  end
-
-  def language=(value)
-    @api.language = value
-  end
-
-  def language_header
-    @api.language_header
-  end
-
-  def language_header=(value)
-    @api.language_header = value
+    @api.language = opts[:language] if opts.has_key?(:language)
+    @api.language_header = opts[:language_header] if opts.has_key?(:language_header)
   end
 
   def client_message(key, **values)

data/lib/haveapi/client/resource_instance.rb

@@ -205,10 +205,17 @@ module HaveAPI::Client
     def find_association(res_desc, res_val)
       return nil unless res_val
 
-      tmp = @client
+      resource = @client
+      path = []
 
-      res_desc[:resource].each do |r|
-        tmp = tmp.method(r).call
+      res_desc[:resource].each do |name|
+        path << name
+
+        begin
+          resource = resource.resources.fetch(name.to_sym)
+        rescue KeyError
+          raise ProtocolError, "associated resource '#{path.join('.')}' not found"
+        end
       end
 
       # FIXME: read _meta namespace from description
@@ -217,8 +224,8 @@ module HaveAPI::Client
       ResourceInstance.new(
         @client,
         @api,
-        tmp,
-        action: tmp.actions[:show],
+        resource,
+        action: resource.actions[:show],
         resolved: meta[:resolved],
         response: meta[:resolved] ? res_val : nil,
         meta: meta

data/lib/haveapi/client/validators/inclusion.rb

@@ -6,7 +6,7 @@ module HaveAPI::Client
 
     def valid?
       if opts[:values].is_a?(::Hash)
-        opts[:values].keys.include?(value)
+        opts[:values].keys.any? { |v| v.to_s == value.to_s }
 
       else
         opts[:values].include?(value)

data/lib/haveapi/client/version.rb

@@ -1,6 +1,6 @@
 module HaveAPI
   module Client
     PROTOCOL_VERSION = '2.0'.freeze
-    VERSION = '0.29.4'.freeze
+    VERSION = '0.29.6'.freeze
   end
 end

data/spec/description_method_security_spec.rb

@@ -80,6 +80,10 @@ RSpec.describe HaveAPI::Client::Client do
         actions: {},
         resources: {}
       },
+      language: {
+        actions: {},
+        resources: {}
+      },
       users: {
         actions: {},
         resources: {}
@@ -94,8 +98,9 @@ RSpec.describe HaveAPI::Client::Client do
     expect(client.method(:setup).owner).to eq(described_class)
     expect(client.authenticate(:token, token: 'secret-token')).to eq(:authenticated)
     expect(api.authenticate_calls).to eq(2)
+    expect(client.language).to be_a(HaveAPI::Client::Resource)
     expect(client.users).to be_a(HaveAPI::Client::Resource)
-    expect(client.resources.keys).to contain_exactly(:authenticate, :setup, :users)
+    expect(client.resources.keys).to contain_exactly(:authenticate, :setup, :language, :users)
   end
 
   it 'does not let actions or nested resources replace resource methods' do

data/spec/i18n_spec.rb

@@ -24,6 +24,18 @@ RSpec.describe HaveAPI::Client::Client do
     expect(client.communicator.language_headers).to eq('X-Language' => 'cs-CZ')
   end
 
+  it 'updates and reports language options through the option interface' do
+    client = described_class.new(TEST_SERVER.base_url)
+
+    client.set_opts(language: 'cs-CZ', language_header: 'X-Language')
+
+    expect(client.opts(:language, :language_header)).to eq(
+      language: 'cs-CZ',
+      language_header: 'X-Language'
+    )
+    expect(client.communicator.language_headers).to eq('X-Language' => 'cs-CZ')
+  end
+
   it 'localizes local validation errors' do
     client = described_class.new(TEST_SERVER.base_url, language: 'cs')
 
@@ -33,4 +45,17 @@ RSpec.describe HaveAPI::Client::Client do
         expect(err.errors[:i]).to include('není platné celé číslo')
       end
   end
+
+  it 'accepts a value from localized choice metadata' do
+    client = described_class.new(TEST_SERVER.base_url, language: 'cs')
+    values = client.test.actions[:echo_choice]
+                   .input_params[:format]
+                   .dig(:validators, :include, :values)
+
+    expect(values).to eq(archive: 'Archiv', stream: 'Proud')
+
+    response = client.test.echo_choice(format: 'archive')
+
+    expect(response[:format]).to eq('archive')
+  end
 end

data/spec/resource_instance_association_spec.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class ResourceAssociationTestCommunicator
+  attr_reader :calls
+
+  def initialize(resolved:, association_path: ['language'])
+    @resolved = resolved
+    @association_path = association_path
+    @calls = []
+  end
+
+  def describe_api(_version)
+    {
+      resources: {
+        language: resource_description(
+          show: action_description(
+            namespace: 'language',
+            path: '/v1/languages/{language_id}',
+            parameters: {
+              id: { type: 'Integer' },
+              code: { type: 'String' }
+            }
+          )
+        ),
+        user: resource_description(
+          current: action_description(
+            namespace: 'user',
+            path: '/v1/users/current',
+            parameters: {
+              id: { type: 'Integer' },
+              language: {
+                type: 'Resource',
+                resource: @association_path,
+                value_id: 'id',
+                value_label: 'code'
+              }
+            }
+          )
+        )
+      }
+    }
+  end
+
+  def call(action, _params)
+    @calls << action.name
+
+    case action.name
+    when :current
+      response(
+        user: {
+          id: 1,
+          language: {
+            id: 1,
+            code: 'cs',
+            _meta: {
+              resolved: @resolved,
+              path_params: [1]
+            }
+          }
+        }
+      )
+    when :show
+      response(
+        language: {
+          id: 1,
+          code: 'cs'
+        }
+      )
+    else
+      raise "unexpected action #{action.name}"
+    end
+  end
+
+  def url
+    'https://api.example'
+  end
+
+  protected
+
+  def resource_description(actions)
+    {
+      actions: actions.transform_values { |v| v },
+      resources: {}
+    }
+  end
+
+  def action_description(namespace:, path:, parameters:)
+    {
+      auth: false,
+      description: 'test action',
+      aliases: [],
+      blocking: false,
+      input: {
+        parameters: {},
+        layout: 'object',
+        namespace: namespace
+      },
+      output: {
+        parameters: parameters,
+        layout: 'object',
+        namespace: namespace
+      },
+      meta: {
+        object: nil,
+        global: nil
+      },
+      examples: [],
+      scope: "#{namespace}#show",
+      path: path,
+      method: 'GET',
+      help: "#{path}?method=GET"
+    }
+  end
+
+  def response(values)
+    {
+      status: true,
+      response: values.merge(_meta: {}),
+      message: nil,
+      errors: nil
+    }
+  end
+end
+
+RSpec.describe HaveAPI::Client::ResourceInstance do
+  def client_for(...)
+    communicator = ResourceAssociationTestCommunicator.new(...)
+    client = HaveAPI::Client::Client.new(
+      'https://api.example',
+      communicator: communicator
+    )
+
+    [client, communicator]
+  end
+
+  it 'materializes a resolved association through the resource registry' do
+    client, communicator = client_for(resolved: true)
+
+    user = client.user.current
+
+    expect(user.language_id).to eq(1)
+    expect(user.language.code).to eq('cs')
+    expect(communicator.calls).to eq([:current])
+  end
+
+  it 'resolves a lazy association through the resource registry' do
+    client, communicator = client_for(resolved: false)
+
+    user = client.user.current
+
+    expect(user.language.code).to eq('cs')
+    expect(communicator.calls).to eq(%i[current show])
+  end
+
+  it 'reports an invalid associated resource path as a protocol error' do
+    client, = client_for(resolved: true, association_path: ['missing'])
+
+    expect { client.user.current }
+      .to raise_error(
+        HaveAPI::Client::ProtocolError,
+        "associated resource 'missing' not found"
+      )
+  end
+end

data/spec/validators/inclusion_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HaveAPI::Client::Validators::Inclusion do
+  subject(:validator) do
+    described_class.new(
+      { values: values, message: 'not included' },
+      value,
+      other_params
+    )
+  end
+
+  let(:other_params) { Struct.new(:params).new({}) }
+
+  context 'with an array of values' do
+    let(:values) { %w[archive stream] }
+
+    it 'uses exact membership' do
+      expect(described_class.new(
+               { values: values, message: 'not included' },
+               'archive',
+               other_params
+             )).to be_valid
+      expect(described_class.new(
+               { values: values, message: 'not included' },
+               :archive,
+               other_params
+             )).not_to be_valid
+    end
+  end
+
+  context 'with a map of labeled values' do
+    let(:values) { { archive: 'Archive', stream: 'Stream' } }
+
+    context 'with a matching string value' do
+      let(:value) { 'archive' }
+
+      it { is_expected.to be_valid }
+    end
+
+    context 'with a missing string value' do
+      let(:value) { 'incremental_stream' }
+
+      it { is_expected.not_to be_valid }
+    end
+  end
+
+  context 'with a numeric map key parsed from JSON' do
+    let(:values) { { '1': 'One', '2': 'Two' } }
+    let(:value) { 1 }
+
+    it { is_expected.to be_valid }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-client
 version: !ruby/object:Gem::Version
-  version: 0.29.4
+  version: 0.29.6
 platform: ruby
 authors:
 - Jakub Skokan
@@ -162,8 +162,10 @@ files:
 - spec/integration/client_spec.rb
 - spec/integration/typed_input_spec.rb
 - spec/load_spec.rb
+- spec/resource_instance_association_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_server.rb
+- spec/validators/inclusion_spec.rb
 homepage: ''
 licenses:
 - MIT