tzispa 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854b76c406ea8c9fa9742f2e4cd8daa7ec4fea16
-  data.tar.gz: 604cb924b0d88785ac2c9f7808eecb594bda3534
+  metadata.gz: a3636dd9fdb2d87f20c713f22b24979f7581e90b
+  data.tar.gz: 56a337b9749c02ee44c343e6c4064e18b09207f0
 SHA512:
-  metadata.gz: 5703eafce64f5b86c2de1e2dd7c9d8235a692a84ffd0fa2ac40c63c37a6de495c559b89f7ec46f29bfe1f7a31a69427d1a8c204551eaf6dc321019e45f8ffad1
-  data.tar.gz: bd6804a30b18b86fa577ca6f2a70c8efe433124caeeaf86f76e43a9d26853bd24ffde5f4985813f9b49cf70793f8afc3ebf4973c114551af694ecb8daf1c5d7f
+  metadata.gz: c06aaad81f83e726c4e7bfbaabdb732ed6d17fac90c2e9daa939a7bcc6bccd25fab887ce6068a10bd3ac3ae2d3c09511c2d9874eca61ac2667534eed7e256f24
+  data.tar.gz: 30f16894884f47f20ee479365cd3a00e3d4b5ee92a48a1f4f0157bf62e53946cc5484d1d63c397bd11e4c52e158a29046ee5c58e6441bd9503cd6ba26a9e2fd3

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Tzispa
 
 General purpose web framework
 
+## v0.5.7
+- add provides DSL method to specify allowe verbs in api handlers
+- handler calling improvements in api the controller
+
 ## v0.5.6
 - more application DSL usage improvements
 - application builder passed in the run method

data/lib/tzispa/api/handler.rb

@@ -5,6 +5,14 @@ require 'json'
 
 module Tzispa
   module Api
+
+    class ApiException < StandardError; end
+    class UnknownHandlerVerb < ApiException
+      def initialize(s, name)
+        super("Unknown verb: '#{s}' called in api handler '#{name}'")
+      end
+    end
+
     class Handler
       extend Forwardable
 
@@ -53,6 +61,26 @@ module Tzispa
         end
       end
 
+      def send(verb, predicate)
+        raise UnknownHandlerVerb.new(verb, self.class.name) unless self.class.provides? verb
+        args = predicate ? predicate.split('__') : nil
+        __send__ verb, *args
+      end
+
+      def self.provides(*args)
+        (@provides ||= Array.new).tap { |prv|
+          args&.each { |s|
+            prv << s.to_sym
+          }
+        }
+      end
+
+      def self.provides?(value)
+        value = value.to_sym
+        @provides&.include?(value) && public_method_defined?(value)
+      end
+
+
       private
 
       def result_messages(status)

data/lib/tzispa/controller/api.rb

@@ -10,48 +10,51 @@ require 'tzispa/utils/string'
 
 module Tzispa
   module Controller
+
+    class ControllerException < StandardError; end
+
     class Api < Base
 
       include Tzispa::Helpers::Response
 
-      attr_reader :hnd
+      attr_reader :handler
 
       def self.generate_handler(domain, name)
         @domain = domain
-        @handler = name
+        @handler_name = name
         raise "The handler '#{name}' already exist" if File.exist?(handler_class_file)
         File.open(handler_class_file, "w") { |f|
-          hnd_code = TzString.new
-          f.puts hnd_code.indenter("require 'tzispa/api/handler'\n\n")
+          handler_code = TzString.new
+          f.puts handler_code.indenter("require 'tzispa/api/handler'\n\n")
           level = 0
           handler_namespace.split('::').each { |ns|
-            f.puts hnd_code.indenter("module #{ns}\n", level > 0 ? 2 : 0).to_s
+            f.puts handler_code.indenter("module #{ns}\n", level > 0 ? 2 : 0).to_s
             level += 1
           }
-          f.puts hnd_code.indenter("\nclass #{handler_class_name} < Tzispa::Api::Handler\n\n", 2)
-          f.puts hnd_code.indenter("end\n\n")
+          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 hnd_code.unindenter("end\n", 2)
+            f.puts handler_code.unindenter("end\n", 2)
           }
         }
       end
 
 
       def dispatch!
-        @handler, domain_name = context.router_params[:handler].split('.').reverse
+        @handler_name, domain_name = context.router_params[:handler].split('.').reverse
         @domain = domain_name.nil? ? context.app.domain : Tzispa::Domain.new(name: domain_name)
         @verb = context.router_params[:verb]
         @predicate = context.router_params[:predicate]
-        @hnd = handler_class.new(context)
-        @predicate ? hnd.send(@verb, @predicate) : hnd.send(@verb)
-        context.flash << hnd.message
-        send hnd.response_verb if hnd.response_verb
+        @handler = handler_class.new(context)
+        handler.send @verb, @predicate
+        context.flash << handler.message
+        send handler.response_verb if handler.response_verb
         response.finish
       end
 
       def redirect
-        url = if hnd.data && !hnd.data.strip.empty?
-          hnd.data.start_with?('#') ? "#{request.referer}#{hnd.data}" : hnd.data
+        url = if handler.data && !handler.data.strip.empty?
+          handler.data.start_with?('#') ? "#{request.referer}#{handler.data}" : handler.data
         else
           request.referer
         end
@@ -59,18 +62,18 @@ module Tzispa
       end
 
       def html
-        response.body << hnd.data
+        response.body << handler.data
         content_type :htm
         set_action_headers
       end
 
       def json
-        if hnd.data.is_a?(::Hash)
-          data = hnd.data
-          data[:__result_status] = hnd.status
-          data[:__result_message] = hnd.message
+        if handler.data.is_a?(::Hash)
+          data = handler.data
+          data[:__result_status] = handler.status
+          data[:__result_message] = handler.message
         else
-          data = JSON.parse(hnd.data)
+          data = JSON.parse(handler.data)
         end
         response.body << data.to_json
         content_type :json
@@ -78,21 +81,21 @@ module Tzispa
       end
 
       def text
-        response.body << hnd.data
+        response.body << handler.data
         content_type :text
         set_action_headers
       end
 
       def download
-        send_file hnd.data[:path], hnd.data
+        send_file handler.data[:path], handler.data
       end
 
       def handler_class_name
-        "#{TzString.camelize @handler}Handler"
+        "#{TzString.camelize @handler_name}Handler"
       end
 
       def handler_class_file
-        "#{@domain.path}/api/#{@handler}.rb"
+        "#{@domain.path}/api/#{@handler_name}.rb"
       end
 
       def handler_namespace
@@ -100,7 +103,7 @@ module Tzispa
       end
 
       def handler_class
-        @domain.require "api/#{@handler}"
+        @domain.require "api/#{@handler_name}"
         TzString.constantize "#{handler_namespace}::#{handler_class_name}"
       end
 
@@ -110,7 +113,7 @@ module Tzispa
 
       def set_action_headers
         response['X-API'] = "#{context.router_params[:sign]}:#{context.router_params[:handler]}:#{context.router_params[:verb]}:#{context.router_params[:predicate]}"
-        response['X-API-STATE'] = "#{hnd.status}"
+        response['X-API-STATE'] = "#{handler.status}"
       end
 
     end

data/lib/tzispa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Tzispa
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
   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.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack