searchapi 1.0.0

data/lib/searchapi/tiktok_profile_options.rb

@@ -0,0 +1,31 @@
+module SearchAPI
+  class TikTokProfileOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    schema do
+      # required
+      username              String
+    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 ] = 'tiktok_profile'
+      result
+    end
+
+  end
+end

data/lib/searchapi/tiktok_profile_request.rb

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

data/lib/searchapi/tiktok_profile_result.rb

@@ -0,0 +1,71 @@
+require 'forwardable'
+
+module SearchAPI
+
+  # TikTok Search metadata
+  TikTokProfileMetadataSchema = 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 TikTokProfileMetadata < TikTokProfileMetadataSchema
+  end
+
+  # TikTok Search parameters
+  TikTokProfileParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    username              String
+  end
+
+  class TikTokProfileParameters < TikTokProfileParametersSchema
+  end
+
+  # Profile
+  TikTokProfileSchema = DynamicSchema::Struct.define do
+    username              String
+    name                  String
+    bio                   String
+    avatar                String
+    avatar_hd             String, as: :avatar_hd
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+    is_private            [ TrueClass, FalseClass ], as: :is_private
+    is_business           [ TrueClass, FalseClass ], as: :is_business
+    posts                 Integer
+    followers             Integer
+    following             Integer
+    category              String
+    bio_link              String, as: :bio_link
+    hearts                Integer
+    language              String
+    created_at            String, as: :created_at
+  end
+
+  class TikTokProfile < TikTokProfileSchema
+  end
+
+  # Main TikTok profile result
+  TikTokProfileResultSchema = DynamicSchema::Struct.define do
+    search_metadata       TikTokProfileMetadata, as: :search_metadata
+    search_parameters     TikTokProfileParameters, as: :search_parameters
+    profile               TikTokProfile
+    error                 String
+  end
+
+  class TikTokProfileResult < TikTokProfileResultSchema
+    extend Forwardable
+
+    def_delegators :profile, :username, :name, :bio, :avatar, :followers, :following, :hearts
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi/version.rb

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

data/lib/searchapi/youtube_search_options.rb

@@ -0,0 +1,62 @@
+module SearchAPI
+  class YouTubeSearchOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    COUNTRIES = %w[
+      DZ AR AU AT AZ BH BD BY BE BO BA BR BG KH CA
+      CL CO CR HR CY CZ DK DO EC EG SV EE FI FR GE
+      DE GH GR GT HN HK HU IS IN ID IQ IE IL IT JM
+      JP JO KZ KE KW LA LV LB LY LI LT LU MY MT MX
+      ME MA NP NL NZ NI NG MK NO OM PK PA PG PY PE
+      PH PL PT PR QA RO RU SA SN RS SG SK SI ZA KR
+      ES LK SE CH TW TZ TH TN TR UG UA AE GB US UY
+      VE VN YE ZW
+    ]
+
+    LANGUAGES = %w[
+      af az id ms bs ca cs da de et en-in en-gb en
+      es es-419 es-us eu fil fr fr-ca gl hr zu is
+      it sw lv lt hu nl no uz pl pt-pt pt ro sq sk
+      sl sr-latn fi sv vi tr be bg ky kk mk mn ru
+      sr uk el hy iw ur ar fa ne mr hi as bn pa gu
+      or ta te kn ml si th lo my ka am km zh-cn
+      zh-tw zh-hk ja ko
+    ]
+
+    NORMALIZE_UPCASE = ->(v) { v.to_s.upcase }
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      # search query (required)
+      q                       String
+
+      # filter/pagination token
+      sp                      String
+
+      # localization
+      gl                      String, in: COUNTRIES, normalize: NORMALIZE_UPCASE
+      hl                      String, in: LANGUAGES, 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 ] = 'youtube'
+      result
+    end
+
+  end
+end

data/lib/searchapi/youtube_search_request.rb

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

data/lib/searchapi/youtube_search_result.rb

@@ -0,0 +1,411 @@
+require 'forwardable'
+
+module SearchAPI
+
+  # YouTube Search metadata
+  YouTubeSearchMetadataSchema = 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 YouTubeSearchMetadata < YouTubeSearchMetadataSchema
+  end
+
+  # YouTube Search parameters
+  YouTubeSearchParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    sp                    String
+    hl                    String
+    gl                    String
+  end
+
+  class YouTubeSearchParameters < YouTubeSearchParametersSchema
+  end
+
+  # YouTube Search information
+  YouTubeSearchInformationSchema = DynamicSchema::Struct.define do
+    total_results         Integer, as: :total_results
+    state                 String
+    original_query        String, as: :original_query
+    original_query_sp     String, as: :original_query_sp
+    corrected_query       String, as: :corrected_query
+  end
+
+  class YouTubeSearchInformation < YouTubeSearchInformationSchema
+  end
+
+  # YouTube Thumbnail
+  YouTubeThumbnailSchema = DynamicSchema::Struct.define do
+    static                String
+    rich                  String
+  end
+
+  class YouTubeThumbnail < YouTubeThumbnailSchema
+  end
+
+  # Video channel
+  YouTubeVideoChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+    thumbnail             String
+  end
+
+  class YouTubeVideoChannel < YouTubeVideoChannelSchema
+  end
+
+  # Key moment
+  YouTubeKeyMomentSchema = DynamicSchema::Struct.define do
+    title                 String
+    start_seconds         Integer, as: :start_seconds
+    thumbnail             String
+  end
+
+  class YouTubeKeyMoment < YouTubeKeyMomentSchema
+  end
+
+  # Video result
+  YouTubeVideoSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    description           String
+    views                 Integer
+    is_live               [ TrueClass, FalseClass ], as: :is_live
+    channel               YouTubeVideoChannel
+    length                String
+    published_time        String, as: :published_time
+    badges                String, array: true
+    thumbnail             YouTubeThumbnail
+    key_moments           YouTubeKeyMoment, array: true, as: :key_moments
+  end
+
+  class YouTubeVideo < YouTubeVideoSchema
+  end
+
+  # Channel result
+  YouTubeChannelSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    description           String
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+    video_count           Integer, as: :video_count
+    subscribers           Integer
+    thumbnail             YouTubeThumbnail
+  end
+
+  class YouTubeChannel < YouTubeChannelSchema
+  end
+
+  # Playlist channel
+  YouTubePlaylistChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+    link                  String
+  end
+
+  class YouTubePlaylistChannel < YouTubePlaylistChannelSchema
+  end
+
+  # Playlist video
+  YouTubePlaylistVideoSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+    length                String
+  end
+
+  class YouTubePlaylistVideo < YouTubePlaylistVideoSchema
+  end
+
+  # Playlist result
+  YouTubePlaylistSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    video_count           Integer, as: :video_count
+    channel               YouTubePlaylistChannel
+    published_time        String, as: :published_time
+    videos                YouTubePlaylistVideo, array: true
+    thumbnail             String
+  end
+
+  class YouTubePlaylist < YouTubePlaylistSchema
+  end
+
+  # Movie channel
+  YouTubeMovieChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+  end
+
+  class YouTubeMovieChannel < YouTubeMovieChannelSchema
+  end
+
+  # Metadata items
+  YouTubeMetadataItemsSchema = DynamicSchema::Struct.define do
+    top                   String, array: true
+    bottom                String, array: true
+  end
+
+  class YouTubeMetadataItems < YouTubeMetadataItemsSchema
+  end
+
+  # Movie result
+  YouTubeMovieSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    description           String
+    channel               YouTubeMovieChannel
+    length                String
+    metadata_items        YouTubeMetadataItems, as: :metadata_items
+    badges                String, array: true
+    buttons               String, array: true
+    thumbnail             String
+  end
+
+  class YouTubeMovie < YouTubeMovieSchema
+  end
+
+  # Short video
+  YouTubeShortSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    duration              String
+    views                 Integer
+    thumbnail             String
+  end
+
+  class YouTubeShort < YouTubeShortSchema
+  end
+
+  # Shorts section
+  YouTubeShortsSchema = DynamicSchema::Struct.define do
+    section_title         String, as: :section_title
+    position              Integer
+    items                 YouTubeShort, array: true
+  end
+
+  class YouTubeShorts < YouTubeShortsSchema
+  end
+
+  # Post channel
+  YouTubePostChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+    is_verified           [ TrueClass, FalseClass ], as: :is_verified
+    thumbnail             String
+  end
+
+  class YouTubePostChannel < YouTubePostChannelSchema
+  end
+
+  # Post item
+  YouTubePostSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    link                  String
+    text                  String
+    likes                 String
+    extracted_likes       Integer, as: :extracted_likes
+    comments              String
+    extracted_comments    Integer, as: :extracted_comments
+    channel               YouTubePostChannel
+    published_time        String, as: :published_time
+    thumbnail             String
+  end
+
+  class YouTubePost < YouTubePostSchema
+  end
+
+  # Posts section
+  YouTubePostsSchema = DynamicSchema::Struct.define do
+    section_title         String, as: :section_title
+    position              Integer
+    items                 YouTubePost, array: true
+  end
+
+  class YouTubePosts < YouTubePostsSchema
+  end
+
+  # Section channel
+  YouTubeSectionChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+  end
+
+  class YouTubeSectionChannel < YouTubeSectionChannelSchema
+  end
+
+  # Section item
+  YouTubeSectionItemSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+    channel               YouTubeSectionChannel
+    views                 Integer
+    published_time        String, as: :published_time
+    length                String
+    thumbnail             String
+  end
+
+  class YouTubeSectionItem < YouTubeSectionItemSchema
+  end
+
+  # Section
+  YouTubeSectionSchema = DynamicSchema::Struct.define do
+    section_title         String, as: :section_title
+    position              Integer
+    items                 YouTubeSectionItem, array: true
+  end
+
+  class YouTubeSection < YouTubeSectionSchema
+  end
+
+  # People also search for
+  YouTubePeopleAlsoSearchForSchema = DynamicSchema::Struct.define do
+    query                 String
+    link                  String
+    thumbnail             String
+  end
+
+  class YouTubePeopleAlsoSearchFor < YouTubePeopleAlsoSearchForSchema
+  end
+
+  # Ad channel
+  YouTubeAdChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+  end
+
+  class YouTubeAdChannel < YouTubeAdChannelSchema
+  end
+
+  # Ad result
+  YouTubeAdSchema = DynamicSchema::Struct.define do
+    position              Integer
+    id                    String
+    title                 String
+    link                  String
+    description           String
+    website               String
+    channel               YouTubeAdChannel
+    length                String
+    thumbnail             String
+  end
+
+  class YouTubeAd < YouTubeAdSchema
+  end
+
+  # Featured video channel
+  YouTubeFeaturedVideoChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    link                  String
+  end
+
+  class YouTubeFeaturedVideoChannel < YouTubeFeaturedVideoChannelSchema
+  end
+
+  # Featured video
+  YouTubeFeaturedVideoSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    subtitle              String
+    link                  String
+    length                String
+    channel               YouTubeFeaturedVideoChannel
+    thumbnail             String
+  end
+
+  class YouTubeFeaturedVideo < YouTubeFeaturedVideoSchema
+  end
+
+  # Highlighted video
+  YouTubeHighlightedVideoSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    subtitle              String
+    link                  String
+    length                String
+  end
+
+  class YouTubeHighlightedVideo < YouTubeHighlightedVideoSchema
+  end
+
+  # Featured channel
+  YouTubeFeaturedChannelSchema = DynamicSchema::Struct.define do
+    id                    String
+    title                 String
+    subtitle              String
+    link                  String
+    highlighted_video     YouTubeHighlightedVideo, as: :highlighted_video
+    videos                YouTubeFeaturedVideo, array: true
+  end
+
+  class YouTubeFeaturedChannel < YouTubeFeaturedChannelSchema
+  end
+
+  # Pagination
+  YouTubePaginationSchema = DynamicSchema::Struct.define do
+    next_page_token       String, as: :next_page_token
+  end
+
+  class YouTubePagination < YouTubePaginationSchema
+  end
+
+  # Main YouTube search result
+  YouTubeSearchResultSchema = DynamicSchema::Struct.define do
+    search_metadata       YouTubeSearchMetadata, as: :search_metadata
+    search_parameters     YouTubeSearchParameters, as: :search_parameters
+    search_information    YouTubeSearchInformation, as: :search_information
+    suggestions           String, array: true
+    ads                   YouTubeAd, array: true
+    channels              YouTubeChannel, array: true
+    movies                YouTubeMovie, array: true
+    videos                YouTubeVideo, array: true
+    playlists             YouTubePlaylist, array: true
+    sections              YouTubeSection, array: true
+    shorts                YouTubeShorts, array: true
+    posts                 YouTubePosts, array: true
+    people_also_search_for YouTubePeopleAlsoSearchFor, array: true, as: :people_also_search_for
+    featured_channel      YouTubeFeaturedChannel, as: :featured_channel
+    pagination            YouTubePagination
+    error                 String
+  end
+
+  class YouTubeSearchResult < YouTubeSearchResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :videos, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'uri'
+
+require 'faraday'
+require 'dynamic_schema'
+
+require_relative 'searchapi/version'
+
+require_relative 'searchapi/helpers'
+require_relative 'searchapi/error_result'
+require_relative 'searchapi/request'
+require_relative 'searchapi/response_methods'
+
+require_relative 'searchapi/google_search_options'
+require_relative 'searchapi/google_search_result'
+require_relative 'searchapi/google_search_request'
+
+require_relative 'searchapi/youtube_search_options'
+require_relative 'searchapi/youtube_search_result'
+require_relative 'searchapi/youtube_search_request'
+
+require_relative 'searchapi/instagram_profile_options'
+require_relative 'searchapi/instagram_profile_result'
+require_relative 'searchapi/instagram_profile_request'
+
+require_relative 'searchapi/tiktok_profile_options'
+require_relative 'searchapi/tiktok_profile_result'
+require_relative 'searchapi/tiktok_profile_request'
+
+require_relative 'searchapi/google_finance_options'
+require_relative 'searchapi/google_finance_result'
+require_relative 'searchapi/google_finance_request'
+
+require_relative 'searchapi/google_flights_options'
+require_relative 'searchapi/google_flights_result'
+require_relative 'searchapi/google_flights_request'
+
+require_relative 'searchapi/google_light_options'
+require_relative 'searchapi/google_light_result'
+require_relative 'searchapi/google_light_request'
+
+require_relative 'searchapi/google_news_options'
+require_relative 'searchapi/google_news_result'
+require_relative 'searchapi/google_news_request'
+
+require_relative 'searchapi/google_news_portal_options'
+require_relative 'searchapi/google_news_portal_result'
+require_relative 'searchapi/google_news_portal_request'
+
+require_relative 'searchapi/google_news_light_options'
+require_relative 'searchapi/google_news_light_result'
+require_relative 'searchapi/google_news_light_request'
+
+require_relative 'searchapi/google_images_options'
+require_relative 'searchapi/google_images_result'
+require_relative 'searchapi/google_images_request'
+
+require_relative 'searchapi/google_local_options'
+require_relative 'searchapi/google_local_result'
+require_relative 'searchapi/google_local_request'
+
+require_relative 'searchapi/google_scholar_options'
+require_relative 'searchapi/google_scholar_result'
+require_relative 'searchapi/google_scholar_request'
+
+require_relative 'searchapi/module_methods'
+
+module SearchAPI
+  extend ModuleMethods
+end