charyf 0.1.1 → 0.2.5

data/lib/charyf/engine/interface/interface.rb

@@ -5,31 +5,38 @@ require_relative '../dispatcher/base'
 
 module Charyf
   module Interface
+
+    extend Charyf::Strategy::OwnerClass
+
     class Base
 
-      include Charyf::Strategy
-      def self.base
-        Base
-      end
+      include Charyf::Strategy::BaseClass
 
-      sig_self [], 'Charyf::Engine::Dispatcher::Base',
-      def self.dispatcher
-        Charyf.application.dispatcher.new
-      end
+      class << self
 
-      sig_self ['String', 'Charyf::Engine::Response'], nil,
-      def self.reply(conversation_id, response)
-        raise Charyf::Utils::NotImplemented.new
-      end
+        def dispatcher
+          Charyf.application.dispatcher.new
+        end
 
-    end
+        def reply(conversation_id, message_id, response)
+          raise Charyf::Utils::NotImplemented.new
+        end
 
-    def self.known
-      Base.known
-    end
+        def start
+          raise Charyf::Utils::NotImplemented.new
+        end
+
+        def stop
+          raise Charyf::Utils::NotImplemented.new
+        end
+
+        # If stop does not finish till required timeout
+        # Terminate is called
+        def terminate
+          raise Charyf::Utils::NotImplemented.new
+        end
+      end
 
-    def self.list
-      Base.list
     end
   end
 end

data/lib/charyf/engine/interface/program.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 require_relative 'interface'
 require_relative '../request'
 
@@ -11,6 +13,18 @@ module Charyf
 
       attr_reader :handler, :conversation_id
 
+      def self.start
+        # NOP
+      end
+
+      def self.stop
+        # NOP
+      end
+
+      def self.terminate
+        # NOP
+      end
+
       sig_self ['String', 'Charyf::Engine::Response'], nil,
       def self.reply(conversation_id, response)
         interface = _interfaces[conversation_id]
@@ -51,7 +65,7 @@ module Charyf
 
       sig [], 'Charyf::Engine::Request',
       def request
-        Charyf::Engine::Request.new(self.class, conversation_id)
+        Charyf::Engine::Request.new(self.class, conversation_id, SecureRandom.hex)
       end
 
     end

data/lib/charyf/engine/request.rb

@@ -4,27 +4,15 @@ module Charyf
 
       attr_accessor :text
 
+      attr_reader :referer, :conversation_id, :message_id
+
+
       # Module -> anything of type Charyf::Interface::Base
-      sig ['Module', 'String'], nil,
-      def initialize(referer, conversation_id)
+      # sig ['Module', 'String'], nil,
+      def initialize(referer, conversation_id, message_id)
         @referer = referer
         @conversation_id = conversation_id
-      end
-
-      # Module -> Charyf::Interface::Base
-      sig [], 'Module',
-      def referer
-        @referer
-      end
-
-      sig [], 'String',
-      def conversation_id
-        @conversation_id
-      end
-
-      sig [], 'String',
-      def id
-        @referer.strategy_name.to_s + '_#_' + @conversation_id
+        @message_id = message_id
       end
 
     end

data/lib/charyf/engine/response.rb

@@ -3,39 +3,20 @@ module Charyf
     class Response
 
       attr_accessor :text, :html
+      attr_reader :conversation_id, :reply_message_id
 
-      sig [['String', 'NilClass'], ['String', 'NilClass']], nil,
-      def initialize(text, html)
-        @text = text
-        @html = html
+      def initialize(conversation_id, reply_message_id)
+        @text = nil
+        @html = nil
+
+        @conversation_id = conversation_id
+        @reply_message_id = reply_message_id
       end
 
       def empty?
         text.blank? && html.blank?
       end
 
-      # Attr methods for type-checking
-
-      sig ['String', 'NilClass'], ['String', 'NilClass'],
-      def text=(text)
-        @text = text
-      end
-
-      sig [], ['String', 'NilClass'],
-      def text
-        @text
-      end
-
-      sig ['String', 'NilClass'], ['String', 'NilClass'],
-      def html=(html)
-        @html = html
-      end
-
-      sig [], ['String', 'NilClass'],
-      def html
-        @html
-      end
-
     end
   end
 end

data/lib/charyf/engine/routing/default.rb

@@ -0,0 +1,58 @@
+require_relative 'router'
+
+module Charyf
+  module Engine
+    module Routing
+      class Default < Base
+
+        class InvalidRoute < StandardError; end
+
+        strategy_name :default
+
+        def initialize
+          @routes = {
+              Charyf::Engine::Intent.unknown.name => unknown
+          }
+        end
+
+        def draw(&block)
+          instance_eval &block
+        end
+
+        # Context -> Controller
+        def process(context)
+          @routes[context.intent.name.downcase] || invalid
+        end
+
+        def route(intent, to: nil)
+          raise InvalidRoute.new("route '#{intent}' missing to definition") if to.nil?
+
+          @routes[intent.downcase] = parse_target(to)
+        end
+
+        private
+
+        def parse_target(to)
+          if to.is_a? Hash
+            raise InvalidRoute.new("route '#{intent}' incomplete to definition") unless to.keys.map(&:to_sym) & [:skill, :controller, :action] == [:skill, :controller, :action]
+
+            return Result.new(to[:skill], to[:controller], to[:action])
+          end
+
+          if to.is_a? String
+            path, action = to.split("#")
+            path = path.split("/")
+
+            skill = path.delete_at(0)
+            controller = path.join("/")
+
+            return Result.new(skill, controller, action)
+          end
+
+          raise InvalidRoute.new("Unknown definition  to:#{to}")
+        end
+
+      end
+    end
+  end
+end

data/lib/charyf/engine/routing/result.rb

@@ -0,0 +1,25 @@
+module Charyf
+  module Engine
+    module Routing
+      class Result
+
+        attr_reader :skill, :controller, :action
+
+        def initialize(skill, controller, action)
+          @skill = skill
+          @controller = controller
+          @action = action
+        end
+
+        def controller_class_name
+          [skill, controller.split("/")].flatten.compact.map(&:to_s).map(&:camelize).join("::") + "Controller"
+        end
+
+        def skill_class_name
+          skill.to_s.camelize if skill
+        end
+
+      end
+    end
+  end
+end

data/lib/charyf/engine/routing/router.rb

@@ -0,0 +1,33 @@
+require_relative 'result'
+
+module Charyf
+  module Engine
+    module Routing
+
+      extend Charyf::Strategy::OwnerClass
+
+      class Base
+
+        include Charyf::Strategy::BaseClass
+
+        def draw(&block)
+          raise Charyf::Utils::NotImplemented.new
+        end
+
+        # Context -> Controller
+        def process(context)
+          raise Charyf::Utils::NotImplemented.new
+        end
+
+        def unknown
+          Result.new(nil, 'skill', 'unknown')
+        end
+
+        def invalid
+          Result.new(nil, 'skill', 'invalid')
+        end
+
+      end
+    end
+  end
+end

data/lib/charyf/engine/session/processors/processor.rb

@@ -4,13 +4,12 @@ module Charyf
   module Engine
     class Session
       module Processor
-        class Base
 
-          include Charyf::Strategy
-          def self.base
-            Base
-          end
+        extend Charyf::Strategy::OwnerClass
 
+        class Base
+
+          include Charyf::Strategy::BaseClass
 
           sig ['Charyf::Engine::Request'], ['Charyf::Engine::Session', 'NilClass'],
           def process(request)
@@ -23,16 +22,6 @@ module Charyf
           end
 
         end
-
-
-        def self.known
-          Base.known
-        end
-
-        def self.list
-          Base.list
-        end
-
       end
     end
   end

data/lib/charyf/engine/skill/skill.rb

@@ -1,11 +1,9 @@
-require_relative 'routing'
 require_relative 'info'
 
 module Charyf
   module Skill
     class Base
 
-      include Charyf::Skill::Routing
       include Charyf::Skill::Info
 
       class << self

data/lib/charyf/utils/all.rb

@@ -8,6 +8,7 @@ require_relative 'charyf'
 require_relative 'error_handler'
 require_relative 'initializable'
 require_relative 'logger'
-require_relative 'machine'
-require_relative 'strategy'
+require_relative 'pipeline'
+require_relative 'strategy/owner_class'
+require_relative 'strategy/base_class'
 require_relative 'utils'

data/lib/charyf/utils/app_engine.rb

@@ -20,5 +20,33 @@ module Charyf
       self
     end
 
+    def start_interfaces
+      Charyf::Interface.known.map(&:start)
+    end
+
+    def start_pipeline
+
+      begin
+        loop do
+          request = Charyf::Pipeline.dequeue
+
+          Charyf.application.dispatcher.new.dispatch(request)
+        end
+
+      rescue Exception => e
+        if e.is_a? Interrupt
+          puts "\n\nExiting ...\n"
+        elsif e.message =~ /No live threads left./
+          raise "No interfaces are available. The server will now exit."
+        else
+          puts e
+          puts e.backtrace
+          Charyf.application.config.error_handlers.handle_exception(e)
+          raise e
+        end
+      end
+
+    end
+
   end
 end

data/lib/charyf/utils/application/bootstrap.rb

@@ -8,29 +8,6 @@ module Charyf
     # noinspection RubyResolve
     module Bootstrap
 
-      class SkillLoadError < StandardError
-        def initialize(e, skill_name, skill_path)
-          super(e)
-
-          @_name = skill_name
-          @_path = skill_path.dirname
-        end
-
-        def message
-          _message + super
-        end
-
-        def _message
-          <<-EOS
-          
-          Unable to load skill #{@_name}
-          Expected to find: '#{@_name}.rb'
-                Located at: '#{@_path}'
-
-EOS
-        end
-      end
-
       include Charyf::Initializable
 
       class InitializationError < StandardError; end
@@ -46,13 +23,18 @@ EOS
         env_file = self.config.root.join('config', 'environments', "#{Charyf.env}.rb")
 
         if FileTest.exists?(env_file)
-          require env_file
+          require env_file.to_s
         end
+
+        require self.config.root.join('config', 'routes.rb').to_s
       end
 
       initializer :set_load_paths, group: :all do
-        libdir = File.expand_path(self.config.root.join('lib'))
-        $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+        [
+            File.expand_path(self.config.root)
+        ].each do |libdir|
+          $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+        end
       end
 
       #
@@ -69,6 +51,7 @@ EOS
         Charyf.application.session_processor
         Charyf.application.intent_processors
         Charyf.application.dispatcher
+        Charyf.application.routing
       end
 
       #
@@ -94,60 +77,36 @@ EOS
         # Require skill level files
         Charyf::Utils.require_recursive self.config.root.join('app', 'skills'),
                                         condition: condition
-
-        # Require controllers
-        Charyf::Skill.list.each do |skill_klass|
-          # Load initializers
-          root = skill_klass.skill_root
-
-          Dir[root.join('controllers', '**', '*.rb')].each do |controller|
-            require controller
-          end
-        end
       end
 
       #
-      # Load all intents
+      # Load skill controllers
       #
-      initializer :load_skill_intents, groups: :all do
-        # Require Skill intents
-        Charyf::Skill.list.each do |skill_klass|
-          Dir[skill_klass.routing_source_dir.join('**', '*.rb')].each do |file|
-            require file
-          end
-        end
+      initializer :load_skill_controllers, group: :all do
 
         Charyf::Skill.list.each do |skill_klass|
-          skill_name = skill_klass.skill_name
-
-          Charyf.application.intent_processors.each do |processor|
-            # Public routing
-            skill_klass._public_routing(processor.strategy_name).each do |block|
-              processor.get_global.load skill_name, block
-            end
 
-            # Private routing
-            skill_klass._private_routing(processor.strategy_name).each do |block|
-              processor.get_for(skill_name).load skill_name, block
-            end
+          # Load controllers
+          root = skill_klass.skill_root
 
+          Dir[root.join('controllers', '**', '*.rb')].each do |controller|
+            require controller
           end
+
         end
       end
 
       #
-      # Load all user skill files
-      #  - controllers
+      # Load skill initializers
       #
-      initializer :load_skill_controllers, group: :all do
-
+      initializer :initialize_skills, group: :all do
         Charyf::Skill.list.each do |skill_klass|
 
           # Load controllers
           root = skill_klass.skill_root
 
-          Dir[root.join('controllers', '**', '*.rb')].each do |controller|
-            require controller
+          Dir[root.join('initializers', '**', '*.rb')].each do |initializer|
+            require initializer
           end
 
         end
@@ -157,7 +116,7 @@ EOS
       # Load user initializer files
       #
       initializer :run_initializers, group: :all do
-        Dir[self.config.root.join('config', 'initializers', '**', '**.rb')].each do |initializer|
+        Dir[self.config.root.join('config', 'initializers', '**', '*.rb')].each do |initializer|
           require initializer
         end
 

data/lib/charyf/utils/application/configuration.rb

@@ -9,7 +9,7 @@ module Charyf
 
       attr_accessor :console
 
-      attr_accessor :session_processor, :storage_provider, :dispatcher
+      attr_accessor :session_processor, :storage_provider, :dispatcher, :router
       attr_accessor :enabled_intent_processors
 
       def initialize(root)
@@ -26,22 +26,22 @@ module Charyf
         Charyf::ErrorHandlers
       end
 
-      sig [], ['Symbol', 'NilClass'],
+      def router
+        (@router || 'default').to_sym
+      end
+
       def dispatcher
         (@dispatcher || 'default').to_sym
       end
 
-      sig [], ['Symbol'],
       def session_processor
         (@session_processor || 'default').to_sym
       end
 
-      sig [], [Array],
       def enabled_intent_processors
         (@enabled_intent_processors || []).map(&:to_sym)
       end
 
-      sig [], ['Symbol', 'NilClass'],
       def storage_provider
         @storage_provider ? @storage_provider.to_sym : nil
       end

data/lib/charyf/utils/application.rb

@@ -41,7 +41,7 @@ module Charyf
 
     end
 
-    def initialize!(group: :default)
+    def initialize!(group = :default)
       return self if @initialized
       @initialized = true
 
@@ -110,6 +110,18 @@ module Charyf
       klass
     end
 
+    def routing
+      klass = Charyf::Engine::Routing.list[config.router]
+
+      raise Charyf::Utils::InvalidConfiguration.new("No router with name '#{config.router}' found") unless klass
+
+      klass
+    end
+
+    def routes
+      @routes ||= routing.new
+    end
+
     protected
 
     def run_generators_blocks(app) #:nodoc:
@@ -118,7 +130,8 @@ module Charyf
     end
 
     def initializers
-      Bootstrap.initializers_for(self)
+      Bootstrap.initializers_for(self) +
+          (extensions.map { |e| e.class.initializers_for(self) }.flatten)
     end
 
     private

data/lib/charyf/utils/command/actions.rb

@@ -8,10 +8,10 @@ module Charyf
       #   Dir.chdir(File.expand_path("../..", APP_PATH)) unless File.exist?(File.expand_path("config.ru"))
       # end
 
-      def require_application_and_environment!
+      def require_application_and_environment!(group = :default)
         if defined?(APP_PATH)
           require APP_PATH
-          Charyf.application.initialize!
+          Charyf.application.initialize!(group)
         end
       end
 
@@ -19,6 +19,14 @@ module Charyf
         Charyf.application.load_generators
       end
 
+      def start_interfaces!
+        Charyf.application.start_interfaces
+      end
+
+      def start_pipeline!
+        Charyf.application.start_pipeline
+      end
+
     end
   end
 end

data/lib/charyf/utils/commands/all.rb

@@ -4,3 +4,4 @@ require_relative 'console/console_command'
 require_relative 'generate/generate_command'
 require_relative 'destroy/destroy_command'
 require_relative 'help/help'
+require_relative 'server/server_command'

data/lib/charyf/utils/commands/cli/cli_command.rb

@@ -59,6 +59,10 @@ module Charyf
     end
 
     def detect(utterance)
+      if !utterance || utterance.empty?
+        return
+      end
+
       if utterance[0] == ':'
         process_command utterance[1..-1]
         return
@@ -67,7 +71,14 @@ module Charyf
       request = @interface.request
       request.text = utterance
 
-      @interface.process(request)
+      res = @interface.process(request)
+
+      if res[:status] == :NOK && res[:response].is_a?(Exception)
+        e = res[:response]
+        puts ''
+        puts e.inspect
+        puts "\t" + e.backtrace.join("\n\t")
+      end
     end
 
 

data/lib/charyf/utils/commands/help/USAGE

@@ -3,6 +3,8 @@ The most common Charyf commands are:
  cli          Start the Charyf command line interface. Command line
               interface allows to chat with charyf application on
               the base of text messages.
+ server       Start the charyf server with all interfaces
+              (short-cut alias: "s")
 
 All commands can be run with -h (or --help) for more information.
 In addition to those commands, there are: