flightstats-flex 0.1.0

data/README.md

@@ -0,0 +1,252 @@
+flightstats-flex
+================
+
+Ruby client for the FlightStats Flex API.
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'flightstats-flex', :git => 'https://github.com/diditclear/flightstats-client-ruby'
+```
+
+Note that there is an old **flightstats** gem on [Rubygems](http://rubygems.org/gems/flightstats), hence the name **flightstats-flex** for this library.
+
+## Usage
+
+You only need to configure your FlightStats app id and keys:
+
+```ruby
+FlightStats.app_id = '1234'
+FlightStats.app_key = '5678'
+```
+
+You can also specify your own logger:
+
+```ruby
+FlightStats.logger = Logger.new
+```
+
+When using Rails, you can set it up in an initializer (e.g. config/initializers/flightstats.rb):
+
+```ruby
+require 'flightstats'
+
+FlightStats.app_id = '1234'
+FlightStats.app_key = '5678'
+FlightStats.logger = Rails.logger
+```
+
+## Supported APIs
+
+### Airports
+
+#### Active airports
+
+```ruby
+airports = FlightStats::Airport.actives
+```
+
+#### Active airports for date
+
+```ruby
+airports = FlightStats::Airport.actives_for_date 2013, 5, 1
+```
+
+#### All airports (active and inactive)
+
+```ruby
+airports = FlightStats::Airport.all
+```
+
+#### Current airport by code (code type chosen via precedence order)
+
+```ruby
+airports = FlightStats::Airport.current 'PDX'
+```
+
+#### Airport on date by code
+
+```ruby
+airports = FlightStats::Airport.on_date 'PDX', 2013, 5, 1
+```
+
+#### Airports by city code
+
+```ruby
+airports = FlightStats::Airport.by_city_code 'ABC'
+```
+
+#### Airports by country code
+
+```ruby
+airports = FlightStats::Airport.by_country_code 'GB'
+```
+
+#### Airport by FlightStats code
+
+```ruby
+airport = FlightStats::Airport.by_flight_stats_code 'PDX'
+```
+
+#### Airports by IATA code
+
+```ruby
+airports = FlightStats::Airport.by_iata_code 'PDX'
+```
+
+#### Airport by IATA code on date
+
+```ruby
+airport = FlightStats::Airport.by_iata_code_on_date 'PDX', 2013, 5, 1
+```
+
+#### Airports by ICAO code
+
+```ruby
+airports = FlightStats::Airport.by_icao_code 'KPDX'
+```
+
+#### Airport by ICAO code on date
+
+```ruby
+airport = FlightStats::Airport.by_icao_code_on_date 'KPDX', 2013, 5, 1
+```
+
+#### Airports within radius of location
+
+```ruby
+airports = FlightStats::Airport.within_radius 17, 39, 150
+airports.size # => 9
+airports[5].name # => "Papola Casale Airport"
+```
+
+### Flight Status & Track by Flight
+
+#### Flight Status (by flight ID)
+
+```ruby
+flight_status = FlightStats::FlightStatus.by_flight_id 1234
+```
+
+#### Flight status (flights departing on date)
+
+```ruby
+flight_statuses = FlightStats::FlightStatus.departing_on 'UA', 901, 2013, 5, 1
+```
+
+#### Flight status (flights arriving on date)
+
+```ruby
+flight_statuses = FlightStats::FlightStatus.arriving_on 'UA', 901, 2013, 5, 1
+```
+
+#### Flight track (by flight ID)
+
+```ruby
+flight_track = FlightStats::FlightStatus.track_by_flight_id 1234
+```
+
+#### Flight tracks arriving on date (starting from specified hour of day)
+
+```ruby
+flight_tracks = FlightStats::FlightStatus.track_arriving_on 'UA', 901, 2013, 5, 1
+```
+
+#### Flight tracks departing on date (starting from specified hour of day)
+
+```ruby
+flight_tracks = FlightStats::FlightStatus.track_departing_on 'UA', 901, 2013, 5, 1
+```
+
+
+### Schedules/Connections
+
+#### Direct scheduled flights by arrival location and date
+
+```ruby
+flights = FlightStats::Flight.direct_arriving_at 'EWR', 2013, 5, 1
+```
+
+#### Direct scheduled flights by departure location and departure date
+
+```ruby
+flights = FlightStats::Flight.direct_departing_from 'EWR', 2013, 5, 1
+```
+
+#### Direct scheduled flights by carrier, flight number, and arrival date(s)
+
+```ruby
+flights = FlightStats::Flight.direct_arriving_by_flight_number 'UA', 901, 2013, 5, 1
+```
+
+#### Direct scheduled flights by carrier, flight number, arrival location and arrival date(s)
+
+```ruby
+flights = FlightStats::Flight.direct_arriving_by_flight_number_and_location 'UA', 901, 'FRA', 2013, 5, 1
+```
+
+#### Direct scheduled flights by carrier, flight number, and departure date(s)
+
+```ruby
+flights = FlightStats::Flight.direct_arriving_by_flight_number 'UA', 901, 2013, 5, 1
+```
+
+#### Direct scheduled flights by carrier, flight number, departure location and departure date(s)
+
+```ruby
+flights = FlightStats::Flight.direct_arriving_by_flight_number_and_location 'UA', 901, 'FRA', 2013, 5, 1
+```
+
+####  Direct and connecting scheduled flights between two locations by arrival date
+
+```ruby
+flights = FlightStats::Flight.direct_and_connecting_arriving 'SFO', 'FRA', 2013, 5, 1
+```
+
+####  Direct and connecting scheduled flights between two locations by departure date
+
+```ruby
+flights = FlightStats::Flight.direct_and_connecting_departing 'SFO', 'FRA', 2013, 5, 1
+```
+
+
+## Contributing
+
+There are two sets of tests.
+
+The default one uses mock HTTP calls and can be run via:
+```bash
+rake test:spec
+```
+
+The remote ones will issue HTTP calls to FlightStats. You need to update your API credentials in spec/spec_helper.rb before running them:
+
+```bash
+rake test:remote:spec
+```
+
+## License
+
+(The MIT License.)
+
+© 2013 DidItClear
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/flightstats.rb

@@ -0,0 +1,109 @@
+module FlightStats
+  # The exception class from which all FlightStats exceptions inherit.
+  class Error < StandardError
+    def set_message message
+      @message = message
+    end
+
+    # @return [String]
+    def to_s
+      defined? @message and @message or super
+    end
+  end
+
+  # This exception is raised if FlightStats has not been configured.
+  class ConfigurationError < Error
+  end
+
+  class << self
+    # @return [String] An APP id.
+    # @raise [ConfigurationError] If not configured.
+    def app_id
+      defined? @app_id and @app_id or raise(
+        ConfigurationError, "FlightStats.app_id not configured"
+      )
+    end
+    attr_writer :app_id
+
+    # @return [String] An APP key.
+    # @raise [ConfigurationError] If not configured.
+    def app_key
+      defined? @app_key and @app_key or raise(
+        ConfigurationError, "FlightStats.app_key not configured"
+      )
+    end
+    attr_writer :app_key
+
+    # Assigns a logger to log requests/responses and more.
+    #
+    # @return [Logger, nil]
+    # @example
+    #   require 'logger'
+    #   FlightStats.logger = Logger.new STDOUT
+    # @example Rails applications automatically log to the Rails log:
+    #   FlightStats.logger = Rails.logger
+    # @example Turn off logging entirely:
+    #   FlightStats.logger = nil # Or FlightStats.logger = Logger.new nil
+    attr_accessor :logger
+
+    # Convenience logging method includes a Logger#progname dynamically.
+    # @return [true, nil]
+    def log level, message
+      logger.send(level, name) { message }
+    end
+
+    if RUBY_VERSION <= "1.9.0"
+      def const_defined? sym, inherit = false
+        raise ArgumentError, "inherit must be false" if inherit
+        super sym
+      end
+
+      def const_get sym, inherit = false
+        raise ArgumentError, "inherit must be false" if inherit
+        super sym
+      end
+    end
+  end
+
+  require 'flightstats/version'
+
+  require 'flightstats/helper'
+  require 'flightstats/api/errors'
+  require 'flightstats/api/net_http_adapter'
+
+  require 'flightstats/resource'
+
+  require 'flightstats/abstract_date'
+  require 'flightstats/actual_gate_departure'
+  require 'flightstats/actual_runway_departure'
+  require 'flightstats/airline'
+  require 'flightstats/airport'
+  require 'flightstats/airport_resources'
+  require 'flightstats/appendix'
+  require 'flightstats/arrival_date'
+  require 'flightstats/codeshare'
+  require 'flightstats/departure_date'
+  require 'flightstats/equipment'
+  require 'flightstats/estimated_gate_arrival'
+  require 'flightstats/estimated_gate_departure'
+  require 'flightstats/estimated_runway_arrival'
+  require 'flightstats/estimated_runway_departure'
+  require 'flightstats/extended_options'
+  require 'flightstats/flight'
+  require 'flightstats/flight_durations'
+  require 'flightstats/flight_equipment'
+  require 'flightstats/flight_id'
+  require 'flightstats/flight_leg'
+  require 'flightstats/flight_plan_planned_arrival'
+  require 'flightstats/flight_plan_planned_departure'
+  require 'flightstats/flight_status'
+  require 'flightstats/operational_times'
+  require 'flightstats/operator'
+  require 'flightstats/published_arrival'
+  require 'flightstats/published_departure'
+  require 'flightstats/schedule'
+  require 'flightstats/scheduled_gate_arrival'
+  require 'flightstats/scheduled_gate_departure'
+
+  require 'flightstats/api'
+end

data/lib/flightstats/abstract_date.rb

@@ -0,0 +1,6 @@
+module FlightStats
+  class AbstractDate < Resource
+    attr_accessor :date_local,
+                  :date_utc
+  end
+end

data/lib/flightstats/actual_gate_departure.rb

@@ -0,0 +1,4 @@
+module FlightStats
+  class ActualGateDeparture < AbstractDate
+  end
+end

data/lib/flightstats/actual_runway_departure.rb

@@ -0,0 +1,4 @@
+module FlightStats
+  class ActualRunwayDeparture < AbstractDate
+  end
+end

data/lib/flightstats/airline.rb

@@ -0,0 +1,10 @@
+module FlightStats
+  class Airline < Resource
+    attr_accessor :fs,
+                  :iata,
+                  :icao,
+                  :name,
+                  :phone_number,
+                  :active
+  end
+end

data/lib/flightstats/airport.rb

@@ -0,0 +1,88 @@
+module FlightStats
+  class Airport < Resource
+    attr_accessor :fs,
+                  :iata,
+                  :icao,
+                  :faa,
+                  :name,
+                  :street1,
+                  :city,
+                  :city_code,
+                  :state_code,
+                  :postal_code,
+                  :country_code,
+                  :country_name,
+                  :region_name,
+                  :time_zone_region_name,
+                  :weather_zone,
+                  :local_time,
+                  :utc_offset_hours,
+                  :latitude,
+                  :longitude,
+                  :elevation_feet,
+                  :classification,
+                  :active,
+                  :delay_index_url,
+                  :weather_url
+
+    @@base_path = "/flex/airports/rest/v1/json"
+
+    class << self
+      def actives(options = {})
+        from_response API.get("#{base_path}/active", {}, options), 'airports'
+      end
+
+      def actives_for_date(year, month, day, options = {})
+        from_response API.get("#{base_path}/active/#{year}/#{month}/#{day}", {}, options), 'airports'
+      end
+
+      def all(options = {})
+        from_response API.get("#{base_path}/all", {}, options), 'airports'
+      end
+
+      def current(code, options = {})
+        from_response API.get("#{base_path}/#{code}/today", {}, options), 'airport'
+      end
+
+      def on_date(code, year, month, day, options = {})
+        from_response API.get("#{base_path}/#{code}/#{year}/#{month}/#{day}", {}, options), 'airport'
+      end
+
+      def by_city_code(city_code, options = {})
+        from_response API.get("#{base_path}/cityCode/#{city_code}", {}, options), 'airports'
+      end
+
+      def by_country_code(country_code, options = {})
+        from_response API.get("#{base_path}/countryCode/#{country_code}", {}, options), 'airports'
+      end
+
+      def by_flight_stats_code(flight_stats_code, options = {})
+        from_response API.get("#{base_path}/fs/#{flight_stats_code}", {}, options), 'airport'
+      end
+
+      def by_iata_code(iata_code, options = {})
+        from_response API.get("#{base_path}/iata/#{iata_code}", {}, options), 'airports'
+      end
+
+      def by_iata_code_on_date(iata_code, year, month, day, options = {})
+        from_response API.get("#{base_path}/iata/#{iata_code}/#{year}/#{month}/#{day}", {}, options), 'airport'
+      end
+
+      def by_icao_code(icao_code, options = {})
+        from_response API.get("#{base_path}/icao/#{icao_code}", {}, options), 'airports'
+      end
+
+      def by_icao_code_on_date(icao_code, year, month, day, options = {})
+        from_response API.get("#{base_path}/icao/#{icao_code}/#{year}/#{month}/#{day}", {}, options), 'airport'
+      end
+
+      def within_radius(longitude, latitude, radius_miles, options = {})
+        from_response API.get("#{base_path}/withinRadius/#{longitude}/#{latitude}/#{radius_miles}", {}, options), 'airports'
+      end
+
+      def base_path
+        @@base_path
+      end
+    end
+  end
+end