tzispa 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73281443ab56c5d37e05bccc7896d3af2acb3415
-  data.tar.gz: '03076458d15ac0598119430311808949ad0c57e7'
+  metadata.gz: 9e70cadefd940ba6c29f9e922288ae5d6e26f806
+  data.tar.gz: 9d0803b6898b4f23d8117ee20c5854e13bca99ab
 SHA512:
-  metadata.gz: 1ce98d4842005c2af213bd7a560c7b70cc4e8213f9ebc08a7c8909e77cc74817f936bff2eeccf637bce136c6afcde18f8640317788175f9042a0f57c7b94144e
-  data.tar.gz: '079524201c5c1d25dc23ba1de6258eba590a4cd773a968674e07e98224cf2156dac28d3f52a69d756c17565e41910c7a97afe86694a8e68f9d5730e0558e8323'
+  metadata.gz: 83d6b14372cd570718a36f4a68f7480591923033c91046ece2d3c27742c9686872b69457e9534127385ba3ee0f23690cdcc614578be2dedf63c68bc1c851da17
+  data.tar.gz: e7ae49e10763e8bdcf4655a15c3ca68dad2651fba71b0e9d96245820a69b75b2cdcb92c9608202d8aea7dd17ea1ae562637f33889e20d1ba3e27a45260dffcee

data/CHANGELOG.md

@@ -2,6 +2,13 @@ Tzispa
 
 General purpose web framework
 
+## v0.5.11
+- moved app config files location
+- moved app locales base dir
+- api sign checking has been moved to handlers by helpers dsl
+- api dispatch code improvement and fixes
+- code reorganization to expose better interfaces
+
 ## v0.5.10
 - fix: check if the given layout is the default_layout in config before promote into the path params hash
 - add tmp folder in the project creation cli command
@@ -18,7 +25,7 @@ General purpose web framework
 - add path building methods for rig layouts in lib/tzispa/http/context.rb
 
 ## v0.5.7
-- add provides DSL method to specify allowe verbs in api handlers
+- add provides DSL method to specify allowed verbs in api handlers
 - handler calling improvements in api the controller
 
 ## v0.5.6

data/lib/tzispa/api/handler.rb

@@ -2,6 +2,8 @@
 
 require 'forwardable'
 require 'json'
+require 'tzispa/helpers/provider'
+require 'tzispa/helpers/sign_requirer'
 
 module Tzispa
   module Api
@@ -12,13 +14,15 @@ module Tzispa
         super("Unknown verb: '#{s}' called in api handler '#{name}'")
       end
     end
+    class InvalidSign < ApiException; end
 
     class Handler
+      include Tzispa::Helpers::Provider
+      include Tzispa::Helpers::SignRequirer
       extend Forwardable
 
-      def_delegators :@context, :request, :response, :app
-
-      attr_reader :context, :status, :response_verb, :data
+      attr_reader :context, :response_verb, :data, :status
+      def_delegators :@context, :request, :response, :app, :repository, :config
 
       HANDLED_UNDEFINED         = nil
       HANDLED_OK                = 1
@@ -36,54 +40,53 @@ module Tzispa
         @context = context
       end
 
-      def result(response_verb:, status: HANDLED_UNDEFINED, data: nil, detailed_error: nil)
-        @status = status
+      def result(response_verb:, data: nil, status: nil, error: nil)
+        @status = status if status
         @response_verb = response_verb
         @data = data
-        @detailed_error = detailed_error
+        @error = error
+      end
+
+      def result_json(data, status: nil)
+        result response_verb: :json, data: data.to_json, status: status
       end
 
-      def result_json(status=HANDLED_UNDEFINED, data=nil, detailed_error=nil)
-        result response_verb: :json, status: status, data: data.to_json, detailed_error: detailed_error
+      def result_download(data, status: nil)
+        result response_verb: :download, data: data, status: status
+      end
+
+      def not_found
+        result response_verb: :not_found
       end
 
       def message
-        if @status.nil?
-          nil
-        elsif @status >= HANDLED_OK && @status <= HANDLED_ERROR
-          HANDLED_MESSAGES[@status]
-        elsif @status > HANDLED_ERROR && @status < HANDLED_RESULT
-          error_message @status
-        elsif @status > HANDLED_RESULT
-          result_messages @status
-        else
-          nil
+        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
       end
 
       def call(verb, predicate=nil)
-        raise UnknownHandlerVerb.new(verb, self.class.name) unless self.class.provides? verb
-        # allow compound predicates
+        raise UnknownHandlerVerb.new(verb, self.class.name) unless provides? verb
+        raise InvalidSign.new if sign_required? && !sign_valid?
+        # process compound predicates
         args = predicate ? predicate.split(',') : nil
         send verb, *args
       end
 
-      def self.provides(*args)
-        (@provides ||= Hash.new).tap { |prv|
-          args&.each { |s|
-            prv[s.to_sym] = s
-          }
-        }
+      def set_status(value)
+        @status = value
       end
 
-      def self.provides?(verb)
-        value = verb.to_sym
-        @provides&.include?(value) && public_method_defined?(@provides[value])
-      end
 
-      def self.mapping(source, dest)
-        @provides ||= Hash.new
-        @provides[source] = dest
+      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
@@ -93,7 +96,7 @@ module Tzispa
       end
 
       def error_message(status)
-        "#{self.class::ERROR_MESSAGES[status]}#{': '+@detailed_error if @detailed_error}" if (defined?( self.class::ERROR_MESSAGES ) && self.class::ERROR_MESSAGES.is_a?(Hash))
+        "#{self.class::ERROR_MESSAGES[status]}#{': '+@error.to_s if @error}" if (defined?( self.class::ERROR_MESSAGES ) && self.class::ERROR_MESSAGES.is_a?(Hash))
       end
 
 

data/lib/tzispa/app.rb

@@ -77,16 +77,14 @@ module Tzispa
     end
 
     def load!
-      Mutex.new.synchronize {
+      self.class.synchronize {
         load_locales
-        @repository = Data::Repository.new(@config.repository.to_h).load! if @config.respond_to? :repository
-        @engine = Rig::Engine.new(self, @config.template_cache.enabled, @config.template_cache.size)
-        @logger = Logger.new("logs/#{@domain.name}.log", 'weekly')
-        @logger.level = @config.respond_to?(:developing) && @config.developing ? Logger::DEBUG : Logger::INFO
-        @domain.require_dir 'helpers'
-        @domain.require_dir 'services'
-        @domain.require_dir 'api'
-        @domain.require_dir 'middleware'
+        @repository = Data::Repository.new(config.repository.to_h).load! if config.respond_to? :repository
+        @engine = Rig::Engine.new(self, config.template_cache.enabled, config.template_cache.size)
+        @logger = Logger.new("logs/#{domain.name}.log", config.logging.shift_age).tap { |log|
+          log.level = config.developing ? Logger::DEBUG : Logger::INFO
+        } if config.logging&.enabled
+        domain_requires
         @loaded = true
       }
       self
@@ -98,10 +96,17 @@ module Tzispa
 
     private
 
+    def domain_requires
+      domain.require_dir 'helpers'
+      domain.require_dir 'services'
+      domain.require_dir 'api'
+      domain.require_dir 'middleware'
+    end
+
     def load_locales
       if @config.respond_to?(:locales)
         I18n.load_path = Dir["config/locales/*.yml"]
-        I18n.load_path += Dir["#{@domain.path}/config/locales/*.yml"]
+        I18n.load_path += Dir["#{@domain.path}/locales/*.yml"]
       end
     end
 

data/lib/tzispa/config/appconfig.rb

@@ -13,14 +13,13 @@ module Tzispa
 
       attr_reader :domain, :cfname
 
-      def initialize(domain, configname=nil)
+      def initialize(domain)
         @domain = domain
-        @cfname = configname || CONFIG_FILENAME
         @cftime = nil
       end
 
       def filename
-        @filename ||= "#{domain.path}/config/#{cfname}.yml".freeze
+        @filename ||= "config/#{domain.name}.yml"
       end
 
       def load!
@@ -45,6 +44,7 @@ module Tzispa
           cfg['default_encoding'] = 'utf-8'
           cfg['auth_required'] = false
           cfg['salt'] = secret(24)
+          cfg['secret'] = secret(36)
           cfg['locales'] = Hash.new.tap { |loc|
             loc['preload'] = true
             loc['default'] = locale

data/lib/tzispa/controller/api.rb

@@ -17,13 +17,10 @@ module Tzispa
 
       include Tzispa::Helpers::Response
 
-      attr_reader :handler
 
       def self.generate_handler(domain, name)
-        @domain = domain
-        @handler_name = name
         raise "The handler '#{name}' already exist" if File.exist?(handler_class_file)
-        File.open(handler_class_file, "w") { |f|
+        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
@@ -39,81 +36,76 @@ module Tzispa
         }
       end
 
-
       def dispatch!
-        @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]
-        @handler = handler_class.new(context)
-        handler.call @verb, @predicate
-        context.flash << handler.message
-        send handler.response_verb if handler.response_verb
+        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]
+        handler = self.class.handler_class(domain, handler_name).new(context)
+        handler.call verb, predicate
+        send(handler.response_verb, handler) if handler.response_verb
         response.finish
       end
 
-      def redirect
-        url = if handler.data && !handler.data.strip.empty?
-          handler.data.start_with?('#') ? "#{request.referer}#{handler.data}" : handler.data
+      def redirect(target)
+        url = if target.data && !target.data.strip.empty?
+          target.data.start_with?('#') ? "#{request.referer}#{target.data}" : target.data
         else
           request.referer
         end
+        context.flash << target.message if config.sessions&.enabled
         context.redirect url, config.absolute_redirects, response
       end
 
-      def html
-        response.body << handler.data
+      def html(content)
         content_type :htm
-        set_action_headers
+        response.body << content.data
+        set_api_headers content.status
       end
 
-      def json
-        if handler.data.is_a?(::Hash)
-          data = handler.data
-          data[:__result_status] = handler.status
-          data[:__result_message] = handler.message
-        else
-          data = JSON.parse(handler.data)
-        end
-        response.body << data.to_json
+      def json(content)
         content_type :json
-        set_action_headers
+        data = ::Hash === content.data || ::Array === content.data ? content.data : JSON.parse(content.data)
+        response.body << data.to_json
+        set_api_headers content.status
       end
 
-      def text
-        response.body << handler.data
+      def text(content)
         content_type :text
-        set_action_headers
+        response.body << content.data
+        set_api_headers content.status
       end
 
-      def download
-        send_file handler.data[:path], handler.data
+      def download(content)
+        send_file content.data[:path], content.data
       end
 
-      def handler_class_name
-        "#{TzString.camelize @handler_name}Handler"
-      end
+      class << self
 
-      def handler_class_file
-        "#{@domain.path}/api/#{@handler_name}.rb"
-      end
+        def handler_class_name(handler_name)
+          "#{TzString.camelize handler_name}Handler"
+        end
 
-      def handler_namespace
-        "#{TzString.camelize @domain.name }::Api"
-      end
+        def handler_class_file(domain, handler_name)
+          "#{domain.path}/api/#{handler_name}.rb"
+        end
 
-      def handler_class
-        @domain.require "api/#{@handler_name}"
-        TzString.constantize "#{handler_namespace}::#{handler_class_name}"
-      end
+        def handler_namespace(domain)
+          "#{TzString.camelize domain.name }::Api"
+        end
 
+        def handler_class(domain, handler_name)
+          domain.require "api/#{handler_name}"
+          TzString.constantize "#{handler_namespace domain}::#{handler_class_name handler_name}"
+        end
 
-      private
+      end
 
+      private
 
-      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'] = "#{handler.status}"
+      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}"
       end
 
     end

data/lib/tzispa/controller/signed_api.rb

@@ -5,25 +5,8 @@ require 'tzispa/helpers/security'
 module Tzispa
   module Controller
     class SignedApi < Api
-
-      include Tzispa::Helpers::Security
-
-
-      def dispatch!
-        raise Error::InvalidSign.new unless sign?
-        super        
-      end
-
-      private
-
-      def sign?
-        context.router_params[:sign] == sign_array([
-           context.router_params[:handler],
-           context.router_params[:verb],
-           context.router_params[:predicate]
-          ],
-          context.app.config.salt)
-      end
+      
+      # deprecated !!
 
     end
   end

data/lib/tzispa/http/context.rb

@@ -125,6 +125,11 @@ module Tzispa
         end
       end
 
+      def path_sign?(sign, *args)
+        sign == sign_array(args, config.salt)
+      end
+
+
     end
 
   end

data/lib/tzispa/routes.rb

@@ -55,7 +55,7 @@ module Tzispa
     end
 
     def route_rig_signed_api(path, controller: nil, methods: nil)
-      routing :sapi, path, controller || 'signed_api:dispatch!', methods: methods
+      routing :sapi, path, controller || 'api:dispatch!', methods: methods
     end
 
     def route_rig_layout(layout, path, controller: nil, methods: nil)

data/lib/tzispa/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Tzispa
-  VERSION = '0.5.10'
+  VERSION = '0.5.11'
   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.10
+  version: 0.5.11
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -174,7 +174,6 @@ files:
 - lib/tzispa/controller/http_error.rb
 - lib/tzispa/controller/layout.rb
 - lib/tzispa/controller/signed_api.rb
-- lib/tzispa/data/entity.rb
 - lib/tzispa/domain.rb
 - lib/tzispa/http/context.rb
 - lib/tzispa/http/request.rb

data/lib/tzispa/data/entity.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'tzispa/utils/string'
-
-module Tzispa
-  module Data
-    module Entity
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      def entity!
-        @__entity || @__entity = self.class.entity_class.new(self)
-      end
-
-      module ClassMethods
-        def entity_class
-          class_variable_defined?(:@@__entity_class) ?
-            class_variable_get(:@@__entity_class) :
-            class_variable_set(:@@__entity_class, TzString.constantize("#{self}Entity") )
-        end
-      end
-
-      #unless model_class.respond_to?(:entity_class!)
-      #  model_class.send(:define_singleton_method, :entity_class) {
-      #    class_variable_defined?(:@@__entity_class) ?
-      #      class_variable_get(:@@__entity_class) :
-      #      class_variable_set(:@@__entity_class, TzString.constantize("#{self}Entity") )
-      #  }
-      #end
-      #model_class.send(:define_method, :entity!) {
-      #  instance_variable_defined?(:@__entity) ?
-      #    instance_variable_get(:@__entity) :
-      #    instance_variable_set(:@__entity, self.class.entity_class!.new(self))
-      #}
-
-    end
-  end
-end