rasa_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c09eff7cf97b81b2cc360650293f1ad8b20aab0e81b936310bd94a7a1004cdf
+  data.tar.gz: 1e5138e0d841aae0538c5c67cef5bbfccfbb1bd2c7265c0a0af7407b8d4de29a
+SHA512:
+  metadata.gz: 487403bc36224493a4b922a5e192c529675259028ed6c7006056c8e12194a47bf4edebefc2a3df22b57e91358311f64a7c11c0d859a79d5e78ff5e219e36dd6e
+  data.tar.gz: 7dbee14090c93a94897eb7948efe7265d44de208233617a926e00af32e125378b265fce71599b843020b64e97719e0db11065950a5df78c6e5c79aa5511fc370

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

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 bkuliyev@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 rasa_core.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    rasa_core (0.1.0)
+      json (~> 1.8)
+      typhoeus (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.10.0)
+    json (1.8.6)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rasa_core!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,128 @@
+# RasaCore
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rasa_core`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rasa_core'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rasa_core
+
+## Usage
+
+```
+require 'rasa_core'
+
+client = RasaCore::Client.new(server:'172.18.0.3', port:5005)
+client.check_health
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>"hello from Rasa Core: 0.11.3"}
+```
+
+The response is always a hash having five key/values
+* `success` - boolean true or false
+* `timed_out` - boolean true or false
+* `code` - HTTP response code
+* `return_message` - a return message in could not get an http response
+* `body` - body response, may be in a simple string form, Ruby `OpenStruct` object, or a JSON format. By default body is an `OpenStruct` object.   
+
+The `check_health` methods return a simple **'Hello'** string if Core is running.
+
+```
+client.version
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>#<OpenStruct minimum_compatible_version="0.11.0", version="0.11.3">}
+```
+```
+client.status
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>#<OpenStruct is_ready=true, model_fingerprint="12c788db30b74a5a8eb88a640aea9ce6">}
+```
+
+We can change the response format
+```
+client.response_format = :json
+client.version
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>"{\"minimum_compatible_version\":\"0.11.0\",\"version\":\"0.11.3\"}\n"}
+client.status
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>"{\"is_ready\":true,\"model_fingerprint\":\"12c788db30b74a5a8eb88a640aea9ce6\"}\n"}
+```
+
+To send a message to Core
+```
+client.send_message(message:'hello')
+#=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>[#<OpenStruct recipient_id="default", text="Greetings!">]}
+```
+
+We can also specify a sender id when sending a message
+```
+client.send_message(message:'hello', sender_id: 'bayram')
+=> {:success=>true, :timed_out=>false, :return_message=>"No error", :code=>200, :body=>[#<OpenStruct recipient_id="bayram", text="Hi there, friend!">]}
+```
+
+Set and access slots as following
+```
+client.append_slot(sender_id: 'bayram_123', name: "name", value: 'bayram')
+client.append_slot(sender_id: 'bayram_123', name: "email", value: 'bkuliyev@gmail.com')
+resp = client.conversation_tracker(sender_id: 'bayram_123')
+resp[:body].slots.email
+# => "bkuliyev@gmail.com"
+resp[:body].slots.name
+# => "bayram"
+```
+
+Assume that core works on `172.18.0.3:5005`. Let's chat with our bot.
+```
+client = RasaCore::Client.new(server:'172.18.0.3', port:5005)
+
+resp = client.send_message(sender_id: 'bayram_123', message:'Hi')
+puts "Bot says: #{resp[:body].first.text}"
+# => Bot says: Hi!
+resp = client.send_message(sender_id: 'bayram_123', message:'Let us chat')
+puts "Bot says: #{resp[:body].first.text}"
+# => Bot says: Sure. I'd be happy to. What's up?
+```
+
+## Client methods
+#### check_health
+Simple sends a GET request `http://<server>:<port>/` and gets a `hello` response in case the core server is running.
+#### status
+Receives information about the currently loaded agent.
+#### version
+Receives metadata about the running Core instance.
+#### send_message(args={})
+Sends a user message <br>
+Arguments: `sender_id`, `message`<br>
+For example `client.send_message(sender_id: 'bkuliyev@gmail.com', message: 'Hello')`
+#### conversation_tracker(args={})
+Retrieve a conversations tracker
+Arguments: `sender_id`, `include_events`
+#### append_slot(args={})
+Retrieve a conversations tracker<br>
+Arguments: `sender_id`, `include_events`, `timestamp`, `name`, `value`
+#### reset_slots(args={})
+
+## Development
+
+Not all functionalities are implemented yet. I will update the gem gradually by adding other methods to interact with Rasa Core. I'd also be glad to get feedback and suggestions.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rasa_core. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RasaCore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rasa_core/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rasa_core"
+
+# 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/lib/rasa_core.rb

@@ -0,0 +1,8 @@
+module RasaCore;end
+require 'typhoeus'
+require 'json'
+require 'uri'
+require "rasa_core/version"
+require "rasa_core/response_formatter"
+require "rasa_core/typhoeus_client"
+require "rasa_core/client"

data/lib/rasa_core/client.rb

@@ -0,0 +1,95 @@
+class RasaCore::Client
+  include RasaCore::TyphoeusClient
+  include RasaCore::ResponseFormatter
+
+  attr_accessor :response_format
+
+  def initialize(args={})
+    @server = args[:server]
+    @port = args[:port]
+  end
+
+  def check_health
+    build_response(run_request(url: build_url), :no_format)
+  end
+
+  def version
+    response = run_request(url: build_url(path: 'version'))
+    build_response(response)
+  end
+
+  def status
+    response = run_request(url: build_url(path: 'status'))
+    build_response(response)
+  end
+
+  def send_message(args={})
+    path = "webhooks/rest/webhook"
+    body = {sender: args[:sender_id] || 'default', message: args[:message]}
+    response = run_request(url: build_url(path: path), body: body, method: 'post')
+    build_response(response)
+  end
+
+  def conversation_tracker(args={})
+    path = ['conversations', args[:sender_id] || "default", 'tracker'].join('/')
+    query = {include_events: args[:include_events] || "AFTER_RESTART"}
+    url = build_url(path: path, query: query)
+    build_response(run_request(url: url))
+  end
+
+  def append_slot(args={})
+    body = {
+      event: 'slot',
+      timestamp: args[:timestamp],
+      name: args[:name],
+      value: args[:value]}
+    append_event_to_tracker(args, body)
+  end
+
+  def reset_slots(args={})
+    body = {event: 'reset_slots', timestamp: args[:timestamp]}
+    append_event_to_tracker(args, body)
+  end
+
+  def append_action(args={})
+    body = {
+      event: 'action',
+      timestamp: args[:timestamp],
+      name: args[:name],
+      policy: args[:policy],
+      confidence: args[:confidence]}
+    append_event_to_tracker(args, body)
+  end
+
+
+  private
+  def build_url(args={})
+    "#{@server}:#{@port}/#{args[:path]}#{build_url_query(args[:query])}"
+  end
+
+  def build_url_query(query)
+    q = URI.encode_www_form(query || {})
+    q.empty? ? "" : '?'+q
+  end
+
+
+  def build_response(response, frmt=nil)
+    body = response.body
+    body = format_response_body(body, frmt || self.response_format) if response.success?
+
+    {
+      success: response.success?,
+      timed_out: response.timed_out?,
+      return_message: response.return_message,
+      code: response.code,
+      body: body
+    }
+  end
+
+  def append_event_to_tracker(args={}, body={})
+    path = ['conversations', args[:sender_id] || "default", 'tracker/events'].join('/')
+    query = {include_events: args[:include_events] || "AFTER_RESTART"}
+    response = run_request(url: build_url(path: path), query: query, body: body, method: 'post')
+    build_response(response)
+  end
+end

data/lib/rasa_core/response_formatter.rb

@@ -0,0 +1,11 @@
+module RasaCore
+  module ResponseFormatter
+    def format_response_body(body, frmt)
+      if [:no_format, :json].include?(frmt)
+        body
+      else
+        JSON.parse(body || '{}', object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/rasa_core/typhoeus_client.rb

@@ -0,0 +1,14 @@
+module RasaCore
+  module TyphoeusClient
+    def run_request(args={})
+      headers = {'Content-Type': 'application/json'}.merge(args[:headers] || {})
+      request = Typhoeus::Request.new(args[:url],
+        method: args[:method] || 'get',
+        body: args[:body].to_json,
+        headers: headers)
+
+        request.run
+        request.response
+    end
+  end
+end

data/lib/rasa_core/version.rb

@@ -0,0 +1,3 @@
+module RasaCore
+  VERSION = "0.1.0"
+end

data/rasa_core.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rasa_core/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rasa_core"
+  spec.version       = RasaCore::VERSION
+  spec.authors       = ["Bayram"]
+  spec.email         = ["bkuliyev@gmail.com"]
+
+  spec.summary       = %q{This gem is a simple wrapper that allows to interact with Rasa Core.}
+  spec.homepage      = "https://github.com/fade2black/rasa_core"
+  spec.license       = "MIT"
+
+  # 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'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "typhoeus", "~> 1.3"
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rasa_core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bayram
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- bkuliyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rasa_core.rb
+- lib/rasa_core/client.rb
+- lib/rasa_core/response_formatter.rb
+- lib/rasa_core/typhoeus_client.rb
+- lib/rasa_core/version.rb
+- rasa_core.gemspec
+homepage: https://github.com/fade2black/rasa_core
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: This gem is a simple wrapper that allows to interact with Rasa Core.
+test_files: []