amadeus 0.1.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21a68d7b0cd8c5b0c65f4310534feacc0d8f7dc1
-  data.tar.gz: bd34e47eac5eba5834999dc38ee089c6615a2037
+SHA256:
+  metadata.gz: 64a5992be2ac96248448636c4da2b68bf58228bb1cca410838befdedfdb67e18
+  data.tar.gz: 50971ce13f1a050a9dea262172d7cb1a1e4f1d8a4474e1dc828e0f10c07f09cb
 SHA512:
-  metadata.gz: 9bcaab897433ed26c146f3f0179858af0c47a0f91cbc965463c61e7a7577ab9f9e8f9b6e1fc5e3092535ec3e7e0721dda79c7ac4308c5e28c3df9494aed7f674
-  data.tar.gz: 7961bef9c1ed883a2b0cdbbf1fb1eb7e9d8cfe12741128ce068e46c82abaa012c7c057b39c6200d10c1655c94fc63572716eb9ebc7a279cf52d0878e01873a83
+  metadata.gz: 2a5180f26962a7f72a160c629532678ae6d6b895b09ebbedc6fb28d56f760a5d9bda4872af7e31194d64a634557042babffc6e1aeb93bbfc3e3905652c6afa29
+  data.tar.gz: d2d5eb93d0f483528c32b6a807ce82c990df84318f8ece68fd1afbb12768d9277a009df25e8c061812090b8fa148585cf0551e3b7842d0836cb602929a6b70b7

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 1.0.0.beta1 - 2018-03-23
+
+* First Beta release with support for all the initial API endpoints
+
+## 0.1.0 - 2017-07-07
+
+* Initial release
+* Just a placeholder for the `amadeus` gem name

data/LICENSE

@@ -0,0 +1,15 @@
+The MIT License (MIT)
+Copyright (c) 2017 Amadeus IT Group SA
+
+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

@@ -1,43 +1,181 @@
-# Amadeus
+# Amadeus Ruby SDK
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/amadeus`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/amadeus.svg)](https://badge.fury.io/rb/amadeus)
+[![Build Status](https://travis-ci.org/amadeus4dev/amadeus-ruby.svg?branch=master)][travis]
+[![Contact Support](https://img.shields.io/badge/contact-support-blue.svg)][support]
 
-TODO: Delete this and the text above, and describe your gem
+Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
+
+For more details see the [Ruby documentation](https://developer.amadeus.com/docs/ruby) on [Amadeus.com](https://developer.amadeus.com).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This gem requires Ruby 2.2+. You can install install it directly or via bundler.
 
-```ruby
+```sh
 gem 'amadeus'
 ```
 
-And then execute:
+__Next__: [Get Started with the Ruby SDK.](https://developer.amadeus.com/docs/ruby/get_started/initialize)
+
+## Getting Started
+
+To send make your first API call you will need to [register for an Amadeus Developer Account](https://developer.amadeus.com/register) and [set up your first application](https://dashboard.developer.amadeus.com/applications).
+
+```rb
+require 'amadeus'
+
+amadeus = Amadeus::Client.new({
+  client_id: '[YOUR_CLIENT_ID]',
+  client_secret: '[YOUR_CLIENT_SECRET]'
+})
+
+begin
+  puts amadeus.reference_data.urls.checkin_links.get({ airline: '1X' })
+  # => {"meta"=>{"count"=>2, "links"=>{"self"=>"https://test.api.amadeus.com...
+rescue Amadeus::ResponseError => error
+  puts error
+end
+```
+
+__Next__: [Learn more about checkin links](https://developer.amadeus.com/docs/ruby/get_started/checkin_links) with our Ruby SDK.
+
+## Initialization
+
+The client can be initialized directly.
+
+```rb
+# Initialize using parameters
+amadeus = Amadeus::Client.new(client_id: '...', client_secret: '...')
+```
+
+Alternatively it can be initialized without any paramters if the environment variables `AMADEUS_CLIENT_ID` and `AMADEUS_CLIENT_SECRET` are present.
 
-    $ bundle
+```rb
+amadeus = Amadeus::Client.new
+```
+
+Your credentials can be found on the [Amadeus dashboard](https://dashboard.developer.amadeus.com/client_ids). [Sign up](https://developer.amadeus.com/register) for an account today.
 
-Or install it yourself as:
+By default the environment for the SDK is the `:test` environment. To switch to a production (paid-for) environment please switch the hostname as follows:
+
+```rb
+amadeus = Amadeus::Client.new(hostname: :production)
+```
 
-    $ gem install amadeus
+__Next__: [Learn more about our initializing the Ruby SDK](https://developer.amadeus.com/docs/ruby/get_started_initialize) in our documentation.
 
-## Usage
+## Documentation
 
-TODO: Write usage instructions here
+Amadeus has a large set of APIs, and our documentation is here to get you started today.
 
-## Development
+* [Get Started](https://developer.amadeus.com/docs/ruby/get_started) documentation
+  * [Initialize the SDK](https://developer.amadeus.com/docs/ruby/get_started/initialize)
+  * [Find an Airport](https://developer.amadeus.com/docs/ruby/get_started/find_an_airport)
+  * [Book a Flight](https://developer.amadeus.com/docs/ruby/get_started/book_a_flight)
+  * [Get Flight Inspiration](https://developer.amadeus.com/docs/ruby/get_started/get_flight_inspiration)
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Alternatively, head over to our [Reference](https://developer.amadeus.com/docs/ruby/reference) documentation for in-depth information about every SDK method, it's arguments and return types.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Additionally, this SDK has extensive documentation of itself available on [RubyDoc.info](http://www.rubydoc.info/gems/amadeus/0.1.0).
 
-## Contributing
+## Making API calls
+
+This library conveniently maps every API path to a similar path.
+
+For example, `GET /v2/reference-data/urls/checkin-links?airline=1X` would be:
+
+```rb
+amadeus.reference_data.urls.checkin_links.get(airline: '1X')
+```
+
+Similarly, to select a resource by ID, you can pass in the ID to the path.
+
+For example,  `GET /v1/shopping/hotel/123/hotel-offers` would be:
+
+```rb
+amadeus.hotels(123).hotel_offers.get(...)
+```
+
+You can make any arbitrary API call as well directly with the `.get` method:
+
+```rb
+amadeus.get('/v2/reference-data/urls/checkin-links', airline: '1X')
+```
+
+## Response
+
+Every API call returns a `Amadeus::Response` object. If the API call contained
+a JSON response it will parse the JSON into the `.result` attribute. If this data
+also contains a `data` key, it will make that available as the `.data`
+attribute. The raw body of the response is always avaulable as the `.body` attribute.
+
+```rb
+response = amadeus.reference_data.locations.get(
+  keyword: 'LON',
+  subType: Amadeus::Location::ANY
+)
+
+p reponse.body #=> The raw response, as a string
+p reponse.result #=> The body parsed as JSON, if the result was parsable
+p response.data #=> The list of locations, extracted from the JSON
+```
+
+## Pagination
+
+If an API endpoint supports pagination, the other pages are available under the
+`.next`, `.previous`, `.last` and `.first` methods.
+
+```rb
+response = amadeus.reference_data.locations.get(
+  keyword: 'LON',
+  subType: Amadeus::Location::ANY
+)
+
+amadeus.next(response) #=> returns a new response for the next page
+```
+
+If a page is not available, the method will return `nil`.
+
+## Logging & Debugging
+
+The SDK makes it easy to add your own logger.
+
+```rb
+require 'logger'
+
+amadeus = Amadeus::Client.new(
+  client_id: '...',
+  client_secret: '...',
+  logger: Logger.new(STDOUT)
+)
+```
+
+Additionally, to enable more verbose logging, you can set the appropriate level on your own logger, though the easiest way would be to enable debugging via a parameter on initialization, or using the `AMADEUS_LOG_LEVEL` environment variable.
+
+```rb
+require 'logger'
+
+amadeus = Amadeus::Client.new(
+  client_id: '...',
+  client_secret: '...',
+  log_level: 'debug'
+)
+```
+
+## Development & Contributing
+
+Want to contribute? Read our [Contributors Guide](.github/CONTRIBUTING.md) for guidance on installing and running this code in a development environment.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/amadeus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+This library is released under the [MIT License](LICENSE).
+
+## Help
 
-## Code of Conduct
+Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#).
 
-Everyone interacting in the Amadeus project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/amadeus/blob/master/CODE_OF_CONDUCT.md).
+[gem]: https://rubygems.org/gems/amadeus
+[travis]: http://travis-ci.org/amadeus4dev/amadeus-ruby
+[support]: http://developer.amadeus.com/support

data/amadeus.gemspec

@@ -1,27 +1,37 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "amadeus/version"
+require 'amadeus/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "amadeus"
+  spec.name          = 'amadeus'
   spec.version       = Amadeus::VERSION
-  spec.authors       = ["Cristiano Betta"]
-  spec.email         = ["cristiano@betta.io"]
+  spec.authors       = ['Amadeus', 'Cristiano Betta']
+  spec.email         = ['developer@amadeus.com', 'cristiano@betta.io']
 
-  spec.summary       = "Placeholder gem for Amadeus API"
-  spec.description   = "Placeholder gem for Amadeus API"
-  spec.homepage      = "https://github.com/cbetta/amadeus"
-  spec.license       = "MIT"
+  spec.summary       = 'Ruby library for the Amadeus travel APIs'
+  spec.description   = 'Ruby library for the Amadeus travel APIs'
+  spec.homepage      = 'https://github.com/amadeusdev/amadeus-ruby'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(/^(test|spec|features|.github|docs|.gitignore|.rspec)/) ||
+      f.match(/^(.rubocop.yml|.simplecov|.travis.yml|.yardopts)/) ||
+      f.match(/^(CODE_OF_CONDUCT|Rakefile|Guardfile|Gemfile)/)
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'awesome_print', '~> 1.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'guard', '~> 2.14.1'
+  spec.add_development_dependency 'guard-rake', '~> 1.0.0'
+  spec.add_development_dependency 'guard-yard', '~> 2.2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency 'simplecov', '~> 0.15.1'
+  spec.add_development_dependency 'vcr', '~> 4.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.3.0'
 end

data/lib/amadeus.rb

@@ -1,5 +1,32 @@
-require "amadeus/version"
+# frozen_string_literal: true
 
-module Amadeus
-  # Your code goes here...
-end
+require 'amadeus/version'
+require 'amadeus/client/location'
+require 'amadeus/client/response'
+require 'amadeus/client/decorator'
+require 'amadeus/client/access_token'
+require 'amadeus/client/errors'
+require 'amadeus/client'
+
+require 'amadeus/namespaces/travel'
+require 'amadeus/namespaces/shopping'
+require 'amadeus/namespaces/reference_data'
+require 'amadeus/namespaces/reference_data/urls'
+require 'amadeus/namespaces/reference_data/urls/checkin_links'
+require 'amadeus/namespaces/reference_data/location'
+require 'amadeus/namespaces/reference_data/locations'
+require 'amadeus/namespaces/reference_data/locations/airports'
+require 'amadeus/namespaces/shopping/flight_destinations'
+require 'amadeus/namespaces/shopping/flight_offers'
+require 'amadeus/namespaces/shopping/flight_dates'
+require 'amadeus/namespaces/shopping/hotel_offers'
+require 'amadeus/namespaces/shopping/hotel'
+require 'amadeus/namespaces/shopping/hotel/offer'
+require 'amadeus/namespaces/shopping/hotel/hotel_offers'
+require 'amadeus/namespaces/travel/analytics'
+require 'amadeus/namespaces/travel/analytics/fare_searches'
+require 'amadeus/namespaces/travel/analytics/air_traffics'
+
+# The namespace for the files used to make API
+# calls to the Amadeus travel APIs
+module Amadeus; end

data/lib/amadeus/client.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'amadeus/client/validator'
+require 'amadeus/namespaces/core'
+require 'amadeus/client/http'
+require 'amadeus/client/pagination'
+
+module Amadeus
+  # The Amadeus client library for accessing
+  # the travel APIs
+  class Client
+    include Validator
+    include HTTP
+    include Pagination
+    include Amadeus::Namespaces
+
+    # The API key used to authenticate against the API
+    attr_reader :client_id
+    # The API secret used to authenticate against the API
+    attr_reader :client_secret
+    # The logger used to output warnings and debug messages
+    attr_reader :logger
+    # If this client is running in debug, warn, or silent mode
+    attr_reader :log_level
+    # The short name of the host used to make API calls against
+    attr_reader :hostname
+    # The host domain used to make API calls against
+    attr_reader :host
+    # Wether to use HTTPS to connect
+    attr_reader :ssl
+    # The port to connect to, if not the default 443
+    attr_reader :port
+    # A custom App ID to be passed in the User Agent to the server
+    attr_reader :custom_app_id
+    # A custom App version to be passed in the User Agent to the server
+    attr_reader :custom_app_version
+    # The Net:HTTP compatible HTTP client in use
+    attr_reader :http
+
+    # The available hosts for this API
+    HOSTS = {
+      test: 'test.api.amadeus.com',
+      production: 'production.api.amadeus.com'
+    }.freeze
+
+    # Initialize using your credentials:
+    #
+    #   amadeus = Amadeus::Client.new(
+    #     client_id:    'YOUR_CLIENT_ID',
+    #     client_secret: 'YOUR_CLIENT_SECRET'
+    #   )
+    #
+    # Alternatively, initialize the library using
+    # the environment variables +AMADEUS_CLIENT_ID+
+    # and +AMADEUS_CLIENT_SECRET+
+    #
+    #   amadeus = Amadeus::Client.new
+    #
+    # @option options [string] :clientId the API key used to authenticate the
+    #   API
+    # @option options [string] :clientSecret the API secret used to authenticate
+    #  the API
+    # @option options [Object] :logger ('Logger') a `Logger`-compatible logger
+    #  that accepts a debug call
+    # @option options [string] :log_level ('warn') if this client is running in
+    #  debug, warn, or silent mode
+    # @option options [string] :hostname ('production') the name of the server
+    #  API calls are made to (`production` or `test`)
+    # @option options [string] :custom_app_id (null) a custom App ID to be
+    #  passed in the User Agent to the server.
+    # @option options [string] :custom_app_version (null) a custom App Version
+    #  number to be passed in the User Agent to the server.
+    # @option options [Object] :http (Net::HTTP) an optional
+    #  Node/HTTPS-compatible client that accepts a 'request()' call with an
+    #  array of options.
+    # @option options [boolean] :ssl (true) if this client is will use HTTPS
+    def initialize(options = {})
+      initialize_client_credentials(options)
+      initialize_logger(options)
+      initialize_host(options)
+      initialize_custom_app(options)
+      initialize_http(options)
+
+      recognized_options = %i[client_id client_secret
+                              logger host hostname
+                              custom_app_id custom_app_version
+                              http log_level ssl port]
+      warn_on_unrecognized_options(options, logger, recognized_options)
+    end
+
+    private
+
+    def initialize_client_credentials(options)
+      @client_id = init_required(:client_id, options)
+      @client_secret = init_required(:client_secret, options)
+    end
+
+    def initialize_logger(options)
+      @logger       = init_optional(:logger, options, Logger.new(STDOUT))
+      @log_level    = init_optional(:log_level, options, 'warn')
+    end
+
+    def initialize_host(options)
+      @hostname = init_optional(:hostname, options, :test).to_sym
+      @host = init_optional(:host, options, HOSTS[hostname])
+      @ssl =  init_optional(:ssl, options, true)
+      @port = init_optional(:port, options, 443)
+    end
+
+    def initialize_custom_app(options)
+      @custom_app_id = init_optional(:custom_app_id, options, nil)
+      @custom_app_version = init_optional(:custom_app_version, options, nil)
+    end
+
+    def initialize_http(options)
+      @http = init_optional(:http, options, Net::HTTP)
+    end
+  end
+end