searchapi 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d08a566b8b60588ec83cfb8c18f535de5fe329325dfafb1d8120a61f105afeac
-  data.tar.gz: 4a59d8ca1b3921e1d419abd37789ca5098b61f4dd0a5465c1674b76445cff156
+  metadata.gz: bade0e59fb4fc3764856d1cd4a5fed0eef7f06c6b5ce512ff4802d9848269154
+  data.tar.gz: 5ebb00269d7e4b1c01efe107d4082157b513644352674bde9282de28e6975043
 SHA512:
-  metadata.gz: 680bf0570d6b8b814cf7256c5bc3df04d0a3e60f3c38cc7ff420044a51e15836835c8b40ead4c8a613c69016512206cc8f72fe41602124127b8130883d1408bd
-  data.tar.gz: 1dc489acd03a4540dcf63121ae4c4ece11f550f795c0e86a6f4326420c263dee4b0ac0bfc92b805ede693c24232f6d62dbf135bbb64424177963d52c342a7e45
+  metadata.gz: 5f39465a4dbcfe4869e45aec36807fa5e4af2ad6ffc4dd9d974982a9f8d65fa1a49347f8a5a1265876003198af0155052426c14ad77da99ceb1afb3255c60c1a
+  data.tar.gz: 0fab4b542de5214aeb387bdf0530ca2791667b74c8d21e47322d5341cad1dfdd8f095aad1faa7d9879bdbdf051dc684f971d206b29a70a692fa27d9c080bad6a

data/README.md

@@ -1,6 +1,6 @@
-# SearchAPI Ruby Gem
+# SearchApi Ruby Gem
 
-A Ruby client for the [SearchAPI.io](https://searchapi.io) API, providing access to Google Search, YouTube, Instagram, TikTok, and more.
+A Ruby client for the [SearchApi.io](https://searchapi.io) API, providing access to Google Search, YouTube, Instagram, TikTok, and more.
 
 ## Installation
 
@@ -21,33 +21,33 @@ gem install searchapi
 ```ruby
 require 'searchapi'
 
-SearchAPI.api_key ENV['SEARCH_API_KEY']
+SearchApi.api_key ENV['SEARCH_API_KEY']
 ```
 
 ## Available APIs
 
 | API | Method | Description |
 |-----|--------|-------------|
-| Google Search | `SearchAPI.google(query)` | Full Google search with all features |
-| Google Light | `SearchAPI.google_light(query)` | Fast, lightweight Google search |
-| Google News | `SearchAPI.news(query)` | Google News articles |
-| Google News Portal | `SearchAPI.news_portal(query)` | Google News Portal with topics |
-| Google News Light | `SearchAPI.news_light(query)` | Fast, lightweight news search |
-| Google Images | `SearchAPI.images(query)` | Google Image search |
-| Google Local | `SearchAPI.local(query)` | Local business search |
-| Google Scholar | `SearchAPI.scholar(query)` | Academic papers and citations |
-| Google Finance | `SearchAPI.finance(symbol)` | Stock quotes and financial data |
-| Google Flights | `SearchAPI.flights(options)` | Flight search and booking |
-| YouTube | `SearchAPI.youtube(query)` | YouTube video search |
-| Instagram | `SearchAPI.instagram(username)` | Instagram profile data |
-| TikTok | `SearchAPI.tiktok(username)` | TikTok profile data |
+| Google Search | `SearchApi.google(query)` | Full Google search with all features |
+| Google Light | `SearchApi.google_light(query)` | Fast, lightweight Google search |
+| Google News | `SearchApi.news(query)` | Google News articles |
+| Google News Portal | `SearchApi.news_portal(query)` | Google News Portal with topics |
+| Google News Light | `SearchApi.news_light(query)` | Fast, lightweight news search |
+| Google Images | `SearchApi.images(query)` | Google Image search |
+| Google Local | `SearchApi.local(query)` | Local business search |
+| Google Scholar | `SearchApi.scholar(query)` | Academic papers and citations |
+| Google Finance | `SearchApi.finance(symbol)` | Stock quotes and financial data |
+| Google Flights | `SearchApi.flights(options)` | Flight search and booking |
+| YouTube | `SearchApi.youtube(query)` | YouTube video search |
+| Instagram | `SearchApi.instagram(username)` | Instagram profile data |
+| TikTok | `SearchApi.tiktok(username)` | TikTok profile data |
 
 ## Quick Examples
 
 ### Google Search
 
 ```ruby
-response = SearchAPI.google('ruby programming')
+response = SearchApi.google('ruby programming')
 response.result.organic_results.each do |result|
   puts "#{ result.title } - #{ result.link }"
 end
@@ -56,7 +56,7 @@ end
 ### Google News
 
 ```ruby
-response = SearchAPI.news('technology', time_period: :last_week)
+response = SearchApi.news('technology', time_period: :last_week)
 response.result.each do |article|
   puts "#{ article.title } (#{ article.source })"
 end
@@ -65,7 +65,7 @@ end
 ### Google Images
 
 ```ruby
-response = SearchAPI.images('sunset', size: :large, color: :orange)
+response = SearchApi.images('sunset', size: :large, color: :orange)
 response.result.each do |image|
   puts "#{ image.title } - #{ image.original.link }"
 end
@@ -74,28 +74,28 @@ end
 ### Google Finance
 
 ```ruby
-response = SearchAPI.finance('AAPL:NASDAQ')
+response = SearchApi.finance('AAPL:NASDAQ')
 puts "#{ response.result.summary.title }: $#{ response.result.summary.price }"
 ```
 
 ### Google Flights
 
 ```ruby
-options = SearchAPI::GoogleFlightsOptions.build do
+options = SearchApi::GoogleFlightsOptions.build do
   departure_id 'JFK'
   arrival_id 'LAX'
   outbound_date '2026-06-15'
   flight_type :one_way
 end
 
-response = SearchAPI.flights(options)
+response = SearchApi.flights(options)
 puts "Cheapest: $#{ response.result.cheapest&.price }"
 ```
 
 ### YouTube Search
 
 ```ruby
-response = SearchAPI.youtube('ruby tutorial')
+response = SearchApi.youtube('ruby tutorial')
 response.result.videos.each do |video|
   puts "#{ video.title } by #{ video.channel.title }"
 end
@@ -105,11 +105,11 @@ end
 
 ```ruby
 # Instagram
-response = SearchAPI.instagram('instagram')
+response = SearchApi.instagram('instagram')
 puts "#{ response.result.profile.username }: #{ response.result.followers } followers"
 
 # TikTok
-response = SearchAPI.tiktok('tiktok')
+response = SearchApi.tiktok('tiktok')
 puts "#{ response.result.profile.name }: #{ response.result.hearts } hearts"
 ```
 
@@ -119,25 +119,25 @@ Each API supports options via a block or hash:
 
 ```ruby
 # Block syntax
-options = SearchAPI::GoogleSearchOptions.build do
+options = SearchApi::GoogleSearchOptions.build do
   device :mobile
   gl 'us'
   hl 'en'
   time_period :last_week
 end
-response = SearchAPI.google('news', options)
+response = SearchApi.google('news', options)
 
 # Hash syntax
-response = SearchAPI.google('news', { device: :mobile, gl: 'us' })
+response = SearchApi.google('news', { device: :mobile, gl: 'us' })
 ```
 
 Options are case-insensitive and normalized automatically:
 
 ```ruby
 # These are equivalent
-SearchAPI::GoogleFinanceOptions.build { window :'1d' }  # => '1D'
-SearchAPI::GoogleFinanceOptions.build { window :'1D' }  # => '1D'
-SearchAPI::GoogleFinanceOptions.build { window :MAX }   # => 'MAX'
+SearchApi::GoogleFinanceOptions.build { window :'1d' }  # => '1D'
+SearchApi::GoogleFinanceOptions.build { window :'1D' }  # => '1D'
+SearchApi::GoogleFinanceOptions.build { window :MAX }   # => 'MAX'
 ```
 
 ## Response Structure
@@ -145,7 +145,7 @@ SearchAPI::GoogleFinanceOptions.build { window :MAX }   # => 'MAX'
 All responses return a Faraday response with a `result` accessor:
 
 ```ruby
-response = SearchAPI.google('test')
+response = SearchApi.google('test')
 response.success?        # HTTP success
 response.result.success? # API success (no error field)
 response.result.search_metadata
@@ -156,7 +156,7 @@ response.result.organic_results
 Results are enumerable where it makes sense:
 
 ```ruby
-response = SearchAPI.google('ruby')
+response = SearchApi.google('ruby')
 response.result.each { |r| puts r.title }  # Iterates organic_results
 response.result.first                       # First organic result
 response.result.count                       # Number of organic results

data/lib/searchapi/error_result.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class ErrorResult
 
     attr_reader :error_type, :error_description
@@ -39,10 +39,10 @@ module SearchAPI
           "The rate limit has been exceeded." ]
       when 500..599
         [ :server_error,
-          "The SearchAPI server encountered an error while processing the request." ]
+          "The SearchApi server encountered an error while processing the request." ]
       else
         [ :unknown_error,
-          "The SearchAPI service returned an unexpected status code: '#{ status_code }'." ]
+          "The SearchApi service returned an unexpected status code: '#{ status_code }'." ]
       end
     end
 

data/lib/searchapi/google_finance_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleFinanceOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_finance_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleFinanceRequest < Request
 
     def quote( symbol, options = nil, &block )

data/lib/searchapi/google_finance_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # Google Finance Search metadata
   GoogleFinanceMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi/google_flights_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleFlightsOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_flights_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleFlightsRequest < Request
 
     def search( options = nil, &block )

data/lib/searchapi/google_flights_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # Google Flights Search metadata
   GoogleFlightsMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi/google_images_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleImagesOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_images_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleImagesRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/google_images_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleImagesMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_light_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleLightOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_light_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleLightRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/google_light_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleLightMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_local_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleLocalOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_local_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleLocalRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/google_local_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleLocalSearchMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_news_light_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsLightOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_news_light_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsLightRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/google_news_light_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleNewsLightMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_news_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_news_portal_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsPortalOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_news_portal_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsPortalRequest < Request
 
     def search( query = nil, options = nil, &block )

data/lib/searchapi/google_news_portal_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleNewsPortalMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_news_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleNewsRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/google_news_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleNewsMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_scholar_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleScholarOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_scholar_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleScholarRequest < Request
 
     def search( query = nil, options = nil, &block )

data/lib/searchapi/google_scholar_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   GoogleScholarMetadataSchema = DynamicSchema::Struct.define do
     id                    String

data/lib/searchapi/google_search_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleSearchOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/google_search_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class GoogleSearchRequest < Request
 
     def search( query = nil, options = nil, &block )

data/lib/searchapi/google_search_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # Search metadata
   GoogleSearchMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi/helpers.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   module Helpers
 
     def string_camelize( string )

data/lib/searchapi/instagram_profile_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class InstagramProfileOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/instagram_profile_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class InstagramProfileRequest < Request
 
     def profile( username, options = nil, &block )

data/lib/searchapi/instagram_profile_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # Instagram Search metadata
   InstagramProfileMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi/module_methods.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   module ModuleMethods
 
     def connection( connection = nil )

data/lib/searchapi/request.rb

@@ -1,14 +1,14 @@
-module SearchAPI
+module SearchApi
   class Request
 
     BASE_URI = 'https://www.searchapi.io/api/v1'
 
     def initialize( connection: nil, api_key: nil )
-      @connection = connection || SearchAPI.connection
-      @api_key = api_key || SearchAPI.api_key
+      @connection = connection || SearchApi.connection
+      @api_key = api_key || SearchApi.api_key
       raise ArgumentError,
             "The API key is required but was not provided; configure it using " \
-            "'SearchAPI.api_key' or pass it directly." unless @api_key
+            "'SearchApi.api_key' or pass it directly." unless @api_key
     end
 
   protected

data/lib/searchapi/response_methods.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   module ResponseMethods
 
     def self.install( response, result )

data/lib/searchapi/tiktok_profile_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class TikTokProfileOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/tiktok_profile_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class TikTokProfileRequest < Request
 
     def profile( username, options = nil, &block )

data/lib/searchapi/tiktok_profile_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # TikTok Search metadata
   TikTokProfileMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi/version.rb

@@ -1,3 +1,3 @@
-module SearchAPI
-  VERSION = '1.0.0'
+module SearchApi
+  VERSION = '1.1.0'
 end

data/lib/searchapi/youtube_search_options.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class YouTubeSearchOptions
     include DynamicSchema::Definable
     include Helpers

data/lib/searchapi/youtube_search_request.rb

@@ -1,4 +1,4 @@
-module SearchAPI
+module SearchApi
   class YouTubeSearchRequest < Request
 
     def search( query, options = nil, &block )

data/lib/searchapi/youtube_search_result.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 
-module SearchAPI
+module SearchApi
 
   # YouTube Search metadata
   YouTubeSearchMetadataSchema = DynamicSchema::Struct.define do

data/lib/searchapi.rb

@@ -65,6 +65,6 @@ require_relative 'searchapi/google_scholar_request'
 
 require_relative 'searchapi/module_methods'
 
-module SearchAPI
+module SearchApi
   extend ModuleMethods
 end

data/searchapi.gemspec

@@ -3,15 +3,15 @@ require_relative 'lib/searchapi/version'
 Gem::Specification.new do | spec |
 
   spec.name             = 'searchapi'
-  spec.version          = SearchAPI::VERSION
+  spec.version          = SearchApi::VERSION
   spec.authors          = [ 'Kristoph Cichocki-Romanov' ]
   spec.email            = [ 'rubygems.org@kristoph.net' ]
 
   spec.summary          =
-    "A Ruby client for the SearchAPI.io API, supporting various services including " \
+    "A Ruby client for the SearchApi.io API, supporting various services including " \
     "Google Search, YouTube, Instagram, and others."
   spec.description      =
-    "A Ruby client for the SearchAPI.io API. Supports various services including " \
+    "A Ruby client for the SearchApi.io API. Supports various services including " \
     "Google Search, YouTube, Instagram, TikTok, Google Finance, Google Flights, " \
     "Google News, Google Images, Google Scholar, and more."
   spec.license          = 'MIT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: searchapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kristoph Cichocki-Romanov
@@ -79,7 +79,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.3'
-description: A Ruby client for the SearchAPI.io API. Supports various services including
+description: A Ruby client for the SearchApi.io API. Supports various services including
   Google Search, YouTube, Instagram, TikTok, Google Finance, Google Flights, Google
   News, Google Images, Google Scholar, and more.
 email:
@@ -159,6 +159,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: A Ruby client for the SearchAPI.io API, supporting various services including
+summary: A Ruby client for the SearchApi.io API, supporting various services including
   Google Search, YouTube, Instagram, and others.
 test_files: []