charyf 0.1.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f6cd1074674be31d7a9551c96c778d039a6f73e
-  data.tar.gz: 980dbf8c8a5da5bab08be6f2f8e338c50f87dfc5
+  metadata.gz: efad5ad87a312bfef51179279205bfe5b60585d5
+  data.tar.gz: ac9413d5cbf58b5bd492cd9e62b22d7045ca21d6
 SHA512:
-  metadata.gz: b8bc6dfa44d70033e22587490d88f3374b1377bf43f2fc4843d0549abb63bed4a7698044935e480fb0390de32d38e972c8724a522f19a7bae7a3e12571f48dcc
-  data.tar.gz: 397067fb3ade945d097759617ac7f81548f87ab003ae66e2286e5b882f08006e9e80786706b91b25097368193f6bd5e08bd8a6bd3ad872e011b4b37a1a08998f
+  metadata.gz: d05a975f29957417fad8da4b6d805bd93ce0f90fdeecc5af6ce462142461546f7b2dec294c35b5e84cd25c906bae7e6eb7d9ea2797d82f8eb1ea27f0b07e73db
+  data.tar.gz: 3bb190b57931d0b6bcd75a3f6c579e10d233450d41e10d6aeccc37b597a00aebec9b76d52a2d69e2232f2645c22e39022fd7458648f89d98406678007636754d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    charyf (0.1.1)
+    charyf (0.2.5)
       charyf_sig (~> 1.1.2)
       colorize (~> 0.8)
       i18n (~> 0.9)
@@ -10,97 +10,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.4)
-      actionpack (= 5.1.4)
-      nio4r (~> 2.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.4)
-      activesupport (= 5.1.4)
-      globalid (>= 0.3.6)
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activerecord (5.1.4)
-      activemodel (= 5.1.4)
-      activesupport (= 5.1.4)
-      arel (~> 8.0)
-    activesupport (5.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
-    builder (3.2.3)
     charyf_sig (1.1.2)
     coderay (1.1.2)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
-    crass (1.0.3)
     diff-lcs (1.3)
-    erubi (1.7.0)
-    globalid (0.4.1)
-      activesupport (>= 4.2.0)
-    i18n (0.9.1)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.1.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.0)
-      mini_mime (>= 0.1.1)
     method_source (0.9.0)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
-    minitest (5.10.3)
-    nio4r (2.2.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.3)
-    rack-test (0.8.2)
-      rack (>= 1.0, < 3)
-    rails (5.1.4)
-      actioncable (= 5.1.4)
-      actionmailer (= 5.1.4)
-      actionpack (= 5.1.4)
-      actionview (= 5.1.4)
-      activejob (= 5.1.4)
-      activemodel (= 5.1.4)
-      activerecord (= 5.1.4)
-      activesupport (= 5.1.4)
-      bundler (>= 1.3.0)
-      railties (= 5.1.4)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -114,29 +34,8 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-rails (3.7.2)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    sprockets (3.7.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
     thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby
@@ -145,10 +44,8 @@ DEPENDENCIES
   bundler (~> 1.15.4)
   charyf!
   pry (~> 0.10)
-  rails
   rake (~> 10.0)
   rspec (~> 3.0)
-  rspec-rails
 
 BUNDLED WITH
    1.15.4

data/README.md

@@ -1,3 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/charyf.svg)](https://badge.fury.io/rb/charyf)
+
+[![Code Climate](https://codeclimate.com/github/Charyf/charyf-core/badges/gpa.svg)](https://codeclimate.com/github/Charyf/charyf-core) 
+[![Test Coverage](https://codeclimate.com/github/Charyf/charyf-core/badges/coverage.svg)](https://codeclimate.com/github/Charyf/charyf-core/coverage) 
+[![Issue Count](https://codeclimate.com/github/Charyf/charyf-core/badges/issue_count.svg)](https://codeclimate.com/github/Charyf/charyf-core)
+
 # Charyf
 
 Charyf (as **Cha**tbot **r**ub**y** **f**ramework) is a modular chatbot framework library.  
@@ -15,4 +21,4 @@ For more information about using charyf, continue to [Getting Started](https://g
 To read more about roadmap continue to [Roadmap](https://github.com/Charyf/charyf-core/wiki/Roadmap)  
 To report an issue follow steps in [Reporting an issue](https://github.com/Charyf/charyf-core/wiki/Reporting-an-issue)
 
-Continue to [wiki](https://github.com/Charyf/charyf-core/wiki)
+Continue to [wiki](https://github.com/Charyf/charyf-core/wiki)

data/lib/charyf/engine/all.rb

@@ -14,6 +14,9 @@ require_relative 'session/session'
 require_relative 'session/processors/processor'
 require_relative 'session/processors/default'
 
+require_relative 'routing/router'
+require_relative 'routing/default'
+
 require_relative 'skill/skill'
 
 require_relative 'charyf'

data/lib/charyf/engine/context.rb

@@ -2,59 +2,7 @@ module Charyf
   module Engine
     class Context
 
-      sig ['Charyf::Engine::Request'],'Charyf::Engine::Request',
-      def request=(request)
-        @_request = request
-      end
-
-      sig [], 'Charyf::Engine::Request',
-      def request
-        @_request
-      end
-
-      sig [['Charyf::Engine::Intent', 'NilClass']],['Charyf::Engine::Intent', 'NilClass'],
-      def intent=(intent)
-        @_intent = intent
-      end
-
-      sig [], ['Charyf::Engine::Intent', 'NilClass'],
-      def intent
-        @_intent
-      end
-
-      sig [['Charyf::Engine::Session', 'NilClass']],['Charyf::Engine::Session', 'NilClass'],
-      def session=(session)
-        @_session = session
-      end
-
-      sig [], ['Charyf::Engine::Session', 'NilClass'],
-      def session
-        @_session
-      end
-
-      def controller_name
-        session && session.action ?
-            session.controller :
-            intent.controller
-      end
-
-      def full_controller_name
-        session && session.action ?
-            session.full_controller_name :
-            intent.full_controller_name
-      end
-
-      def action_name
-        session && session.action ?
-            session.action :
-            intent.action
-      end
-
-      def skill_name
-        session && session.skill ?
-            session.skill :
-            intent.skill
-      end
+      attr_accessor :request, :intent, :alternative_intents, :session, :routing
 
     end
   end

data/lib/charyf/engine/controller/controller.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 require_relative '../../utils'
 
 require_relative '../response'
@@ -34,7 +36,7 @@ module Charyf
       )
 
         if text.blank? && html.blank?
-          render ||= intent.action
+          render ||= action_name
           ensure_responses_for(render)
         end
 
@@ -43,8 +45,9 @@ module Charyf
           html ||= render_html_response(render)
         end
 
-        response = Charyf::Engine::Response.new(text, html)
-
+        response = Charyf::Engine::Response.new(conversation_id, SecureRandom.hex)
+        response.text = text
+        response.html = html
 
         Charyf.logger.flow_response("[FLOW] Replying on request [#{request.inspect}]" +
                                     " with [#{response.inspect}]"

data/lib/charyf/engine/controller/helpers.rb

@@ -10,15 +10,19 @@ module Charyf
       end # End of ClassMethods
 
       def controller_name
-        context.controller_name
+        context.routing.controller
       end
 
       def action_name
-        context.action_name
+        context.routing.action
       end
 
       def skill_name
-        context.skill_name
+        skill.skill_name
+      end
+
+      def skill
+        context.routing.skill_class_name.nil? ? nil : context.routing.skill_class_name.constantize
       end
 
       def request

data/lib/charyf/engine/controller/renderers.rb

@@ -32,9 +32,9 @@ module Charyf
 
       # TODO sig
       def response_folder
-        return nil if skill_name.to_s.blank?
+        return nil if skill.nil?
 
-        return skill_name.to_s.constantize.skill_root.join('responses', controller_path)
+        return skill.skill_root.join('responses', controller_path)
       end
 
       def ensure_responses_for(action)

data/lib/charyf/engine/dispatcher/base.rb

@@ -6,24 +6,39 @@ require_relative '../request'
 module Charyf
   module Engine
     module Dispatcher
+
+      extend Charyf::Strategy::OwnerClass
+
       class Base
 
-        include Charyf::Strategy
-        def self.base
-          Base
-        end
+        include Charyf::Strategy::BaseClass
 
-        sig ['Charyf::Engine::Request'], nil,
         def dispatch(request)
-        end
+          status, response = dispatch_internal(request)
 
-        def self.setup
-          # Do your setup here
+          {
+              status: status,
+              response: response,
+              request: request
+          }
         end
 
+        def dispatch_async(request)
+          Charyf::Pipeline.enqueue request
+
+          {
+              status: :ASYNC,
+              request: request,
+              response: nil
+          }
+        end
 
         protected
 
+        def dispatch_internal(request)
+          raise Charyf::Utils::NotImplemented.new
+        end
+
         def self.intent_processors
           Charyf.application.intent_processors
         end
@@ -32,6 +47,10 @@ module Charyf
           Charyf.application.session_processor
         end
 
+        def self.routes
+          Charyf.application.routes
+        end
+
         def intent_processors
           self.class.intent_processors
         end
@@ -40,51 +59,48 @@ module Charyf
           self.class.session_processor
         end
 
+        def routes
+          self.class.routes
+        end
+
         sig ['Charyf::Engine::Context'], nil,
         def spawn_controller(context)
-          begin
-            prepare_context context
 
-            Charyf.logger.flow_request("[FLOW] Dispatching request [#{context.request.inspect}]" +
-                                        ", detected intent: [#{context.intent.inspect}]" +
-                                        ", session : [#{context.session.inspect}]"
-            )
+          Charyf.logger.flow_request("[FLOW] Dispatching request [#{context.request.inspect}]" +
+                                      ", detected intent: [#{context.intent.inspect}]" +
+                                      ", session : [#{context.session.inspect}]"
+          )
 
-            controller = get_controller(context)
+          controller = get_controller(context)
 
+          begin
             handle_before_actions(controller)
-            controller.send(context.action_name)
+            result = controller.send(get_action_name(context))
             handle_after_actions(controller)
+
+            return :OK, result
           rescue Exception => e
             # Dispatch the error to all error handlers
             Charyf.configuration.error_handlers.handle_exception(e)
-
             # Catch any error that may occur inside the user controller
-            controller.send(:reply, text: 'There was a problem processing your request. Check the logs please.')
+            # controller.send(:reply, text: 'There was a problem processing your request. Check the logs please.')
+
+            return :NOK, e
           end
 
         end
 
         private
 
-        def prepare_context(context)
-          context.intent ||= Charyf::Engine::Intent::UNKNOWN
-
-          context
-        end
-
         def get_controller(context)
-          controller_name = context.full_controller_name +  'Controller'
+          controller_name = context.routing.controller_class_name
 
-          Object.const_get(controller_name).new(context)
+          # Object.const_get(controller_name).new(context)
+          controller_name.constantize.new(context)
         end
 
         def get_action_name(context)
-          if context.session && context.session.action
-            return context.session.action
-          end
-
-          context.intent.action
+          context.routing.action
         end
 
         def handle_before_actions(controller)
@@ -107,15 +123,6 @@ module Charyf
         end
 
       end # End of Base.class
-
-      def self.known
-        Base.known
-      end
-
-      def self.list
-        Base.list
-      end
-
     end
   end
 end

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

@@ -7,11 +7,7 @@ module Charyf
 
         strategy_name :default
 
-        def self.setup
-
-        end
-
-        def dispatch(request)
+        def dispatch_internal(request)
           # Find if session exist for this request
 
           context = Charyf::Engine::Context.new
@@ -22,13 +18,11 @@ module Charyf
 
           # Get intents
           intents = intent_processors.collect do |processor_klass|
-            processor = processor_klass.get_for(context.session ? context.session.skill : nil)
+            processor = processor_klass.instance
 
             processor.determine(
                 request
             )
-          end.collect do |intent|
-            [intent, intent.alternatives].flatten
           end.flatten.sort_by do |intent|
             intent.confidence
           end.reverse
@@ -38,19 +32,15 @@ module Charyf
 
           # Return best match with alternatives
           if best_match
-            context.intent = Charyf::Engine::Intent.new(
-                best_match.skill,
-                best_match.controller,
-                best_match.action,
-                best_match.confidence,
-                best_match.matches,
-                intents
-            )
-
             context.intent = best_match
+            context.alternative_intents = intents
           end
 
-          # TODO
+          context.routing = routes.process(context)
+
+          # Freeze -> #TODO deep freeze
+          context.freeze
+
           spawn_controller(context)
         end
 

data/lib/charyf/engine/intent/intent.rb

@@ -2,53 +2,18 @@ module Charyf
   module Engine
     class Intent
 
-      sig [['Symbol', 'String', 'NilClass'], ['Symbol', 'String'], ['Symbol', 'String'], 'Numeric', 'Hash', 'Array'], nil,
-      def initialize(skill, controller, action, confidence, matches = Hash.new, alternatives = [])
-        @_skill = skill.to_s
-        @_controller = controller.to_s
-        @_action = action.to_s.downcase
-        @_confidence = confidence
-        @_matches = matches
-        @_alternatives = alternatives
-      end
-
-      sig [], 'Hash',
-      def matches
-        @_matches
-      end
-
-      sig [], 'Numeric',
-      def confidence
-        @_confidence
-      end
-
-      sig [], ['Symbol', 'String'],
-      def full_controller_name
-        @_skill.blank? ? @_controller.camelize : @_skill.camelize + '::' + @_controller.camelize
-      end
-
-      sig [], ['Symbol', 'String'],
-      def controller
-        @_controller
-      end
+      attr_reader :name, :confidence, :entities
 
-      sig [], ['Symbol', 'String'],
-      def action
-        @_action
+      def initialize(name, confidence, entities = Hash.new)
+        @name = name
+        @confidence = confidence
+        @entities = entities || {}
       end
 
-      sig [], 'Array',
-      def alternatives
-        @_alternatives
+      def self.unknown
+        Intent.new('charyf/unknown', 0)
       end
 
-      sig [], ['String', 'Symbol'],
-      def skill
-        @_skill
-      end
-
-      UNKNOWN = Intent.new(nil, :Skill, :unknown, 0)
-
     end
   end
 end

data/lib/charyf/engine/intent/processors/dummy.rb

@@ -11,18 +11,10 @@ module Charyf
 
           strategy_name :dummy
 
-          def self.get_for(skill_name = nil)
-            self.new
-          end
-
           def determine(request)
             unknown
           end
 
-          def load(skill_name, block)
-            nil
-          end
-
         end
       end
     end

data/lib/charyf/engine/intent/processors/helpers.rb

@@ -9,20 +9,10 @@ module Charyf
           end
 
           module ClassMethods
-
-            def scoped_name(skill_name, *args)
-              ([skill_name.to_s] + args).join('_')
-            end
-
-            def unscope_name(skill_name, name)
-              name.start_with?(skill_name.to_s) ? name.sub("#{skill_name.to_s}_", '') : name
-            end
-
           end # End of ClassMethods
 
-          sig [], 'Charyf::Engine::Intent',
           def unknown
-            Charyf::Engine::Intent::UNKNOWN
+            Charyf::Engine::Intent.unknown
           end
 
         end

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

@@ -7,49 +7,23 @@ module Charyf
   module Engine
     class Intent
       module Processor
+
+        extend Charyf::Strategy::OwnerClass
+
         class Base
 
-          include Charyf::Strategy
+          include Charyf::Strategy::BaseClass
           include Charyf::Engine::Intent::Processor::Helpers
 
-          def self.base
-            Base
+          def self.instance
+            @instance = self.new
           end
 
-          sig ['Charyf::Engine::Request'], 'Charyf::Engine::Intent',
           def determine(request)
             raise Charyf::Utils::NotImplemented.new
           end
 
-          #
-          # Load single block of intent definitions
-          #
-          sig_self ['Symbol', 'Proc'], nil,
-          def load(skill_name, block)
-            raise Charyf::Utils::NotImplemented.new
-          end
-
-          sig_self ['Symbol'], 'Charyf::Engine::Intent::Processor::Base',
-          def self.get_for(skill = nil)
-            raise Charyf::Utils::NotImplemented.new
-          end
-
-          sig_self [], 'Charyf::Engine::Intent::Processor::Base',
-          def self.get_global
-            get_for(nil)
-          end
-
-        end
-
-
-        def self.known
-          Base.known
-        end
-
-        def self.list
-          Base.list
         end
-
       end
     end
   end