adapt-charyf 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f8601022ff9f62ba29e03141606deb809bfa3a0
+  data.tar.gz: 8bd5cba22a6272d5ced8e1c4bcb9d297a938c15d
+SHA512:
+  metadata.gz: 3bbcd028c0d0b35885b459f7a738ab18b976afbb01c627553bfbb41d05247b394561c6931e703861222fe576087714a151445453a3d41a53ff756acf32d6166e
+  data.tar.gz: 28214649a4437c363f39f0274be2b2b0ca87dda4beae6f0483cce44268ae750c72c37cf7e56d6d4216a0a00fb6a8a8c98d5527c87fcd0419225a0d3dfacdcf4c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rvmrc
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at richard.ludvigh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

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,102 @@
+# Adapt-Charyf
+
+Adapt-Charyf is a ruby wrapper around Mycroft's Intent parser library [mycroft/Adapt](https://github.com/MycroftAI/adapt). This wrapper provides charyf interface to defining and determining intents.
+
+# Getting Started
+
+Add this line to your charyf application's Gemfile:
+
+```ruby
+gem 'adapt-chartf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adapt-charyf
+    
+Make sure the python library is installed
+```pip install -e git+https://github.com/mycroftai/adapt#egg=adapt-parser``` [or use pip3 if desired]
+
+Adapt-charyf uses ```pycall``` gem to handle python calls.
+
+## Usage
+
+When launching any ruby application using adapt-charyf, ensure that   
+```ENV['PYTHON'] = /path/to/python/with/adapt/libary```   
+is set to python version that has adapt-parser installed.
+
+Defining the intent is very similiar to original adapt library.
+
+### Entities
+
+Firstly we define entites that will occur in our utterances.
+
+**Register an keyword entity**
+
+```ruby
+Skill.public_routing_for :adapt do |routing|
+    routing.register_keywords 'greet', 'Hello', 'Hi'
+end
+```
+
+Keyword entity is defined by its name *greet* and followed by all phrases in this entity.
+For entity *greet* we define two works *Hi* and *Hello*.
+
+**Register regex entity**
+
+User may register regex entity as well. 
+
+```ruby
+Skill.public_routing_for :adapt do |routing|
+    routing.register_regex 'in (?P<location>.*)'
+end
+```
+
+Regex entity requires a regex with one named capture. This named capture is then used as the name of the entity.
+Example above defines new regex entity with name *location*.
+
+> Adapt regex entities use python's syntax as there is no current 1:1 mapping between ruby and python regex syntax. 
+However defining named capture is very similiar.
+
+All defined entities are available in the scope of particular skill and are not visible to other skills. 
+Once can imagine defining entity *hello* as *Skill:Hello*, thus not coliding with other skills.
+
+### Intent
+
+Once our entities are defined and correctly named we can start building intents.
+
+```ruby
+Skill.public_routing_for :adapt do |routing|
+    routing.intent('GreetIntent')
+      .required('greet')
+      #.optional('another_entity')
+      .route_to('base', 'hello')
+end
+```
+
+Example above defines new intent *GreetIntent*, with one required entity. We can also define optional entities which does not need to occur in the utterance.
+Last step of defining is setting the *routing*. By specifying **route_to('base', 'hello')** we define that matched intent should be routed to **Skill::BaseController** into action **hello**.
+
+Routing can't be defined outside the scope of the skill as it is automatically nested into skill namespace.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/adapt-charyf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CharyfAdaptProcessor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adapt-charyf/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/adapt-charyf.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adapt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adapt-charyf"
+  spec.version       = Adapt::VERSION
+  spec.authors       = ["Richard Ludvigh"]
+  spec.email         = ["richard.ludvigh@gmail.com"]
+
+  spec.summary       = 'Charyf intent processor wrapper for MycroftAI/adapt library'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/Charyf/charyf-adapt-processor'
+  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         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "charyf", "~> 0"
+  spec.add_runtime_dependency "pycall", "~> 1.0.3"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.post_install_message = <<-EOM
+Make sure MycroftAI/adapt python library is installed [https://github.com/MycroftAI/adapt].
+Also set the ENV[PYTHON] variable to python executable with the library installed.
+
+Read -> Speak -> Chat!
+  EOM
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'adapt-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
+
+Adapt = Adapt::Intent::Processor
+
+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/lib/adapt/generators/intent/intent_generator.rb

@@ -0,0 +1,19 @@
+require 'charyf/utils/generators/named_base'
+
+module Adapt
+  module Generators
+    class IntentGenerator < Charyf::Generators::NamedBase
+
+      source_root File.expand_path('templates', __dir__)
+
+      def public_routing
+        template 'intents/adapt_public.rb', File.join('app/skills', skill_content_path, 'intents', 'adapt_public.rb')
+      end
+
+      def private_routing
+        template 'intents/adapt_private.rb', File.join('app/skills', skill_content_path, 'intents', 'adapt_private.rb')
+      end
+
+    end
+  end
+end

data/lib/adapt/generators/intent/templates/intents/adapt_private.rb.tt

@@ -0,0 +1,3 @@
+<%= class_name -%>.private_routing_for :adapt do |routing|
+
+end

data/lib/adapt/generators/intent/templates/intents/adapt_public.rb.tt

@@ -0,0 +1,9 @@
+<%= class_name -%>.public_routing_for :adapt do |routing|
+
+  routing.register_keywords 'skill_name', '<%= class_name.gsub("::", " ") -%>'
+
+  routing.intent('Example')
+      .required('skill_name')
+      .route_to('base', 'example')
+
+end

data/lib/adapt/processor.rb

@@ -0,0 +1,94 @@
+require 'pycall/import'
+
+require_relative 'routing_builder'
+
+module Adapt
+  module Intent
+    class Processor < Charyf::Engine::Intent::Processor::Base
+
+      strategy_name :adapt
+
+      MUTEX = Mutex.new.freeze
+      private_constant :MUTEX
+
+      class << self
+        include PyCall::Import
+
+        def get_for(skill_name = nil)
+          engine = engine(skill_name)
+
+          self.new(skill_name, engine)
+        end
+
+        def engine(skill_name = nil)
+          MUTEX.synchronize {
+            return _engines[skill_name] ||= init_engine
+          }
+        end
+
+        def init_engine
+          unless @_python_loaded
+            pyfrom 'adapt.intent', import: :IntentBuilder
+            pyfrom 'adapt.engine', import: :IntentDeterminationEngine
+            @_python_loaded = true
+          end
+
+          IntentDeterminationEngine.new
+        end
+
+        def _engines
+          @engines ||= {}
+        end
+
+        def _intents
+          @intents ||= {}
+        end
+
+      end
+
+      def initialize(skill_name, engine)
+        @skill_name = skill_name
+        @engine = engine
+      end
+
+      def load(skill_name, block)
+        builder = Adapt::RoutingBuilder.new(skill_name)
+
+        block.call(builder)
+
+        intents = builder.build(@engine, IntentBuilder)
+
+        # TODO handle already existing
+        intents.each do |intent|
+          self.class._intents[intent.name] = intent
+        end
+      end
+
+      def determine(request)
+        adapt_intent = nil
+        text = Charyf.application.parser.normalize(request.text)
+        generator = @engine.determine_intent(text)
+        begin
+          adapt_intent = PyCall.builtins.next(generator)
+        rescue PyCall::PyError
+          # ignored
+        end
+
+        return unknown unless adapt_intent
+
+        confidence = adapt_intent['confidence']
+        app_intent = self.class._intents[adapt_intent['intent_type']]
+
+
+        matches =  app_intent.entities.map { |e| e.keys.first }.inject({}) do |h, entity|
+          h[self.class.unscope_name(app_intent.skill_name, entity)] = adapt_intent[entity]
+          h
+        end
+
+        Charyf::Engine::Intent.new(app_intent.skill_name, app_intent.controller, app_intent.action, confidence, matches)
+      end
+
+
+    end
+  end
+end

data/lib/adapt/routing_builder.rb

@@ -0,0 +1,104 @@
+module Adapt
+  class RoutingBuilder
+
+    class InvalidState < StandardError; end
+
+    class Intent
+      attr_reader :skill_name, :name, :controller, :action, :entities
+
+      def initialize(skill_name, name)
+        @skill_name = skill_name
+        @name = name
+        @controller = nil
+        @action = nil
+
+        @entities = []
+      end
+
+      def required(entity)
+        entity = Adapt::Intent::Processor.scoped_name(@skill_name, entity)
+        @entities << {entity => :required}
+
+        return self
+      end
+
+      def optional(entity)
+        entity = Adapt::Intent::Processor.scoped_name(@skill_name, entity)
+        @entities << {entity => :optional}
+
+        return self
+      end
+
+      def route_to(controller, action)
+        @controller = controller
+        @action = action
+      end
+    end # End of Intent.class
+
+    def initialize(skill_name)
+      @skill_name = skill_name
+
+      @keywords = {}
+      @regexps = []
+      @intents = []
+    end
+
+    def register_keywords(category, word, *words)
+      words = [word] + words
+
+      (@keywords[Adapt::Intent::Processor.scoped_name(@skill_name, category)] ||= []).push(words).flatten!
+    end
+
+    def register_regex(regex)
+      @regexps << scope_regex(regex)
+
+    end
+
+    def intent(name)
+      intent = Intent.new(@skill_name, Adapt::Intent::Processor.scoped_name(@skill_name,name.to_s.gsub(' ', '')))
+      @intents << intent
+
+      intent
+    end
+
+    def build(engine, intent_builder_class)
+      @keywords.each do |group, words|
+        words.each do |word|
+          engine.register_entity(word, group)
+        end
+      end
+
+      @regexps.each do |regexp|
+        engine.register_regex_entity(regexp)
+      end
+
+      @intents.each do |intent|
+        builder = intent_builder_class.new(intent.name)
+
+        intent.entities.each do |entity|
+          entity, method = entity.first
+          case method
+            when :required
+              builder.require(entity)
+            when :optional
+              builder.optionally(entity)
+            else
+              raise InvalidState.new('You should never end up here')
+          end
+
+          adapt_intent = builder.build
+          engine.register_intent_parser(adapt_intent)
+        end
+      end
+
+      @intents
+    end
+
+    private
+
+    def scope_regex(regex)
+      regex.to_s.gsub(/\(\?P\<(.*)\>/, "(?P<#{Adapt::Intent::Processor.scoped_name(@skill_name, '\1').gsub('.', '_')}>")
+    end
+
+  end
+end

data/lib/adapt/version.rb

@@ -0,0 +1,3 @@
+module Adapt
+  VERSION = '0.2.1'
+end

data/lib/adapt-charyf.rb

@@ -0,0 +1,14 @@
+require 'charyf'
+require_relative 'adapt/processor'
+
+module Adapt
+  class Extension < Charyf::Extension
+
+    generators do
+      require_relative 'adapt/generators/intent/intent_generator'
+    end
+
+    config.generators.skill_hooks :intents, :adapt => true
+
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: adapt-charyf
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Richard Ludvigh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: charyf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pycall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Charyf intent processor wrapper for MycroftAI/adapt library
+email:
+- richard.ludvigh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adapt-charyf.gemspec
+- bin/console
+- bin/setup
+- lib/adapt-charyf.rb
+- lib/adapt/generators/intent/intent_generator.rb
+- lib/adapt/generators/intent/templates/intents/adapt_private.rb.tt
+- lib/adapt/generators/intent/templates/intents/adapt_public.rb.tt
+- lib/adapt/processor.rb
+- lib/adapt/routing_builder.rb
+- lib/adapt/version.rb
+homepage: https://github.com/Charyf/charyf-adapt-processor
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  Make sure MycroftAI/adapt python library is installed [https://github.com/MycroftAI/adapt].
+  Also set the ENV[PYTHON] variable to python executable with the library installed.
+
+  Read -> Speak -> Chat!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Charyf intent processor wrapper for MycroftAI/adapt library
+test_files: []