tzispa 0.5.13 → 0.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fc85a39ec42b71cb36319ccf24e814ca72c2512
-  data.tar.gz: d648e30afbfea5e4de07da024019235836532487
+  metadata.gz: 679fca5266d73401ce64876f16bf8d6a867eacf3
+  data.tar.gz: 5a4fb29bec5b1e0110de07ee18e38aba806c88f9
 SHA512:
-  metadata.gz: 2db1ce9275f3a90b2518b1814d555131550792cd7de4356bb711a17c29e329f7bbf03585690853f46c7cceb366bc56a0a5158a2763d78dfba00db641cce96b98
-  data.tar.gz: 1ef6d906982dd5be0eb4f60f08ecac5ad25f6657006a2465d856531a52c25e0f9bc93ec5560d2ce3d2540329531949d9c2168ac86becc7e830011e76948fe14a
+  metadata.gz: b13878b1fc41fb1ecc5b69366ca7802ada0751fe4d880247e5f1eb7fd680da6b057950b97b9e77cba1e02c8ec4ef269737843e007075985c019de47e67545dc9
+  data.tar.gz: 7e1f29257c2764a4761e49051fce89869cfe2faa51b4aeac0880a03a3ce667dea15de69e4286b2b7474c1f9ebb9db97a726e05c344b9617235f31feeaec6f60e

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Tzispa
 
 General purpose web framework
 
+## v0.5.14
+- populate json response when there are handler errros
+- api error messages now managed by i18n files
+- code fixes for replacing TzString with String refinement
+
 ## v0.5.13
 - update code creation templates in cli to reflect DSL changes
 - remove not used gem dependencies

data/lib/tzispa/api/handler.rb

@@ -2,8 +2,10 @@
 
 require 'forwardable'
 require 'json'
+require 'i18n'
 require 'tzispa/helpers/provider'
 require 'tzispa/helpers/sign_requirer'
+require 'tzispa/utils/string'
 
 module Tzispa
   module Api
@@ -21,34 +23,32 @@ module Tzispa
       include Tzispa::Helpers::SignRequirer
       extend Forwardable
 
+      using Tzispa::Utils
+
       attr_reader :context, :response_verb, :data, :status
       def_delegators :@context, :request, :response, :app, :repository, :config
 
-      HANDLED_UNDEFINED         = nil
-      HANDLED_OK                = 1
-      HANDLED_MISSING_PARAMETER = 98
-      HANDLED_ERROR             = 99
-      HANDLED_RESULT            = 200
+      HANDLER_STATUS_UNDEFINED  = nil
+      HANDLER_STATUS_OK         = :ok
+      HANDLER_MISSING_PARAMETER = :missing_parameter
 
-      HANDLED_MESSAGES = {
-        HANDLED_OK                => 'La operación se ha realizado correctamente',
-        HANDLED_MISSING_PARAMETER => 'Error: faltan parámetros para realizar la operación',
-        HANDLED_ERROR             => 'Error indeterminado: la operación no se ha podido realizar'
-      }
 
       def initialize(context)
         @context = context
       end
 
-      def result(response_verb:, data: nil, status: nil, error: nil)
-        @status = status if status
+      def result(response_verb:, data: nil, status: HANDLER_STATUS_UNDEFINED)
         @response_verb = response_verb
+        @status = status if status
         @data = data
-        @error = error
       end
 
-      def result_json(data, status: nil, error: nil)
-        result response_verb: :json, data: data, status: status, error: error
+      def error?
+        status && status != HANDLER_STATUS_OK
+      end
+
+      def result_json(data, status: nil)
+        result response_verb: :json, data: data, status: status
       end
 
       def result_download(data, status: nil)
@@ -60,17 +60,10 @@ module Tzispa
       end
 
       def message
-        case ss = status.to_i
-        when ss >= HANDLED_OK && ss <= HANDLED_ERROR
-          HANDLED_MESSAGES[status]
-        when ss > HANDLED_ERROR && ss < HANDLED_RESULT
-          error_message status
-        when ss > HANDLED_RESULT
-          result_messages status
-        end
+        I18n.t("#{self.class.name.dottize}.#{status}ss", default: "#{status}") if status
       end
 
-      def call(verb, predicate=nil)
+      def run!(verb, predicate=nil)
         raise UnknownHandlerVerb.new(verb, self.class.name) unless provides? verb
         raise InvalidSign.new if sign_required? && !sign_valid?
         # process compound predicates
@@ -82,23 +75,12 @@ module Tzispa
         @status = value
       end
 
-
       protected
 
       def static_path_sign?
         context.path_sign? context.router_params[:sign], context.router_params[:handler], context.router_params[:verb], context.router_params[:predicate]
       end
 
-      private
-
-      def result_messages(status)
-        self.class::RESULT_MESSAGES[status] if (defined?( self.class::RESULT_MESSAGES ) && self.class::RESULT_MESSAGES.is_a?(Hash))
-      end
-
-      def error_message(status)
-        "#{self.class::ERROR_MESSAGES[status]}#{': '+@error.to_s if @error}" if (defined?( self.class::ERROR_MESSAGES ) && self.class::ERROR_MESSAGES.is_a?(Hash))
-      end
-
 
     end
   end

data/lib/tzispa/command/app.rb

@@ -10,6 +10,8 @@ module Tzispa
 
     class App
 
+      using Tzispa::Utils
+
       APP_STRUCTURE = [
         'api',
         'locales',
@@ -40,7 +42,7 @@ module Tzispa
       private
 
       def app_class_name
-        @app_class_name ||= "#{TzString.camelize domain.name}App"
+        @app_class_name ||= "#{domain.name.camelize}App"
       end
 
       def update_project

data/lib/tzispa/controller/api.rb

@@ -15,26 +15,9 @@ module Tzispa
 
     class Api < Base
 
-      include Tzispa::Helpers::Response
-
+      using Tzispa::Utils
 
-      def self.generate_handler(domain, name)
-        raise "The handler '#{name}' already exist" if File.exist?(handler_class_file)
-        File.open(handler_class_file(domain, name), "w") { |f|
-          handler_code = TzString.new
-          f.puts handler_code.indenter("require 'tzispa/api/handler'\n\n")
-          level = 0
-          handler_namespace.split('::').each { |ns|
-            f.puts handler_code.indenter("module #{ns}\n", level > 0 ? 2 : 0).to_s
-            level += 1
-          }
-          f.puts handler_code.indenter("\nclass #{handler_class_name} < Tzispa::Api::Handler\n\n", 2)
-          f.puts handler_code.indenter("end\n\n")
-          handler_namespace.split('::').each { |ns|
-            f.puts handler_code.unindenter("end\n", 2)
-          }
-        }
-      end
+      include Tzispa::Helpers::Response
 
       def dispatch!
         handler_name, domain_name = context.router_params[:handler].split('.').reverse
@@ -42,48 +25,52 @@ module Tzispa
         verb = context.router_params[:verb]
         predicate = context.router_params[:predicate]
         handler = self.class.handler_class(domain, handler_name).new(context)
-        handler.call verb, predicate
+        handler.run! verb, predicate
         send(handler.response_verb, handler) if handler.response_verb
         response.finish
       end
 
-      def redirect(target)
-        url = if target.data && !target.data.strip.empty?
-          target.data.start_with?('#') ? "#{request.referer}#{target.data}" : target.data
+      def redirect(handler)
+        url = if handler.data && !handler.data.strip.empty?
+          handler.data.start_with?('#') ? "#{request.referer}#{handler.data}" : handler.data
         else
           request.referer
         end
-        context.flash << target.message if config.sessions&.enabled
+        puts "#{handler.error?} -> #{handler.message}"
+        context.flash << handler.message if config.sessions&.enabled && handler.error?
         context.redirect url, config.absolute_redirects, response
       end
 
-      def html(content)
+      def html(handler)
         content_type :htm
-        response.body << content.data
-        set_api_headers content.status
+        context.flash << handler.message if config.sessions&.enabled && handler.error?
+        response.body << handler.data
+        set_api_headers handler.status
       end
 
-      def json(content)
+      def json(handler)
         content_type :json
-        data = ::Hash === content.data || ::Array === content.data ? content.data : JSON.parse(content.data)
-        response.body << data.to_json
-        set_api_headers content.status
+        data = ::String === handler.data ? JSON.parse(handler.data) : handler.data.to_json
+        response.body << data
+        response.body << Hash[:__error, true, :__msg_error, handler.message].to_json if handler.error?
+        set_api_headers handler.status
       end
 
-      def text(content)
+      def text(handler)
         content_type :text
-        response.body << content.data
-        set_api_headers content.status
+        context.flash << handler.message if config.sessions&.enabled && handler.error?
+        response.body << handler.data
+        set_api_headers handler.status
       end
 
-      def download(content)
-        send_file content.data[:path], content.data
+      def download(handler)
+        send_file handler.data[:path], handler.data
       end
 
       class << self
 
         def handler_class_name(handler_name)
-          "#{TzString.camelize handler_name}Handler"
+          "#{handler_name.camelize}Handler"
         end
 
         def handler_class_file(domain, handler_name)
@@ -91,12 +78,30 @@ module Tzispa
         end
 
         def handler_namespace(domain)
-          "#{TzString.camelize domain.name }::Api"
+          "#{domain.name.to_s.camelize}::Api"
         end
 
         def handler_class(domain, handler_name)
           domain.require "api/#{handler_name}"
-          TzString.constantize "#{handler_namespace domain}::#{handler_class_name handler_name}"
+          "#{handler_namespace domain}::#{handler_class_name handler_name}".constantize
+        end
+
+        def generate_handler(domain, name)
+          raise "The handler '#{name}' already exist" if File.exist?(handler_class_file)
+          File.open(handler_class_file(domain, name), "w") { |f|
+            handler_code = String.new
+            f.puts handler_code.indenter("require 'tzispa/api/handler'\n\n")
+            level = 0
+            handler_namespace.split('::').each { |ns|
+              f.puts handler_code.indenter("module #{ns}\n", level > 0 ? 2 : 0).to_s
+              level += 1
+            }
+            f.puts handler_code.indenter("\nclass #{handler_class_name} < Tzispa::Api::Handler\n\n", 2)
+            f.puts handler_code.indenter("end\n\n")
+            handler_namespace.split('::').each { |ns|
+              f.puts handler_code.unindenter("end\n", 2)
+            }
+          }
         end
 
       end
@@ -105,7 +110,7 @@ module Tzispa
 
       def set_api_headers(status)
         response['X-API'] = "#{context.router_params[:handler]}:#{context.router_params[:verb]}:#{context.router_params[:predicate]}"
-        response['X-API-STATE'] = "#{status.to_i}"
+        response['X-API-STATE'] = "#{status}"
       end
 
     end

data/lib/tzispa/routes.rb

@@ -10,6 +10,8 @@ module Tzispa
 
   class Routes
 
+    using Tzispa::Utils
+
     CONTROLLERS_BASE = 'Tzispa::Controller'
 
     attr_reader :router, :map_path
@@ -29,7 +31,7 @@ module Tzispa
       spec_control, callmethod = controller.to_s.split(':')
       mpath = spec_control.split('#')
       req_controller = mpath.pop
-      controller = TzString.camelize(req_controller).to_s
+      controller = req_controller.camelize
       if mpath.count > 1
         controller_module = mpath.collect!{ |w| w.capitalize }.join('::')
         require_relative "./controller/#{req_controller}"
@@ -38,7 +40,7 @@ module Tzispa
         require "tzispa/controller/#{req_controller}"
       end
       @router.add(path).tap { |rule|
-        rule.to TzString.constantize("#{controller_module}::#{controller}").new(@app, callmethod)
+        rule.to "#{controller_module}::#{controller}".constantize.new(@app, callmethod)
         rule.name = route_id
         rule.add_request_method(methods) if methods
         rule.add_match_with(matching) if matching

data/lib/tzispa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Tzispa
-  VERSION = '0.5.13'
+  VERSION = '0.5.14'
   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.5.13
+  version: 0.5.14
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A sparkling web framework