tzispa 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3c9ec75a6f6b5e1a856c9efaf1a194018b4c681
-  data.tar.gz: f0fb7fa9a508b73195bd771f5d28b65ef2351bf8
+  metadata.gz: 13911ddd5b938320efb3e6aa971d996be88581e5
+  data.tar.gz: a054ae603791f5a57a66b40a837ea5fd95b254cb
 SHA512:
-  metadata.gz: 37c653c9b2283901357381d58ede86a80ab844e77cd0977bd5e7d52609788f81668fd3fa830782cebaa82fc53f2d2d6a3bc7f82f5b9c8b517ff2e7767927846b
-  data.tar.gz: ac0e1ef05c586f958873a46bcf9b3c8630a8de6449e536daabae0291ad39d144d8275bc66cba6aebf67e641feb7206f04b62ce734eb91357fc10ac1099786f75
+  metadata.gz: 28359f1534f2799ab711386a2caab2641bb047b663a864de73c815851192e772e520acc3d71831c2cabe3143e4706b3fa4702975a9d8b7e147f85212b55c4135
+  data.tar.gz: 976f8d1b4b7e18af9887e3400d56320de2a45e300822b696846441dc7f2557f35eed6a56eb649722d02f711dcc91f88f6b7e611aa0004385ff073c48f6b6cd77

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Tzispa
 
 General purpose web framework
 
+## v0.7.6
+- added custom error pages option in base controller
+- disable custom error page in the api controller
+
 ## v0.7.5
 - bug fix in controller base response status code was not being set
 

data/lib/tzispa/api/handler.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require 'forwardable'
-require 'json'
-require 'i18n'
 require 'tzispa/helpers/provider'
 require 'tzispa/helpers/sign_requirer'
 require 'tzispa/helpers/hooks/before'
 require 'tzispa/helpers/hooks/after'
-require 'tzispa/utils/string'
+require_relative 'handler_error'
 
 module Tzispa
   module Api
@@ -23,6 +21,7 @@ module Tzispa
     class Handler
       extend Forwardable
 
+      include Tzispa::Api::HandlerError
       include Tzispa::Helpers::Provider
       include Tzispa::Helpers::SignRequirer
       include Tzispa::Helpers::Hooks::Before
@@ -34,30 +33,15 @@ module Tzispa
       def_delegators :@context, :request, :response, :app, :repository,
                      :config, :logger, :unauthorized_but_logged, :login_redirect
 
-      attr_writer :error
-
-      HANDLER_OK                = :ok
-      HANDLER_MISSING_PARAMETER = :missing_parameter
-
       def initialize(context)
         @context = context
         @error = nil
         @status = nil
       end
 
-      def error?
-        @error && @error != HANDLER_OK
-      end
-
-      def error_status(error, status = nil)
-        @error = error
-        @status = status
-      end
-
-      def result(type:, data: nil, error: nil)
+      def result(type:, data: nil)
         @type = type
         @data = data
-        @error = error if error
       end
 
       def result_json(data)
@@ -72,17 +56,12 @@ module Tzispa
         result type: :redirect, data: data
       end
 
-      def not_found
-        result type: :not_found
-      end
-
-      def message
-        I18n.t(error_id, default: error.to_s) if error
-      end
-
-      def error_id
-        "#{self.class.name.dottize}.#{error}" if error
+      def error_status(code, http_status = nil)
+        @error = code
+        @status = http_status
+        result_json error_message: message, error_code: code
       end
+      alias result_error error_status
 
       def run!(verb, predicate = nil)
         raise UnknownHandlerVerb.new(verb, self.class.name) unless provides? verb

data/lib/tzispa/api/handler_error.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'tzispa/utils/string'
+
+module Tzispa
+  module Api
+    module HandlerError
+
+      using Tzispa::Utils::TzString
+
+      HANDLER_OK = :ok
+
+      def error?
+        @error && @error != HANDLER_OK
+      end
+
+      def message
+        I18n.t(error_id, default: error.to_s) if error
+      end
+
+      def error_id
+        "#{self.class.name.dottize}.#{error}" if error
+      end
+
+      def http_bad_request(error = nil)
+        error_status error || :bad_requuest, 400
+      end
+
+      def http_unauthorized(error = nil)
+        error_status error || :unauthorized, 401
+      end
+
+      def http_forbidden(error = nil)
+        error_status error || :forbidden, 403
+      end
+
+      def http_not_found(error = nil)
+        error_status error || :not_found, 404
+      end
+
+      def http_not_aceptable(error = nil)
+        error_status error || :not_acceptable, 406
+      end
+
+      def http_conflict(error = nil)
+        error_status error || :conflict, 409
+      end
+
+      def http_gone(error = nil)
+        error_status error || :gone, 410
+      end
+
+      def http_token_required(error = nil)
+        error_status error || :token_required, 499
+      end
+
+      def http_server_error(error = nil)
+        error_status error || :internal_server_error, 500
+      end
+
+      def http_not_implemented(error = nil)
+        error_status error || :not_implemented, 501
+      end
+
+      def http_bad_gateway(error = nil)
+        error_status error || :bad_gateway, 502
+      end
+
+      def http_service_unavailable(error = nil)
+        error_status error || :service_unavailable, 503
+      end
+
+    end
+  end
+end

data/lib/tzispa/controller/api.rb

@@ -17,6 +17,10 @@ module Tzispa
 
       include Tzispa::Helpers::Response
 
+      def initialize(app, callmethod = :dispatch!)
+        super(app, callmethod, false)
+      end
+
       def dispatch!
         verb = context.router_params[:verb]
         predicate = context.router_params[:predicate]
@@ -47,7 +51,7 @@ module Tzispa
       end
 
       def empty(handler)
-        api_response nil, nil, handler.status, handler.error
+        api_response handler.status
       end
 
       def redirect(handler)
@@ -56,23 +60,18 @@ module Tzispa
       end
 
       def html(handler)
-        content = handler.error? ? handler.message : handler.data
-        api_response :htm, content, handler.status, handler.error
+        content = handler.data unless handler.error?
+        api_response handler.status, content, :htm
       end
 
       def json(handler)
-        content = if handler.error?
-                    { error_message: handler.message,
-                      error_code: handler.error }.to_json
-                  else
-                    handler.data.is_a?(::String) ? JSON.parse(handler.data) : handler.data.to_json
-                  end
-        api_response :json, content, handler.status, handler.error
+        content = handler.data.is_a?(::String) ? JSON.parse(handler.data) : handler.data.to_json        
+        api_response handler.status, content, :json
       end
 
       def text(handler)
-        content = handler.error? ? handler.message : handler.data
-        api_response :text, content, handler.status, handler.error
+        content = handler.data unless handler.error?
+        api_response handler.status, content, :text
       end
 
       def download(handler)
@@ -83,11 +82,10 @@ module Tzispa
         context.flash << message if config.sessions&.enabled
       end
 
-      def api_response(type = nil, content = nil, status = nil, error = nil)
+      def api_response(status, content = nil, type = nil)
         content_type(type) if type
         response.body = content if content
         response.status = status if status
-        api_headers error
       end
 
       def request_method
@@ -113,16 +111,6 @@ module Tzispa
             .constantize
         end
       end
-
-      private
-
-      def api_headers(error = nil)
-        handler = context.router_params[:handler]
-        verb = context.router_params[:verb]
-        predicate = context.router_params[:predicate]
-        response['X-API'] = "#{handler}:#{verb}:#{predicate}"
-        response['X-API-SR'] = error.to_s if error
-      end
     end
 
   end

data/lib/tzispa/controller/base.rb

@@ -17,13 +17,14 @@ module Tzispa
       include Tzispa::Helpers::Hooks::Before
       include Tzispa::Helpers::Hooks::After
 
-      attr_reader :context, :application, :callmethod
+      attr_reader :context, :application, :callmethod, :custom_error
       def_delegators :@context, :request, :response, :config,
                      :login_redirect, :unauthorized_but_logged
 
-      def initialize(app, callmethod = nil)
+      def initialize(app, callmethod = nil, custom_error = true)
         @callmethod = callmethod
         @application = app
+        @custom_error = custom_error
       end
 
       def call(env)
@@ -46,32 +47,32 @@ module Tzispa
         prepare_response(500, error: ex)
       end
 
-      def prepare_response(status, content: nil, error: nil)
+      def prepare_response(status, error: nil)
         response.status = status if status.is_a?(Integer)
         if context.client_error?
           prepare_client_error(status, error)
         elsif context.server_error?
           prepare_server_error(status, error)
-        elsif content
-          response.body = content
         end
       end
 
       def prepare_client_error(status, error = nil)
         status.tap do |code|
           context.logger.info log_format(code, error.to_s) if error
-          response.body = error_page(context.domain, status: code)
+          response.body = error_page(context.domain, status: code) if custom_error
         end
       end
 
       def prepare_server_error(status, error = nil)
         status.tap do |code|
           context.logger.error log_format(code, error_log(error)) if error
-          response.body = if error && Tzispa::Environment.development?
-                            debug_info(error)
-                          else
-                            error_page(context.domain, status: code)
-                          end
+          if custom_error
+            response.body = if error && Tzispa::Environment.development?
+                              debug_info(error)
+                            else
+                              error_page(context.domain, status: code)
+                            end
+          end
         end
       end
 

data/lib/tzispa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Tzispa
-  VERSION = '0.7.5'
+  VERSION = '0.7.6'
   FRAMEWORK_NAME = 'Tzispa'
   GEM_NAME = 'tzispa'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tzispa
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,6 +184,7 @@ files:
 - bin/tzispa
 - lib/tzispa.rb
 - lib/tzispa/api/handler.rb
+- lib/tzispa/api/handler_error.rb
 - lib/tzispa/app.rb
 - lib/tzispa/bin/tzispa
 - lib/tzispa/cli.rb