aws-lex-conversation 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 196357c0326b8a475650f1be193292f99818ca79b98a9957234f01b5e228caf9
+  data.tar.gz: 4acba1d9e6647752ecb57d6fed79746214fbf5dbaba2f495085a77ebb0aa2cde
+SHA512:
+  metadata.gz: b66d860466c3514f7e4122dccc9545eaf98b3d0fd8a6535873f323c73366071197c6b545f67eef71d25f86ea1d4ddd02a334660087a7ec3c84e85dce00f9f82d
+  data.tar.gz: d02d3473ef14600f09d78a94bf839c80dce492943956e1afe565261eca22b33dac50c1d6699687e57d97c69e95955a81a415cc122d122f05aab9393e662bd3a1

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+    - name: Install Bundler
+      run:  gem install bundler
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Install Ruby Dependencies
+      run: |
+        bundle --version
+        bundle config set path 'vendor/bundle'
+        bundle install --jobs 4 --retry 3
+    - name: Run Tests
+      env:
+        RAILS_ENV: test
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler artifacts
+vendor/bundle
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+Documentation:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 150
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+Metrics/LineLength:
+  Max: 130
+Metrics/MethodLength:
+  Max: 25
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/aws-lex-conversation.rb
+Style/Lambda:
+  EnforcedStyle: literal
+Style/GuardClause:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  SimpleCov.minimum_coverage 100.00
+end

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 webmaster@ama.ab.ca. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'factory_bot'
+gem 'pry'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop', '0.85.1'
+gem 'simplecov'

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alberta Motor Association
+
+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,160 @@
+# Aws::Lex::Conversation
+
+Have you played around with [AWS Lex](https://aws.amazon.com/lex/) and quickly realized you were duplicating code to read and generate the [Lex Lambda input event and response format](https://docs.aws.amazon.com/lex/latest/dg/lambda-input-response-format.html)?
+
+`Aws::Lex::Conversation` provides a mechanism to define the flow of a Lex conversation with a user easily!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aws-lex-conversation'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+At a high level, you must create a new instance of `Aws::Lex::Conversation`.
+
+Generally the conversation instance will be initialized inside your Lambda handler method as follows:
+
+```ruby
+def my_lambda_handler(event:, context:)
+  conversation = Aws::Lex::Conversation.new(event: event, context: context)
+
+  # define a chain of your own Handler classes
+  conversation.handlers = [
+    {
+      handler: Aws::Lex::Conversation::Handler::Delegate,
+      options: {
+        respond_on: ->(conversation) { conversation.current_intent.name == 'MyIntent' }
+      }
+    }
+  ]
+
+  # return a response object to indicate Lex's next action
+  conversation.respond
+end
+```
+
+Any custom behaviour in your flow is achieved by defining a Handler class. Handler classes must provide the following:
+
+1. Inherit from `Aws::Lex::Conversation::Handler::Base`.
+2. Define a `will_respond?(conversation)` method that returns a boolean value.
+3. Define a `response(conversation)` method to return final response to Lex. This method is called if `will_respond?` returns `true`.
+
+The handlers defined on an `Aws::Lex::Conversation` instance will be called one-by-one in the order defined.
+
+The first handler that returns `true` for the `will_respond?` method will provide the final Lex response action.
+
+### Custom Handler Example
+
+```ruby
+class SayHello < Aws::Lex::Conversation::Handler::Base
+  def will_respond?(conversation)
+    conversation.lex.incovation_source.dialog_code_hook? && # callback is for DialogCodeHook (i.e. validation)
+    conversation.lex.current_intent.name == 'SayHello' &&   # Lex has routed to the 'SayHello' intent
+    conversation.slots[:name]                               # our expected slot value is set
+  end
+
+  def response(conversation)
+    name = conversation.slots[:name]
+
+    # NOTE: you can use the Type::* classes if you wish. The final output
+    # will be normalized to a value that complies with the Lex response format.
+    #
+    # You can also specify raw values for the response:
+    #
+    # conversation.close(
+    #   fulfillment_state: 'Fulfilled',
+    #   message: { content: "Hello, #{name}!", contentType: 'PlainText' }
+    # )
+    #
+    conversation.close(
+      fulfillment_state: Aws::Lex::Conversation::Type::FulfillmentState.new('Fulfilled'),
+      message: Aws::Lex::Conversation::Type::Message.new(
+        content: "Hello, #{name}!",
+        content_type: Aws::Lex::Conversation::Type::Message::ContentType.new('PlainText')
+      )
+    )
+  end
+end
+```
+
+## Built-In Handlers
+
+### `Aws::Lex::Conversation::Handler::Echo`
+
+This handler simply returns a close response with a message that matches the `inputTranscript` property of the input event.
+
+| Option           | Required | Description                                                  | Default Value                       |
+|------------------|----------|--------------------------------------------------------------|-------------------------------------|
+| respond_on       | No       | A callable that provides the condition for `will_handle?`.   | `->(c) { false }`                   |
+| fulfillment_state| No       | The `fulfillmentState` value (i.e. `Fulfilled` or `Failed`). | `Fulfilled`                         |
+| content_type     | No       | The `contentType` for the message response.                  | `PlainText`                         |
+| content          | No       | The response message content.                                | `conversation.lex.input_transcript` |
+
+i.e.
+
+```ruby
+conversation = Aws::Lex::Conversation.new(event: event, context: context)
+conversation.handlers = [
+  {
+    handler: Aws::Lex::Conversation::Handler::Echo,
+    options: {
+      respond_on: ->(c) { true },
+      fulfillment_state: 'Failed',
+      content_type: 'SSML',
+      content: '<speak>Sorry<break> an error occurred.</speak>'
+    }
+  }
+]
+conversation.respond # => { dialogAction: { type: 'Close' } ... }
+```
+
+### `Aws::Lex::Conversation::Handler::Delegate`
+
+This handler returns a `Delegate` response to the Lex bot (i.e. "do the next bot action").
+
+| Option           | Required | Description                                                  | Default Value                       |
+|------------------|----------|--------------------------------------------------------------|-------------------------------------|
+| respond_on       | No       | A callable that provides the condition for `will_handle?`.   | `->(c) { false }`                   |
+
+i.e.
+
+```ruby
+conversation = Aws::Lex::Conversation.new(event: event, context: context)
+conversation.handlers = [
+  {
+    handler: Aws::Lex::Conversation::Handler::Delegate,
+    options: {
+      respond_on: ->(c) { true }
+    }
+  }
+]
+conversation.respond # => { dialogAction: { type: 'Delegate' } }
+```
+
+## 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/amaabca/aws-lex-conversation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/amaabca/aws-lex-conversation/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Aws::Lex::Conversation project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/amaabca/aws-lex-conversation/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]
+
+RuboCop::RakeTask.new

data/aws-lex-conversation.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/aws/lex/conversation/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'aws-lex-conversation'
+  spec.version = Aws::Lex::Conversation::VERSION
+  spec.authors = [
+    'Jesse Doyle',
+    'Michael van den Beuken',
+    'Darko Dosenovic',
+    'Zoie Carnegie',
+    'Carlos Mejia Castelo'
+  ]
+  spec.email = [
+    'jesse.doyle@ama.ab.ca',
+    'michael.vandenbeuken@ama.ab.ca',
+    'darko.dosenovic@ama.ab.ca',
+    'zoie.carnegie@ama.ab.ca',
+    'carlos.mejiacastelo@ama.ab.ca'
+  ]
+
+  spec.summary = 'AWS Lex Conversation Dialog Management'
+  spec.description = 'Easily manage the flow and logic of your AWS Lex conversations.'
+  spec.homepage = 'https://github.com/amaabca/aws-lex-conversation'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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_dependency 'shrink_wrap'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'aws/lex/conversation'
+
+# 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