Merge pull request #56 from gocardless/andrei/handle-bad-gateway-errors

Add special treating for 502 errors

Create class for Bad Gateway error and treat the case separately.

Bump version to 0.4.4

lib/companies_house/bad_gateway_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CompaniesHouse
+  # Raised when a request returned a 502
+  class BadGatewayError < APIError
+    def initialize(response = nil)
+      super("Bad gateway error", response)
+    end
+  end
+end

lib/companies_house/client.rb

@@ -14,6 +14,7 @@ class Client
 
     def initialize(config)
       raise ArgumentError, "Missing API key" unless config[:api_key]
+
       @api_key = config[:api_key]
       @endpoint = URI(config[:endpoint] || ENDPOINT)
       @open_timeout = config[:open_timeout] || 60

lib/companies_house/request.rb

@@ -5,6 +5,7 @@
 require "companies_house/authentication_error"
 require "companies_house/rate_limit_error"
 require "companies_house/timeout_error"
+require "companies_house/bad_gateway_error"
 
 require "virtus"
 require "uri"
@@ -88,6 +89,8 @@ def parse(response, resource_type, resource_id)
         raise CompaniesHouse::NotFoundError.new(resource_type, resource_id, response)
       when "429"
         raise CompaniesHouse::RateLimitError, response
+      when "502"
+        raise CompaniesHouse::BadGatewayError, response
       else
         raise CompaniesHouse::APIError.new("Unknown API response", response)
       end

lib/companies_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompaniesHouse
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

spec/spec_helper.rb

@@ -72,6 +72,14 @@ def notifications_of
     it_behaves_like "an error response"
   end
 
+  context "502" do
+    let(:status) { 502 }
+    let(:message) { "Bad gateway error - HTTP 502" }
+    let(:error_class) { CompaniesHouse::BadGatewayError }
+
+    it_behaves_like "an error response"
+  end
+
   context "any other code" do
     let(:status) { 342 }
     let(:message) { "Unknown API response - HTTP 342" }