switch HTTP library to faraday to allow adapter to select HTTP library, and fix test

Author: jvmvik

Gemfile

@@ -2,6 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
+group :development, :production do
+  gem 'faraday', '~> 2.0'
+end
+
 group :test, :development do
   # code coloring for yard
   gem 'redcarpet'
@@ -20,4 +24,3 @@ group :test, :development do
     gem "pry-byebug"
   end
 end
-

lib/serpapi.rb

@@ -4,8 +4,10 @@ module SerpApi
   # see serpapi/serpapi for implementation
 end
 
-# load native ruby dependency
-require 'open-uri'
+# load faraday HTTP lib
+require 'faraday'
+
+# load 
 require 'json'
 
 # implementation

lib/serpapi/client.rb

@@ -30,7 +30,7 @@ class Client
     # key can be either a symbol or a string.
     #
     # @param [Hash] params default for the search
-    def initialize(params = {})
+    def initialize(params = {}, adapter = :net_http)
       # set default read timeout
       @timeout = params[:timeout] || params['timeout'] || 120
       @timeout.freeze
@@ -42,6 +42,9 @@ def initialize(params = {})
       # set default params safely in memory
       @params = params.clone || {}
       @params.freeze
+
+      # setup connection socket
+      @socket = Faraday.new(url: "https://#{BACKEND}")
     end
 
     # perform a search using SerpApi.com
@@ -104,63 +107,50 @@ def api_key
 
     private
 
-    # build url from the search params
-    #
-    # @param [String] endpoint HTTP service uri
-    # @param [Hash] params custom search inputs
-    # @return formatted HTTPS URL
-    def build_url(endpoint, params)
-      # force default
-      query = (@params || {}).merge(params || {})
+    # @return [Hash] query parameter
+    def query(params)
+      # merge default params with custom params
+      q = (@params || {}).merge(params || {})
 
       # set ruby client
-      query[:source] = 'serpapi-ruby:' << SerpApi::VERSION
+      q[:source] = 'serpapi-ruby:' << SerpApi::VERSION
 
       # delete empty key/value
-      query.compact!
-
-      # HTTP params encoding
-      encoded_query = URI.encode_www_form(query)
-
-      # return URL
-      URI::HTTPS.build(host: BACKEND, path: endpoint, query: encoded_query)
+      q.compact
     end
 
     # get HTTP query formatted results
     #
     # @param [String] endpoint HTTP service uri
     # @param [Symbol] decoder type :json or :html
     # @param [Hash] params custom search inputs
+    # @param [Boolean] symbolize_names if true, convert JSON keys to symbols
     # @return decoded payload as JSON / Hash or String
-    def get(endpoint, decoder = :json, params = {})
-      url = build_url(endpoint, params)
-      payload = URI(url).open(read_timeout: timeout).read
-      decode(payload, decoder)
-      rescue OpenURI::HTTPError => err
-        data = JSON.parse(err.io.read)
-        if data.key?('error')
-          raise SerpApiException, "error: #{data['error']} from url: #{url}"
+    def get(endpoint, decoder = :json, params = {}, symbolize_names = true)
+      begin
+        payload = @socket.get(endpoint) do |req|
+          req.params = query(params)
+          req.options.timeout = timeout
         end
-        raise SerpApiException, "fail: get url: #{url} response: #{data}"
-      rescue => err
-        raise SerpApiException, "fail: get url: #{url} caused by: #{err}"
+        # read http response
+        data = payload.body
+        # decode payload using JSON native parser
+        if decoder == :json
+          data = JSON.parse(data, symbolize_names: symbolize_names)
+          if data.class == Hash && data.key?('error')
+            raise SerpApiException, "get failed with error: #{data['error']} from url: #{endpoint}, params: #{params}, decoder: #{decoder}, http status: #{payload.status} "
+          end
+          if payload.status != 200
+            raise SerpApiException, "get failed with response status: #{payload.status} reponse: #{data} on get url: #{endpoint}, params: #{params}, decoder: #{decoder}"
+          end
+        end
+        # return raw HTML
+        return data
+      rescue Faraday::Error => err
+        raise SerpApiException, "fail: get url: #{endpoint} caused by #{err.class} : #{err.message} (params: #{params}, decoder: #{decoder})"
       end
     end
 
-    # decode HTTP payload either as :json or :html
-    #
-    # @param [String] payload to decode
-    # @param [Symbol] decoder type :json or :html
-    # @return decoded payload as JSON / Hash or HTML / String
-    def decode(payload, decoder)
-      case decoder
-      when :json
-        JSON.parse(payload, symbolize_names: true)
-      when :html
-        payload
-      else
-        msg = "not supported decoder #{decoder}. should be: :html or :json (Symbol)"
-        raise SerpApiException, msg
-      end
-    end
+  end
+
 end

spec/serpapi/client/account_api_spec.rb

@@ -25,5 +25,7 @@
     expect(account_info[:account_id]).not_to be_empty
     expect(account_info[:api_key]).not_to be_empty
     expect(account_info[:account_email]).not_to be_empty
+
+    puts "search left: #{account_info[:plan_searches_left]}"
   end
 end

spec/serpapi/client/client_spec.rb

@@ -2,7 +2,6 @@
 
 describe 'client full coverage' do
   before(:all) do
-    pp Module.constants.select { |c| c.to_s =~ /SerpApi/ }
     @client = SerpApi::Client.new(engine: 'google', api_key: ENV['API_KEY'], timeout: 30)
   end
 
@@ -59,7 +58,7 @@
     begin
       @client.search({})
     rescue SerpApi::Errors::SerpApiException => e
-      expect(e.message).to include('fail: get url')
+      expect(e.message).to include('get failed with response')
     rescue => e
       raise("wrong exception: #{e}")
     end

spec/serpapi/client/location_api_spec.rb

@@ -3,15 +3,14 @@
 describe 'SerpApi Location API' do
   it 'Get normalized location for Austin, TX' do
     client = SerpApi::Client.new(api_key: ENV['API_KEY'])
-    location_list = client.location(q: 'Austin', limit: 3)
-    expect(location_list.size).to eq(3)
+    location_list = client.location(q: 'Austin, TX', limit: 3)
+    expect(location_list.size).to eq(1)
 
     first = location_list.first
-    expect(first[:id]).to eq('585069bdee19ad271e9bc072')
+    expect(first[:id]).not_to be_nil
     expect(first[:name]).to eq('Austin, TX')
     expect(first[:country_code]).to eq('US')
     expect(first[:target_type]).to eq('DMA Region')
-    expect(first[:reach]).to eq(5_560_000)
     expect(first[:gps]).to eq([-97.7430608, 30.267153])
     expect(first[:keys]).to eq(%w[austin tx texas united states])
     expect(first[:canonical_name]).to eq('Austin,TX,Texas,United States')