odata4 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d39ce48da9f2bd4c5e58b4be1e0d5ac4a60c4f3e
-  data.tar.gz: 0428d049a8e814d727fc7796c795fc4fddbe8265
+  metadata.gz: 681b21fbcc189d8fd525c14967ee0536e5175831
+  data.tar.gz: 0c1c00d948fbbf6da13d9474e89c68f87a32e60b
 SHA512:
-  metadata.gz: 6d7a7d71b67e188600e7c7ccce3dd55721a27e3cc3371d790eb2d430f4b045e365d37871cd6dd9629586553e22029b52020c622cb0840ab94a52ef05475eb66d
-  data.tar.gz: 70712da5e1e2e2dfc6b9d244b97cdd95c1fa4f727dac590aea3786e8494efa1f8244f82a65b778a2a824fd7bf16ac43a177e1842017789e7cd681ed28819f9f4
+  metadata.gz: caa27586434ea04697571112c0151e5487e0212dd630e96ad6e57689ccc608a07883ba723926bbac06d6b0d0dc5efba22129389216148cb0ba31f644f8e4c15b
+  data.tar.gz: d7c03530c1bb69d48ef53f2fcbfd3a9085025c67c0f30200acb208734b755cc565e6f05ce8f86bc6403fde13ab028c5689d546f02562d5c2be9e34677c51bbbf

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.9.1
+
+* [New] Raising specific error classes instead of `RuntimeError` when request fails
+
 ## 0.9.0
 
 * [Breaking] Use Faraday instead of Typhoeus as HTTP connection adapter.

data/lib/odata4.rb

@@ -13,6 +13,7 @@ require 'json'
 # require 'active_support/concern'
 
 require 'odata4/version'
+require 'odata4/errors'
 require 'odata4/property_registry'
 require 'odata4/property'
 require 'odata4/properties'

data/lib/odata4/errors.rb

@@ -0,0 +1,68 @@
+module OData4
+  # Base class for OData4 errors
+  class Error < StandardError
+  end
+
+  # Base class for network errors
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response, message = nil)
+      @message  = message
+      @response = response
+    end
+
+    def http_status
+      response.status
+    end
+
+    def message
+      [default_message, @message].compact.join(': ')
+    end
+
+    def default_message
+      nil
+    end
+  end
+
+  class ClientError < RequestError
+  end
+
+  class ServerError < RequestError
+  end
+
+  module Errors
+    ERROR_MAP = []
+
+    CLIENT_ERRORS = {
+      400 => "Bad Request",
+      401 => "Access Denied",
+      403 => "Forbidden",
+      404 => "Not Found",
+      405 => "Method Not Allowed",
+      406 => "Not Acceptable",
+      413 => "Request Entity Too Large"
+    }
+
+    CLIENT_ERRORS.each do |code, message|
+      klass = Class.new(ClientError) do
+        send(:define_method, :default_message) { "#{code} #{message}" }
+      end
+      const_set(message.delete(' \-\''), klass)
+      ERROR_MAP[code] = klass
+    end
+
+    SERVER_ERRORS = {
+      500 => "Internal Server Error",
+      503 => "Service Unavailable"
+    }
+
+    SERVER_ERRORS.each do |code, message|
+      klass = Class.new(ServerError) do
+        send(:define_method, :default_message) { "#{code} #{message}" }
+      end
+      const_set(message.delete(' \-\''), klass)
+      ERROR_MAP[code] = klass
+    end
+  end
+end

data/lib/odata4/service/response.rb

@@ -94,17 +94,10 @@ module OData4
       # occured.
       #
       # @return [self]
-      def validate!
-        raise "Bad Request. #{error_message(response)}" if status == 400
-        raise "Access Denied" if status == 401
-        raise "Forbidden" if status == 403
-        raise "Not Found" if [0,404].include?(status)
-        raise "Method Not Allowed" if status == 405
-        raise "Not Acceptable" if status == 406
-        raise "Request Entity Too Large" if status == 413
-        raise "Internal Server Error" if status == 500
-        raise "Service Unavailable" if status == 503
-        self
+      def validate_response!
+        if error = OData4::Errors::ERROR_MAP[status]
+          raise error, response, error_message
+        end
       end
 
       private
@@ -117,7 +110,7 @@ module OData4
             Body: #{response.body}
         EOS
         check_content_type
-        validate!
+        validate_response!
       rescue Faraday::TimeoutError
         logger.info "Request timed out."
         @timed_out = true
@@ -144,7 +137,7 @@ module OData4
           # We catch that here and bypass content type detection.
           @empty = true
         else
-          raise ArgumentError, "Invalid response type '#{content_type}'"
+          raise RequestError, response, "Invalid response type '#{content_type}'"
         end
       end
 

data/lib/odata4/version.rb

@@ -1,3 +1,3 @@
 module OData4
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/spec/odata4/entity_set_spec.rb

@@ -101,7 +101,7 @@ describe OData4::EntitySet, vcr: {cassette_name: 'entity_set_specs'} do
     end
 
     it 'raises an error when no entity was found' do
-      expect { nonexistant_entity }.to raise_error(RuntimeError, /Not Found/)
+      expect { nonexistant_entity }.to raise_error(OData4::Errors::NotFound)
     end
 
     describe 'eager loading' do

data/spec/odata4/errors_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe OData4::RequestError do
+  subject { OData4::RequestError.new(response, 'The server made a boo-boo.') }
+  let(:response) { instance_double('Faraday::Response', status: 400) }
+
+  describe '#http_status' do
+    it 'returns the status code' do
+      expect(subject.http_status).to eq(response.status)
+    end
+  end
+
+  describe '#response' do
+    it 'returns the response' do
+      expect(subject.response).to eq(response)
+    end
+  end
+
+  describe '#message' do
+    it 'returns the error message' do
+      expect(subject.message).to eq('The server made a boo-boo.')
+    end
+  end
+end
+
+describe OData4::Errors::InternalServerError do
+  let(:response) { instance_double('Faraday::Response', status: 500) }
+
+  context 'with custom error message' do
+    subject { OData4::Errors::InternalServerError.new(response, 'The server made a boo-boo.')}
+
+    describe '#message' do
+      it 'combines default message with custom message' do
+        expect(subject.message).to eq('500 Internal Server Error: The server made a boo-boo.')
+      end
+    end
+  end
+
+  context 'without custom error message' do
+    subject { OData4::Errors::InternalServerError.new(response) }
+
+    describe '#message' do
+      it 'returns the default message' do
+        expect(subject.message).to eq('500 Internal Server Error')
+      end
+    end
+  end
+end

data/spec/odata4/service/response_spec.rb

@@ -74,4 +74,12 @@ describe OData4::Service::Response, vcr: {cassette_name: 'service/response_specs
     it { expect(subject).to be_success }
     it { expect(subject.body).to match(/123/) }
   end
+
+  context 'with unregistered content type' do
+    let(:content_type) { 'text/unknown' }
+    let(:response_status) { 200 }
+    let(:response_body) { '123' }
+
+    it { expect { subject }.to raise_error(OData4::RequestError) }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: odata4
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Christoph Wagner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,6 +203,7 @@ files:
 - lib/odata4/entity.rb
 - lib/odata4/entity_container.rb
 - lib/odata4/entity_set.rb
+- lib/odata4/errors.rb
 - lib/odata4/navigation_property.rb
 - lib/odata4/navigation_property/proxy.rb
 - lib/odata4/properties.rb
@@ -277,6 +278,7 @@ files:
 - spec/odata4/entity_container_spec.rb
 - spec/odata4/entity_set_spec.rb
 - spec/odata4/entity_spec.rb
+- spec/odata4/errors_spec.rb
 - spec/odata4/navigation_property/proxy_spec.rb
 - spec/odata4/navigation_property_spec.rb
 - spec/odata4/properties/binary_spec.rb
@@ -362,6 +364,7 @@ test_files:
 - spec/odata4/entity_container_spec.rb
 - spec/odata4/entity_set_spec.rb
 - spec/odata4/entity_spec.rb
+- spec/odata4/errors_spec.rb
 - spec/odata4/navigation_property/proxy_spec.rb
 - spec/odata4/navigation_property_spec.rb
 - spec/odata4/properties/binary_spec.rb