gris 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52bcd59c303ceabf2a94e804e7ba70de117fdec6
-  data.tar.gz: 2d2445908532e655da55c60d1417b5f2b290751e
+  metadata.gz: ba36f4e2e607cba06f2812fa378d65f8757f158f
+  data.tar.gz: a69a898390400d437e5c96d5b486835ce3e94b75
 SHA512:
-  metadata.gz: 9efbb2afac85185af3d3e2922230a87d43122deec3dbbc0a18afd6cfc1117fb23696e3e49dc40aa35feede2c4ea5f4faf5c9928688fdf8888b587fc0aac67e00
-  data.tar.gz: f18acc03a113e6443ebf95ec31b828cde16a3d2b4b87a03454f1001d174593ca1cdea9083e46eff0c7f5c233f6bfc75b62c26b4daa215d6c4f1fa95ba5d3b37b
+  metadata.gz: a99a3dbf8338aeb8a3897c468e7f800c08d83fbb7ee638f9e730634579bf04b6e42a9753f0ec3fc05b8e5f54e14457c0c084ca8413d62f9d120eae0c887401e9
+  data.tar.gz: 6c367e60923c73d404b0ff51238bf30c5367c35f2c75efc0443b7d79f7d8f00472555262d0c56cb25e75ded3c15b7f39c8e59d920fb8109ceeab6039d709f5b2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gris (0.5.2)
+    gris (0.5.3)
       activesupport (~> 4.2, >= 4.2.0)
       chronic (~> 0.10.0)
       dalli (~> 2.7)

data/lib/gris.rb

@@ -18,6 +18,7 @@ require 'gris/grape_extensions/date_time_helpers'
 require 'gris/grape_extensions/error_helpers'
 require 'gris/identity'
 require 'gris/middleware/health'
+require 'gris/middleware/error_handlers'
 require 'gris/output_formatters/paginated_presenter'
 require 'gris/output_formatters/presenter'
 require 'gris/output_formatters/presenter_link_helpers'

data/lib/gris/application.rb

@@ -4,10 +4,13 @@ module Gris
   class Application
     include ActiveSupport::Configurable
     config_accessor :use_health_middleware
+    config_accessor :use_error_handlers_middleware
 
     def self.instance(config = {})
       @instance ||= Rack::Builder.new do
         use Gris::Middleware::Health unless config[:use_health_middleware] == false
+        use Gris::Middleware::ErrorHandlers unless config[:use_error_handlers_middleware] == false
+
         use Rack::Cors do
           allow do
             origins '*'
@@ -19,14 +22,7 @@ module Gris
     end
 
     def call(env)
-      response = ApplicationEndpoint.call(env)
-      case response[0]
-      when 404, 500
-        body = { code: response[0], message: response[2] }.to_json
-        [response[0], response[1], [body]]
-      else
-        response
-      end
+      ApplicationEndpoint.call(env)
     end
   end
 end

data/lib/gris/generators/templates/scaffold/config/application.rb.tt

@@ -9,7 +9,8 @@ ActiveSupport::Dependencies.autoload_paths += relative_load_paths
 
 module <%= app_name.classify %>
   class Application < Gris::Application
-    # config.use_health_middleware = false
+    config.use_error_handlers_middleware = true
+    config.use_health_middleware = true
 
     def self.instance(*)
       super(config)

data/lib/gris/grape_extensions/error_helpers.rb

@@ -1,8 +1,8 @@
 module Gris
   module ErrorHelpers
-    def error!(message, status, options = nil)
-      message = { error: message }.merge(options.is_a?(String) ? { text: options } : options) if options
-      throw :error, message: message, status: status
+    def gris_error!(message, status)
+      response = { status: status, message: message }
+      throw :error, message: response, status: status
     end
 
     Grape::Endpoint.send :include, self if defined?(Grape)

data/lib/gris/middleware/error_handlers.rb

@@ -0,0 +1,40 @@
+module Gris
+  class Middleware
+    class ErrorHandlers
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call env
+        case response[0]
+        when 400..500
+          format_error_response response
+        else
+          response
+        end
+      rescue RuntimeError => e
+        error = { status: 500, message: e.message }
+        error_response(error.to_json, 500)
+      rescue ::ActiveRecord::RecordNotFound => e
+        error = { status: 404, message: e.message }
+        error_response(error.to_json, 404)
+      end
+
+      private
+
+      def format_error_response(response)
+        if response[2].respond_to? :body
+          response
+        else
+          error = { status: response[0], message: response[2] }
+          error_response(error.to_json, response[0], response[1])
+        end
+      end
+
+      def error_response(message, status, headers = {})
+        Rack::Response.new([message], status, headers).finish
+      end
+    end
+  end
+end

data/lib/gris/version.rb

@@ -1,5 +1,5 @@
 module Gris
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 
   class Version
     class << self

data/spec/generators/scaffold_generator_spec.rb

@@ -72,6 +72,10 @@ describe Gris::Generators::ScaffoldGenerator do
           'ActiveSupport::Dependencies.autoload_paths += relative_load_paths'
         )
       end
+      it 'includes optional middleware configs' do
+        expect(config_application_file).to include('config.use_error_handlers_middleware = true')
+        expect(config_application_file).to include('config.use_health_middleware = true')
+      end
     end
 
     it 'generates an application endpoint' do

data/spec/grape_extensions/error_helpers_spec.rb

@@ -4,15 +4,12 @@ describe Gris::ErrorHelpers do
   before do
     @helper = SpecApiErrorHelper.new
   end
-  context 'error with text' do
-    it 'does not wrap a grape error without text' do
-      @helper.error!('error', 400)
-      expect(@helper.message).to eq(message: 'error', status: 400)
-      expect(@helper.thrown).to eq(:error)
-    end
-    it 'wraps a grape error with text' do
-      @helper.error!('error', 400, 'text')
-      expect(@helper.message).to eq(message: { error: 'error', text: 'text' }, status: 400)
+
+  context 'gris_error!' do
+    it 'returns a correctly formatted error message' do
+      @helper.gris_error! 'error', 400
+      expect(@helper.message)
+        .to eq(message: { message: 'error', status: 400 }, status: 400)
       expect(@helper.thrown).to eq(:error)
     end
   end

data/spec/integration/application_error_response_spec.rb

@@ -8,7 +8,7 @@ describe 'application error response' do
     request = Faraday.get "http://localhost:#{app_port}/bogus"
     response = JSON.parse request.body
     expect(request.status).to eq 404
-    expect(response['code']).to eq 404
+    expect(response['status']).to eq 404
     expect(response['message']).to eq ['Not Found']
   end
 end

data/spec/middleware/error_handlers_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Gris::Middleware::ErrorHandlers do
+  include Rack::Test::Methods
+  describe 'errors' do
+    subject { Class.new(Grape::API) }
+
+    let(:app) { subject }
+
+    let(:fake_active_record) do
+      module ActiveRecord
+        class RecordNotFound < StandardError
+        end
+      end
+    end
+
+    before do
+      subject.format :json
+      subject.use Gris::Middleware::ErrorHandlers
+
+      subject.get :generic_error do
+        fail 'api error'
+      end
+
+      subject.get :gris_error do
+        gris_error! 'Forbidden', 401
+      end
+
+      subject.get :error do
+        error! 'Forbidden', 401
+      end
+
+      subject.get :activerecord_error do
+        fail ActiveRecord::RecordNotFound
+      end
+    end
+
+    it 'retuns a Not Found error for missing routes' do
+      get '/bogus'
+      expect(response_code).to eq 404
+      expect(response_body).to eq 'Not Found'
+    end
+
+    it 'returns a formatted message for gris_error!' do
+      get '/gris_error'
+      expect(response_code).to eq 401
+      expect(parsed_response_body['status']).to eq 401
+      expect(parsed_response_body['message']).to eq 'Forbidden'
+    end
+
+    it 'returns a formatted message for error!' do
+      get '/error'
+      expect(response_code).to eq 401
+      expect(parsed_response_body['error']).to eq 'Forbidden'
+    end
+
+    it 'returns a formatted message for ActiveRecord::RecordNotFound' do
+      fake_active_record
+      get '/activerecord_error'
+      expect(response_code).to eq 404
+      expect(parsed_response_body['status']).to eq 404
+      expect(parsed_response_body['message']).to eq 'ActiveRecord::RecordNotFound'
+    end
+
+    it 'returns a formatted message when an exception is raised' do
+      get '/generic_error'
+      expect(response_code).to eq 500
+      expect(parsed_response_body['status']).to eq 500
+      expect(parsed_response_body['message']).to eq 'api error'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,7 +6,12 @@ require 'gris'
 require 'gris/cli'
 require 'rack/test'
 require 'fakefs/spec_helpers'
+require 'gris/rspec_extensions/response_helpers'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.include Gris::RspecExtensions::ResponseHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gris
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -369,6 +369,7 @@ files:
 - lib/gris/grape_extensions/date_time_helpers.rb
 - lib/gris/grape_extensions/error_helpers.rb
 - lib/gris/identity.rb
+- lib/gris/middleware/error_handlers.rb
 - lib/gris/middleware/health.rb
 - lib/gris/output_formatters/paginated_presenter.rb
 - lib/gris/output_formatters/presenter.rb
@@ -390,6 +391,7 @@ files:
 - spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/integration/application_error_response_spec.rb
+- spec/middleware/error_handlers_spec.rb
 - spec/output_formatters/presenter_link_helpers_spec.rb
 - spec/secrets_spec.rb
 - spec/spec_helper.rb
@@ -436,6 +438,7 @@ test_files:
 - spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/integration/application_error_response_spec.rb
+- spec/middleware/error_handlers_spec.rb
 - spec/output_formatters/presenter_link_helpers_spec.rb
 - spec/secrets_spec.rb
 - spec/spec_helper.rb