From b5e4868ab0dafa184e43ec5b9da19b06b636191b Mon Sep 17 00:00:00 2001 From: Andy Wang Date: Tue, 17 Nov 2026 21:45:36 +0800 Subject: [PATCH] Override defaults across String and Symbol query keys String and Symbol keys are accepted for request parameters, but merging them as distinct Hash keys sends both defaults and overrides under the same HTTP field name. Remove a default when its opposite key type is present in the call. Preserve actual key objects, payload values, output precedence, and nil compaction. Fixes #45 --- CHANGELOG.md | 1 + lib/serpapi/client.rb | 5 +- spec/serpapi/client/query_overrides_spec.rb | 115 ++++++++++++++++++++ 3 files changed, 120 insertions(+), 1 deletion(-) create mode 100644 spec/serpapi/client/query_overrides_spec.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index fa01a94..167b355 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog + * [Unreleased] Override client query defaults consistently across String and Symbol keys * [Unreleased] Add native Extract API support via the `extract` method * [Unreleased] Apply the `timeout` option to persistent connections * [Unreleased] Add Image API support diff --git a/lib/serpapi/client.rb b/lib/serpapi/client.rb index 14eeb94..b5d0e4a 100644 --- a/lib/serpapi/client.rb +++ b/lib/serpapi/client.rb @@ -287,7 +287,10 @@ def query(params) raise SerpApiError, "params must be hash, not: #{params.class}" unless params.instance_of?(Hash) # merge default params with custom params - q = @params.clone.merge(params) + defaults = @params.reject do |key, _| + (key.is_a?(Symbol) && params.key?(key.to_s)) || (key.is_a?(String) && params.key?(key.to_sym)) + end + q = defaults.merge(params) q.delete('output') if params.key?(:output) q.delete(:output) if params.key?('output') && !params.key?(:output) diff --git a/spec/serpapi/client/query_overrides_spec.rb b/spec/serpapi/client/query_overrides_spec.rb new file mode 100644 index 0000000..ea89276 --- /dev/null +++ b/spec/serpapi/client/query_overrides_spec.rb @@ -0,0 +1,115 @@ +require 'spec_helper' +require 'stringio' +require 'uri' + +describe 'query parameter overrides' do + let(:transport) { HTTP::Client.new } + let(:response) do + double(status: 200, headers: { 'Content-Type' => 'application/json' }, body: '{}') + end + let(:requests) { [] } + + before do + allow(HTTP).to receive(:timeout).and_return(transport) + allow(transport).to receive(:perform) do |request, _options| + requests << request + response + end + end + + def query_values(name) + URI.decode_www_form(requests.last.uri.query).select { |key, _| key == name }.map(&:last) + end + + %w[engine api_key custom_backend_option].each do |name| + [[name, name.to_sym], [name.to_sym, name]].each do |default_key, call_key| + it "replaces #{default_key.inspect} with #{call_key.inspect} in the encoded request" do + client = SerpApi::Client.new(default_key => 'default-value', persistent: false) + params = { call_key => 'override-value' }.freeze + + client.search(params) + + expect(query_values(name)).to eq(['override-value']) + expect(client.params[default_key]).to eq('default-value') + expect(params).to eq(call_key => 'override-value') + end + end + end + + [['output', :output], [:output, 'output']].each do |default_key, call_key| + it "keeps output overrides working from #{default_key.inspect} to #{call_key.inspect}" do + client = SerpApi::Client.new(default_key => 'html', persistent: false) + + client.search(call_key => 'md') + + expect(query_values('output')).to eq(['md']) + end + end + + it 'removes a default when its differently keyed override is nil' do + client = SerpApi::Client.new('location' => 'Austin', persistent: false) + + client.search(location: nil) + + expect(query_values('location')).to eq([]) + end + + it 'retains defaults with no per-call override' do + client = SerpApi::Client.new('engine' => 'google', persistent: false) + + client.search(q: 'coffee') + + expect(query_values('engine')).to eq(['google']) + expect(query_values('q')).to eq(['coffee']) + end + + [:engine, 'engine'].each do |key| + it "keeps Extract engine forcing with #{key.inspect} defaults" do + client = SerpApi::Client.new(key => 'google', persistent: false) + + client.extract(url: 'https://example.com/', 'engine' => 'bing') + + expect(query_values('engine')).to eq(['extract']) + end + end + + [:html, :md].each do |format| + it "keeps #{format} output forcing with conflicting defaults and call keys" do + client = SerpApi::Client.new('output' => 'json', persistent: false) + + client.public_send(format, output: 'json', 'output' => 'json') + + expect(query_values('output')).to eq([format.to_s]) + end + end + + it 'preserves symbol-output precedence within a single call' do + client = SerpApi::Client.new(persistent: false) + + client.search('output' => 'html', output: 'md') + + expect(query_values('output')).to eq(['md']) + end + + it 'overrides a string-keyed API key in a multipart image upload' do + client = SerpApi::Client.new('api_key' => 'default-value', persistent: false) + image = StringIO.new('image-data') + + client.upload_image(image, api_key: 'override-value') + + body = +'' + requests.last.body.each { |chunk| body << chunk } + expect(body.scan('name="api_key"').size).to eq(1) + expect(body).to include('override-value', 'image-data') + expect(body).not_to include('default-value') + expect(image).not_to be_closed + end + + it 'preserves array-valued backend parameters' do + client = SerpApi::Client.new('include_tags' => ['title'], persistent: false) + + client.extract(url: 'https://example.com/', include_tags: ['main', 'article']) + + expect(query_values('include_tags')).to eq(['main', 'article']) + end +end