sacs_ruby 0.1.1

data/lib/sacs_ruby/api/alternate_date.rb

@@ -0,0 +1,13 @@
+module SacsRuby
+  module API
+    # The Bargain Finder Max Alternate Date Shopping API allows you to specify
+    # multiple itinerary options and date pair combinations per request.
+    class AlternateDate < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1.9.0/shop/altdates/flights?mode=live'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/bargain_finder_max.rb

@@ -0,0 +1,15 @@
+module SacsRuby
+  module API
+    # Bargain Finder Max (BFM), our best-in-class low fare search product, is
+    # used to search for the lowest available priced itineraries based upon a
+    # travel date. A wide range of user-specified criteria can be applied to
+    # the search.
+    class BargainFinderMax < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1.9.0/shop/flights?mode=live'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/car_availability.rb

@@ -0,0 +1,13 @@
+module SacsRuby
+  module API
+    # The Car Availability API returns real-time rental car pricing
+    # and availability information.
+    class CarAvailability < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v2.4.0/shop/cars'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/city_pairs_lookup.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The City Pairs Lookup API consists of supplemental APIs which retrieve
+    # city pairs that can be passed to applicable Air Shopping REST APIs. A city
+    # pair is passed as a combination of an origin and destination airport.
+    # For example, City Pairs Lookup retrieves the SJU-MIA city pair (San Juan
+    # International, Puerto Rico to Miami International). You can pass this city
+    # pair for any applicable air search API request, e.g., Lead Price Calendar.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/city_pairs_lookup API Documentation
+    # @see Base Base class for documentation
+    class CityPairsLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/shop/flights/origins-destinations'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/countries_lookup.rb

@@ -0,0 +1,15 @@
+module SacsRuby
+  module API
+    # The Countries Lookup API retrieves a list of origin and destination
+    # countries. These countries can be used as a filter in applicable
+    # REST APIs. This API is point of sale specific (each point of sale
+    # supports a unique list of origin and destination countries).
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/countries_lookup API Documentation
+    # @see Base Base class for documentation
+    class CountriesLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/countries'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/destination_finder.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The Destination Finder API returns the lowest published fares
+    # available to destinations from a given origin.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/search/destination_finder API Documentation
+    # @see Base Base class for documentation
+    class DestinationFinder < SacsRuby::Base
+      def required_vars
+        %i( origin )
+      end
+
+      def endpoint_url
+        '/v2/shop/flights/fares'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/fare_range.rb

@@ -0,0 +1,25 @@
+module SacsRuby
+  module API
+    # The Fare Range API returns the median, highest, and lowest published fares
+    # that were ticketed via the Sabre GDS during the previous 4 weeks for each
+    # of the future departure dates in a range, using the specific origin,
+    # destination, and length of stay in the request.
+    # In the request, future departure dates can range from 0-90 days, from the
+    # day of the API request. Length of stay is any single value from 0-16 days.
+    # The API also returns a rating of high, medium, or low, which represents
+    # the quantity of tickets that the API referenced to obtain the published
+    # fare values.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/intelligence/fare_range API Documentation
+    # @see Base Base class for documentation
+    class FareRange < SacsRuby::Base
+      def required_vars
+        %i(origin destination earliestdeparturedate latestdeparturedate
+           lengthofstay)
+      end
+
+      def endpoint_url
+        '/v1/historical/flights/fares'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/flights_to.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The Flights To API returns 20 of the lowest published
+    # fares available for a given destination.
+    # @see https://developer.sabre.com/docs/rest_apis/air/search/flights_to/ API Documentation
+    # @see Base Base class for documentation
+    class FlightsTo < SacsRuby::Base
+      def required_vars
+        %i(destination)
+      end
+
+      def endpoint_url
+        "/v1/shop/flights/cheapest/fares/#{opts.delete(:destination)}"
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/geo_autocomplete.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The Geo Autocomplete API returns a list of location predictions
+    # for text-based geographic search queries.
+    # @see https://developer.sabre.com/docs/rest_apis/utility/geo_autocomplete/ API Documentation
+    # @see Base Base class for documentation
+    class GeoAutocomplete < SacsRuby::Base
+      def required_vars
+        %i(query)
+      end
+
+      def endpoint_url
+        '/v1/lists/utilities/geoservices/autocomplete'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/geo_code.rb

@@ -0,0 +1,12 @@
+module SacsRuby
+  module API
+    # The Geo Code API returns the geographic information of a given location.
+    class GeoCode < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1/lists/utilities/geocode/locations'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/geo_search.rb

@@ -0,0 +1,12 @@
+module SacsRuby
+  module API
+    # The Geo Search API returns a list of places around a given location.
+    class GeoSearch < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1/lists/utilities/geosearch/locations'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/insta_flights_search.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The InstaFlights Search API retrieves roundtrip flight itineraries
+    # with published fares and fare breakdowns available from the Sabre
+    # cache for a certain origin, destination, and roundtrip travel dates.
+    # The origins and destinations are airport codes
+    class InstaFlightsSearch < SacsRuby::Base
+      def required_vars
+        %i(origin destination departuredate returndate)
+      end
+
+      def endpoint_url
+        '/v1/shop/flights'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/lead_price_calendar.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The Lead Price Calendar API returns the lowest published fares each of
+    # the next 192 calendar days for a given city pair.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/search/lead_price_calendar API Documentation
+    # @see Base Base class for documentation
+    class LeadPriceCalendar < SacsRuby::Base
+      def required_vars
+        %i(origin destination lengthofstay)
+      end
+
+      def endpoint_url
+        '/v2/shop/flights/fares'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/low_fare_forecast.rb

@@ -0,0 +1,19 @@
+module SacsRuby
+  module API
+    # The Low Fare Forecast API forecasts the price range into which the
+    # lowest published fare that is available via the Sabre GDS is predicted
+    # to fall within the next 7 days, for a specific origin and destination on
+    # specific roundtrip travel dates.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/intelligence/low_fare_forecast API Documentation
+    # @see Base Base class for documentation
+    class LowFareForecast < SacsRuby::Base
+      def required_vars
+        %i(origin destination departuredate returndate)
+      end
+
+      def endpoint_url
+        '/v1/forecast/flights/fares'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/low_fare_history.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # The Low Fare History API returns each day of the past two weeks
+    # lowest published fares for a given city/date pair.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/intelligence/low_fare_history API Documentation
+    # @see Base Base class for documentation
+    class LowFareHistory < SacsRuby::Base
+      def required_vars
+        %i(origin destination departuredate returndate)
+      end
+
+      def endpoint_url
+        '/v1/historical/shop/flights/fares'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/multi_airport_city_lookup.rb

@@ -0,0 +1,20 @@
+module SacsRuby
+  module API
+    # The Multi-Airport City Lookup API returns a list of multi-airport city
+    # (MAC) codes. The response contains multi-airport cities located in the
+    # requested country(s), sorted by city name, in ascending rank order. If no
+    # country is specified, then all MAC codes and cities are returned. An
+    # example multi-airport city code is CHI, and the corresponding city name is
+    # Chicago. Note: Some city codes represent a metropolitan area that
+    # contains more than one major city. For example, the MAC code "QDF"
+    # represents Dallas and Ft. Worth, Texas. In this case, the city name is
+    # "Dallas / Ft. Worth".
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/multiairport_city_lookup API Documentation
+    # @see Base Base class for documentation
+    class MultiAirportCityLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/cities'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/point_of_sale_country_code_lookup.rb

@@ -0,0 +1,17 @@
+module SacsRuby
+  module API
+    # Point of Sale Country Code Lookup is a supplemental API that retrieves a
+    # list of supported point of sale country codes and associated country
+    # names. The country codes can be passed as a parameter in certain REST API
+    # requests (those which support a 'pointofsalecountry' parameter). When a
+    # point of sale country is submitted with the request, only data related to
+    # that point of sale will be included in the response.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/point_of_sale_country_code_lookup API Documentation
+    # @see Base Base class for documentation
+    class PointOfSaleCountryCodeLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/pointofsalecountries'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/seat_map.rb

@@ -0,0 +1,13 @@
+module SacsRuby
+  module API
+    # The Seat Map API returns real-time seat map and specific seat pricing
+    # and availability information for a given aircraft.
+    class SeatMap < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v3.0.0/book/flights/seatmaps?mode=live'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/top_destinations.rb

@@ -0,0 +1,19 @@
+module SacsRuby
+  module API
+    # The Top Destinations API retrieves top booked leisure destinations from a
+    # given origin and returns them in ascending rank order.
+    # The API looks up the traffic volume booked via the Sabre GDS to the top
+    # destinations for the previous 2, 8 or 12 weeks. It returns up to 50
+    # results per origin by rank - rank one is most popular; whereas, rank 50
+    # is least popular. Origin can be a multi-airport city (MAC) code, airport
+    # code, country code, or all possible origins (domestic and international)
+    # combined.
+    # @see https://developer.sabre.com/docs/rest_apis/air/search/flights_to/ API Documentation
+    # @see Base Base class for documentation
+    class TopDestinations < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/top/destinations'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/travel_seasonality.rb

@@ -0,0 +1,23 @@
+module SacsRuby
+  module API
+    # The Travel Seasonality API returns a traffic volume rating for each week
+    # of the year for a given destination.
+    # In total, each request returns a booked traffic volume rating of low,
+    # medium or high for each week (1-52) of the next year for a given
+    # destination. Each week is compared with the traffic volume of the other 51
+    # weeks. The API then calculates whether that week is high or low
+    # seasonality, e.g., week 32 is compared with the 1st, 2nd, 3rd … 33rd,
+    # 34th, 35th… 52nd weeks.
+    # @see https://developer.sabre.com/docs/rest_apis/air/search/flights_to/ API Documentation
+    # @see Base Base class for documentation
+    class TravelSeasonality < SacsRuby::Base
+      def required_vars
+        %i(destination)
+      end
+
+      def endpoint_url
+        "/v1/historical/flights/#{opts.delete(:destination)}/seasonality"
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/travel_seasonality_airports_lookup.rb

@@ -0,0 +1,13 @@
+module SacsRuby
+  module API
+    # The Travel Seasonality Airports Lookup API retrieves a list of our
+    # supported destinations.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/travel_seasonality_airports_lookup API Documentation
+    # @see Base Base class for documentation
+    class TravelSeasonalityAirportsLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/historical/seasonality/airports'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/travel_theme_lookup.rb

@@ -0,0 +1,15 @@
+module SacsRuby
+  module API
+    # The Travel Theme Lookup API returns a list of supported Sabre themes.
+    # A theme is similar to a travel category, and is based on geography, points
+    # of interest, and recreational activities, such as beaches, national parks,
+    # or skiing.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/travel_theme_lookup API Documentation
+    # @see Base Base class for documentation
+    class TravelThemeLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/supported/shop/themes'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/base.rb

@@ -0,0 +1,47 @@
+module SacsRuby
+  # Base class for API
+  class Base
+    attr_reader :opts, :token, :results, :url
+
+    def self.get(*args)
+      new(*args).get
+    end
+
+    def initialize(opts = {})
+      @token = opts.delete(:token)
+      @opts = opts
+    end
+
+    def get
+      validate!(opts)
+      response = SacsRuby.client.get(request_params)
+      @results = JSON.load(response)
+    end
+
+    def valid?
+      return true unless self.respond_to? :required_vars
+      @missing_opts = required_vars - opts.keys
+      @missing_opts.empty?
+    end
+
+    def url
+      fail ApiEndpointError, 'Missing endpoint url' unless self.respond_to? :endpoint_url
+      fail ConfigurationError if SacsRuby.configuration.nil?
+      [SacsRuby.configuration.environment, endpoint_url, '?', build_query].join
+    end
+
+    private
+
+    def validate!(opts)
+      fail ApiArgumentError, "Missing required params: #{@missing_opts.join(' ')}" unless valid?
+    end
+
+    def build_query
+      opts.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def request_params
+      @token.nil? ? { url: url } : { url: url, token: @token }
+    end
+  end
+end