flight_radar 0.2.0 → 0.3.0

data/flight_radar.gemspec

@@ -1,33 +1,37 @@
 # frozen_string_literal: true
 
+require_relative 'lib/flight_radar/version'
+
 Gem::Specification.new do |spec|
-  spec.name          = "flight_radar"
-  spec.version       = "0.2.0"
-  spec.authors       = ["Jakub Polak"]
-  spec.email         = ["jakub.polak.vz@gmail.com"]
+  spec.name          = 'flight_radar'
+  spec.version       = FlightRadar::VERSION
+  spec.authors       = ['Jakub Polak']
+  spec.email         = ['jakub.polak.vz@gmail.com']
 
-  spec.summary       = "Ruby gem for fetching aircraft data from Flightradar24"
-  spec.description   = "To use this API see more information at: https://www.flightradar24.com/terms-and-conditions"
-  spec.homepage      = "https://github.com/kupolak/flight_radar"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.summary       = 'Ruby gem for fetching aircraft data from Flightradar24'
+  spec.description   = 'Unofficial Ruby wrapper for Flightradar24 API. Fetch real-time flight data, ' \
+                       'airport statistics, airline information, and more. For terms see: ' \
+                       'https://www.flightradar24.com/terms-and-conditions'
+  spec.homepage      = 'https://github.com/kupolak/flight_radar'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/kupolak/flight_radar"
-  spec.metadata["changelog_uri"] = "https://github.com/kupolak/flight_radar/blob/main/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['documentation_uri'] = 'https://kupolak.github.io/flight_radar/'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty", "~> 0.21.0"
+  spec.add_dependency 'httparty', '>= 0.21', '< 0.24'
 
-  spec.add_development_dependency "rake", "~>13.1.0"
-  spec.add_development_dependency "rspec", "~>3.12.0"
-  spec.add_development_dependency "rubocop", "~>1.59.0"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/flight_radar/core.rb

@@ -1,59 +1,64 @@
 # frozen_string_literal: true
 
+# The `Core` module contains constants related to FlightRadar API endpoints,
+# URLs for various data sources, and headers used in HTTP requests.
 module Core
-  API_FLIGHT_RADAR_BASE_URL = "https://api.flightradar24.com/common/v1"
-  CDN_FLIGHT_RADAR_BASE_URL = "https://cdn.flightradar24.com"
-  FLIGHT_RADAR_BASE_URL = "https://www.flightradar24.com"
-  DATA_LIVE_BASE_URL = "https://data-live.flightradar24.com"
-  DATA_CLOUD_BASE_URL = "https://data-cloud.flightradar24.com"
+  API_FLIGHT_RADAR_BASE_URL = 'https://api.flightradar24.com/common/v1'
+  CDN_FLIGHT_RADAR_BASE_URL = 'https://cdn.flightradar24.com'
+  FLIGHT_RADAR_BASE_URL = 'https://www.flightradar24.com'
+  DATA_LIVE_BASE_URL = 'https://data-live.flightradar24.com'
+  DATA_CLOUD_BASE_URL = 'https://data-cloud.flightradar24.com'
 
   # User login URL.
-  USER_LOGIN_URL = "#{FLIGHT_RADAR_BASE_URL}/user/login"
-  USER_LOGOUT_URL = "#{FLIGHT_RADAR_BASE_URL}/user/logout"
+  USER_LOGIN_URL = "#{FLIGHT_RADAR_BASE_URL}/user/login".freeze
+  USER_LOGOUT_URL = "#{FLIGHT_RADAR_BASE_URL}/user/logout".freeze
 
   # Most tracked data URL
-  MOST_TRACKED_URL = "#{FLIGHT_RADAR_BASE_URL}/flights/most-tracked"
+  MOST_TRACKED_URL = "#{FLIGHT_RADAR_BASE_URL}/flights/most-tracked".freeze
 
   # Search data URL
-  SEARCH_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/v1/search/web/find?query={}&limit=50"
+  SEARCH_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/v1/search/web/find".freeze
 
   # Flights data URLs.
-  REAL_TIME_FLIGHT_TRACKER_DATA_URL = "#{DATA_CLOUD_BASE_URL}/zones/fcgi/feed.js"
-  FLIGHT_DATA_URL = "#{DATA_LIVE_BASE_URL}/clickhandler/?flight={}"
+  REAL_TIME_FLIGHT_TRACKER_DATA_URL = "#{DATA_CLOUD_BASE_URL}/zones/fcgi/feed.js".freeze
+  FLIGHT_DATA_URL = "#{DATA_LIVE_BASE_URL}/clickhandler/?flight={}".freeze
+  FLIGHT_PLAYBACK_URL = "#{DATA_LIVE_BASE_URL}/clickhandler/".freeze
 
   # Airports data URLs.
-  API_AIRPORT_DATA_URL = "#{API_FLIGHT_RADAR_BASE_URL}/airport.json"
-  AIRPORT_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/airports/traffic-stats/?airport="
-  AIRPORTS_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/_json/airports.php"
+  API_AIRPORT_DATA_URL = "#{API_FLIGHT_RADAR_BASE_URL}/airport.json".freeze
+  AIRPORT_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/airports/traffic-stats/?airport=".freeze
+  AIRPORTS_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/_json/airports.php".freeze
+  AIRPORT_ARRIVALS_URL = "#{FLIGHT_RADAR_BASE_URL}/data/airports/".freeze
+  AIRPORT_DEPARTURES_URL = "#{FLIGHT_RADAR_BASE_URL}/data/airports/".freeze
 
   # Airlines data URL.
-  AIRLINES_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/_json/airlines.php"
+  AIRLINES_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/_json/airlines.php".freeze
 
   # Zones data URL.
-  ZONES_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/js/zones.js.php"
+  ZONES_DATA_URL = "#{FLIGHT_RADAR_BASE_URL}/js/zones.js.php".freeze
 
   # Country flag image URL.
-  COUNTRY_FLAG_URL = "#{FLIGHT_RADAR_BASE_URL}/static/images/data/flags-small/"
+  COUNTRY_FLAG_URL = "#{FLIGHT_RADAR_BASE_URL}/static/images/data/flags-small/".freeze
 
   # Airline logo image URL.
-  AIRLINE_LOGO_URL = "#{CDN_FLIGHT_RADAR_BASE_URL}/assets/airlines/logotypes/"
-  ALTERNATIVE_AIRLINE_LOGO_URL = "#{FLIGHT_RADAR_BASE_URL}/static/images/data/operators/"
+  AIRLINE_LOGO_URL = "#{CDN_FLIGHT_RADAR_BASE_URL}/assets/airlines/logotypes/".freeze
+  ALTERNATIVE_AIRLINE_LOGO_URL = "#{FLIGHT_RADAR_BASE_URL}/static/images/data/operators/".freeze
 
   HEADERS = {
-    "accept-encoding": "gzip, br",
-    "accept-language": "pt-BR,pt;q=0.9,en-US;q=0.8,en;q=0.7",
-    "cache-control": "max-age=0",
-    "origin": "#{FLIGHT_RADAR_BASE_URL}",
-    "referer": "#{FLIGHT_RADAR_BASE_URL}/",
-    "sec-fetch-dest": "empty",
-    "sec-fetch-mode": "cors",
-    "sec-fetch-site": "same-site",
-    "user-agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36"
-  }
-
-  JSON_HEADERS = HEADERS
-  JSON_HEADERS["accept"] = "application/json"
-
-  IMAGE_HEADERS = HEADERS
-  IMAGE_HEADERS["accept"] = "image/gif, image/jpg, image/jpeg, image/png"
+    'accept-encoding': 'gzip, br',
+    'accept-language': 'pt-BR,pt;q=0.9,en-US;q=0.8,en;q=0.7',
+    'cache-control': 'max-age=0',
+    origin: FLIGHT_RADAR_BASE_URL.to_s,
+    referer: "#{FLIGHT_RADAR_BASE_URL}/",
+    'sec-fetch-dest': 'empty',
+    'sec-fetch-mode': 'cors',
+    'sec-fetch-site': 'same-site',
+    'user-agent': 'Mozilla/5.0 (Windows NT 6.1)
+                   AppleWebKit/537.36 (KHTML, like Gecko)
+                   Chrome/87.0.4280.88 Safari/537.36'
+  }.freeze
+
+  JSON_HEADERS = HEADERS.merge('accept' => 'application/json').freeze
+
+  IMAGE_HEADERS = HEADERS.merge('accept' => 'image/gif, image/jpg, image/jpeg, image/png').freeze
 end

data/lib/flight_radar/flight.rb

@@ -1,73 +1,109 @@
-# frozen_string_literal: true
-
-class Flight
-  @default_text = "N/A"
-
-  attr_accessor :id
-
-  def initialize(flight_id, info)
-    @id = flight_id
-    @icao_24bit = get_info(info[0])
-    @latitude = get_info(info[1])
-    @longitude = get_info(info[2])
-    @heading = get_info(info[3])
-    @altitude = get_info(info[4])
-    @ground_speed = get_info(info[5])
-    @squawk = get_info(info[6])
-    @aircraft_code = get_info(info[8])
-    @registration = get_info(info[9])
-    @time = get_info(info[10])
-    @origin_airport_iata = get_info(info[11])
-    @destination_airport_iata = get_info(info[12])
-    @number = get_info(info[13])
-    @airline_iata = get_info(info[13][0..1])
-    @on_ground = get_info(info[14])
-    @vertical_speed = get_info(info[15])
-    @callsign = get_info(info[16])
-    @airline_icao = get_info(info[18])
-  end
-
-  def inspect
-    to_s
-  end
-
-  def to_s
-    "<(#{@aircraft_code}) #{@registration} - Altitude: #{@altitude} - Ground Speed: #{@ground_speed} - Heading: #{@ground_speed}>"
-  end
-
-  def altitude
-    "#{@altitude} ft"
-  end
-
-  def flight_level
-    if @altitude > 10_000
-      "#{@altitude[0..2]} FL"
-    else
-      altitude
-    end
-  end
-
-  def ground_speed
-    speed = "#{@ground_speed} kt"
-    speed += "s" if @ground_speed > 1
-    speed
-  end
-
-  def heading
-    "#{@heading}°"
-  end
-
-  def vertical_speed
-    "#{@vertical_speed} fpm"
-  end
-
-  private
-
-  def get_info(info)
-    if (info || info.zero?) && (info != @default_text)
-      info
-    else
-      @default_text
-    end
-  end
-end
+# frozen_string_literal: true
+
+# The `Flight` class represents information about a flight obtained from a data source.
+# It provides methods to access and format various attributes related to the flight,
+# such as altitude, ground speed, heading, and more.
+class Flight
+  DEFAULT_TEXT = 'N/A'
+
+  # Accessor for the flight ID.
+  attr_accessor :id
+
+  # Read-only accessors for flight attributes.
+  attr_reader :icao_24bit, :latitude, :longitude,
+              :squawk, :aircraft_code, :registration, :time, :origin_airport_iata,
+              :destination_airport_iata, :number, :airline_iata, :on_ground,
+              :callsign, :airline_icao
+
+  # Initializes a new instance of the `Flight` class with the given flight ID and information.
+  #
+  # @param flight_id [String] The unique identifier for the flight.
+  # @param info [Array<String>] An array containing various information about the flight.
+  #   The order of elements in the array is assumed to follow a specific pattern.
+  #   (e.g., info[0] is ICAO 24-bit address, info[1] is latitude, info[2] is longitude, and so on.)
+  # rubocop:disable Metrics
+  def initialize(flight_id, info)
+    @id = flight_id
+    @icao_24bit = get_info(info[0])
+    @latitude = get_info(info[1])
+    @longitude = get_info(info[2])
+    @heading = get_info(info[3])
+    @altitude = get_info(info[4])
+    @ground_speed = get_info(info[5])
+    @squawk = get_info(info[6])
+    @aircraft_code = get_info(info[8])
+    @registration = get_info(info[9])
+    @time = get_info(info[10])
+    @origin_airport_iata = get_info(info[11])
+    @destination_airport_iata = get_info(info[12])
+    @number = get_info(info[13])
+    @airline_iata = @number != DEFAULT_TEXT && @number.length >= 2 ? @number[0..1] : DEFAULT_TEXT
+    @on_ground = get_info(info[14])
+    @vertical_speed = get_info(info[15])
+    @callsign = get_info(info[16])
+    @airline_icao = get_info(info[18])
+  end
+  # rubocop:enable Metrics
+
+  # Returns a string representation of the `Flight` object.
+  #
+  # @return [String] A formatted string containing relevant information about the flight.
+  def to_s
+    "<(#{@aircraft_code}) #{@registration}
+    - Altitude: #{@altitude}
+    - Ground Speed: #{@ground_speed}
+    - Heading: #{@heading}>"
+  end
+
+  # Returns a formatted string representing the altitude of the flight.
+  #
+  # @return [String] Formatted altitude string (e.g., "5000 ft").
+  def altitude
+    "#{@altitude} ft"
+  end
+
+  # Returns a formatted string representing the flight level based on altitude.
+  #
+  # @return [String] Formatted flight level string (e.g., "FL350").
+  def flight_level
+    return altitude if @altitude == DEFAULT_TEXT || @altitude.to_i <= 10_000
+
+    "FL#{(@altitude.to_i / 100).to_s.rjust(3, '0')}"
+  end
+
+  # Returns a formatted string representing the ground speed of the flight.
+  #
+  # @return [String] Formatted ground speed string (e.g., "300 kts").
+  def ground_speed
+    return "#{@ground_speed} kt" if @ground_speed == DEFAULT_TEXT
+
+    speed_value = @ground_speed.to_i
+    speed = "#{speed_value} kt"
+    speed += 's' if speed_value > 1
+    speed
+  end
+
+  # Returns a formatted string representing the heading of the flight.
+  #
+  # @return [String] Formatted heading string (e.g., "120°").
+  def heading
+    "#{@heading}°"
+  end
+
+  # Returns a formatted string representing the vertical speed of the flight.
+  #
+  # @return [String] Formatted vertical speed string (e.g., "1000 fpm").
+  def vertical_speed
+    "#{@vertical_speed} fpm"
+  end
+
+  private
+
+  # Helper method to ensure that the information is not nil or the default text.
+  #
+  # @param info [String] The information to be validated.
+  # @return [String] The original information if it is not nil or the default text.
+  def get_info(info)
+    info && info != DEFAULT_TEXT ? info : DEFAULT_TEXT
+  end
+end

data/lib/flight_radar/request.rb

@@ -1,38 +1,80 @@
-# frozen_string_literal: true
-
-require "httparty"
-
-# Request class for handling API requests
-class Request
-  def initialize(url, headers = {}, params = {})
-    @url = url
-    @params = params
-    @headers = headers
-    @lang = "en"
-
-    @response = send_request(url, headers, params)
-  end
-
-  def content
-    @response.parsed_response
-  end
-
-  def content_type
-    @response.content_type
-  end
-
-  def status_code
-    @response.code
-  end
-
-  private
-
-  def params_to_string(params)
-    params.to_a.map { |k, v| "#{k}=#{v}" }.join("&")
-  end
-
-  def send_request(url, headers, params)
-    url = "#{url}?#{params_to_string(params)}" if params
-    HTTParty.get(url, headers)
-  end
-end
+# frozen_string_literal: true
+
+require 'httparty'
+
+# The `Request` class handles making HTTP requests using the HTTParty gem.
+class Request
+  # Initializes a new instance of the `Request` class.
+  #
+  # @param url [String] The URL for the HTTP request.
+  # @param headers [Hash] (optional) The headers to include in the HTTP request.
+  # @param params [Hash] (optional) The parameters to include in the HTTP request.
+  def initialize(url, headers = {}, params = {})
+    @url = url
+    @params = params
+    @headers = headers
+    @lang = 'en'
+
+    @response = send_request(url, headers, params)
+  end
+
+  # Returns the parsed content of the HTTP response.
+  #
+  # @return [Hash] The parsed content of the HTTP response.
+  def content
+    @response.parsed_response
+  end
+
+  # Returns the content type of the HTTP response.
+  #
+  # @return [String] The content type of the HTTP response.
+  def content_type
+    @response.content_type
+  end
+
+  # Returns the status code of the HTTP response.
+  #
+  # @return [Integer] The status code of the HTTP response.
+  def status_code
+    @response.code
+  end
+
+  # Checks if the HTTP response code indicates success.
+  #
+  # @return [Boolean] Returns true if the response code is within the range 200 to 299 (inclusive), indicating success.
+  def success?
+    (200..299).include?(@response.code)
+  end
+
+  private
+
+  # Sends an HTTP GET request using the specified URL, headers, and parameters.
+  #
+  # @param url [String] The URL for the HTTP request.
+  # @param headers [Hash] The headers to include in the HTTP request.
+  # @param params [Hash] The parameters to include in the HTTP request.
+  # @return [HTTParty::Response] The HTTParty response object.
+  def send_request(url, headers, params)
+    full_url = build_full_url(url, params)
+    HTTParty.get(full_url, headers)
+  end
+
+  # Builds the full URL by appending parameters to the base URL.
+  #
+  # @param url [String] The base URL.
+  # @param params [Hash] The parameters to include in the URL.
+  # @return [String] The full URL for the HTTP request.
+  def build_full_url(url, params)
+    return url unless params
+
+    "#{url}?#{params_to_string(params)}"
+  end
+
+  # Converts parameters to a query string.
+  #
+  # @param params [Hash] The parameters to convert.
+  # @return [String] The query string representation of the parameters.
+  def params_to_string(params)
+    HTTParty::HashConversions.to_params(params)
+  end
+end

data/lib/flight_radar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FlightRadar
+  VERSION = '0.3.0'
+end