sacs_ruby 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75d94307e3961345367091ae837f1eaa43585ad5
+  data.tar.gz: 17fa57d319d3a0e795ed7b9e4b1ad29d7f7f7c29
+SHA512:
+  metadata.gz: 9216b138e08cba97fe16e77df0bd0f31b77e24b698aeb3d1b2113f8f94c5c91576de0f9e4727ed8829132993a9f37aa2e9614c9e02507503bcccbe71ee9cf0a0
+  data.tar.gz: 147e6fd9812b5ff9e28d6d3232ac1222bbd8902320f17675c9431ffb9eae6228851b4d5a30a527bd2c97e8dc4427b32d6de1515c0e929f9622840ee5f57f33b9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+sabre

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sacs_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Sabre Corp
+
+MIT License
+
+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/README.md

@@ -0,0 +1,196 @@
+# Ruby Sabre API Client
+
+This library implements [Sabre REST API](https://developer.sabre.com/docs/read/REST_APIs)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sacs_ruby'
+```
+
+If you are not using JRuby please consider using [Oj gem](https://github.com/ohler55/oj) for JSON serialization.
+To install Oj add this line to your Gemfile:
+
+```ruby
+gem 'oj'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sacs_ruby
+
+## Configuration
+
+To get API keys please register on [developer.sabre.com](https://developer.sabre.com/member/register)
+
+Initialize gem with configuration file. If using Rails add it to `config/initializers/sacs_ruby.rb`
+
+```ruby
+SacsRuby.configure do |config|
+  config.user_id = '' # User ID
+  config.group = '' # Group
+  config.domain = 'EXT' # Domain
+  config.client_secret = '' # Client Secret
+  config.environment = 'https://api.test.sabre.com' # Environment
+  config.token_strategy = :single # or :shared - see Token paragraph
+end
+```
+
+#### Use environment variables to store API keys. Never commit it for security reasons.
+
+### Access Token
+
+For single server configuration you can use default token strategy:
+```ruby
+config.token_strategy = :single
+```
+Token will be obtained with first request, then stored and auto renewed through life of the server.
+Be aware that there is a limit of tokens issued for given API keys.
+
+For multi server configuration (or development when a lot of restarts happen) please
+use shared token strategy:
+```ruby
+config.token_strategy = :shared
+```
+
+To request token use:
+```ruby
+token = SacsRuby.client.fetch_token
+token.access_token
+token.expires_on
+```
+Please store it and implement token refresh in to your workflow.
+
+Expired token will raise `SacsRuby::AuthorizationError`.
+
+To use shared token add it as argument, ie:
+```ruby
+results = SacsRuby::API::BargainFinderMax.get(payload: payload, token: received_access_token)
+```
+
+### Environment
+
+When using `https://api.test.sabre.com`, Sabre TEST API will be used.
+
+When you will be ready, you can request access to PROD servers and change to
+`https://api.sabre.com`
+
+## Usage
+
+For detailed documentation regarding required params and possible response, please refer to [Sabre REST API documentation](https://developer.sabre.com/docs/read/REST_APIs)
+
+### Basic usage
+
+Each API endpoint listed in documentation can be requested following this pattern:
+```ruby
+SacsRuby::API::NameOfTheApi.get(*args)
+```
+
+Example:
+
+```ruby
+results = SacsRuby::API::InstaFlightsSearch.get(origin: 'LAX', destination: 'JFK', departuredate: '2015-12-01', returndate: '2015-12-06') # add `token: token_string` if needed
+```
+
+or:
+
+```ruby
+ifs = SacsRuby::API::InstaFlightsSearch.new(origin: 'LAX', destination: 'JFK', departuredate: '2015-12-04', returndate: '2015-12-06')
+
+ifs.opts # => {:origin=>"LAX", :destination=>"JFK", :departuredate=>"2015-12-04", :returndate=>"2015-12-06"}
+
+ifs.get # gets data from api
+
+ifs.results # prints response hash
+```
+
+If required params are missed during endpoint initialization `SacsRuby::ApiArgumentError` will be raised.
+
+Sometimes additional argument requires another argument to be present.
+If it is missing, `SacsRuby::BadRequestError` will be raised with error description provided by the API.
+
+
+### Advanced usage
+
+Sabre API is very powerful tool. Some of the endpoints cannot accept single arguments,
+due to complexity of request.
+
+For those endpoints you need to build JSON payload.
+
+We recomend to create method which will build hash and then converts it to JSON.
+
+Ie:
+```ruby
+class BargainFinderMax
+  def self.build_json(params)
+    {
+      'OTA_AirLowFareSearchRQ' => {
+        'OriginDestinationInformation' => [{
+          'DepartureDateTime' => departure_date_helper(params),
+          'DestinationLocation' => {
+            'LocationCode' => params['destination']
+          },
+          'OriginLocation' => {
+            'LocationCode' => params['origin']
+          },
+          'RPH' => params['rph']
+        }],
+        'POS' => {
+          'Source' => [{
+            'RequestorID' => {
+              'CompanyName' => {
+                'Code' => params['pos_company_code']
+              }, 'ID' => params['pos_id'], 'Type' => params['pos_type']
+            }
+          }]
+        },
+        'TPA_Extensions' => {
+          'IntelliSellTransaction' => {
+            'RequestType' => {
+              'Name' => params['request_type']
+            }
+          }
+        },
+        'TravelPreferences' => {
+          'TPA_Extensions' => {
+            'NumTrips' => {
+              'Number' => 1
+            }
+          }
+        },
+        'TravelerInfoSummary' => {
+          'AirTravelerAvail' => [{
+            'PassengerTypeQuantity' => [{
+              'Code' => params['passenger_code'],
+              'Quantity' => params['passenger_qnt'].to_i
+            }]
+          }]
+        }
+      }
+    }.to_json
+  end
+
+  def self.departure_date_helper(params)
+    DateTime.strptime(params['departure_date'], '%m/%d/%Y').strftime('%FT%T')
+  end
+end
+
+payload = BargainFinderMax.build_json(params)
+results = SacsRuby::API::BargainFinderMax.get(payload: payload)
+```
+Pay attention to the format of required arguments.
+
+### Support
+
+- [Stack Overflow](http://stackoverflow.com/questions/tagged/sabre)
+- Need to report an issue/improvement? Use the built-in [issues](https://github.com/SabreDevStudio/SACS-Ruby/issues) section.
+- [Sabre Dev Studio](https://developer.sabre.com/)
+
+### Disclaimer of Warranty and Limitation of Liability
+This software and any compiled programs created using this software are furnished “as is” without warranty of any kind, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. No oral or written information or advice given by Sabre, its agents or employees shall create a warranty or in any way increase the scope of this warranty, and you may not rely on any such information or advice. Sabre does not warrant, guarantee, or make any representations regarding the use, or the results of the use, of this software, compiled programs created using this software, or written materials in terms of correctness, accuracy, reliability, currentness, or otherwise. The entire risk as to the results and performance of this software and any compiled applications created using this software is assumed by you. Neither Sabre nor anyone else who has been involved in the creation, production or delivery of this software shall be liable for any direct, indirect, consequential, or incidental damages (including damages for loss of business profits, business interruption, loss of business information, and the like) arising out of the use of or inability to use such product even if Sabre has been advised of the possibility of such damages.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sabre"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sacs_ruby.rb

@@ -0,0 +1,56 @@
+require 'sacs_ruby/version'
+require 'sacs_ruby/error'
+require 'rest-client'
+
+module SacsRuby
+  autoload :Configuration, 'sacs_ruby/configuration'
+  autoload :Credentials, 'sacs_ruby/credentials'
+  autoload :Client, 'sacs_ruby/client'
+  autoload :Base, 'sacs_ruby/base'
+  autoload :JSON, 'sacs_ruby/json'
+  autoload :BasePost, 'sacs_ruby/base_post'
+
+  module API
+    autoload :InstaFlightsSearch, 'sacs_ruby/api/insta_flights_search'
+    autoload :LeadPriceCalendar,'sacs_ruby/api/lead_price_calendar'
+    autoload :DestinationFinder, 'sacs_ruby/api/destination_finder'
+    autoload :FlightsTo, 'sacs_ruby/api/flights_to'
+    autoload :LowFareForecast, 'sacs_ruby/api/low_fare_forecast'
+    autoload :FareRange, 'sacs_ruby/api/fare_range'
+    autoload :TravelSeasonality, 'sacs_ruby/api/travel_seasonality'
+    autoload :TopDestinations, 'sacs_ruby/api/top_destinations'
+    autoload :LowFareHistory, 'sacs_ruby/api/low_fare_history'
+    autoload :PointOfSaleCountryCodeLookup, 'sacs_ruby/api/point_of_sale_country_code_lookup'
+    autoload :TravelSeasonalityAirportsLookup, 'sacs_ruby/api/travel_seasonality_airports_lookup'
+    autoload :CountriesLookup, 'sacs_ruby/api/countries_lookup'
+    autoload :CityPairsLookup, 'sacs_ruby/api/city_pairs_lookup'
+    autoload :TravelThemeLookup, 'sacs_ruby/api/travel_theme_lookup'
+    autoload :MultiAirportCityLookup, 'sacs_ruby/api/multi_airport_city_lookup'
+    autoload :AirportsAtCitiesLookup, 'sacs_ruby/api/airports_at_cities_lookup'
+    autoload :AirlineAllianceLookup, 'sacs_ruby/api/airline_alliance_lookup'
+    autoload :AircraftEquipmentLookup, 'sacs_ruby/api/aircraft_equipment_lookup'
+    autoload :AirlineLookup, 'sacs_ruby/api/airline_lookup'
+    autoload :GeoAutocomplete, 'sacs_ruby/api/geo_autocomplete'
+    autoload :BargainFinderMax, 'sacs_ruby/api/bargain_finder_max'
+    autoload :AlternateAirportShop, 'sacs_ruby/api/alternate_airport_shop'
+    autoload :AlternateDate, 'sacs_ruby/api/alternate_date'
+    autoload :AdvancedCalendarSearch, 'sacs_ruby/api/advanced_calendar_search'
+    autoload :SeatMap, 'sacs_ruby/api/seat_map'
+    autoload :CarAvailability, 'sacs_ruby/api/car_availability'
+    autoload :GeoCode, 'sacs_ruby/api/geo_code'
+    autoload :GeoSearch, 'sacs_ruby/api/geo_search'
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+end

data/lib/sacs_ruby/api/advanced_calendar_search.rb

@@ -0,0 +1,13 @@
+module SacsRuby
+  module API
+    # The Advanced Calendar Search API returns the lowest published fares and
+    # flight itineraries for a given city pair.
+    class AdvancedCalendarSearch < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1.9.0/shop/calendar/flights?mode=live'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/aircraft_equipment_lookup.rb

@@ -0,0 +1,14 @@
+module SacsRuby
+  module API
+    # The Aircraft Equipment Lookup API returns the aircraft name associated
+    # with a specified IATA aircraft equipment code. If no code is specified,
+    # the API returns all codes and their corresponding names.
+    # @see https://developer.sabre.com/docs/rest_apis/utility/aircraft_equipment_lookup API Documentation
+    # @see Base Base class for documentation
+    class AircraftEquipmentLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/utilities/aircraft/equipment'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/airline_alliance_lookup.rb

@@ -0,0 +1,15 @@
+module SacsRuby
+  module API
+    # The Airline Alliance Lookup API returns the airline alliance member
+    # information associated with a specified airline alliance group code.
+    # If no code is specified, the API returns all airline alliance groups and
+    # their corresponding member information.
+    # @see https://developer.sabre.com/docs/rest_apis/utility/airline_alliance_lookup API Documentation
+    # @see Base Base class for documentation
+    class AirlineAllianceLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/utilities/airlines/alliances'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/airline_lookup.rb

@@ -0,0 +1,14 @@
+module SacsRuby
+  module API
+    # The Airline Lookup API returns the airline name associated with a
+    # specified IATA airline code. If no code is specified, the API returns all
+    # codes and their corresponding names.
+    # @see https://developer.sabre.com/docs/read/rest_apis/utility/airline_lookup API Documentation
+    # @see Base Base class for documentation
+    class AirlineLookup < SacsRuby::Base
+      def endpoint_url
+        '/v1/lists/utilities/airlines'
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/airports_at_cities_lookup.rb

@@ -0,0 +1,19 @@
+module SacsRuby
+  module API
+    # The Airports at Cities Lookup API returns the major airport, rail station
+    # and other codes that are associated with a single a multi-airport city
+    # (MAC) code. An example multi-airport city code is CHI, and the
+    # corresponding city name is Chicago.
+    # @see https://developer.sabre.com/docs/read/rest_apis/air/utility/airports_at_cities_lookup API Documentation
+    # @see Base Base class for documentation
+    class AirportsAtCitiesLookup < SacsRuby::Base
+      def required_vars
+        %i(city)
+      end
+
+      def endpoint_url
+        "/v1/lists/supported/cities/#{opts.delete(:city)}/airports"
+      end
+    end
+  end
+end

data/lib/sacs_ruby/api/alternate_airport_shop.rb

@@ -0,0 +1,15 @@
+module SacsRuby
+  module API
+    # The Alternate Airport Shop API allows you to define up to 20 airports per
+    # origin and/or destination. The API returns the lead fare (either nonstop
+    # or overall, whichever is lowest) with the corresponding flight itinerary
+    # and fare breakdown for each lead fare.
+    class AlternateAirportShop < SacsRuby::Base
+      include BasePost
+
+      def endpoint_url
+        '/v1.9.0/shop/altairports/flights?mode=live'
+      end
+    end
+  end
+end