searchapi 1.0.0

data/lib/searchapi/google_light_result.rb

@@ -0,0 +1,198 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleLightMetadataSchema = DynamicSchema::Struct.define do
+    id                    String
+    status                String
+    created_at            String, as: :created_at
+    request_time_taken    Float, as: :request_time_taken
+    parsing_time_taken    Float, as: :parsing_time_taken
+    total_time_taken      Float, as: :total_time_taken
+    request_url           String, as: :request_url
+    html_url              String, as: :html_url
+    json_url              String, as: :json_url
+  end
+
+  class GoogleLightMetadata < GoogleLightMetadataSchema
+  end
+
+  GoogleLightParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    location              String
+    location_used         String, as: :location_used
+    uule                  String
+    google_domain         String, as: :google_domain
+    hl                    String
+    gl                    String
+    lr                    String
+    nfpr                  String
+    filter                String
+    safe                  String
+    page                  Integer
+  end
+
+  class GoogleLightParameters < GoogleLightParametersSchema
+  end
+
+  GoogleLightSearchInformationSchema = DynamicSchema::Struct.define do
+    query_displayed       String, as: :query_displayed
+    page                  Integer
+    detected_location     String, as: :detected_location
+    did_you_mean          String, as: :did_you_mean
+  end
+
+  class GoogleLightSearchInformation < GoogleLightSearchInformationSchema
+  end
+
+  GoogleLightAnswerBoxSourceSchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    displayed_link        String, as: :displayed_link
+  end
+
+  class GoogleLightAnswerBoxSource < GoogleLightAnswerBoxSourceSchema
+  end
+
+  GoogleLightAnswerBoxSchema = DynamicSchema::Struct.define do
+    question              String
+    answer                String
+    answer_highlight      String, as: :answer_highlight
+    answer_list           String, array: true, as: :answer_list
+    source                GoogleLightAnswerBoxSource
+  end
+
+  class GoogleLightAnswerBox < GoogleLightAnswerBoxSchema
+  end
+
+  GoogleLightKnowledgeGraphSourceSchema = DynamicSchema::Struct.define do
+    name                  String
+    link                  String
+  end
+
+  class GoogleLightKnowledgeGraphSource < GoogleLightKnowledgeGraphSourceSchema
+  end
+
+  GoogleLightKnowledgeGraphSchema = DynamicSchema::Struct.define do
+    title                 String
+    type                  String
+    rating                Float
+    reviews               Integer
+    website               String
+    directions            String
+    source                GoogleLightKnowledgeGraphSource
+    description           String
+    facts                 Hash
+    thumbnail             String
+    images                String, array: true
+  end
+
+  class GoogleLightKnowledgeGraph < GoogleLightKnowledgeGraphSchema
+  end
+
+  GoogleLightSitelinkSchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+  end
+
+  class GoogleLightSitelink < GoogleLightSitelinkSchema
+  end
+
+  GoogleLightSitelinksSchema = DynamicSchema::Struct.define do
+    inline                GoogleLightSitelink, array: true
+  end
+
+  class GoogleLightSitelinks < GoogleLightSitelinksSchema
+  end
+
+  GoogleLightOrganicResultSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    link                  String
+    displayed_link        String, as: :displayed_link
+    snippet               String
+    date                  String
+    rating                Float
+    reviews               Integer
+    sitelinks             GoogleLightSitelinks
+    extensions            String, array: true
+  end
+
+  class GoogleLightOrganicResult < GoogleLightOrganicResultSchema
+  end
+
+  GoogleLightTopStorySchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    source                String
+    date                  String
+  end
+
+  class GoogleLightTopStory < GoogleLightTopStorySchema
+  end
+
+  GoogleLightLatestPostSchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    source                String
+    date                  String
+  end
+
+  class GoogleLightLatestPost < GoogleLightLatestPostSchema
+  end
+
+  GoogleLightRelatedQuestionSchema = DynamicSchema::Struct.define do
+    question              String
+    answer                String
+    answer_highlight      String, as: :answer_highlight
+    answer_list           String, array: true, as: :answer_list
+    source                GoogleLightAnswerBoxSource
+  end
+
+  class GoogleLightRelatedQuestion < GoogleLightRelatedQuestionSchema
+  end
+
+  GoogleLightRelatedSearchSchema = DynamicSchema::Struct.define do
+    query                 String
+  end
+
+  class GoogleLightRelatedSearch < GoogleLightRelatedSearchSchema
+  end
+
+  GoogleLightPaginationSchema = DynamicSchema::Struct.define do
+    current               Integer
+    previous              String
+    _value                :next, type: String
+  end
+
+  class GoogleLightPagination < GoogleLightPaginationSchema
+  end
+
+  GoogleLightResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleLightMetadata, as: :search_metadata
+    search_parameters     GoogleLightParameters, as: :search_parameters
+    search_information    GoogleLightSearchInformation, as: :search_information
+    answer_box            GoogleLightAnswerBox, as: :answer_box
+    knowledge_graph       GoogleLightKnowledgeGraph, as: :knowledge_graph
+    organic_results       GoogleLightOrganicResult, array: true, as: :organic_results
+    top_stories           GoogleLightTopStory, array: true, as: :top_stories
+    latest_posts          GoogleLightLatestPost, array: true, as: :latest_posts
+    related_questions     GoogleLightRelatedQuestion, array: true, as: :related_questions
+    related_searches      GoogleLightRelatedSearch, array: true, as: :related_searches
+    pagination            GoogleLightPagination
+    error                 String
+  end
+
+  class GoogleLightResult < GoogleLightResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :organic_results, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi/google_local_options.rb

@@ -0,0 +1,40 @@
+module SearchAPI
+  class GoogleLocalOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    DEVICES = %w[ desktop mobile tablet ]
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      device                String, in: DEVICES, normalize: NORMALIZE_DOWNCASE
+      location              String
+      uule                  String
+      google_domain         String
+      gl                    String
+      hl                    String
+      page                  Integer
+    end
+
+    def self.build( options = nil, &block )
+      new( api_options: builder.build( options, &block ) )
+    end
+
+    def self.build!( options = nil, &block )
+      new( api_options: builder.build!( options, &block ) )
+    end
+
+    def initialize( options = {}, api_options: nil )
+      @options = self.class.builder.build( options || {} )
+      @options = api_options.merge( @options ) if api_options
+    end
+
+    def to_h
+      result = @options.to_h
+      result[ :engine ] = 'google_local'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_local_request.rb

@@ -0,0 +1,26 @@
+module SearchAPI
+  class GoogleLocalRequest < Request
+
+    def search( query, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleLocalOptions ) ? options : GoogleLocalOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_local' }
+      end
+      options[ :q ] = query.to_s
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleLocalSearchResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+  end
+end

data/lib/searchapi/google_local_result.rb

@@ -0,0 +1,85 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleLocalSearchMetadataSchema = DynamicSchema::Struct.define do
+    id                    String
+    status                String
+    created_at            String, as: :created_at
+    request_time_taken    Float, as: :request_time_taken
+    parsing_time_taken    Float, as: :parsing_time_taken
+    total_time_taken      Float, as: :total_time_taken
+    request_url           String, as: :request_url
+    html_url              String, as: :html_url
+    json_url              String, as: :json_url
+  end
+
+  class GoogleLocalSearchMetadata < GoogleLocalSearchMetadataSchema
+  end
+
+  GoogleLocalSearchParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    device                String
+    location              String
+    location_used         String, as: :location_used
+    uule                  String
+    google_domain         String, as: :google_domain
+    gl                    String
+    hl                    String
+    page                  Integer
+  end
+
+  class GoogleLocalSearchParameters < GoogleLocalSearchParametersSchema
+  end
+
+  GoogleLocalSearchExtractedPriceSchema = DynamicSchema::Struct.define do
+    min                   Integer
+    max                   Integer
+  end
+
+  class GoogleLocalSearchExtractedPrice < GoogleLocalSearchExtractedPriceSchema
+  end
+
+  GoogleLocalSearchResultItemSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    ludocid               String
+    rating                Float
+    reviews               Integer
+    price                 String
+    extracted_price       GoogleLocalSearchExtractedPrice, as: :extracted_price
+    comment               String
+    extensions            String, array: true
+    image                 String
+    link                  String
+    hotel_class           String, as: :hotel_class
+    amenities             String, array: true
+    direction             String
+    website               String
+    phone                 String
+    order                 String
+  end
+
+  class GoogleLocalSearchResultItem < GoogleLocalSearchResultItemSchema
+  end
+
+  GoogleLocalSearchResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleLocalSearchMetadata, as: :search_metadata
+    search_parameters     GoogleLocalSearchParameters, as: :search_parameters
+    local_results         GoogleLocalSearchResultItem, array: true, as: :local_results
+    error                 String
+  end
+
+  class GoogleLocalSearchResult < GoogleLocalSearchResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :local_results, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi/google_news_light_options.rb

@@ -0,0 +1,47 @@
+module SearchAPI
+  class GoogleNewsLightOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    TIME_PERIODS = %w[ last_hour last_day last_week last_month last_year ]
+    SORT_BY = %w[ most_recent ]
+    SAFE_SEARCH = %w[ active off ]
+
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      location              String
+      uule                  String
+      google_domain         String, as: :google_domain
+      gl                    String
+      hl                    String
+      time_period           String, in: TIME_PERIODS, as: :time_period, normalize: NORMALIZE_DOWNCASE
+      sort_by               String, in: SORT_BY, as: :sort_by, normalize: NORMALIZE_DOWNCASE
+      nfpr                  Integer
+      filter                Integer
+      safe                  String, in: SAFE_SEARCH, normalize: NORMALIZE_DOWNCASE
+      page                  Integer
+    end
+
+    def self.build( options = nil, &block )
+      new( api_options: builder.build( options, &block ) )
+    end
+
+    def self.build!( options = nil, &block )
+      new( api_options: builder.build!( options, &block ) )
+    end
+
+    def initialize( options = {}, api_options: nil )
+      @options = self.class.builder.build( options || {} )
+      @options = api_options.merge( @options ) if api_options
+    end
+
+    def to_h
+      result = @options.to_h
+      result[ :engine ] = 'google_news_light'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_news_light_request.rb

@@ -0,0 +1,26 @@
+module SearchAPI
+  class GoogleNewsLightRequest < Request
+
+    def search( query, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsLightOptions ) ? options : GoogleNewsLightOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news_light' }
+      end
+      options[ :q ] = query.to_s
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleNewsLightResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+  end
+end

data/lib/searchapi/google_news_light_result.rb

@@ -0,0 +1,94 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleNewsLightMetadataSchema = DynamicSchema::Struct.define do
+    id                    String
+    status                String
+    created_at            String, as: :created_at
+    request_time_taken    Float, as: :request_time_taken
+    parsing_time_taken    Float, as: :parsing_time_taken
+    total_time_taken      Float, as: :total_time_taken
+    request_url           String, as: :request_url
+    html_url              String, as: :html_url
+    json_url              String, as: :json_url
+  end
+
+  class GoogleNewsLightMetadata < GoogleNewsLightMetadataSchema
+  end
+
+  GoogleNewsLightParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    location              String
+    location_used         String, as: :location_used
+    uule                  String
+    google_domain         String, as: :google_domain
+    gl                    String
+    hl                    String
+    time_period           String, as: :time_period
+    sort_by               String, as: :sort_by
+    nfpr                  Integer
+    filter                Integer
+    safe                  String
+    page                  Integer
+  end
+
+  class GoogleNewsLightParameters < GoogleNewsLightParametersSchema
+  end
+
+  GoogleNewsLightSearchInformationSchema = DynamicSchema::Struct.define do
+    query_displayed       String, as: :query_displayed
+    total_results         Integer, as: :total_results
+    page                  Integer
+    time_taken_displayed  Float, as: :time_taken_displayed
+    detected_location     String, as: :detected_location
+  end
+
+  class GoogleNewsLightSearchInformation < GoogleNewsLightSearchInformationSchema
+  end
+
+  GoogleNewsLightArticleSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    link                  String
+    source                String
+    date                  String
+    snippet               String
+    thumbnail             String
+  end
+
+  class GoogleNewsLightArticle < GoogleNewsLightArticleSchema
+  end
+
+  GoogleNewsLightTopStorySchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    source                String
+    date                  String
+  end
+
+  class GoogleNewsLightTopStory < GoogleNewsLightTopStorySchema
+  end
+
+  GoogleNewsLightResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleNewsLightMetadata, as: :search_metadata
+    search_parameters     GoogleNewsLightParameters, as: :search_parameters
+    search_information    GoogleNewsLightSearchInformation, as: :search_information
+    organic_results       GoogleNewsLightArticle, array: true, as: :organic_results
+    top_stories           GoogleNewsLightTopStory, array: true, as: :top_stories
+    error                 String
+  end
+
+  class GoogleNewsLightResult < GoogleNewsLightResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :organic_results, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi/google_news_options.rb

@@ -0,0 +1,53 @@
+module SearchAPI
+  class GoogleNewsOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    DEVICES = %w[ desktop mobile tablet ]
+    SAFE_SEARCH = %w[ active off ]
+    TIME_PERIODS = %w[ last_hour last_day last_week last_month last_year ]
+    SORT_BY = %w[ most_recent ]
+
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      device                String, in: DEVICES, normalize: NORMALIZE_DOWNCASE
+      location              String
+      uule                  String
+      google_domain         String
+      hl                    String
+      gl                    String
+      lr                    String
+      cr                    String
+      nfpr                  String
+      filter                String
+      safe                  String, in: SAFE_SEARCH, normalize: NORMALIZE_DOWNCASE
+      page                  Integer
+      time_period           String, in: TIME_PERIODS, normalize: NORMALIZE_DOWNCASE
+      time_period_min       String
+      time_period_max       String
+      sort_by               String, in: SORT_BY, normalize: NORMALIZE_DOWNCASE
+    end
+
+    def self.build( options = nil, &block )
+      new( api_options: builder.build( options, &block ) )
+    end
+
+    def self.build!( options = nil, &block )
+      new( api_options: builder.build!( options, &block ) )
+    end
+
+    def initialize( options = {}, api_options: nil )
+      @options = self.class.builder.build( options || {} )
+      @options = api_options.merge( @options ) if api_options
+    end
+
+    def to_h
+      result = @options.to_h
+      result[ :engine ] = 'google_news'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_news_portal_options.rb

@@ -0,0 +1,40 @@
+module SearchAPI
+  class GoogleNewsPortalOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    SORT_BY = %w[ relevance date ]
+
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      ceid                  String
+      story_token           String, as: :story_token
+      topic_token           String, as: :topic_token
+      publication_token     String, as: :publication_token
+      section_token         String, as: :section_token
+      sort_by               String, in: SORT_BY, as: :sort_by, normalize: NORMALIZE_DOWNCASE
+    end
+
+    def self.build( options = nil, &block )
+      new( api_options: builder.build( options, &block ) )
+    end
+
+    def self.build!( options = nil, &block )
+      new( api_options: builder.build!( options, &block ) )
+    end
+
+    def initialize( options = {}, api_options: nil )
+      @options = self.class.builder.build( options || {} )
+      @options = api_options.merge( @options ) if api_options
+    end
+
+    def to_h
+      result = @options.to_h
+      result[ :engine ] = 'google_news_portal'
+      result
+    end
+
+  end
+end