amadeus 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 791529954c105956f49fc4fb7501fcbde20c6e315a63b5b458e26cc55fe69ec1
-  data.tar.gz: 8d9809a62d730f91031edef5a45eb8ce37efcdb96949ded22c0197390aa0f7c5
+  metadata.gz: 317bd9d6cad6d73e64e60eeb11a7c20c2f858af4d19ed911ec01272b4276e89b
+  data.tar.gz: 4a3f55ab0b9a58ae32ab392257131956428450b433fd45114526cfa045908607
 SHA512:
-  metadata.gz: c861dfa5193329f99c90d059f5b44d6ea6942ad5df3cffb7ada477fe728b557db4e4652892a5d0d0e04358646eedb42caf0c680166acd3328ebd44136e5cf519
-  data.tar.gz: 830555fa850108f7e9e085450f99b3204ac978b60d16a576a687aaf69b77954239a08c5421cf45922682004a9b0598dfeb75bba21bfcb44ebcd972dc90817a7c
+  metadata.gz: 1499acbe2d880c597424df6e06d06849cb71b4b61a16ccf55bdaf4ed442ecdc578a4dd16df0eb82e12e45acac90b50fdf1a6818c8956ea447cffd28b091009b7
+  data.tar.gz: 89379f8c00da7c677e66f1eff6904fb4da6a02ee0c9e2d731a4252801d571648c1cf8fff6ce0b72873e034821dc28ca9410230b52461054940f00c3d707e456f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.0.beta6 - 2018-04-05
+
+Adds easier to read error messages
+
 ## 1.0.0.beta5 - 2018-03-28
 
 Add support for Amadeus's specific `Accept` request header.

data/README.md

@@ -8,14 +8,14 @@
 
 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).
+For more details see the [Ruby documentation](https://developer.amadeus.com/docs/ruby) on [Amadeus.com](https://developer.amadeus.com) and the [class reference](https://amadeus4dev.github.io/amadeus-ruby) here on GitHub.
 
 ## Installation
 
 This gem requires Ruby 2.2+. You can install install it directly or via bundler.
 
 ```rb
-gem 'amadeus', '~> 1.0.0.beta5'
+gem 'amadeus', '~> 1.0.0.beta6'
 ```
 
 __Next__: [Get Started with the Ruby SDK.](https://developer.amadeus.com/docs/ruby/get_started/initialize)
@@ -161,7 +161,7 @@ require 'logger'
 amadeus = Amadeus::Client.new(
   client_id: '...',
   client_secret: '...',
-  log_level: 'debug'
+  log_level: 'debug' # or "warn" or "silent", defaults to "silent"
 )
 ```
 

data/lib/amadeus/client.rb

@@ -41,7 +41,7 @@ module Amadeus
     # The available hosts for this API
     HOSTS = {
       test: 'test.api.amadeus.com',
-      production: 'production.api.amadeus.com'
+      production: 'api.amadeus.com'
     }.freeze
 
     # Initialize using your credentials:
@@ -63,8 +63,8 @@ module Amadeus
     #  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] :log_level ('silent') 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

data/lib/amadeus/client/errors.rb

@@ -18,11 +18,6 @@ module Amadeus
     # @return [String]
     attr_reader :code
 
-    # The content of the response that describes the error
-    #
-    # @return [Hash]
-    attr_reader :description
-
     # Initializes an error by storing the {Amadeus::Response} object
     # that raised this error. The continues to determien the custom
     # error message
@@ -31,9 +26,9 @@ module Amadeus
     # @!visibility private
     def initialize(response)
       @response = response
-      @description = determine_description
-      super(@description)
       @code = determine_code
+
+      super(description)
     end
 
     # PROTECTED
@@ -49,13 +44,52 @@ module Amadeus
 
     private
 
-    def determine_description
-      return nil unless response && response.parsed
-      result = response.result
-      return result['errors'] if result['errors']
-      return result if result['error_description']
+    # Determines the description for this error, as used in in the error output
+    def description
+      description = short_description
+      description += long_description
+      description
+    end
+
+    # Determines the short description, printed after on the same line as the
+    # error class name
+    def short_description
+      if response.respond_to?(:status_code) && response.status_code
+        "[#{response.status_code}]"
+      else
+        '[---]'
+      end
+    end
+
+    # Determines the longer description, printed after the initial error
+    def long_description
+      return '' unless response && response.parsed
+      message = ''
+      message += error_description if response.result['error_description']
+      message += errors_description if response.result['errors']
+      message
+    end
+
+    # Returns the description of a single error
+    def error_description
+      message = ''
+      message += "\n#{response.result['error']}" if response.result['error']
+      message += "\n#{response.result['error_description']}"
+      message
+    end
+
+    # Returns the description of multiple errors
+    def errors_description
+      response.result['errors'].map do |error|
+        message = "\n"
+        if error['source'] && error['source']['parameter']
+          message += "[#{error['source']['parameter']}] "
+        end
+        message + error['detail'] if error['detail']
+      end.join
     end
 
+    # Determines the code for this error
     def determine_code
       self.class.to_s.split('::').last
     end

data/lib/amadeus/client/request.rb

@@ -58,6 +58,8 @@ module Amadeus
       http_request
     end
 
+    # PROTECTED
+
     # Builds the request object
     def http_request
       @http_request ||= begin
@@ -130,8 +132,9 @@ module Amadeus
     end
 
     def uri
-      url = "#{@scheme}://#{@host}#{@path}"
+      url = "#{@scheme}://#{@host}"
       url += ":#{@port}" unless port_matches_scheme
+      url += @path.to_s
       uri = URI(url)
       params = flatten_keys(@params)
       uri.query = URI.encode_www_form(params) if @verb == :GET

data/lib/amadeus/client/validator.rb

@@ -19,7 +19,7 @@ module Amadeus
       # @!visibility private
       def initialize_logger(options)
         @logger       = init_optional(:logger, options, Logger.new(STDOUT))
-        @log_level    = init_optional(:log_level, options, 'warn')
+        @log_level    = init_optional(:log_level, options, 'silent')
       end
 
       # Initializes the port, hostname, and use of SSL

data/lib/amadeus/namespaces/shopping/hotel/hotel_offers.rb

@@ -32,7 +32,7 @@ module Amadeus
           # @return [Amadeus::Response] a parsed response
           # @raise [Amadeus::Base] an exception if the call failed
           # @example Search for hotels in London
-          #   amadeus.shopping.hotels('SMPARCOL').hotel_offers.get
+          #   amadeus.shopping.hotel('SMPARCOL').hotel_offers.get
           #
           def get(params = {})
             client.get("/v1/shopping/hotels/#{@hotel_id}/hotel-offers", params)

data/lib/amadeus/namespaces/shopping/hotel/offer.rb

@@ -36,7 +36,7 @@ module Amadeus
           # @return [Amadeus::Response] a parsed response
           # @raise [Amadeus::Base] an exception if the call failed
           # @example Search for hotels in London
-          #   amadeus.shopping.hotels('SMPARCOL')
+          #   amadeus.shopping.hotel('SMPARCOL')
           #     .offers('AC7D4DA2C322A73AF0824318A4965DA2805A3FC2').get
           #
           def get(params = {})

data/lib/amadeus/version.rb

@@ -2,5 +2,5 @@
 
 module Amadeus
   # The current client version
-  VERSION = '1.0.0.beta5'.freeze
+  VERSION = '1.0.0.beta6'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amadeus
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Amadeus
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print