searchapi 1.0.0

data/lib/searchapi/google_flights_result.rb

@@ -0,0 +1,275 @@
+require 'forwardable'
+
+module SearchAPI
+
+  # Google Flights Search metadata
+  GoogleFlightsMetadataSchema = 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 GoogleFlightsMetadata < GoogleFlightsMetadataSchema
+  end
+
+  # Google Flights Search parameters
+  GoogleFlightsParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    departure_id          String, as: :departure_id
+    arrival_id            String, as: :arrival_id
+    currency              String
+    hl                    String
+    gl                    String
+    outbound_date         String, as: :outbound_date
+    return_date           String, as: :return_date
+    flight_type           String, as: :flight_type
+    travel_class          String, as: :travel_class
+    stops                 String
+    sort_by               String, as: :sort_by
+    adults                Integer
+    children              Integer
+    infants_in_seat       Integer, as: :infants_in_seat
+    infants_on_lap        Integer, as: :infants_on_lap
+  end
+
+  class GoogleFlightsParameters < GoogleFlightsParametersSchema
+  end
+
+  # Airport details
+  GoogleFlightsAirportSchema = DynamicSchema::Struct.define do
+    name                  String
+    id                    String
+    date                  String
+    time                  String
+  end
+
+  class GoogleFlightsAirport < GoogleFlightsAirportSchema
+  end
+
+  # Detected extensions (amenities)
+  GoogleFlightsExtensionsSchema = DynamicSchema::Struct.define do
+    has_power_and_usb_outlets       [ TrueClass, FalseClass ], as: :has_power_and_usb_outlets
+    has_personal_video_screen       [ TrueClass, FalseClass ], as: :has_personal_video_screen
+    has_live_tv                     [ TrueClass, FalseClass ], as: :has_live_tv
+    has_on_demand_video             [ TrueClass, FalseClass ], as: :has_on_demand_video
+    has_stream_video_to_own_device  [ TrueClass, FalseClass ], as: :has_stream_video_to_own_device
+    wifi                            String
+    seat_type                       String, as: :seat_type
+    legroom_short                   String, as: :legroom_short
+    legroom_long                    String, as: :legroom_long
+    carbon_emission                 Float, as: :carbon_emission
+  end
+
+  class GoogleFlightsExtensions < GoogleFlightsExtensionsSchema
+  end
+
+  # Flight segment
+  GoogleFlightsSegmentSchema = DynamicSchema::Struct.define do
+    departure_airport     GoogleFlightsAirport, as: :departure_airport
+    arrival_airport       GoogleFlightsAirport, as: :arrival_airport
+    duration              Integer
+    airplane              String
+    airline               String
+    airline_logo          String, as: :airline_logo
+    travel_class          String, as: :travel_class
+    flight_number         String, as: :flight_number
+    ticket_also_sold_by   String, array: true, as: :ticket_also_sold_by
+    is_overnight          [ TrueClass, FalseClass ], as: :is_overnight
+    is_often_delayed      [ TrueClass, FalseClass ], as: :is_often_delayed
+    extensions            String, array: true
+    detected_extensions   GoogleFlightsExtensions, as: :detected_extensions
+  end
+
+  class GoogleFlightsSegment < GoogleFlightsSegmentSchema
+  end
+
+  # Layover
+  GoogleFlightsLayoverSchema = DynamicSchema::Struct.define do
+    duration              Integer
+    name                  String
+    id                    String
+    is_overnight          [ TrueClass, FalseClass ], as: :is_overnight
+  end
+
+  class GoogleFlightsLayover < GoogleFlightsLayoverSchema
+  end
+
+  # Carbon emissions
+  GoogleFlightsCarbonEmissionsSchema = DynamicSchema::Struct.define do
+    this_flight           Integer, as: :this_flight
+    typical_for_this_route Integer, as: :typical_for_this_route
+    difference_percent    Integer, as: :difference_percent
+    lowest_route          Integer, as: :lowest_route
+  end
+
+  class GoogleFlightsCarbonEmissions < GoogleFlightsCarbonEmissionsSchema
+  end
+
+  # Flight option
+  GoogleFlightsFlightSchema = DynamicSchema::Struct.define do
+    flights               GoogleFlightsSegment, array: true
+    layovers              GoogleFlightsLayover, array: true
+    total_duration        Integer, as: :total_duration
+    carbon_emissions      GoogleFlightsCarbonEmissions, as: :carbon_emissions
+    price                 Integer
+    type                  String
+    extensions            String, array: true
+    airline_logo          String, as: :airline_logo
+    booking_token         String, as: :booking_token
+    departure_token       String, as: :departure_token
+  end
+
+  class GoogleFlightsFlight < GoogleFlightsFlightSchema
+  end
+
+  # Price range
+  GoogleFlightsPriceRangeSchema = DynamicSchema::Struct.define do
+    low_price             Integer, as: :low_price
+    high_price            Integer, as: :high_price
+  end
+
+  class GoogleFlightsPriceRange < GoogleFlightsPriceRangeSchema
+  end
+
+  # Price history point
+  GoogleFlightsPriceHistorySchema = DynamicSchema::Struct.define do
+    price                 Integer
+    iso_date              String, as: :iso_date
+  end
+
+  class GoogleFlightsPriceHistory < GoogleFlightsPriceHistorySchema
+  end
+
+  # Price insights
+  GoogleFlightsPriceInsightsSchema = DynamicSchema::Struct.define do
+    lowest_price          Integer, as: :lowest_price
+    price_level           String, as: :price_level
+    typical_price_range   GoogleFlightsPriceRange, as: :typical_price_range
+    price_history         GoogleFlightsPriceHistory, array: true, as: :price_history
+  end
+
+  class GoogleFlightsPriceInsights < GoogleFlightsPriceInsightsSchema
+  end
+
+  # Airport data
+  GoogleFlightsAirportDataInnerSchema = DynamicSchema::Struct.define do
+    id                    String
+    name                  String
+  end
+
+  class GoogleFlightsAirportDataInner < GoogleFlightsAirportDataInnerSchema
+  end
+
+  GoogleFlightsAirportDataSchema = DynamicSchema::Struct.define do
+    airport               GoogleFlightsAirportDataInner
+    city                  String
+    country               String
+    country_code          String, as: :country_code
+    image                 String
+    thumbnail             String
+  end
+
+  class GoogleFlightsAirportData < GoogleFlightsAirportDataSchema
+  end
+
+  # Airport info
+  GoogleFlightsAirportInfoSchema = DynamicSchema::Struct.define do
+    departure             GoogleFlightsAirportData, array: true
+    arrival               GoogleFlightsAirportData, array: true
+  end
+
+  class GoogleFlightsAirportInfo < GoogleFlightsAirportInfoSchema
+  end
+
+  # Booking request
+  GoogleFlightsBookingRequestSchema = DynamicSchema::Struct.define do
+    url                   String
+    post_data             String, as: :post_data
+  end
+
+  class GoogleFlightsBookingRequest < GoogleFlightsBookingRequestSchema
+  end
+
+  # Local price
+  GoogleFlightsLocalPriceSchema = DynamicSchema::Struct.define do
+    currency              String
+    price                 Integer
+  end
+
+  class GoogleFlightsLocalPrice < GoogleFlightsLocalPriceSchema
+  end
+
+  # Booking option
+  GoogleFlightsBookingOptionSchema = DynamicSchema::Struct.define do
+    book_with             String, as: :book_with
+    airline_logos         String, array: true, as: :airline_logos
+    flight_numbers        String, array: true, as: :flight_numbers
+    price                 Integer
+    local_prices          GoogleFlightsLocalPrice, array: true, as: :local_prices
+    option_title          String, as: :option_title
+    extensions            String, array: true
+    baggage_prices        String, array: true, as: :baggage_prices
+    booking_phone         String, as: :booking_phone
+    booking_request       GoogleFlightsBookingRequest, as: :booking_request
+    is_split_booking      [ TrueClass, FalseClass ], as: :is_split_booking
+  end
+
+  class GoogleFlightsBookingOption < GoogleFlightsBookingOptionSchema
+  end
+
+  # Selected flight
+  GoogleFlightsSelectedFlightSchema = DynamicSchema::Struct.define do
+    flights               GoogleFlightsSegment, array: true
+    layovers              GoogleFlightsLayover, array: true
+    total_duration        Integer, as: :total_duration
+    carbon_emissions      GoogleFlightsCarbonEmissions, as: :carbon_emissions
+    type                  String
+    airline_logo          String, as: :airline_logo
+  end
+
+  class GoogleFlightsSelectedFlight < GoogleFlightsSelectedFlightSchema
+  end
+
+  # Main Google Flights result
+  GoogleFlightsResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleFlightsMetadata, as: :search_metadata
+    search_parameters     GoogleFlightsParameters, as: :search_parameters
+    best_flights          GoogleFlightsFlight, array: true, as: :best_flights
+    other_flights         GoogleFlightsFlight, array: true, as: :other_flights
+    price_insights        GoogleFlightsPriceInsights, as: :price_insights
+    airports              GoogleFlightsAirportInfo, array: true
+    selected_flights      GoogleFlightsSelectedFlight, array: true, as: :selected_flights
+    booking_options       GoogleFlightsBookingOption, array: true, as: :booking_options
+    error                 String
+  end
+
+  class GoogleFlightsResult < GoogleFlightsResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :best_flights, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+
+    def all_flights
+      ( best_flights || [] ) + ( other_flights || [] )
+    end
+
+    def cheapest
+      all_flights.min_by { | f | f.price || Float::INFINITY }
+    end
+
+    def fastest
+      all_flights.min_by { | f | f.total_duration || Float::INFINITY }
+    end
+  end
+
+end

data/lib/searchapi/google_images_options.rb

@@ -0,0 +1,64 @@
+module SearchAPI
+  class GoogleImagesOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    DEVICES = %w[ desktop mobile tablet ]
+    SAFE_SEARCH = %w[ active off ]
+    SIZES = %w[ large medium icon larger_than_400x300 larger_than_640x480 larger_than_800x600
+                larger_than_1024x768 larger_than_2mp larger_than_4mp larger_than_6mp
+                larger_than_8mp larger_than_12mp larger_than_15mp larger_than_20mp
+                larger_than_40mp larger_than_70mp ]
+    COLORS = %w[ black_and_white color transparent red orange yellow green teal blue
+                 purple pink white gray black brown ]
+    IMAGE_TYPES = %w[ clipart line_drawing gif face photo ]
+    TIME_PERIODS = %w[ last_hour last_day last_week last_month last_year ]
+    USAGE_RIGHTS = %w[ creative_commons_licenses commercial_or_other_licenses ]
+    ASPECT_RATIOS = %w[ square tall wide panoramic ]
+
+    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
+      lr                    String
+      cr                    String
+      nfpr                  Integer
+      filter                Integer
+      safe                  String, in: SAFE_SEARCH, normalize: NORMALIZE_DOWNCASE
+      tbs                   String
+      size                  String, in: SIZES, normalize: NORMALIZE_DOWNCASE
+      color                 String, in: COLORS, normalize: NORMALIZE_DOWNCASE
+      image_type            String, in: IMAGE_TYPES, normalize: NORMALIZE_DOWNCASE
+      time_period           String, in: TIME_PERIODS, normalize: NORMALIZE_DOWNCASE
+      usage_rights          String, in: USAGE_RIGHTS, normalize: NORMALIZE_DOWNCASE
+      aspect_ratio          String, in: ASPECT_RATIOS, 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_images'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_images_request.rb

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

data/lib/searchapi/google_images_result.rb

@@ -0,0 +1,133 @@
+require 'forwardable'
+
+module SearchAPI
+
+  GoogleImagesMetadataSchema = 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 GoogleImagesMetadata < GoogleImagesMetadataSchema
+  end
+
+  GoogleImagesParametersSchema = DynamicSchema::Struct.define do
+    engine                String
+    q                     String
+    device                String
+    uule                  String
+    location              String
+    location_used         String, as: :location_used
+    cr                    String
+    google_domain         String, as: :google_domain
+    hl                    String
+    gl                    String
+    lr                    String
+    nfpr                  Integer
+    filter                Integer
+    safe                  String
+    page                  Integer
+    tbs                   String
+    chips                 String
+    size                  String
+    color                 String
+    image_type            String, as: :image_type
+    time_period           String, as: :time_period
+    usage_rights          String, as: :usage_rights
+    aspect_ratio          String, as: :aspect_ratio
+    next_page_token       String, as: :next_page_token
+  end
+
+  class GoogleImagesParameters < GoogleImagesParametersSchema
+  end
+
+  GoogleImagesSearchInformationSchema = 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 GoogleImagesSearchInformation < GoogleImagesSearchInformationSchema
+  end
+
+  GoogleImagesSuggestionSchema = DynamicSchema::Struct.define do
+    title                 String
+    link                  String
+    thumbnail             String
+  end
+
+  class GoogleImagesSuggestion < GoogleImagesSuggestionSchema
+  end
+
+  GoogleImagesSourceSchema = DynamicSchema::Struct.define do
+    name                  String
+    link                  String
+  end
+
+  class GoogleImagesSource < GoogleImagesSourceSchema
+  end
+
+  GoogleImagesOriginalSchema = DynamicSchema::Struct.define do
+    link                  String
+    width                 Integer
+    height                Integer
+  end
+
+  class GoogleImagesOriginal < GoogleImagesOriginalSchema
+  end
+
+  GoogleImageSchema = DynamicSchema::Struct.define do
+    position              Integer
+    title                 String
+    source                GoogleImagesSource
+    original              GoogleImagesOriginal
+    thumbnail             String
+    tag                   String
+  end
+
+  class GoogleImage < GoogleImageSchema
+  end
+
+  GoogleImagesRelatedSearchSchema = DynamicSchema::Struct.define do
+    link                  String
+    query                 String
+    highlighted           String, array: true
+    thumbnail             String
+  end
+
+  class GoogleImagesRelatedSearch < GoogleImagesRelatedSearchSchema
+  end
+
+  GoogleImagesResultSchema = DynamicSchema::Struct.define do
+    search_metadata       GoogleImagesMetadata, as: :search_metadata
+    search_parameters     GoogleImagesParameters, as: :search_parameters
+    search_information    GoogleImagesSearchInformation, as: :search_information
+    suggestions           GoogleImagesSuggestion, array: true
+    images                GoogleImage, array: true
+    related_searches      GoogleImagesRelatedSearch, array: true, as: :related_searches
+    error                 String
+  end
+
+  class GoogleImagesResult < GoogleImagesResultSchema
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :images, :each, :[], :count, :size, :length, :first, :last, :empty?
+
+    def success?
+      self.error.nil?
+    end
+  end
+
+end

data/lib/searchapi/google_light_options.rb

@@ -0,0 +1,43 @@
+module SearchAPI
+  class GoogleLightOptions
+    include DynamicSchema::Definable
+    include Helpers
+
+    SAFE_SEARCH = %w[ active off ]
+    NORMALIZE_DOWNCASE = ->(v) { v.to_s.downcase }
+
+    schema do
+      q                     String
+      location              String
+      uule                  String
+      google_domain         String
+      hl                    String
+      gl                    String
+      lr                    String
+      nfpr                  String
+      filter                String
+      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_light'
+      result
+    end
+
+  end
+end

data/lib/searchapi/google_light_request.rb

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