Collect exceptions under KrackenError and move them to errors.rb

This is also intended to clean up some of the duplicate code that was a
by product of the changes living in an app before merged upstream.

Author: csexton

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kracken (0.0.9)
+    kracken (0.1.0)
       faraday (~> 0.8)
       omniauth (~> 1.0)
       omniauth-oauth2 (~> 1.1)
@@ -55,22 +55,21 @@ GEM
     erubis (2.7.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    globalid (0.3.3)
+    globalid (0.3.5)
       activesupport (>= 4.1.0)
-    hashie (3.4.0)
-    hike (1.2.3)
+    hashie (3.4.2)
     i18n (0.7.0)
     json (1.8.2)
-    jwt (1.4.1)
+    jwt (1.5.1)
     loofah (2.0.1)
       nokogiri (>= 1.5.9)
     mail (2.6.3)
       mime-types (>= 1.16, < 3)
     method_source (0.8.2)
-    mime-types (2.4.3)
+    mime-types (2.6.1)
     mini_portile (0.6.2)
     minitest (5.5.1)
-    multi_json (1.11.0)
+    multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     nokogiri (1.6.6.2)
@@ -84,9 +83,7 @@ GEM
     omniauth (1.2.2)
       hashie (>= 1.2, < 4)
       rack (~> 1.0)
-    omniauth-oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
-      multi_json (~> 1.3)
+    omniauth-oauth2 (1.3.1)
       oauth2 (~> 1.0)
       omniauth (~> 1.2)
     pry (0.10.1)
@@ -142,18 +139,14 @@ GEM
     rspec-support (3.2.2)
     safe_yaml (1.0.4)
     slop (3.6.0)
-    sprockets (2.12.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
+    sprockets (3.2.0)
       rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.4)
+    sprockets-rails (2.3.2)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
     thor (0.19.1)
     thread_safe (0.3.5)
-    tilt (1.4.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     webmock (1.20.4)

lib/kracken/controllers/json_api_compatible.rb

@@ -4,25 +4,6 @@ module Kracken
   module Controllers
     module JsonApiCompatible
 
-      class ResourceNotFound < StandardError
-        attr_reader :missing_ids, :resource
-        def initialize(resource, missing_ids)
-          @missing_ids = Array(missing_ids)
-          @resource    = resource
-          super(
-            "Couldn't find #{resource} with id(s): #{missing_ids.join(', ')}"
-          )
-        end
-      end
-
-      class TokenUnauthorized < StandardError
-        def initialize(msg = nil)
-          msg ||= 'HTTP Token: Access denied.'
-          super(msg)
-        end
-      end
-
-      class UnprocessableEntity < StandardError; end
 
       module MungeAndMirror
         # Wraps the data root in an Array, if it is not already an Array. This

lib/kracken/controllers/token_authenticatable.rb

@@ -13,11 +13,12 @@ def self.included(base)
 
           rescue_from Kracken::RequestError do |_|
             # TODO: Handle other types of errors (such as if the server is down)
-            raise Kracken::Controllers::JsonApiCompatible::TokenUnauthorized,
+            raise TokenUnauthorized,
               "Invalid credentials"
           end
         end
 
+
       end
 
       attr_reader :current_user
@@ -51,14 +52,6 @@ def munge_header_auth_token!
         request.env['HTTP_AUTHORIZATION'] = "Token token=\"#{params[:token]}\""
       end
 
-      # Customize the `authenticate_or_request_with_http_token` process:
-      # http://api.rubyonrails.org/classes/ActionController/HttpAuthentication/Token/ControllerMethods.html#method-i-request_http_token_authentication
-      def request_http_token_authentication(realm = 'Application')
-        # Modified from https://github.com/rails/rails/blob/60d0aec7/actionpack/lib/action_controller/metal/http_authentication.rb#L490-L499
-        headers["WWW-Authenticate"] = %(Token realm="#{realm.gsub(/"/, "")}")
-        render json: { error: 'HTTP Token: Access denied.' }, status: :unauthorized
-      end
-
       def realm
         self.class.realm
       end

lib/kracken/error.rb

@@ -1,5 +1,27 @@
 module Kracken
-  KrackenError = Class.new(StandardError)
-  RequestError = Class.new(KrackenError)
-  MissingUIDError = Class.new(KrackenError)
+  KrackenError        = Class.new(StandardError)
+  RequestError        = Class.new(KrackenError)
+  MissingUIDError     = Class.new(KrackenError)
+
+  module Controllers
+    UnprocessableEntity = Class.new(StandardError)
+
+    class TokenUnauthorized < KrackenError
+      def initialize(msg = nil)
+        msg ||= 'HTTP Token: Access denied.'
+        super(msg)
+      end
+    end
+
+    class ResourceNotFound < KrackenError
+      attr_reader :missing_ids, :resource
+      def initialize(resource, missing_ids)
+        @missing_ids = Array(missing_ids)
+        @resource    = resource
+        super(
+          "Couldn't find #{resource} with id(s): #{missing_ids.join(', ')}"
+        )
+      end
+    end
+  end
 end

lib/kracken/json_api/exception_wrapper.rb

@@ -4,9 +4,9 @@ class ExceptionWrapper < ActionDispatch::ExceptionWrapper
       cattr_accessor :rescue_with_details_responses
       @@rescue_with_details_responses = Hash.new
       @@rescue_with_details_responses.merge!(
-        'Kracken::Controllers::JsonApiCompatible::ResourceNotFound' => :not_found,
-        'Kracken::Controllers::JsonApiCompatible::TokenUnauthorized' => :unauthorized,
-        'Kracken::Controllers::JsonApiCompatible::UnprocessableEntity' => :unprocessable_entity,
+        'Kracken::Controllers::ResourceNotFound' => :not_found,
+        'Kracken::Controllers::TokenUnauthorized' => :unauthorized,
+        'Kracken::Controllers::UnprocessableEntity' => :unprocessable_entity,
       )
 
       def self.status_code_for_exception(class_name)

spec/dummy/config/application.rb

@@ -9,6 +9,7 @@
 
 Bundler.require(*Rails.groups)
 require "kracken"
+require "kracken/json_api"
 
 module Dummy
   class Application < Rails::Application
@@ -23,6 +24,9 @@ class Application < Rails::Application
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
+    config.middleware.insert_after ActionDispatch::DebugExceptions,
+                                   Kracken::JsonApi::PublicExceptions
+
   end
 end
 

spec/requests/api_spec.rb

@@ -9,10 +9,9 @@ def headers_with_token(token)
 
     let(:json){ Fixtures.auth_hash.to_json }
 
-    describe "requests to and authenticatable resource", type: :request do
-      it "Renders unauthorized if there is no token" do
-        get api_index_path
-        expect(response.status).to eq(401)
+    describe "authenticatable resource", type: :request do
+      it "will raise error if there is no token" do
+        expect{get api_index_path}.to raise ::Kracken::Controllers::TokenUnauthorized
       end
 
       it "is redirected to the oauth server if there is no current user" do