flightstats-flex 0.1.0

data/lib/flightstats/airport_resources.rb

@@ -0,0 +1,7 @@
+module FlightStats
+  class AirportResources < Resource
+    attr_accessor :departure_gate,
+                  :arrival_terminal,
+                  :arrival_gate
+  end
+end

data/lib/flightstats/api.rb

@@ -0,0 +1,73 @@
+module FlightStats
+  class API
+    require 'flightstats/api/errors'
+    require 'flightstats/resource'
+
+    @@base_uri = "https://api.flightstats.com"
+
+    class << self
+      # Additional HTTP headers sent with each API call
+      # @return [Hash{String => String}]
+      def headers
+        @headers ||= { 'Accept' => accept, 'User-Agent' => user_agent }
+      end
+
+      # @return [String, nil] Accept-Language header value
+      def accept_language
+        headers['Accept-Language']
+      end
+
+      # @param [String] language Accept-Language header value
+      def accept_language=(language)
+        headers['Accept-Language'] = language
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def head uri, params = {}, options = {}
+        request :head, uri, { :params => params }.merge(options)
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def get uri, params = {}, options = {}
+        request :get, uri, { :params => params }.merge(options)
+      end
+
+      # @return [Net::HTTPCreated, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def post uri, body = nil, options = {}
+        request :post, uri, { :body => body.to_s }.merge(options)
+      end
+
+      # @return [Net::HTTPOK, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def put uri, body = nil, options = {}
+        request :put, uri, { :body => body.to_s }.merge(options)
+      end
+
+      # @return [Net::HTTPNoContent, Net::HTTPResponse]
+      # @raise [ResponseError] With a non-2xx status code.
+      def delete uri, options = {}
+        request :delete, uri, options
+      end
+
+      # @return [URI::Generic]
+      def base_uri
+        URI.parse @@base_uri
+      end
+
+      # @return [String]
+      def user_agent
+        "FlightStats/#{FlightStats::Version}; #{RUBY_DESCRIPTION}"
+      end
+
+      private
+
+      def accept
+        'application/json'
+      end
+      alias content_type accept
+    end
+  end
+end

data/lib/flightstats/api/errors.rb

@@ -0,0 +1,120 @@
+require 'cgi'
+require 'json'
+
+module FlightStats
+  class API
+    # The superclass to all errors that occur when making an API request.
+    class ResponseError < Error
+      attr_reader :request
+      attr_reader :response
+
+      def initialize request, response
+        @request, @response = request, response
+      end
+
+      def code
+        response.code.to_i if response
+      end
+
+      def to_s
+        if description
+          return CGI.unescapeHTML [description, details].compact.join(' ')
+        end
+
+        return super unless code
+        "%d %s (%s %s)" % [
+          code, http_error, request.method, API.base_uri + request.path
+        ]
+      end
+
+      def message
+        json and json['error'] and json['error']['errorMessage']
+      end
+
+      def code
+        json and json['error'] and json['error']['errorCode']
+      end
+
+      private
+
+      def http_error
+        Helper.demodulize self.class.name.gsub(/([a-z])([A-Z])/, '\1 \2')
+      end
+
+      def json
+        return @json if defined? @json
+        @json = (JSON.parse(response.body) if response && !response.body.empty?)
+      end
+    end
+
+    # === 3xx Redirection
+    #
+    # Not an error, per se, but should result in one in the normal course of
+    # API interaction.
+    class Redirection < ResponseError
+    end
+
+    # === 4xx Client Error
+    #
+    # The superclass to all client errors (responses with status code 4xx).
+    class ClientError < ResponseError
+    end
+
+    # === 400 Bad Request
+    #
+    # Something was wrong with the request submitted, and it must be corrected
+    # before it can succeed. The response body will include details about the error.
+    class BadRequest < ClientError
+    end
+
+    # === 403 Forbidden
+    #
+    # Authorization failure; valid credentials were not provided.
+    class Forbidden < ClientError
+    end
+
+    # === 404 Not Found
+    #
+    # No resource was found at the specified URI.
+    class NotFound < ClientError
+    end
+
+    # === 405 Method Not Allowed
+    #
+    # The HTTP request specified a method (e.g. PUT, DELETE, OPTIONS, etc.)
+    # that is not supported by this resource.
+    class MethodNotAllowed < ClientError
+    end
+
+    # === 5xx Server Error
+    #
+    # The superclass to all server errors (responses with status code 5xx).
+    class ServerError < ResponseError
+    end
+
+    # === 500 Internal Server Error
+    #
+    # Unexpected server-side failure. Should this occur, please contact us
+    # for assistance. The response body will include a unique identifier
+    # that we can use to help locate the problem.
+    class InternalServerError < ServerError
+    end
+
+    # Error mapping by status code.
+    ERRORS = Hash.new { |hash, code|
+      unless hash.key? code
+        case code
+          when 400...500 then ClientError
+          when 500...600 then ServerError
+          else                ResponseError
+        end
+      end
+    }.update(
+      400 => BadRequest,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      500 => InternalServerError
+    ).freeze
+  end
+end

data/lib/flightstats/api/net_http_adapter.rb

@@ -0,0 +1,114 @@
+require 'cgi'
+require 'net/http'
+require 'net/https'
+
+module FlightStats
+  class API
+    module Net
+      module HTTPAdapter
+        # A hash of Net::HTTP settings configured before the request.
+        #
+        # @return [Hash]
+        def net_http
+          @net_http ||= {}
+        end
+
+        # Used to store any Net::HTTP settings.
+        #
+        # @example
+        #   FlightStats::API.net_http = {
+        #     :verify_mode => OpenSSL::SSL::VERIFY_PEER,
+        #     :ca_path     => "/etc/ssl/certs",
+        #     :ca_file     => "/opt/local/share/curl/curl-ca-bundle.crt"
+        #   }
+        attr_writer :net_http
+
+        private
+
+        METHODS = {
+          :head   => ::Net::HTTP::Head,
+          :get    => ::Net::HTTP::Get,
+          :post   => ::Net::HTTP::Post,
+          :put    => ::Net::HTTP::Put,
+          :delete => ::Net::HTTP::Delete
+        }
+
+        def request method, uri, options = {}
+          head = headers.dup
+          head.update options[:head] if options[:head]
+          head.delete_if { |_, value| value.nil? }
+          uri = base_uri + uri
+
+          query_params = "?"
+          query_params += "#{CGI.escape 'appId'}=#{CGI.escape FlightStats.app_id.to_s}"
+          query_params += "&#{CGI.escape 'appKey'}=#{CGI.escape FlightStats.app_key.to_s}"
+          if options[:params] && !options[:params].empty?
+            pairs = options[:params].map { |key, value|
+              "#{CGI.escape key.to_s}=#{CGI.escape value.to_s}"
+            }
+            query_params += "&#{pairs.join '&'}"
+          end
+          uri += query_params
+
+          request = METHODS[method].new uri.request_uri, head
+          if options[:body]
+            request['Content-Type'] = content_type
+            request.body = options[:body]
+          end
+          if options[:etag]
+            request['If-None-Match'] = options[:etag]
+          end
+          if options[:format]
+            request['Accept'] = FORMATS[options[:format]]
+          end
+          if options[:locale]
+            request['Accept-Language'] = options[:locale]
+          end
+          http = ::Net::HTTP.new uri.host, uri.port
+          http.use_ssl = uri.scheme == 'https'
+          net_http.each_pair { |key, value| http.send "#{key}=", value }
+
+          if FlightStats.logger
+            FlightStats.log :info, "===> %s %s" % [request.method, uri]
+            headers = request.to_hash
+            headers['authorization'] &&= ['Basic [FILTERED]']
+            FlightStats.log :debug, headers.inspect
+            if request.body && !request.body.empty?
+              FlightStats.log :debug, request.body
+            end
+            start_time = Time.now
+          end
+
+          response = http.start { http.request request }
+          code = response.code.to_i
+
+          if FlightStats.logger
+            latency = (Time.now - start_time) * 1_000
+            level = case code
+              when 200...300 then :info
+              when 300...400 then :warn
+              when 400...500 then :error
+              else                :fatal
+            end
+            FlightStats.log level, "<=== %d %s (%.1fms)" % [
+              code,
+              response.class.name[9, response.class.name.length].gsub(
+                /([a-z])([A-Z])/, '\1 \2'
+              ),
+              latency
+            ]
+            FlightStats.log :debug, response.to_hash.inspect
+            FlightStats.log :debug, response.body if response.body
+          end
+
+          case code
+            when 200...300 then response
+            else                raise ERRORS[code].new request, response
+          end
+        end
+      end
+    end
+
+    extend Net::HTTPAdapter
+  end
+end

data/lib/flightstats/appendix.rb

@@ -0,0 +1,6 @@
+module FlightStats
+  class Appendix < Resource
+    attr_accessor :airlines,
+                  :airports
+  end
+end

data/lib/flightstats/arrival_date.rb

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

data/lib/flightstats/codeshare.rb

@@ -0,0 +1,7 @@
+module FlightStats
+  class Codeshare < Resource
+    attr_accessor :fs_code,
+                  :flight_number,
+                  :relationship
+  end
+end

data/lib/flightstats/departure_date.rb

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

data/lib/flightstats/equipment.rb

@@ -0,0 +1,10 @@
+module FlightStats
+  class Equipment < Resource
+    attr_accessor :iata,
+                  :name,
+                  :turbo_prop,
+                  :jet,
+                  :widebody,
+                  :regional
+  end
+end

data/lib/flightstats/estimated_gate_arrival.rb

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

data/lib/flightstats/estimated_gate_departure.rb

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

data/lib/flightstats/estimated_runway_arrival.rb

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

data/lib/flightstats/estimated_runway_departure.rb

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

data/lib/flightstats/extended_options.rb

@@ -0,0 +1,6 @@
+module FlightStats
+  class ExtendedOptions < Resource
+    attr_accessor :requested,
+                  :interpreted
+  end
+end

data/lib/flightstats/flight.rb

@@ -0,0 +1,61 @@
+module FlightStats
+  class Flight < Resource
+    attr_accessor :departure_airport_fs_code,
+                  :arrival_airport_fs_code,
+                  :departure_date_from,
+                  :departure_date_to,
+                  :departure_days_of_week,
+                  :arrival_date_adjustment,
+                  :departure_time,
+                  :arrival_time,
+                  :distance_miles,
+                  :flight_duration_minutes,
+                  :layover_duration_minutes,
+                  :flight_type,
+                  :service_type,
+                  :online,
+                  :flight_legs
+
+    class << self
+      def direct_arriving_at(arrival_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/to/#{arrival_code}/arriving/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_departing_from(departure_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/from/#{departure_code}/departing/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_arriving_by_flight_number(carrier, flight_number, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/flight/#{carrier}/#{flight_number}/arriving/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_arriving_by_flight_number_and_location(carrier, flight_number, arrival_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/flight/#{carrier}/#{flight_number}/to/#{arrival_code}/arriving/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_departing_by_flight_number(carrier, flight_number, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/flight/#{carrier}/#{flight_number}/departing/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_departing_by_flight_number_and_location(carrier, flight_number, arrival_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/direct/flight/#{carrier}/#{flight_number}/to/#{arrival_code}/departing/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_and_connecting_arriving(departure_code, arrival_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/connecting/from/#{departure_code}/to/#{arrival_code}/arriving/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+
+      def direct_and_connecting_departing(departure_code, arrival_code, year, month, day, options = {})
+        from_response API.get("/flex/connections/rest/v1/json/connecting/from/#{departure_code}/to/#{arrival_code}/departing/#{year}/#{month}/#{day}", {}, options), 'flights'
+      end
+    end
+
+    def to_s
+      str = "#{departure_airport_fs_code} - #{arrival_airport_fs_code} (#{distance_miles} miles): from #{departure_date_from} to #{departure_date_to}"
+      flight_legs.each do |leg|
+        str << "\n  #{leg.to_s}"
+      end
+      str
+    end
+  end
+end