serpapi 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf26fc67e0314db3dcdc7505883936a534faa9ca10021ee5db722cd40ffc1fd8
-  data.tar.gz: 047216ed0cceeb4bc18edc82a104c961b527076527c68e4f10eb5f576dec48fd
+  metadata.gz: 256135fd8adcf51d34456850db13dc6110f8f9886d1c6ee162344b78b3ffacf1
+  data.tar.gz: 51b6b6482ac8ac3ca5bd882d8bfe7750a7de0a5b84bf85199ef80b06ae670968
 SHA512:
-  metadata.gz: d1413d68e289bc72ae2de9a264c9fa6e4a757fa2993d3cff8a2a8d9cc76e8a0441dc92e6164a93ab7fb972d60e63fe3ea716c09db26fa3fb187aeacdce7f4c67
-  data.tar.gz: 546ae88d007ba76a7ae9633c9b3780f7ff255892e2d9951971d2b32ef4a1cca5148de8857f2ba1de7113d19221b099d4bfd75e8e71fc6437be7548b09235d01e
+  metadata.gz: a42455d35414bd84de2e7e1f8c1185c9da913994b83738e7207d5622070202d839c185007d629e0aa19880aaebf64d146ad86fd038110239722032b695e19dab
+  data.tar.gz: fd987c93d188904abface957957483be583f8ae54ec68a2876d99354a8dd704c07df5d7c55f7c51451a128a0c5f3f457f7b5b0a2f0f4e157eb74a30ac38a8342

data/lib/serpapi/client.rb

@@ -181,6 +181,11 @@ module SerpApi
       @socket.close if @socket
     end
 
+    def inspect
+      masked_key = api_key && (api_key.length > 8 ? "#{api_key[..3]}****#{api_key[-4..]}" : '****')
+      "#<#{self.class} @engine=#{engine} @timeout=#{timeout} @persistent=#{persistent} api_key=#{masked_key}>"
+    end
+
     private
 
     # @param [Hash] params to merge with default parameters provided to the constructor.
@@ -210,47 +215,79 @@ module SerpApi
     # @param [Hash] params custom search inputs
     # @return [String|Hash] raw HTML or decoded response as JSON / Hash
     def get(endpoint, decoder = :json, params = {})
-      # execute get via open socket
-      response = if persistent?
-                   @socket.get(endpoint, params: query(params))
-                 else
-                   HTTP.timeout(timeout).get("https://#{BACKEND}#{endpoint}", params: query(params))
-                 end
-
-      # decode response using JSON native parser
+      response = execute_request(endpoint, params)
+      handle_response(response, decoder, endpoint, params)
+    end
+
+    def execute_request(endpoint, params)
+      if persistent?
+        @socket.get(endpoint, params: query(params))
+      else
+        url = "https://#{BACKEND}#{endpoint}"
+        HTTP.timeout(timeout).get(url, params: query(params))
+      end
+    end
+
+    def handle_response(response, decoder, endpoint, params)
       case decoder
       when :json
-        # read http response
-        begin
-          # user can turn on/off JSON keys to symbols
-          # this is more memory efficient, but not always needed
-          symbolize_names = params.key?(:symbolize_names) ? params[:symbolize_names] : true
-
-          # parse JSON response with Ruby standard library
-          data = JSON.parse(response.body, symbolize_names: symbolize_names)
-          if data.instance_of?(Hash) && data.key?(:error)
-            raise SerpApiError, "HTTP request failed with error: #{data[:error]} from url: https://#{BACKEND}#{endpoint}, params: #{params}, decoder: #{decoder}, response status: #{response.status} "
-          elsif response.status != 200
-            raise SerpApiError, "HTTP request failed with response status: #{response.status} reponse: #{data} on get url: https://#{BACKEND}#{endpoint}, params: #{params}, decoder: #{decoder}"
-          end
-        rescue JSON::ParserError
-          raise SerpApiError, "JSON parse error: #{response.body} on get url: https://#{BACKEND}#{endpoint}, params: #{params}, decoder: #{decoder}, response status: #{response.status}"
-        end
-
-        # discard response body
-        response.flush if persistent?
-
-        data
+        process_json_response(response, endpoint, params)
       when :html
-        # html decoder
-        if response.status != 200
-          raise SerpApiError, "HTTP request failed with response status: #{response.status} reponse: #{data} on get url: https://#{BACKEND}#{endpoint}, params: #{params}, decoder: #{decoder}"
-        end
-
-        response.body
+        process_html_response(response, endpoint, params)
       else
         raise SerpApiError, "not supported decoder: #{decoder}, available: :json, :html"
       end
     end
+
+    def process_json_response(response, endpoint, params)
+      symbolize = params.fetch(:symbolize_names, true)
+
+      begin
+        data = JSON.parse(response.body, symbolize_names: symbolize)
+        validate_json_content!(data, response, endpoint, params)
+      rescue JSON::ParserError
+        raise_parser_error(response, endpoint, params)
+      end
+
+      response.flush if persistent?
+      data
+    end
+
+    def process_html_response(response, endpoint, params)
+      raise_http_error(response, nil, endpoint, params, decoder: :html) if response.status != 200
+      response.body
+    end
+
+    def validate_json_content!(data, response, endpoint, params)
+      if data.is_a?(Hash) && data.key?(:error)
+        raise_http_error(response, data, endpoint, params, explicit_error: data[:error])
+      elsif response.status != 200
+        raise_http_error(response, data, endpoint, params)
+      end
+    end
+
+    # Centralized error raising to clean up the logic methods
+    def raise_http_error(response, data, endpoint, params, explicit_error: nil, decoder: :json)
+      msg = "HTTP request failed with status: #{response.status}"
+      msg += " error: #{explicit_error}" if explicit_error
+
+      raise SerpApiError.new(
+        "#{msg} from url: https://#{BACKEND}#{endpoint}",
+        serpapi_error: explicit_error || (data.is_a?(Hash) ? data[:error] : nil),
+        search_params: params,
+        response_status: response.status,
+        search_id: data.is_a?(Hash) ? data&.dig(:search_metadata, :id) : nil,
+        decoder: decoder
+      )
+    end
+
+    def raise_parser_error(response, endpoint, params)
+      raise SerpApiError.new(
+        "JSON parse error: #{response.body} on get url: https://#{BACKEND}#{endpoint}",
+        search_params: params,
+        response_status: response.status,
+        decoder: :json
+      )
+    end
   end
 end

data/lib/serpapi/error.rb

@@ -2,13 +2,81 @@
 # frozen_string_literal: true
 
 module SerpApi
-  # SerpApiError wraps any errors related to the SerpApi client.
+  # Custom error class for SerpApi-related errors.
+  # Inherits from StandardError.
+  # Includes optional attributes for detailed error context.
+  # Attributes:
+  # - serpapi_error: String error message from SerpApi (optional)
+  # - search_params: Hash of search parameters used (optional)
+  # - response_status: Integer HTTP or response status code (optional)
+  # - search_id: String id returned by the service for the search (optional)
+  # - decoder: Symbol representing the decoder/format used (optional) (e.g. :json)
   class SerpApiError < StandardError
-    # List the specific types of errors handled by the Error class.
-    #  - HTTP response errors from SerpApi.com
-    #  - Missing API key
-    #  - Credit limit
-    #  - Incorrect query
-    #  - more ...
+    attr_reader :serpapi_error, :search_params, :response_status, :search_id, :decoder
+
+    # All attributes are optional keyword arguments.
+    #
+    # @param message [String, nil] an optional human message passed to StandardError
+    # @param serpapi_error [String, nil] optional error string coming from SerpAPI
+    # @param search_params [Hash, nil] optional hash of the search parameters used
+    # @param response_status [Integer, nil] optional HTTP or response status code
+    # @param search_id [String, nil] optional id returned by the service for the search
+    # @param decoder [Symbol, nil] optional decoder/format used (e.g. :json)
+    def initialize(message = nil,
+                   serpapi_error: nil,
+                   search_params: nil,
+                   response_status: nil,
+                   search_id: nil,
+                   decoder: nil)
+      super(message)
+
+      @serpapi_error = validate_optional_string(serpapi_error, :serpapi_error)
+      @search_params = search_params.dup
+      @response_status = validate_optional_integer(response_status, :response_status)
+      @search_id = validate_optional_string(search_id, :search_id)
+      @decoder = validate_optional_symbol(decoder, :decoder)
+    end
+
+    # Return a compact hash representation (omits nil values).
+    #
+    # @return [Hash]
+    def to_h
+      {
+        message: message,
+        serpapi_error: serpapi_error,
+        search_params: search_params.dup,
+        response_status: response_status,
+        search_id: search_id,
+        decoder: decoder
+      }.compact
+    end
+
+    private
+
+    def validate_optional_string(value, name = nil)
+      return nil if value.nil?
+      raise TypeError, "expected #{name || 'value'} to be a String, got #{value.class}" unless value.is_a?(String)
+
+      value.freeze
+    end
+
+    def validate_optional_integer(value, name = nil)
+      return nil if value.nil?
+      return value if value.is_a?(Integer)
+
+      # Accept numeric-like strings (e.g. "200") by converting; fail otherwise.
+      begin
+        Integer(value)
+      rescue ArgumentError, TypeError
+        raise TypeError, "expected #{name || 'value'} to be an Integer (or integer-like), got #{value.inspect}"
+      end
+    end
+
+    def validate_optional_symbol(value, name = nil)
+      return nil if value.nil?
+      raise TypeError, "expected #{name || 'value'} to be a Symbol, got #{value.class}" unless value.is_a?(Symbol)
+
+      value
+    end
   end
 end

data/lib/serpapi/version.rb

@@ -1,4 +1,4 @@
 module SerpApi
   # Current version of the gem
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: serpapi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - victor benarbia
 - Julien Khaleghy
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -111,6 +112,7 @@ homepage: https://github.com/serpapi/serpapi-ruby
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,7 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Official Ruby library for SerpApi.com
 test_files: []