flight_radar 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a90f6971658d712566667b5602acbc862430ae4b97e0ed7286846dbe5e107066
-  data.tar.gz: ee9dafc558f2c91303c5ecaa55a65de73be55c0f656a62b5528b8b0da0e93b93
+  metadata.gz: 577b655ed0ac3653a99092e3e9c076befa0c8c1b58c205da36e01c49979cb7c6
+  data.tar.gz: 020ffcf2ac3b110f0424cf2fc9b5e09c63e165efb5eae7be6ffff904d9d9660d
 SHA512:
-  metadata.gz: 880969b6f309af65e1de1bba3a0a2f715ae2a1035a8b45b19872935862a86b9e633fa5256e7daa9b9e989af0d58eeae11149f339944b045e8a9ed137167f223c
-  data.tar.gz: ede6e35686c08e885dcc3760c531beffbde7c61a473eea060cb6d2f95c89b2268b3b78e36e8cd88be391298d7a30061036fa3a0d8372be7dd8e8d0a49064484a
+  metadata.gz: 306207a684236c5e747a32eca79272b43163f2364c2f73efe8f8339b971ddffec7be3e11c5b11f0048b2bc14f0bab85fe2441c86b1c6028be3482ecc4c56cbe6
+  data.tar.gz: 6675ebe2ea8b5e8e0fee89b40aa4f8875132650ade80db3c4998d394f3d454c3257fd2e5433c841ef8a3e1557ad30c50e302e54f811f68b4d64ef210a0725f75

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ruby.yml

@@ -19,7 +19,8 @@ jobs:
       - name: Set up Ruby and install dependencies
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.2
+          bundler-cache: true
 
       - name: Install dependencies
         run: |

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-11-25
+
+### Added
+- New `search(query, limit)` method for searching flights, airports, and airlines
+- New `most_tracked` method to retrieve most tracked flights in real-time
+- New `flight_playback(flight_id)` method for retrieving flight path history
+- New `aircraft(registration)` method for searching aircraft by registration number
+- New `airline_fleet(airline_code)` method for retrieving airline fleet information
+- Added `attr_reader` for all Flight class instance variables (icao_24bit, latitude, longitude, squawk, aircraft_code, registration, time, origin_airport_iata, destination_airport_iata, number, airline_iata, on_ground, callsign, airline_icao)
+- Enhanced gemspec with bug_tracker_uri and documentation_uri metadata
+- Updated README with comprehensive documentation for all new methods
+
+### Fixed
+- Fixed bug in Flight#to_s method where heading was displaying ground_speed value
+- Fixed HEADERS constant mutation issue in Core module by using .merge() and .freeze
+- Fixed inconsistent Request class usage in airport and flight_details methods
+- Fixed flight_level method attempting to slice integer instead of properly dividing by 100
+- Fixed ground_speed method type comparison issue
+- Fixed airline_iata extraction to safely handle nil/short values
+- Fixed flaky airline_logo test to require at least 1 logo instead of exactly 2
+
+### Changed
+- Refactored airport method to use Request class instead of direct HTTParty.get
+- Refactored flight_details method to use Request class for consistency
+- Updated GitHub Actions workflow to use Ruby 3.2
+- Added bundler-cache to CI for faster builds
+- Gemspec now loads version dynamically from FlightRadar::VERSION
+- Enhanced gemspec description with more details
+
 ## [0.2.1] - 2023-12-21
 - Code refactor
 - Add documentation to the code

data/README.md

@@ -8,13 +8,20 @@
 - [Usage](#usage)
     - [Airlines](#airlines)
     - [Airport](#airport)
+    - [Airports](#airports)
     - [Zones](#zones)
     - [Flights](#flights)
     - [Flight Details](#flight-details)
+    - [Flight Playback](#flight-playback)
     - [Flights by Airline](#flights-by-airline)
     - [Flights by Bounds](#flights-by-bounds)
+    - [Search](#search)
+    - [Most Tracked Flights](#most-tracked-flights)
+    - [Aircraft Information](#aircraft-information)
+    - [Airline Fleet](#airline-fleet)
     - [Airline Logo](#airline-logo)
     - [Country Flag](#country-flag)
+- [Documentation](#documentation)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -58,9 +65,10 @@ FlightRadar.airlines
 
 ### Airport
 
+Get traffic statistics for a specific airport.
+
 ```ruby
-airport = "LAX"
-FlightRadar.airport(airport)
+FlightRadar.airport("LAX")
 ```
 
 **Sample response:**
@@ -68,22 +76,21 @@ FlightRadar.airport(airport)
 ```ruby
 {
   "details" => {
-    "name" => "Lodz Wladyslaw Reymont Airport",
+    "name" => "Los Angeles International Airport",
     "code" => {
-      "iata" => "LCJ",
-      "icao" => "EPLL"
+      "iata" => "LAX",
+      "icao" => "KLAX"
     },
     "position" => {
-      "latitude" => 51.721882,
-      "longitude" => 19.39813,
-      "altitude" => 604,
+      "latitude" => 33.942536,
+      "longitude" => -118.408075,
+      "altitude" => 125,
       "country" => {
-        "id" => nil,
-        "name" => "Poland",
-        "code" => "POL"
+        "name" => "United States",
+        "code" => "USA"
       },
       "region" => {
-        "city" => "Lodz"
+        "city" => "Los Angeles"
       }
     },
     # ...
@@ -91,6 +98,24 @@ FlightRadar.airport(airport)
 }
 ```
 
+### Airports
+
+Get a list of all airports.
+
+```ruby
+FlightRadar.airports
+```
+
+**Sample response:**
+
+```ruby
+[
+  {"name" => "Hartsfield-Jackson Atlanta Intl", "iata" => "ATL", "icao" => "KATL", "lat" => 33.6367, "lon" => -84.4281},
+  {"name" => "Los Angeles Intl", "iata" => "LAX", "icao" => "KLAX", "lat" => 33.9425, "lon" => -118.408},
+  # ...
+]
+```
+
 ### Zones
 
 ```ruby
@@ -151,6 +176,8 @@ FlightRadar.flights
 
 ### Flight Details
 
+Get detailed information about a specific flight.
+
 ```ruby
 flight_id = FlightRadar.flights.sample.id
 FlightRadar.flight_details(flight_id)
@@ -191,6 +218,17 @@ FlightRadar.flight_details(flight_id)
 }
 ```
 
+### Flight Playback
+
+Get playback data for a specific flight (includes full flight path history).
+
+```ruby
+flight_id = FlightRadar.flights.sample.id
+FlightRadar.flight_playback(flight_id)
+```
+
+**Note:** This is an alias for `flight_details` and returns the same data structure.
+
 ### Flights by airline
 
 ```ruby
@@ -255,6 +293,8 @@ FlightRadar.airline_logo(iata, icao)
 
 ### Country flag
 
+Get the URL of a country flag image.
+
 ```ruby
 FlightRadar.country_flag("Poland")
 ```
@@ -265,6 +305,100 @@ FlightRadar.country_flag("Poland")
 "https://www.flightradar24.com/static/images/data/flags-small/poland.gif"
 ```
 
+### Search
+
+Search for flights, airports, and airlines.
+
+```ruby
+FlightRadar.search("LOT", 10)
+```
+
+**Sample response:**
+
+```ruby
+{
+  "results" => [
+    {
+      "id" => "LOT",
+      "label" => "LOT (LOT / LO)",
+      "detail" => {
+        "operator_id" => 11,
+        "iata" => "LO",
+        "logo" => "https://cdn.flightradar24.com/assets/airlines/logotypes/11.png"
+      },
+      "type" => "operator",
+      "match" => "icao",
+      "name" => "LOT"
+    },
+    # ...
+  ],
+  "stats" => {
+    "total" => {
+      "all" => 42,
+      "airport" => 12,
+      "operator" => 15,
+      "live" => 8
+    }
+  }
+}
+```
+
+### Most Tracked Flights
+
+Get the most tracked flights in real-time.
+
+```ruby
+FlightRadar.most_tracked
+```
+
+**Sample response:**
+
+```ruby
+{
+  "data" => [
+    {
+      "flight_id" => "2abc1234",
+      "flight" => "AA100",
+      "callsign" => "AAL100",
+      "squawk" => "1234",
+      "clicks" => 5420,
+      # ...
+    },
+    # ...
+  ],
+  "update_time" => 1700000000,
+  "version" => 1
+}
+```
+
+### Aircraft Information
+
+Search for aircraft by registration number.
+
+```ruby
+FlightRadar.aircraft("N12345")
+```
+
+**Sample response:**
+
+Returns search results similar to the `search` method, filtered for aircraft.
+
+### Airline Fleet
+
+Get fleet information for a specific airline.
+
+```ruby
+FlightRadar.airline_fleet("LOT")
+```
+
+**Sample response:**
+
+Returns search results similar to the `search` method, showing airline and aircraft information.
+
+## Documentation
+
+Live documentation of the gem is available [at this GitHub page](https://kupolak.github.io/flight_radar/).
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/flight_radar.gemspec

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
+require_relative 'lib/flight_radar/version'
+
 Gem::Specification.new do |spec|
   spec.name          = 'flight_radar'
-  spec.version       = '0.2.1'
+  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.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['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.
@@ -25,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '~> 0.21.0'
+  spec.add_dependency 'httparty', '>= 0.21', '< 0.24'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/flight_radar/core.rb

@@ -17,16 +17,19 @@ module Core
   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".freeze
+  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".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".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".freeze
@@ -41,7 +44,6 @@ module Core
   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
 
-  # rubocop:disable Style/MutableConstant
   HEADERS = {
     'accept-encoding': 'gzip, br',
     'accept-language': 'pt-BR,pt;q=0.9,en-US;q=0.8,en;q=0.7',
@@ -54,12 +56,9 @@ module Core
     'user-agent': 'Mozilla/5.0 (Windows NT 6.1)
                    AppleWebKit/537.36 (KHTML, like Gecko)
                    Chrome/87.0.4280.88 Safari/537.36'
-  }
-  # rubocop:enable Style/MutableConstant
+  }.freeze
 
-  JSON_HEADERS = HEADERS
-  JSON_HEADERS['accept'] = 'application/json'
+  JSON_HEADERS = HEADERS.merge('accept' => 'application/json').freeze
 
-  IMAGE_HEADERS = HEADERS
-  IMAGE_HEADERS['accept'] = 'image/gif, image/jpg, image/jpeg, image/png'
+  IMAGE_HEADERS = HEADERS.merge('accept' => 'image/gif, image/jpg, image/jpeg, image/png').freeze
 end

data/lib/flight_radar/flight.rb

@@ -9,6 +9,12 @@ class Flight
   # 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.
@@ -31,7 +37,7 @@ class Flight
     @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])
+    @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])
@@ -46,7 +52,7 @@ class Flight
     "<(#{@aircraft_code}) #{@registration}
     - Altitude: #{@altitude}
     - Ground Speed: #{@ground_speed}
-    - Heading: #{@ground_speed}>"
+    - Heading: #{@heading}>"
   end
 
   # Returns a formatted string representing the altitude of the flight.
@@ -60,15 +66,20 @@ class Flight
   #
   # @return [String] Formatted flight level string (e.g., "FL350").
   def flight_level
-    @altitude > 10_000 ? "#{@altitude[0..2]} FL" : altitude
+    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
-    speed = "#{@ground_speed} kt"
-    speed += 's' if @ground_speed > 1
+    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
 

data/lib/flight_radar/version.rb

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

data/lib/flight_radar.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'flight_radar/version'
 require_relative 'flight_radar/core'
 require_relative 'flight_radar/request'
 require_relative 'flight_radar/flight'
 
 # FlightRadar module for sending requests to FlightRadar24 API
 module FlightRadar
-  VERSION = '0.2.1'
-
   module_function
 
   # Default configuration parameters for FlightRadar requests.
@@ -58,7 +57,9 @@ module FlightRadar
   # @param code [String] The code of the airport.
   # @return [Hash] A hash containing traffic statistics for the specified airport.
   def airport(code)
-    HTTParty.get("https://data-live.flightradar24.com/airports/traffic-stats/?airport=#{code}").parsed_response
+    url = "#{Core::DATA_LIVE_BASE_URL}/airports/traffic-stats/?airport=#{code}"
+    request = Request.new(url, Core::JSON_HEADERS)
+    request.content
   end
 
   # Retrieves a list of airports.
@@ -114,8 +115,51 @@ module FlightRadar
   # @return [Hash] A hash containing information about flight tracking zones.
   def zones
     request = Request.new(Core::ZONES_DATA_URL, Core::JSON_HEADERS)
-    request = request.content
-    request.delete('version')
-    request
+    content = request.content
+    content.delete('version')
+    content
+  end
+
+  # Searches for flights, airports, and airlines.
+  #
+  # @param query [String] The search query (e.g., flight number, airport code, airline name).
+  # @param limit [Integer] (optional) Maximum number of results to return (default: 50).
+  # @return [Hash] A hash containing search results grouped by type.
+  def search(query, limit = 50)
+    url = "#{Core::SEARCH_DATA_URL}?query=#{query}&limit=#{limit}"
+    request = Request.new(url, Core::JSON_HEADERS)
+    request.content
+  end
+
+  # Retrieves a list of the most tracked flights.
+  #
+  # @return [Hash] A hash containing information about the most tracked flights.
+  def most_tracked
+    request = Request.new(Core::MOST_TRACKED_URL, Core::JSON_HEADERS)
+    request.content
+  end
+
+  # Retrieves playback data for a specific flight (alias for flight_details with version parameter).
+  #
+  # @param flight_id [String] The ID of the flight.
+  # @return [Hash] A hash containing detailed playback information including flight path.
+  def flight_playback(flight_id)
+    flight_details(flight_id)
+  end
+
+  # Retrieves information about a specific aircraft by registration number.
+  #
+  # @param registration [String] The aircraft registration number (e.g., "N12345").
+  # @return [Hash] A hash containing search results for the aircraft.
+  def aircraft(registration)
+    search(registration)
+  end
+
+  # Retrieves fleet information for a specific airline.
+  #
+  # @param airline_code [String] The airline code (IATA or ICAO).
+  # @return [Hash] A hash containing information about the airline's fleet.
+  def airline_fleet(airline_code)
+    search(airline_code)
   end
 end

metadata

@@ -1,36 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: flight_radar
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jakub Polak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2025-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.21.0
-description: 'To use this API see more information at: https://www.flightradar24.com/terms-and-conditions'
+        version: '0.24'
+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'
 email:
 - jakub.polak.vz@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -47,6 +55,7 @@ files:
 - lib/flight_radar/core.rb
 - lib/flight_radar/flight.rb
 - lib/flight_radar/request.rb
+- lib/flight_radar/version.rb
 homepage: https://github.com/kupolak/flight_radar
 licenses:
 - MIT
@@ -54,6 +63,8 @@ metadata:
   homepage_uri: https://github.com/kupolak/flight_radar
   source_code_uri: https://github.com/kupolak/flight_radar
   changelog_uri: https://github.com/kupolak/flight_radar/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kupolak/flight_radar/issues
+  documentation_uri: https://kupolak.github.io/flight_radar/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -70,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby gem for fetching aircraft data from Flightradar24