charyf 0.1.1

checksums.yaml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/Charyf/#{repo_name}" }
+
+# Specify your gem's dependencies in charyf.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    charyf (0.1.1)
+      charyf_sig (~> 1.1.2)
+      colorize (~> 0.8)
+      i18n (~> 0.9)
+      thor (>= 0.18.1, < 2.0)
+
+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)
+      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)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    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
+
+DEPENDENCIES
+  bundler (~> 1.15.4)
+  charyf!
+  pry (~> 0.10)
+  rails
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Richard Ludvigh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# Charyf
+
+Charyf (as **Cha**tbot **r**ub**y** **f**ramework) is a modular chatbot framework library.  
+The main purpose is to provide functional and easy to use way to define intents, responses and to model the conversation.
+
+Charyf isolates developers from internals such as routing, dispatching, rendering and handling sessions, to maintain focus on the application logic and the dialogue flow.
+
+
+For more information about using charyf, continue to [Getting Started](https://github.com/Charyf/charyf-core/wiki/Getting-Started)
+
+***
+
+**Charyf** is still in early stages of development. Be aware that current version still has limited features and may contain unidentified bugs.
+
+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)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/charyf-debug

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# require_relative '../lib/charyf'
+# require_relative '../lib/charyf/utils/commands'
+require_relative '../lib/charyf'
+require_relative '../lib/charyf/utils/cli'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "charyf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/charyf.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'charyf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'charyf'
+  spec.version       = Charyf::VERSION::STRING
+  spec.authors       = ['Richard Ludvigh']
+  spec.email         = ['richard.ludvigh@gmail.com']
+
+  spec.summary       = 'Your favorite modular chatbot ruby framework'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/Charyf/charyf-core'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.1'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = Dir['**/*'].reject do |f|
+    f.match(%r{^(test|spec|features|pkg)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  # Internal dependencies
+  spec.add_runtime_dependency 'charyf_sig', '~> 1.1.2'
+
+  # External dependencies
+  spec.add_runtime_dependency 'i18n', '~> 0.9'
+  spec.add_runtime_dependency 'colorize', '~> 0.8'
+  spec.add_runtime_dependency 'thor', '>= 0.18.1', '< 2.0'
+
+  # Development dependencies
+  spec.add_development_dependency 'bundler', '~> 1.15.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/exe/charyf

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "charyf/utils/cli"

data/lib/charyf/deps.rb

@@ -0,0 +1,9 @@
+# Signature checking
+if %w(development test).include?((ENV['CHARYF_ENV'] || 'development').downcase) || ENV['ENABLE_SIG']
+  require 'charyf_sig'
+  else
+  require 'charyf_sig/none'
+end
+
+# I18n
+require 'i18n'

data/lib/charyf/engine/all.rb

@@ -0,0 +1,22 @@
+require_relative 'controller/controller'
+
+require_relative 'dispatcher/base'
+require_relative 'dispatcher/default'
+
+require_relative 'intent/intent'
+require_relative 'intent/processors/processor'
+require_relative 'intent/processors/dummy'
+
+require_relative 'interface/interface'
+require_relative 'interface/program'
+
+require_relative 'session/session'
+require_relative 'session/processors/processor'
+require_relative 'session/processors/default'
+
+require_relative 'skill/skill'
+
+require_relative 'charyf'
+require_relative 'context'
+require_relative 'request'
+require_relative 'response'

data/lib/charyf/engine/charyf.rb

@@ -0,0 +1,5 @@
+# Dependency on utils
+require_relative '../utils'
+
+module Charyf
+end

data/lib/charyf/engine/context.rb

@@ -0,0 +1,61 @@
+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
+
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Charyf
+  module Controller
+    module Actions
+
+      class InvalidDefinitionError < StandardError; end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        def before_action(method_name, only: [], except: [])
+          (@_before_actions ||= {})[method_name] = Charyf::Utils.create_action_filters(only, except)
+        end
+
+        def _before_actions(action)
+          (@_before_actions || {}).select { |_,v| Charyf::Utils.match_action_filters?(action.to_sym, v) }.keys
+        end
+
+      end # End of ClassMethods
+
+      def logger
+        Charyf.logger
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require_relative '../../utils'
+
+require_relative '../response'
+require_relative 'renderers'
+require_relative 'conversation'
+require_relative 'helpers'
+require_relative 'actions'
+
+module Charyf
+  module Controller
+    class Base
+
+      include Renderers
+      include Helpers
+      include Actions
+
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+      end
+
+      def unknown
+        reply text: "I don't know what you meant by '#{request.text}'"
+      end
+
+      protected
+
+      sig [{text: ['String','NilClass'], render: ['Symbol', 'String', 'NilClass']}], nil,
+      def reply(
+          text: nil,
+          html: nil,
+          render: nil
+      )
+
+        if text.blank? && html.blank?
+          render ||= intent.action
+          ensure_responses_for(render)
+        end
+
+        if response_folder
+          text ||= render_text_response(render)
+          html ||= render_html_response(render)
+        end
+
+        response = Charyf::Engine::Response.new(text, html)
+
+
+        Charyf.logger.flow_response("[FLOW] Replying on request [#{request.inspect}]" +
+                                    " with [#{response.inspect}]"
+        )
+
+        request.referer.reply(conversation_id, response)
+      end
+
+      def conversation_id
+        request.conversation_id
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module Charyf
+  module Controller
+    module Conversation
+
+      class InvalidDefinitionError < StandardError; end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # def auto_keep_conversation(only: [], except: [])
+        #   if only && !only.empty? && except && !except.empty?
+        #     raise InvalidDefinitionError.new("Define only or except, don't define both");
+        #   end
+        #
+        #   @_converse_on = (except && !except.empty?) ? :all : only.map(&:to_sym)
+        #   @_dont_converse_on = except.map(&:to_sym)
+        # end
+        #
+        # def _converse_on?(action)
+        #   (@_converse_on == :all && !@_dont_converse_on.include?(action.to_sym)) ||
+        #       ((@_converse_on != :all) && (@_converse_on || []).include?(action.to_sym))
+        # end
+
+      end # End of ClassMethods
+
+      # def init_machine(machine)
+      #
+      # end
+
+      # def keep_conversation(controller: nil, action: nil, store: Hash.new)
+      #   session = @context.session || Charyf::Engine::Session.init(request.id, intent.skill)
+      #
+      #   if action
+      #     controller ||= controller_name
+      #     session.route_to(controller, action)
+      #   end
+      #
+      #   unless store.empty?
+      #     store.each do |k,v|
+      #       session.storage.store(k, v)
+      #     end
+      #   end
+      #
+      #   session.keep!
+      # end
+      #
+      # def end_conversation
+      #   session.invalidate! if session
+      #
+      #   nil
+      # end
+
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Charyf
+  module Controller
+    module Helpers
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+      end # End of ClassMethods
+
+      def controller_name
+        context.controller_name
+      end
+
+      def action_name
+        context.action_name
+      end
+
+      def skill_name
+        context.skill_name
+      end
+
+      def request
+        context.request
+      end
+
+      def session
+        context.session
+      end
+
+      def intent
+        context.intent
+      end
+
+    end
+  end
+end