searchapi 1.0.0

data/lib/searchapi/google_news_portal_request.rb

@@ -0,0 +1,89 @@
+module SearchAPI
+  class GoogleNewsPortalRequest < Request
+
+    def search( query = nil, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsPortalOptions ) ? options : GoogleNewsPortalOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news_portal' }
+      end
+      options[ :q ] = query.to_s if query
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleNewsPortalResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+    def story( story_token, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsPortalOptions ) ? options : GoogleNewsPortalOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news_portal' }
+      end
+      options[ :story_token ] = story_token.to_s
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleNewsPortalResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+    def topic( topic_token, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsPortalOptions ) ? options : GoogleNewsPortalOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news_portal' }
+      end
+      options[ :topic_token ] = topic_token.to_s
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleNewsPortalResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+    def publication( publication_token, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsPortalOptions ) ? options : GoogleNewsPortalOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news_portal' }
+      end
+      options[ :publication_token ] = publication_token.to_s
+
+      response = get( "#{ BASE_URI }/search", options, &block )
+      attributes = ( JSON.parse( response.body, symbolize_names: true ) rescue nil )
+
+      result = if response.success?
+        GoogleNewsPortalResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+  end
+end

data/lib/searchapi/google_news_portal_result.rb

@@ -0,0 +1,137 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleNewsPortalMetadataSchema = 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 GoogleNewsPortalMetadata < GoogleNewsPortalMetadataSchema
+  end
+
+  GoogleNewsPortalParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    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, as: :sort_by
+  end
+
+  class GoogleNewsPortalParameters < GoogleNewsPortalParametersSchema
+  end
+
+  GoogleNewsPortalSourceSchema = DynamicSchema::Struct.define do
+    name                  String
+    favicon               String
+    authors               String, array: true
+  end
+
+  class GoogleNewsPortalSource < GoogleNewsPortalSourceSchema
+  end
+
+  GoogleNewsPortalArticleSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    link                  String
+    thumbnail             String
+    iso_date              String, as: :iso_date
+    story_token           String, as: :story_token
+    story_title           String, as: :story_title
+    section               String
+    source                GoogleNewsPortalSource
+  end
+
+  class GoogleNewsPortalArticle < GoogleNewsPortalArticleSchema
+  end
+
+  GoogleNewsPortalMenuTopicSchema = DynamicSchema::Struct.define do
+    title                 String
+    topic_token           String, as: :topic_token
+  end
+
+  class GoogleNewsPortalMenuTopic < GoogleNewsPortalMenuTopicSchema
+  end
+
+  GoogleNewsPortalRelatedTopicSchema = DynamicSchema::Struct.define do
+    title                 String
+    topic_token           String, as: :topic_token
+    thumbnail             String
+  end
+
+  class GoogleNewsPortalRelatedTopic < GoogleNewsPortalRelatedTopicSchema
+  end
+
+  GoogleNewsPortalRelatedPublicationSchema = DynamicSchema::Struct.define do
+    name                  String
+    publication_token     String, as: :publication_token
+    thumbnail             String
+  end
+
+  class GoogleNewsPortalRelatedPublication < GoogleNewsPortalRelatedPublicationSchema
+  end
+
+  GoogleNewsPortalSubMenuSectionSchema = DynamicSchema::Struct.define do
+    title                 String
+    section_token         String, as: :section_token
+  end
+
+  class GoogleNewsPortalSubMenuSection < GoogleNewsPortalSubMenuSectionSchema
+  end
+
+  GoogleNewsPortalPostOnXSchema = DynamicSchema::Struct.define do
+    link                  String
+    snippet               String
+    author                String
+    author_link           String, as: :author_link
+    author_thumbnail      String, as: :author_thumbnail
+    date                  String
+  end
+
+  class GoogleNewsPortalPostOnX < GoogleNewsPortalPostOnXSchema
+  end
+
+  GoogleNewsPortalFAQSchema = DynamicSchema::Struct.define do
+    question              String
+    answer                String
+    link                  String
+  end
+
+  class GoogleNewsPortalFAQ < GoogleNewsPortalFAQSchema
+  end
+
+  GoogleNewsPortalResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleNewsPortalMetadata, as: :search_metadata
+    search_parameters     GoogleNewsPortalParameters, as: :search_parameters
+    organic_results       GoogleNewsPortalArticle, array: true, as: :organic_results
+    menu_topics           GoogleNewsPortalMenuTopic, array: true, as: :menu_topics
+    related_topics        GoogleNewsPortalRelatedTopic, array: true, as: :related_topics
+    related_publications  GoogleNewsPortalRelatedPublication, array: true, as: :related_publications
+    sub_menu_sections     GoogleNewsPortalSubMenuSection, array: true, as: :sub_menu_sections
+    posts_on_x            GoogleNewsPortalPostOnX, array: true, as: :posts_on_x
+    frequently_asked_questions GoogleNewsPortalFAQ, array: true, as: :frequently_asked_questions
+    error                 String
+  end
+
+  class GoogleNewsPortalResult < GoogleNewsPortalResultSchema
+    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_request.rb

@@ -0,0 +1,26 @@
+module SearchAPI
+  class GoogleNewsRequest < Request
+
+    def search( query, options = nil, &block )
+      if options
+        options = options.is_a?( GoogleNewsOptions ) ? options : GoogleNewsOptions.build!( options.to_h )
+        options = options.to_h
+      else
+        options = { engine: 'google_news' }
+      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?
+        GoogleNewsResult.new( attributes || {} )
+      else
+        ErrorResult.new( response.status, attributes )
+      end
+
+      ResponseMethods.install( response, result )
+    end
+
+  end
+end

data/lib/searchapi/google_news_result.rb

@@ -0,0 +1,129 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleNewsMetadataSchema = 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 GoogleNewsMetadata < GoogleNewsMetadataSchema
+  end
+
+  GoogleNewsParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    device                String
+    uule                  String
+    location              String
+    location_used         String, as: :location_used
+    google_domain         String, as: :google_domain
+    hl                    String
+    gl                    String
+    lr                    String
+    cr                    String
+    nfpr                  String
+    filter                String
+    safe                  String
+    page                  String
+    time_period           String, as: :time_period
+    time_period_min       String, as: :time_period_min
+    time_period_max       String, as: :time_period_max
+    sort_by               String, as: :sort_by
+  end
+
+  class GoogleNewsParameters < GoogleNewsParametersSchema
+  end
+
+  GoogleNewsSearchInformationSchema = 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
+    did_you_mean          String, as: :did_you_mean
+    has_no_results_for    [ TrueClass, FalseClass ], as: :has_no_results_for
+    showing_results_for   String, as: :showing_results_for
+  end
+
+  class GoogleNewsSearchInformation < GoogleNewsSearchInformationSchema
+  end
+
+  GoogleNewsArticleSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    link                  String
+    source                String
+    date                  String
+    snippet               String
+    is_live               [ TrueClass, FalseClass ], as: :is_live
+    favicon               String
+    thumbnail             String
+  end
+
+  class GoogleNewsArticle < GoogleNewsArticleSchema
+  end
+
+  GoogleNewsTopStorySchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    author                String
+    author_link           String, as: :author_link
+    source                String
+    date                  String
+    snippet               String
+    is_live               [ TrueClass, FalseClass ], as: :is_live
+    is_video              [ TrueClass, FalseClass ], as: :is_video
+    thumbnail             String
+  end
+
+  class GoogleNewsTopStory < GoogleNewsTopStorySchema
+  end
+
+  GoogleNewsMoreLinkSchema = DynamicSchema::Struct.define do
+    link                  String
+  end
+
+  class GoogleNewsMoreLink < GoogleNewsMoreLinkSchema
+  end
+
+  GoogleNewsPaginationSchema = DynamicSchema::Struct.define do
+    current               Integer
+    previous              String
+    _value                :next, type: String
+    other_pages           Hash, as: :other_pages
+  end
+
+  class GoogleNewsPagination < GoogleNewsPaginationSchema
+  end
+
+  GoogleNewsResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleNewsMetadata, as: :search_metadata
+    search_parameters     GoogleNewsParameters, as: :search_parameters
+    search_information    GoogleNewsSearchInformation, as: :search_information
+    organic_results       GoogleNewsArticle, array: true, as: :organic_results
+    top_stories           GoogleNewsTopStory, array: true, as: :top_stories
+    top_stories_more_link GoogleNewsMoreLink, as: :top_stories_more_link
+    pagination            GoogleNewsPagination
+    error                 String
+  end
+
+  class GoogleNewsResult < GoogleNewsResultSchema
+    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_scholar_options.rb

@@ -0,0 +1,48 @@
+module SearchAPI
+  class GoogleScholarOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    SAFE_SEARCH = %w[ active off ]
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      cites                 String
+      cluster               String
+      hl                    String
+      lr                    String
+      safe                  String, in: SAFE_SEARCH, normalize: NORMALIZE_DOWNCASE
+      filter                Integer
+      as_ylo                Integer
+      as_yhi                Integer
+      scisbd                Integer
+      as_vis                Integer
+      as_rr                 Integer
+      as_sdt                String
+      source                String
+      num                   Integer, in: 1..20
+      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_scholar'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_scholar_request.rb

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

data/lib/searchapi/google_scholar_result.rb

@@ -0,0 +1,195 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleScholarMetadataSchema = 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 GoogleScholarMetadata < GoogleScholarMetadataSchema
+  end
+
+  GoogleScholarParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    cites                 String
+    cluster               String
+    hl                    String
+    lr                    String
+    scisbd                Integer
+    as_ylo                Integer, as: :as_ylo
+    as_yhi                Integer, as: :as_yhi
+    as_rr                 Integer, as: :as_rr
+    as_vis                Integer, as: :as_vis
+    as_sdt                String, as: :as_sdt
+    filter                Integer
+    safe                  String
+    source                String
+    num                   Integer
+    page                  Integer
+  end
+
+  class GoogleScholarParameters < GoogleScholarParametersSchema
+  end
+
+  GoogleScholarDidYouMeanSchema = DynamicSchema::Struct.define do
+    text                  String
+    link                  String
+  end
+
+  class GoogleScholarDidYouMean < GoogleScholarDidYouMeanSchema
+  end
+
+  GoogleScholarSearchInformationSchema = DynamicSchema::Struct.define do
+    total_results         Integer, as: :total_results
+    page                  Integer
+    time_taken_displayed  Float, as: :time_taken_displayed
+    query_displayed       String, as: :query_displayed
+    did_you_mean          GoogleScholarDidYouMean, as: :did_you_mean
+  end
+
+  class GoogleScholarSearchInformation < GoogleScholarSearchInformationSchema
+  end
+
+  GoogleScholarCitedBySchema = DynamicSchema::Struct.define do
+    total                 Integer
+  end
+
+  class GoogleScholarCitedBy < GoogleScholarCitedBySchema
+  end
+
+  GoogleScholarProfileSchema = DynamicSchema::Struct.define do
+    name                  String
+    link                  String
+    author_id             String, as: :author_id
+    affiliations          String
+    email                 String
+    cited_by              GoogleScholarCitedBy, as: :cited_by
+  end
+
+  class GoogleScholarProfile < GoogleScholarProfileSchema
+  end
+
+  GoogleScholarOrganizationSchema = DynamicSchema::Struct.define do
+    name                  String
+    link                  String
+    org_id                String, as: :org_id
+    university            String
+  end
+
+  class GoogleScholarOrganization < GoogleScholarOrganizationSchema
+  end
+
+  GoogleScholarResourceSchema = DynamicSchema::Struct.define do
+    name                  String
+    format                String
+    link                  String
+  end
+
+  class GoogleScholarResource < GoogleScholarResourceSchema
+  end
+
+  GoogleScholarAuthorSchema = DynamicSchema::Struct.define do
+    name                  String
+    id                    String
+    link                  String
+  end
+
+  class GoogleScholarAuthor < GoogleScholarAuthorSchema
+  end
+
+  GoogleScholarCitedByLinkSchema = DynamicSchema::Struct.define do
+    total                 Integer
+    link                  String
+    cites_id              String, as: :cites_id
+  end
+
+  class GoogleScholarCitedByLink < GoogleScholarCitedByLinkSchema
+  end
+
+  GoogleScholarVersionsSchema = DynamicSchema::Struct.define do
+    total                 Integer
+    link                  String
+    cluster_id            String, as: :cluster_id
+  end
+
+  class GoogleScholarVersions < GoogleScholarVersionsSchema
+  end
+
+  GoogleScholarInlineLinksSchema = DynamicSchema::Struct.define do
+    cited_by              GoogleScholarCitedByLink, as: :cited_by
+    versions              GoogleScholarVersions
+    related_articles_link String, as: :related_articles_link
+    cached_page_link      String, as: :cached_page_link
+  end
+
+  class GoogleScholarInlineLinks < GoogleScholarInlineLinksSchema
+  end
+
+  GoogleScholarArticleSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    link                  String
+    data_cid              String, as: :data_cid
+    type                  String
+    publication           String
+    snippet               String
+    resource              GoogleScholarResource
+    authors               GoogleScholarAuthor, array: true
+    inline_links          GoogleScholarInlineLinks, as: :inline_links
+  end
+
+  class GoogleScholarArticle < GoogleScholarArticleSchema
+  end
+
+  GoogleScholarRelatedSearchSchema = DynamicSchema::Struct.define do
+    query                 String
+    highlighted           String, array: true
+    link                  String
+  end
+
+  class GoogleScholarRelatedSearch < GoogleScholarRelatedSearchSchema
+  end
+
+  GoogleScholarPaginationSchema = DynamicSchema::Struct.define do
+    current               Integer
+    previous              String
+    _value                :next, type: String
+    other_pages           Hash, as: :other_pages
+  end
+
+  class GoogleScholarPagination < GoogleScholarPaginationSchema
+  end
+
+  GoogleScholarResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleScholarMetadata, as: :search_metadata
+    search_parameters     GoogleScholarParameters, as: :search_parameters
+    search_information    GoogleScholarSearchInformation, as: :search_information
+    profiles              GoogleScholarProfile, array: true
+    organizations         GoogleScholarOrganization, array: true
+    organic_results       GoogleScholarArticle, array: true, as: :organic_results
+    related_searches      GoogleScholarRelatedSearch, array: true, as: :related_searches
+    pagination            GoogleScholarPagination
+    error                 String
+  end
+
+  class GoogleScholarResult < GoogleScholarResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :organic_results, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end