rester 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a956ec7341aeae0c4895abc0684e5263768db7
-  data.tar.gz: d6df4b2046cf53633904e640fc9fd6f73ac54946
+  metadata.gz: feecdb5b8bdfda29d9df2683370a79eb805365ef
+  data.tar.gz: e56faba40a47774b17e4db017ec4b7b2fb09213a
 SHA512:
-  metadata.gz: a7fb0534dc29e1212502043018e4168f1a0e85bfda35c5566ce737e7d06d3c5a77d37fc371d1e671d689c162730bb779a9feeea365060a4699f3f4c06103b771
-  data.tar.gz: 2cd61c0e13f38878324282d630c0945aca0465d1690a8a20db723204e085611342c66c480ee38a0de7d0708691a7d1cbf69de90c9a89ec81b8a2ba5d9ee6a304
+  metadata.gz: 32e24fa563229bcad341c0b06668c67e93fd96196124bcc74e23a1b9d4222765a82d95179d97ad7b9a7430a9c78af85660c66620c433b49ae55ad21220b61aeb
+  data.tar.gz: 57982fbf4923f471ddaf64387d4de8b4ede4c1f12f8654ca3dbdc963fa6490cb0998e19fe173099c4cde289bb6c381a9635c7e36f6df04eda300157af1e6ff0f

data/lib/rester/client/adapters/stub_adapter.rb

@@ -66,7 +66,7 @@ module Rester
         end
 
         # Verify body, if there is one
-        unless (request = action['request'] || {}) == params
+        unless (request = Utils.stringify_vals(action['request'] || {})) == params
           fail Errors::StubError,
             "#{verb} #{path} with context '#{context}' params don't match stub. Expected: #{request} Got: #{params}"
         end
@@ -82,7 +82,7 @@ module Rester
       # Useful for testing without having to set the context.
       def _find_context_by_params(path, verb, params)
         (stub[path][verb].find { |_, action|
-          (action['request'] || {}) == params
+          (Utils.stringify_vals(action['request'] || {})) == params
         } || []).first
       end
     end # StubAdapter

data/lib/rester/errors.rb

@@ -4,8 +4,8 @@ module Rester
       ##
       # Throws an error instead of raising it, which is more performant. Must
       # be caught by an appropriate error handling wrapper.
-      def throw_error!(klass, message=nil)
-        error = message ? klass.new(message) : klass.new
+      def throw_error!(error, message = nil)
+        error = error.new(message) if error.is_a?(Class)
         throw :error, error
       end
     end # Class Methods
@@ -23,22 +23,36 @@ module Rester
     class HttpError < Error; end
 
     ##
-    # Request Errors
+    # 400 Errors
+    class RequestError < HttpError
+      attr_reader :error
 
-    # 400 Error
-    class RequestError < HttpError; end
-    class ValidationError < RequestError; end
+      def initialize(error, message = nil)
+        @error = error
+        super(message)
+      end
+    end
+
+    class ValidationError < RequestError
+      def initialize(message = nil)
+        super('validation', message)
+      end
+    end
 
+    ##
     # 401 Error
-    class AuthenticationError < RequestError; end
+    class AuthenticationError < HttpError; end
 
+    ##
     # 403 Error
-    class ForbiddenError < RequestError; end
+    class ForbiddenError < HttpError; end
 
+    ##
     # 404 Not Found
-    class NotFoundError < RequestError; end
+    class NotFoundError < HttpError; end
 
+    ##
     # 500 ServerError
-    class ServerError < RequestError; end
+    class ServerError < HttpError; end
   end # Errors
 end # Rester

data/lib/rester/middleware/error_handling.rb

@@ -24,10 +24,11 @@ module Rester
         code = _error_to_http_code(error)
 
         unless [401, 403, 404].include?(code)
-          body_h = {
-            message: error.message,
-            error: _error_name(error)
-          }
+          body_h = { error: _error_name(error) }
+
+          if error.message && error.message != error.class.name
+            body_h.merge!(message: error.message)
+          end
 
           if code == 500
             body_h[:backtrace] = error.backtrace
@@ -40,14 +41,14 @@ module Rester
 
       def _error_to_http_code(error)
         case error
-        when Errors::NotFoundError
-          404
-        when Errors::ForbiddenError
-          403
-        when Errors::AuthenticationError
-          401
         when Errors::RequestError
           400
+        when Errors::AuthenticationError
+          401
+        when Errors::ForbiddenError
+          403
+        when Errors::NotFoundError
+          404
         when Errors::ServerError
           500
         else
@@ -55,8 +56,16 @@ module Rester
         end
       end
 
-      def _error_name(exception)
-        Utils.underscore(exception.class.name.split('::').last.sub('Error', ''))
+      ##
+      # Takes an exception and returns an appropriate name to return to the
+      # client.
+      def _error_name(error)
+        case error
+        when Errors::RequestError
+          error.error
+        else
+          Utils.underscore(error.class.name.split('::').last.sub('Error', ''))
+        end
       end
     end # ErrorHandling
   end # Middleware

data/lib/rester/rspec.rb

@@ -29,35 +29,56 @@ RSpec.configure do |config|
     #
     # would produce:
     #
-    # request_args = ['With some context', 'GET', '/v1/tests']
-    #
-    request_args = ex.example_group.parent_groups.map { |a|
+    # context, verb, path = ['With some context', 'GET', '/v1/tests']
+    context, verb, path = ex.example_group.parent_groups.map { |a|
       a.description unless a.metadata[:description] == a.described_class.to_s
     }.compact
 
-    context = request_args[0]
-    verb    = request_args[1]
-    path    = request_args[2]
-
     begin
-      params   = @rester_stub[path][verb][context]['request']
-      response = @rester_stub[path][verb][context]['response']
+      stub_params       = @rester_stub[path][verb][context]['request']
+      raw_stub_response = @rester_stub[path][verb][context]['response']
     rescue NoMethodError
       fail Rester::Errors::StubError,
-        "Could not find path: #{path.inspect} verb: #{verb.inspect} context: #{context.inspect} in #{@rester_stub_filepath}"
+        "Could not find path: #{path.inspect} verb: #{verb.inspect} context: "\
+          "#{context.inspect} in #{@rester_stub_filepath}"
     end
 
-    ex.example_group.let(:subject) {
-      @rester_adapter.request(verb.downcase.to_sym, path, params)
+    ##
+    # Raw response from the service.
+    # [HTTP CODE, JSON String]
+    ex.example_group.let(:raw_service_response) {
+      @rester_adapter.request(verb.downcase.to_sym, path, stub_params)
+    }
+
+    ##
+    # Parsed service response
+    ex.example_group.let(:service_response) {
+      JSON.parse(raw_service_response.last, symbolize_names: true)
     }
 
+    ##
+    # HTTP status code returned by service.
+    ex.example_group.let(:service_response_code) { raw_service_response.first }
+
+    ##
+    # Expected response body specified in by the stub.
     ex.example_group.let(:stub_response) {
-      [response['code'], response['body'].to_json]
+      JSON.parse((raw_stub_response['body'] || {}).to_json,
+        symbolize_names: true)
     }
+
+    ##
+    # HTTP status code expected by the stub.
+    ex.example_group.let(:stub_response_code) { raw_stub_response['code'] }
+
+    ##
+    # Set the subject to be the service response (parsed ruby hash of the
+    # returned data).
+    ex.example_group.let(:subject) { service_response }
   end
 
   config.after :each, rester: // do |ex|
-    expect(subject).to eq stub_response
+    expect(service_response_code).to eq stub_response_code
   end
 
   ##
@@ -76,7 +97,7 @@ RSpec.configure do |config|
 
         missing_contexts.each { |missing_context, _|
           context_group = _find_or_create_child(verb_group, missing_context)
-          context_group.it { is_expected.to eq stub_response }
+          context_group.it { is_expected.to include stub_response }
         }
       }
     }

data/lib/rester/service/resource.rb

@@ -96,8 +96,8 @@ module Rester
         self.class.method_params[method_name.to_sym]
       end
 
-      def error!(message=nil)
-        Errors.throw_error!(Errors::RequestError, message)
+      def error!(error, message = nil)
+        Errors.throw_error!(Errors::RequestError.new(error, message))
       end
 
       private

data/lib/rester/utils.rb

@@ -46,6 +46,18 @@ module Rester
         hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
       end
 
+      def stringify_vals(hash={})
+        hash.inject({}) { |memo,(k,v)|
+          case v
+          when Hash
+            memo[k] = stringify_vals(v)
+          else
+            memo[k] = v.to_s
+          end
+          memo
+        }
+      end
+
       def classify(str)
         str.to_s.split("_").map(&:capitalize).join
       end

data/lib/rester/version.rb

@@ -1,3 +1,3 @@
 module Rester
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rester
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Robert Honer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack