contentful-management 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5ebdbf246240b9eeaf315eb01fd8950cce67a4
-  data.tar.gz: bb20ddab6ba4bd2ee7353e2d9c5eb841027955b3
+  metadata.gz: 1c4ec83b46a51eb77dec3b180f0e016a8e0955f4
+  data.tar.gz: f399a8297f69fa59fc7bc2d84726b599a90293f2
 SHA512:
-  metadata.gz: a365765f6243235b658fc34e692939687e44d7d679fde7c3a93417c64d63bb0421d5fe128d9d5df831d3370d055ae7ff7ca7530892bfdc7962a68d57b1cf1139
-  data.tar.gz: 978075d563968f6cca95c76d0a96ab15fb4068c13e9f7f1f8c395a93ab9ae04103760647ce21c0c4f0aaf672eb7daa1a63699b3bf032b1ff1f53798daabf8b2c
+  metadata.gz: 2c7b7cc83f3a25c245f7fc5903fd6acc096f6d7a8225c9cb10676d728c2f406ff82c6db899220daaf7a7622bc5c82bc7081db217ee5c0a3ea6d4441322fb9b7a
+  data.tar.gz: 213e66c26d64ba6045f56aec03c4520e3bfa6ef5477cea6007790b56cda5e00af1a6578b3e2665f0d4f352487278ea457cb6b0bfaae0f984b58527f80e968034

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master
 
+## 1.10.0
+### Added
+* Added better error messages for all possible API errors [#95](https://github.com/contentful/contentful-management.rb/issues/95)
+
 ## 1.9.0
 ### Added
 * Added option to disable Content Type caching completely.

data/lib/contentful/management/error.rb

@@ -12,75 +12,233 @@ module Contentful
           message: response.error_message,
           details: response.raw.body.instance_variable_get(:@contents)
         }
-        super @response.error_message
+        super best_available_message
       end
 
       # Shortcut for creating specialized error classes
       # USAGE rescue Contentful::Management::Error[404]
       def self.[](error_status_code)
-        case error_status_code
-        when 404
-          NotFound
-        when 400
-          BadRequest
-        when 403
-          AccessDenied
-        when 409
-          Conflict
-        when 401
-          Unauthorized
-        when 422
-          UnprocessableEntity
-        when 429
-          RateLimitExceeded
-        when 500
-          ServerError
-        when 503
-          ServiceUnavailable
-        else
-          Error
-        end
+        errors = {
+          400 => BadRequest,
+          401 => Unauthorized,
+          403 => AccessDenied,
+          404 => NotFound,
+          409 => Conflict,
+          422 => UnprocessableEntity,
+          429 => RateLimitExceeded,
+          500 => ServerError,
+          502 => BadGateway,
+          503 => ServiceUnavailable
+        }.freeze
+
+        errors.key?(error_status_code) ? errors[error_status_code] : Error
       end
-    end
 
-    # 404
-    class NotFound < Error
+      protected
+
+      def default_error_message
+        "The following error was received: #{@response.raw.body}"
+      end
+
+      def handle_details(details)
+        details.to_s
+      end
+
+      def additional_info?
+        false
+      end
+
+      def additional_info
+        []
+      end
+
+      def best_available_message
+        error_message = [
+          "HTTP status code: #{@response.raw.status}"
+        ]
+
+        begin
+          response_json = @response.load_json
+          message = response_json.fetch('message', default_error_message)
+          details = response_json.fetch('details', nil)
+          request_id = response_json.fetch('requestId', nil)
+
+          error_message << "Message: #{message}"
+          error_message << "Details: #{handle_details(details)}" if details
+          error_message << "Request ID: #{request_id}" if request_id
+        rescue
+          error_message << "Message: #{default_error_message}"
+        end
+
+        error_message << additional_info if additional_info?
+
+        error_message.join("\n")
+      end
     end
 
     # 400
     class BadRequest < Error
+      protected
+
+      def default_error_message
+        'The request was malformed or missing a required parameter.'
+      end
+
+      def handle_details(details)
+        return details if details.is_a?(String)
+
+        handle_detail = proc do |detail|
+          return detail if detail.is_a?(String)
+          detail.fetch('details', nil)
+        end
+
+        inner_details = details['errors'].map { |detail| handle_detail[detail] }.reject(&:nil?)
+        inner_details.join("\n\t")
+      end
+    end
+
+    # 401
+    class Unauthorized < Error
+      protected
+
+      def default_error_message
+        'The authorization token was invalid.'
+      end
     end
 
     # 403
     class AccessDenied < Error
+      protected
+
+      def default_error_message
+        'The specified token does not have access to the requested resource.'
+      end
+
+      def handle_details(details)
+        "\n\tReasons:\n\t\t#{details['reasons'].join("\n\t\t")}"
+      end
     end
 
-    # 401
-    class Unauthorized < Error
+    # 404
+    class NotFound < Error
+      protected
+
+      def default_error_message
+        'The requested resource or endpoint could not be found.'
+      end
+
+      def handle_details(details)
+        return details if details.is_a?(String)
+
+        message = "The requested #{details['type']} could not be found."
+
+        resource_id = details.fetch('id', nil)
+        message += " ID: #{resource_id}." if resource_id
+
+        message
+      end
     end
 
     # 409
     class Conflict < Error
+      protected
+
+      def default_error_message
+        'Version mismatch error. The version you specified was incorrect. This may be due to someone else editing the content.'
+      end
     end
 
     # 422
     class UnprocessableEntity < Error
+      protected
+
+      def default_error_message
+        'The resource you sent in the body is invalid.'
+      end
+
+      def handle_error(error)
+        name = error['name']
+        path = error['path']
+        value = error['value']
+
+        "\t* Name: #{name} - Path: '#{path}' - Value: '#{value}'"
+      end
+
+      def handle_details(details)
+        errors = []
+        details['errors'].each do |error|
+          errors << handle_error(error)
+        end
+
+        "\n#{errors.join("\n")}"
+      end
     end
 
     # 429
     class RateLimitExceeded < Error
+      # Rate Limit Reset Header Key
+      RATE_LIMIT_RESET_HEADER_KEY = 'x-contentful-ratelimit-reset'.freeze
+
+      def reset_time?
+        # rubocop:disable Style/DoubleNegation
+        !!reset_time
+        # rubocop:enable Style/DoubleNegation
+      end
+
+      # Time until next available request, in seconds.
+      def reset_time
+        @reset_time ||= @response.raw[RATE_LIMIT_RESET_HEADER_KEY]
+      end
+
+      protected
+
+      def additional_info?
+        reset_time?
+      end
+
+      def additional_info
+        ["Time until reset (seconds): #{reset_time}"]
+      end
+
+      def default_error_message
+        'Rate limit exceeded. Too many requests.'
+      end
     end
 
     # 500
     class ServerError < Error
+      protected
+
+      def default_error_message
+        'Internal server error.'
+      end
+    end
+
+    # 502
+    class BadGateway < Error
+      protected
+
+      def default_error_message
+        'The requested space is hibernated.'
+      end
     end
 
     # 503
     class ServiceUnavailable < Error
+      protected
+
+      def default_error_message
+        'Service unavailable.'
+      end
     end
 
     # Raised when response is no valid json
     class UnparsableJson < Error
+      protected
+
+      def default_error_message
+        @response.error_message
+      end
     end
 
     # Raised when response is not parsable as a Contentful::Management::Resource

data/lib/contentful/management/response.rb

@@ -41,6 +41,11 @@ module Contentful
         end
       end
 
+      # Returns the JSON body of the response
+      def load_json
+        MultiJson.load(unzip_response(raw))
+      end
+
       private
 
       def error_object?
@@ -87,10 +92,6 @@ module Contentful
         UnparsableJson.new(self)
       end
 
-      def load_json
-        MultiJson.load(unzip_response(raw))
-      end
-
       def unzip_response(response)
         parsed_response = response.to_s
         if response.headers['Content-Encoding'].eql?('gzip')

data/lib/contentful/management/version.rb

@@ -3,6 +3,6 @@ module Contentful
   # Management Namespace
   module Management
     # Gem Version
-    VERSION = '1.9.0'.freeze
+    VERSION = '1.10.0'.freeze
   end
 end

data/spec/fixtures/json_responses/400_details_errors_object.json

@@ -0,0 +1,14 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": {
+    "errors": [
+        {
+            "details": "some error"
+        }
+    ]
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/400_details_errors_string.json

@@ -0,0 +1,12 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": {
+    "errors": [
+      "some error"
+    ]
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/400_details_string.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "details": "some error",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/403_reasons.json

@@ -0,0 +1,13 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "AccessDenied"
+  },
+  "details": {
+    "reasons": [
+        "foo",
+        "bar"
+    ]
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/404_details_string.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "details": "The resource could not be found",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/404_id.json

@@ -0,0 +1,11 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "details": {
+    "type": "Asset",
+    "id": "foobar"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/404_type.json

@@ -0,0 +1,10 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "details": {
+    "type": "Asset"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/422_details.json

@@ -0,0 +1,22 @@
+{
+  "requestId": "044bb23356babe4f11a3f7f1e77c762a",
+  "message":"The resource you sent in the body is invalid.",
+  "details":{
+    "errors":[
+      {
+        "name":"taken",
+        "path":"display_code",
+        "value":"en-US"
+      },
+      {
+        "name":"fallback locale creates a loop",
+        "path":"fallback_code",
+        "value":"en-US"
+      }
+    ]
+  },
+  "sys":{
+    "type":"Error",
+    "id":"ValidationFailed"
+  }
+}

data/spec/fixtures/json_responses/default_400.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadRequest"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_401.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "Unauthorized"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_403.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "AccessDenied"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_404.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_409.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "Conflict"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_422.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "UnprocessableEntity"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_429.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "RateLimitExceeded"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_500.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "ServerError"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_502.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "BadGateway"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/default_503.json

@@ -0,0 +1,7 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "ServiceUnavailable"
+  },
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/not_found.json

@@ -0,0 +1,13 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "details": {
+    "type": "Entry",
+    "space": "cfexampleapi",
+    "id": "not found"
+  },
+  "message": "The resource could not be found.",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/other_error.json

@@ -0,0 +1,9 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "SomeError"
+  },
+  "details": "some text",
+  "message": "Some error occurred.",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/other_error_no_details.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "SomeError"
+  },
+  "message": "Some error occurred.",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/other_error_no_message.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "SomeError"
+  },
+  "details": "some text",
+  "requestId": "85f-351076632"
+}

data/spec/fixtures/json_responses/other_error_no_request_id.json

@@ -0,0 +1,8 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "SomeError"
+  },
+  "details": "some text",
+  "message": "Some error occurred."
+}

data/spec/fixtures/json_responses/other_error_nothing.json

@@ -0,0 +1,6 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "SomeError"
+  }
+}

data/spec/fixtures/json_responses/unparsable.json

@@ -0,0 +1,13 @@
+{
+  "sys": {
+    "type": "Error",
+    "id": "NotFound"
+  },
+  "details": {
+    "type": "Entry",
+    "space": "cfexampleapi",
+    "id": "not found"
+  },
+  "message": "The resource could not be found.",
+  "requestId": "85f-351076632",
+  "missing": "braceright"

data/spec/fixtures/vcr_cassettes/asset/destroy_published.yml

@@ -168,7 +168,7 @@ http_interactions:
             "type": "Error",
             "id": "BadRequest"
           },
-          "message": "Cannot deleted published"
+          "message": "Cannot delete published"
         }
     http_version: 
   recorded_at: Thu, 31 Jul 2014 07:28:33 GMT

data/spec/fixtures/vcr_cassettes/content_type/destroy_activated.yml

@@ -157,7 +157,7 @@ http_interactions:
             "type": "Error",
             "id": "BadRequest"
           },
-          "message": "Cannot deleted published"
+          "message": "Cannot delete published"
         }
     http_version: 
   recorded_at: Thu, 31 Jul 2014 08:42:20 GMT

data/spec/lib/contentful/management/asset_spec.rb

@@ -76,7 +76,12 @@ module Contentful
           vcr('asset/find_not_found') do
             result = subject.find(space_id, 'not_exist')
             expect(result).to be_kind_of Contentful::Management::NotFound
-            expect(result.message).to eq 'The resource could not be found.'
+            message = [
+              "HTTP status code: 404 Not Found",
+              "Message: The resource could not be found.",
+              "Details: The requested Asset could not be found. ID: not_exist."
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
       end
@@ -86,7 +91,11 @@ module Contentful
           vcr('asset/destroy_published') do
             result = subject.find(space_id, 'r7o2iuDeSc4UmioOuoKq6').destroy
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eq 'Cannot deleted published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Cannot delete published"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
         it 'returns true when asset is not published' do
@@ -112,7 +121,11 @@ module Contentful
           vcr('asset/unpublish_already_unpublished') do
             result = subject.find(space_id, asset_id_2).unpublish
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eq 'Not published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Not published"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
       end

data/spec/lib/contentful/management/content_type_spec.rb

@@ -63,7 +63,11 @@ module Contentful
           vcr('content_type/destroy_activated') do
             result = subject.find(space_id, '66jvD8UhNKmWGk24KKq0EW').destroy
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eq 'Cannot deleted published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Cannot delete published"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
 
@@ -129,7 +133,11 @@ module Contentful
             content_type = subject.find(space_id, deactivate_content)
             content_type.sys[:version] = -1
             result = content_type.deactivate
-            expect(result.message).to eq 'Not published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Not published"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
       end

data/spec/lib/contentful/management/entry_spec.rb

@@ -122,7 +122,11 @@ module Contentful
           vcr('entry/service_unavailable') do
             result = subject.find(space_id, 'not_exist')
             expect(result).to be_kind_of Contentful::Management::ServiceUnavailable
-            expect(result.message).to eq 'Service Unavailable, contentful.com API seems to be down'
+            message = [
+              "HTTP status code: 503 Service Unavailable",
+              "Message: Service unavailable."
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
       end
@@ -132,7 +136,11 @@ module Contentful
           vcr('entry/destory_published') do
             result = subject.find(space_id, '3U7JqGuVzOWIimU40mKeem').destroy
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eq 'Cannot deleted published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Cannot deleted published"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
         it 'returns true when entry is not published' do
@@ -158,7 +166,11 @@ module Contentful
           vcr('entry/unpublish_already_unpublished') do
             result = subject.find(space_id, entry_id).unpublish
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eq 'Not published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Not published"
+            ].join("\n")
+            expect(result.message).to eq message
             expect(result.error[:message]).to eq 'Not published'
             expect(result.error[:url]).to eq 'spaces/yr5m0jky5hsh/entries/4Rouux8SoUCKwkyCq2I0E0/published'
             expect(result.error[:details]).to eq "{\n  \"sys\": {\n    \"type\": \"Error\",\n    \"id\": \"BadRequest\"\n  },\n  \"message\": \"Not published\"\n}\n"
@@ -224,7 +236,11 @@ module Contentful
           vcr('entry/unarchive_already_unarchived') do
             result = subject.find(space_id, entry_id).unarchive
             expect(result).to be_kind_of Contentful::Management::BadRequest
-            expect(result.message).to eql 'Not archived'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Not archived"
+            ].join("\n")
+            expect(result.message).to eq message
           end
         end
       end
@@ -243,7 +259,11 @@ module Contentful
           vcr('entry/archive_published') do
             entry = subject.find(space_id, entry_id).archive
             expect(entry).to be_kind_of Contentful::Management::BadRequest
-            expect(entry.message).to eql 'Cannot archive published'
+            message = [
+              "HTTP status code: 400 Bad Request",
+              "Message: Cannot archive published"
+            ].join("\n")
+            expect(entry.message).to eq message
           end
         end
       end

data/spec/lib/contentful/management/error_class_spec.rb

@@ -0,0 +1,369 @@
+require 'spec_helper'
+
+class MockRequest
+  def endpoint; end
+end
+
+describe Contentful::Management::Error do
+  let(:r) { Contentful::Management::Response.new raw_fixture('not_found', 404), MockRequest.new }
+
+  describe '#response' do
+    it 'returns the response the error has been initialized with' do
+      expect(Contentful::Management::Error.new(r).response).to be r
+    end
+  end
+
+  describe '#message' do
+    it 'returns the message found in the response json' do
+      message = "HTTP status code: 404\n"\
+                "Message: The resource could not be found.\n"\
+                "Details: {\"type\"=>\"Entry\", \"space\"=>\"cfexampleapi\", \"id\"=>\"not found\"}\n"\
+                "Request ID: 85f-351076632"
+      expect(Contentful::Management::Error.new(r).message).not_to be_nil
+      expect(Contentful::Management::Error.new(r).message).to eq message
+    end
+
+    describe 'message types' do
+      describe 'default messages' do
+        it '400' do
+          response = Contentful::Management::Response.new raw_fixture('default_400', 400), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 400\n"\
+                    "Message: The request was malformed or missing a required parameter.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '401' do
+          response = Contentful::Management::Response.new raw_fixture('default_401', 401), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 401\n"\
+                    "Message: The authorization token was invalid.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '403' do
+          response = Contentful::Management::Response.new raw_fixture('default_403', 403), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 403\n"\
+                    "Message: The specified token does not have access to the requested resource.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '404' do
+          response = Contentful::Management::Response.new raw_fixture('default_404', 404), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 404\n"\
+                    "Message: The requested resource or endpoint could not be found.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '409' do
+          response = Contentful::Management::Response.new raw_fixture('default_409', 409), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 409\n"\
+                    "Message: Version mismatch error. The version you specified was incorrect. This may be due to someone else editing the content.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '422' do
+          response = Contentful::Management::Response.new raw_fixture('default_422', 422), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 422\n"\
+                    "Message: The resource you sent in the body is invalid.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '429' do
+          response = Contentful::Management::Response.new raw_fixture('default_429', 429), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 429\n"\
+                    "Message: Rate limit exceeded. Too many requests.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '500' do
+          response = Contentful::Management::Response.new raw_fixture('default_500', 500), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 500\n"\
+                    "Message: Internal server error.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '502' do
+          response = Contentful::Management::Response.new raw_fixture('default_502', 502), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 502\n"\
+                    "Message: The requested space is hibernated.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it '503' do
+          response = Contentful::Management::Response.new raw_fixture('default_503', 503), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 503\n"\
+                    "Message: Service unavailable.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+      end
+
+      describe 'special cases' do
+        describe '400' do
+          it 'details is a string' do
+            response = Contentful::Management::Response.new raw_fixture('400_details_string', 400), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'details is an object, internal errors are strings' do
+            response = Contentful::Management::Response.new raw_fixture('400_details_errors_string', 400), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'details is an object, internal errors are objects which have details' do
+            response = Contentful::Management::Response.new raw_fixture('400_details_errors_object', 400), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 400\n"\
+                      "Message: The request was malformed or missing a required parameter.\n"\
+                      "Details: some error\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '403' do
+          it 'has an array of reasons' do
+            response = Contentful::Management::Response.new raw_fixture('403_reasons', 403), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 403\n"\
+                      "Message: The specified token does not have access to the requested resource.\n"\
+                      "Details: \n\tReasons:\n"\
+                      "\t\tfoo\n"\
+                      "\t\tbar\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '404' do
+          it 'details is a string' do
+            response = Contentful::Management::Response.new raw_fixture('404_details_string', 404), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 404\n"\
+                      "Message: The requested resource or endpoint could not be found.\n"\
+                      "Details: The resource could not be found\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'has a type' do
+            response = Contentful::Management::Response.new raw_fixture('404_type', 404), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 404\n"\
+                      "Message: The requested resource or endpoint could not be found.\n"\
+                      "Details: The requested Asset could not be found.\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+
+          it 'can specify the resource id' do
+            response = Contentful::Management::Response.new raw_fixture('404_id', 404), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 404\n"\
+                      "Message: The requested resource or endpoint could not be found.\n"\
+                      "Details: The requested Asset could not be found. ID: foobar.\n"\
+                      "Request ID: 85f-351076632"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '422' do
+          it 'can show formatted details' do
+            response = Contentful::Management::Response.new raw_fixture('422_details', 422), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 422\n"\
+                      "Message: The resource you sent in the body is invalid.\n"\
+                      "Details: \n"\
+                      "\t* Name: taken - Path: 'display_code' - Value: 'en-US'\n"\
+                      "\t* Name: fallback locale creates a loop - Path: 'fallback_code' - Value: 'en-US'\n"\
+                      "Request ID: 044bb23356babe4f11a3f7f1e77c762a"
+            expect(error.message).to eq message
+          end
+        end
+
+        describe '429' do
+          it 'can show the time until reset' do
+            response = Contentful::Management::Response.new raw_fixture('default_429', 429, false, {'x-contentful-ratelimit-reset' => 60}), MockRequest.new
+            error = Contentful::Management::Error[response.raw.status].new(response)
+
+            message = "HTTP status code: 429\n"\
+                      "Message: Rate limit exceeded. Too many requests.\n"\
+                      "Request ID: 85f-351076632\n"\
+                      "Time until reset (seconds): 60"
+            expect(error.message).to eq message
+          end
+        end
+      end
+
+      describe 'generic error' do
+        it 'with everything' do
+          response = Contentful::Management::Response.new raw_fixture('other_error', 512), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Details: some text\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'no details' do
+          response = Contentful::Management::Response.new raw_fixture('other_error_no_details', 512), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'no request id' do
+          response = Contentful::Management::Response.new raw_fixture('other_error_no_request_id', 512), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: Some error occurred.\n"\
+                    "Details: some text"
+          expect(error.message).to eq message
+        end
+
+        it 'no message' do
+          response = Contentful::Management::Response.new raw_fixture('other_error_no_message', 512), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: The following error was received: {\n"\
+                    "  \"sys\": {\n"\
+                    "    \"type\": \"Error\",\n"\
+                    "    \"id\": \"SomeError\"\n"\
+                    "  },\n"\
+                    "  \"details\": \"some text\",\n"\
+                    "  \"requestId\": \"85f-351076632\"\n"\
+                    "}\n"\
+                    "\n"\
+                    "Details: some text\n"\
+                    "Request ID: 85f-351076632"
+          expect(error.message).to eq message
+        end
+
+        it 'nothing' do
+          response = Contentful::Management::Response.new raw_fixture('other_error_nothing', 512), MockRequest.new
+          error = Contentful::Management::Error[response.raw.status].new(response)
+
+          message = "HTTP status code: 512\n"\
+                    "Message: The following error was received: {\n"\
+                    "  \"sys\": {\n"\
+                    "    \"type\": \"Error\",\n"\
+                    "    \"id\": \"SomeError\"\n"\
+                    "  }\n"\
+                    "}\n"
+          expect(error.message).to eq message
+        end
+      end
+    end
+  end
+
+  describe Contentful::Management::UnparsableJson do
+    describe '#message' do
+      it 'returns the json parser\'s message' do
+        uj = Contentful::Management::Response.new raw_fixture('unparsable'), MockRequest.new
+        expect(Contentful::Management::UnparsableJson.new(uj).message).to \
+            include 'unexpected token'
+      end
+    end
+  end
+
+  describe '.[]' do
+    it 'returns BadRequest error class for 400' do
+      expect(Contentful::Management::Error[400]).to eq Contentful::Management::BadRequest
+    end
+
+    it 'returns Unauthorized error class for 401' do
+      expect(Contentful::Management::Error[401]).to eq Contentful::Management::Unauthorized
+    end
+
+    it 'returns AccessDenied error class for 403' do
+      expect(Contentful::Management::Error[403]).to eq Contentful::Management::AccessDenied
+    end
+
+    it 'returns NotFound error class for 404' do
+      expect(Contentful::Management::Error[404]).to eq Contentful::Management::NotFound
+    end
+
+    it 'returns Conflict error class for 409' do
+      expect(Contentful::Management::Error[409]).to eq Contentful::Management::Conflict
+    end
+
+    it 'returns UnprocessableEntity error class for 422' do
+      expect(Contentful::Management::Error[422]).to eq Contentful::Management::UnprocessableEntity
+    end
+
+    it 'returns RateLimitExceeded error class for 429' do
+      expect(Contentful::Management::Error[429]).to eq Contentful::Management::RateLimitExceeded
+    end
+
+    it 'returns ServerError error class for 500' do
+      expect(Contentful::Management::Error[500]).to eq Contentful::Management::ServerError
+    end
+
+    it 'returns BadGateway error class for 502' do
+      expect(Contentful::Management::Error[502]).to eq Contentful::Management::BadGateway
+    end
+
+    it 'returns ServiceUnavailable error class for 503' do
+      expect(Contentful::Management::Error[503]).to eq Contentful::Management::ServiceUnavailable
+    end
+
+    it 'returns generic error class for any other value' do
+      expect(Contentful::Management::Error[nil]).to eq Contentful::Management::Error
+      expect(Contentful::Management::Error[200]).to eq Contentful::Management::Error
+    end
+  end
+end
+

data/spec/support/json_responses.rb

@@ -0,0 +1,18 @@
+require 'multi_json'
+
+def raw_fixture(which, status = 200, _as_json = false, headers = {})
+  object = Object.new
+  allow(object).to receive(:status) { status }
+  allow(object).to receive(:headers) { headers }
+  allow(object).to receive(:to_s) { File.read File.dirname(__FILE__) + "/../fixtures/json_responses/#{which}.json" }
+  allow(object).to receive(:body) { object.to_s }
+  allow(object).to receive(:[]) { |key| object.headers[key] }
+
+  object
+end
+
+def json_fixture(which, _as_json = false)
+  MultiJson.load(
+    File.read File.dirname(__FILE__) + "/../fixtures/json_responses/#{which}.json"
+  )
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-management
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Piotr Protas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -375,6 +375,31 @@ files:
 - lib/contentful/management/webhook_health.rb
 - lib/contentful/management/webhook_webhook_call_methods_factory.rb
 - lib/contentful/management/webhook_webhook_health_methods_factory.rb
+- spec/fixtures/json_responses/400_details_errors_object.json
+- spec/fixtures/json_responses/400_details_errors_string.json
+- spec/fixtures/json_responses/400_details_string.json
+- spec/fixtures/json_responses/403_reasons.json
+- spec/fixtures/json_responses/404_details_string.json
+- spec/fixtures/json_responses/404_id.json
+- spec/fixtures/json_responses/404_type.json
+- spec/fixtures/json_responses/422_details.json
+- spec/fixtures/json_responses/default_400.json
+- spec/fixtures/json_responses/default_401.json
+- spec/fixtures/json_responses/default_403.json
+- spec/fixtures/json_responses/default_404.json
+- spec/fixtures/json_responses/default_409.json
+- spec/fixtures/json_responses/default_422.json
+- spec/fixtures/json_responses/default_429.json
+- spec/fixtures/json_responses/default_500.json
+- spec/fixtures/json_responses/default_502.json
+- spec/fixtures/json_responses/default_503.json
+- spec/fixtures/json_responses/not_found.json
+- spec/fixtures/json_responses/other_error.json
+- spec/fixtures/json_responses/other_error_no_details.json
+- spec/fixtures/json_responses/other_error_no_message.json
+- spec/fixtures/json_responses/other_error_no_request_id.json
+- spec/fixtures/json_responses/other_error_nothing.json
+- spec/fixtures/json_responses/unparsable.json
 - spec/fixtures/pixel.jpg
 - spec/fixtures/vcr_cassettes/api_key/all_for_space.yml
 - spec/fixtures/vcr_cassettes/api_key/create_for_space.yml
@@ -676,6 +701,7 @@ files:
 - spec/lib/contentful/management/content_type_spec.rb
 - spec/lib/contentful/management/editor_interface_spec.rb
 - spec/lib/contentful/management/entry_spec.rb
+- spec/lib/contentful/management/error_class_spec.rb
 - spec/lib/contentful/management/locale_spec.rb
 - spec/lib/contentful/management/organization_spec.rb
 - spec/lib/contentful/management/personal_access_token_spec.rb
@@ -690,6 +716,7 @@ files:
 - spec/lib/contentful/management/webhook_health_spec.rb
 - spec/lib/contentful/management/webhook_spec.rb
 - spec/spec_helper.rb
+- spec/support/json_responses.rb
 - spec/support/vcr.rb
 homepage: https://github.com/contentful/contentful-management.rb
 licenses:
@@ -716,6 +743,31 @@ signing_key:
 specification_version: 4
 summary: contentful management api
 test_files:
+- spec/fixtures/json_responses/400_details_errors_object.json
+- spec/fixtures/json_responses/400_details_errors_string.json
+- spec/fixtures/json_responses/400_details_string.json
+- spec/fixtures/json_responses/403_reasons.json
+- spec/fixtures/json_responses/404_details_string.json
+- spec/fixtures/json_responses/404_id.json
+- spec/fixtures/json_responses/404_type.json
+- spec/fixtures/json_responses/422_details.json
+- spec/fixtures/json_responses/default_400.json
+- spec/fixtures/json_responses/default_401.json
+- spec/fixtures/json_responses/default_403.json
+- spec/fixtures/json_responses/default_404.json
+- spec/fixtures/json_responses/default_409.json
+- spec/fixtures/json_responses/default_422.json
+- spec/fixtures/json_responses/default_429.json
+- spec/fixtures/json_responses/default_500.json
+- spec/fixtures/json_responses/default_502.json
+- spec/fixtures/json_responses/default_503.json
+- spec/fixtures/json_responses/not_found.json
+- spec/fixtures/json_responses/other_error.json
+- spec/fixtures/json_responses/other_error_no_details.json
+- spec/fixtures/json_responses/other_error_no_message.json
+- spec/fixtures/json_responses/other_error_no_request_id.json
+- spec/fixtures/json_responses/other_error_nothing.json
+- spec/fixtures/json_responses/unparsable.json
 - spec/fixtures/pixel.jpg
 - spec/fixtures/vcr_cassettes/api_key/all_for_space.yml
 - spec/fixtures/vcr_cassettes/api_key/create_for_space.yml
@@ -1017,6 +1069,7 @@ test_files:
 - spec/lib/contentful/management/content_type_spec.rb
 - spec/lib/contentful/management/editor_interface_spec.rb
 - spec/lib/contentful/management/entry_spec.rb
+- spec/lib/contentful/management/error_class_spec.rb
 - spec/lib/contentful/management/locale_spec.rb
 - spec/lib/contentful/management/organization_spec.rb
 - spec/lib/contentful/management/personal_access_token_spec.rb
@@ -1031,4 +1084,5 @@ test_files:
 - spec/lib/contentful/management/webhook_health_spec.rb
 - spec/lib/contentful/management/webhook_spec.rb
 - spec/spec_helper.rb
+- spec/support/json_responses.rb
 - spec/support/vcr.rb