Skip to content

Constructor symbolize_names defaults are ignored #44

Open

Description

@yorzi

Basic checks

  • I searched existing issues, open and closed, and this has not been reported (reported previously in author-withdrawn Fix timeout & symbolize_names in default #22; no active parser-precedence fix)
  • I can reproduce this consistently on master
  • This is a serpapi-ruby bug, not my application code

What's broken?

Client.new(symbolize_names: false) is documented in
lib/serpapi/client.rb:60, but JSON responses still have Symbol keys.
process_json_response at line 354 reads only the method-call params.
Constructor defaults are never consulted.

This affects searches, account responses, archived searches, and image
uploads. search_archive cannot receive a per-call parser option, so its
constructor default is especially important.

Closed #22 included this
fix alongside many unrelated changes. Its author closed it and deleted
the branch. This is a focused follow-up, not a new discovery.
Open #39 fixes caller Hash
mutation; #42 changes
error policy and error metadata. Neither fixes parser-option precedence.

One interaction to decide on: error detection reads Symbol keys only
(data.key?(:error)). Per-call symbolize_names: false already has this
gap on master. Once the constructor option works, those clients hit it
as well: a 200 response with an error key is returned instead of
raised, and a 401 raises with serpapi_error set to nil. With #42
applied, constructor false gives the same results as the default for
all three cases I checked. I suggest this fix lands after #42 or together
with it.

How to reproduce

From the repository root, after bundle install. This replaces the
transport in this process and makes no network request:

bundle exec ruby -Ilib - <<'RUBY'
require 'serpapi'

response = Struct.new(:status, :headers, :body).new(
  200, { 'Content-Type' => 'application/json' }, '{"search_metadata":{"id":"offline"}}'
)
transport = Object.new
transport.define_singleton_method(:get) { |*_args, **_options| response }
HTTP.define_singleton_method(:timeout) { |_timeout| transport }
client = SerpApi::Client.new(persistent: false, symbolize_names: false)
p client.search(q: 'coffee').keys
RUBY

Expected behavior

["search_metadata"]. Per-call settings override constructor settings,
and absent settings keep the default Symbol keys.

What actually happened

[:search_metadata]

I have a small local fix with tests and can open a PR.

Environment

  • Ruby 3.4.4, macOS arm64
  • serpapi-ruby master at 786baa6848020df031abed734ed7ff03af3a6560
  • HTTP.rb 5.3.1, RSpec 3.13.2
  • No API credentials, external requests, or search credits used

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions