aws-lex-conversation 0.5.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196357c0326b8a475650f1be193292f99818ca79b98a9957234f01b5e228caf9
-  data.tar.gz: 4acba1d9e6647752ecb57d6fed79746214fbf5dbaba2f495085a77ebb0aa2cde
+  metadata.gz: bb6d1313f30041f9896bccc30fe2511d7eb0f377f505dc3c3c8e153e2838151d
+  data.tar.gz: aa0804ca414e0c68d982ae8ba601a7f46a729678130babb56d7eb87edf119cd3
 SHA512:
-  metadata.gz: b66d860466c3514f7e4122dccc9545eaf98b3d0fd8a6535873f323c73366071197c6b545f67eef71d25f86ea1d4ddd02a334660087a7ec3c84e85dce00f9f82d
-  data.tar.gz: d02d3473ef14600f09d78a94bf839c80dce492943956e1afe565261eca22b33dac50c1d6699687e57d97c69e95955a81a415cc122d122f05aab9393e662bd3a1
+  metadata.gz: 3471ce6eddb122e71cb81aad093e663165bae469b8317c045eddb4f3ba21412ed3815e3f9e895aea121a6af61ae143abb15c0cff1520c10243bfe51a807b09b8
+  data.tar.gz: 906124b34ad1218de0c2725942620fc530120b855cf8e12552c8fc9b841fa18894a7327d92e908ff02e8e3bf276da7d1c4a951efcb87bb2c8f4dd19ecf057bc0

data/README.md

@@ -58,13 +58,13 @@ The first handler that returns `true` for the `will_respond?` method will provid
 ```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.invocation_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
+    conversation.slots[:name].filled?                       # our expected slot value is set
   end
 
   def response(conversation)
-    name = conversation.slots[:name]
+    name = conversation.slots[:name].value
 
     # 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.

data/lib/aws/lex/conversation.rb

@@ -5,7 +5,7 @@ require_relative 'conversation/base'
 module Aws
   module Lex
     class Conversation
-      include Support::Responses
+      include Support::Mixins::Responses
 
       attr_accessor :event, :context, :lex
 

data/lib/aws/lex/conversation/base.rb

@@ -10,8 +10,11 @@ require_relative 'response/confirm_intent'
 require_relative 'response/delegate'
 require_relative 'response/elicit_intent'
 require_relative 'response/elicit_slot'
-require_relative 'support/responses'
+require_relative 'support/mixins/responses'
+require_relative 'support/mixins/slot_elicitation'
 require_relative 'support/inflector'
+require_relative 'slot/elicitation'
+require_relative 'slot/elicitor'
 require_relative 'type/base'
 require_relative 'type/enumeration'
 require_relative 'type/sentiment_label'
@@ -22,6 +25,7 @@ require_relative 'type/dialog_action_type'
 require_relative 'type/confirmation_status'
 require_relative 'type/fulfillment_state'
 require_relative 'type/recent_intent_summary_view'
+require_relative 'type/slot'
 require_relative 'type/slot_resolution'
 require_relative 'type/slot_detail'
 require_relative 'type/current_intent'

data/lib/aws/lex/conversation/slot/elicitation.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Slot
+        class Elicitation
+          attr_accessor :name, :elicit, :message, :follow_up_message,
+                        :content_type, :fallback, :maximum_elicitations,
+                        :conversation
+
+          def initialize(opts = {})
+            self.name = opts.fetch(:name)
+            self.elicit = opts.fetch(:elicit) { ->(_c) { true } }
+            self.message = opts.fetch(:message)
+            self.follow_up_message = opts.fetch(:follow_up_message) { opts.fetch(:message) }
+            self.content_type = opts.fetch(:content_type) do
+              Aws::Lex::Conversation::Type::Message::ContentType.new('PlainText')
+            end
+            self.fallback = opts.fetch(:fallback) { ->(_c) {} }
+            self.maximum_elicitations = opts.fetch(:maximum_elicitations) { 0 }
+          end
+
+          def elicit!
+            return fallback.call(conversation) if maximum_elicitations?
+
+            increment_slot_elicitations!
+            conversation.elicit_slot(
+              slot_to_elicit: name,
+              message: {
+                contentType: content_type,
+                content: elicitation_content
+              }
+            )
+          end
+
+          def elicit?
+            elicit.call(conversation) && !slot.filled?
+          end
+
+          private
+
+          def slot
+            conversation.slots[name.to_sym]
+          end
+
+          def elicitation_content
+            first_elicitation? ? compose_message(message) : compose_message(follow_up_message)
+          end
+
+          def compose_message(msg)
+            msg.is_a?(Proc) ? msg.call(conversation) : msg
+          end
+
+          def increment_slot_elicitations!
+            conversation.session[session_key] = elicitation_attempts + 1
+          end
+
+          def maximum_elicitations?
+            return false if maximum_elicitations.zero?
+
+            elicitation_attempts > maximum_elicitations
+          end
+
+          def first_elicitation?
+            elicitation_attempts == 1
+          end
+
+          def session_key
+            :"SlotElicitations_#{name}"
+          end
+
+          def elicitation_attempts
+            conversation.session[session_key].to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/lex/conversation/slot/elicitor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Slot
+        class Elicitor
+          attr_accessor :conversation, :elicitations
+
+          def initialize(opts = {})
+            self.conversation = opts.fetch(:conversation)
+            self.elicitations = opts.fetch(:elicitations) { [] }
+            elicitations.each do |elicitation|
+              elicitation.conversation = conversation
+            end
+          end
+
+          def elicit?
+            incomplete_elicitations.any?
+          end
+
+          def elicit!
+            incomplete_elicitations.first.elicit! if elicit?
+          end
+
+          private
+
+          def incomplete_elicitations
+            elicitations.select(&:elicit?)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/lex/conversation/support/mixins/responses.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Support
+        module Mixins
+          module Responses
+            def close(opts = {})
+              params = {
+                session_attributes: lex.session_attributes,
+                recent_intent_summary_view: lex.recent_intent_summary_view
+              }.merge(opts)
+              Response::Close.new(params).to_lex
+            end
+
+            def confirm_intent(opts = {})
+              params = {
+                session_attributes: lex.session_attributes,
+                recent_intent_summary_view: lex.recent_intent_summary_view,
+                intent_name: lex.current_intent.name,
+                slots: lex.current_intent.slots
+              }.merge(opts)
+              Response::ConfirmIntent.new(params).to_lex
+            end
+
+            def delegate(opts = {})
+              params = {
+                session_attributes: lex.session_attributes,
+                recent_intent_summary_view: lex.recent_intent_summary_view,
+                slots: lex.current_intent.slots
+              }.merge(opts)
+              Response::Delegate.new(params).to_lex
+            end
+
+            def elicit_intent(opts = {})
+              params = {
+                session_attributes: lex.session_attributes,
+                recent_intent_summary_view: lex.recent_intent_summary_view
+              }.merge(opts)
+              Response::ElicitIntent.new(params).to_lex
+            end
+
+            def elicit_slot(opts = {})
+              params = {
+                session_attributes: lex.session_attributes,
+                recent_intent_summary_view: lex.recent_intent_summary_view,
+                slots: lex.current_intent.slots,
+                intent_name: lex.current_intent.name
+              }.merge(opts)
+              Response::ElicitSlot.new(params).to_lex
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/lex/conversation/support/mixins/slot_elicitation.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Support
+        module Mixins
+          module SlotElicitation
+            def self.included(base)
+              base.include(InstanceMethods)
+              base.extend(ClassMethods)
+              base.attr_accessor(:conversation)
+              base.class_attribute(:slots_to_elicit)
+            end
+
+            module InstanceMethods
+              def elicit_slots!
+                slot_elicitor.elicit!
+              end
+
+              def slots_elicitable?
+                slot_elicitor.elicit?
+              end
+
+              private
+
+              def slot_elicitor
+                @slot_elicitor ||= Aws::Lex::Conversation::Slot::Elicitor.new(
+                  conversation: conversation,
+                  elicitations: self.class.slots_to_elicit
+                )
+              end
+            end
+
+            module ClassMethods
+              def slot(opts = {})
+                self.slots_to_elicit ||= []
+                self.slots_to_elicit.push(
+                  Aws::Lex::Conversation::Slot::Elicitation.new(opts)
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/lex/conversation/type/base.rb

@@ -19,7 +19,8 @@ module Aws
 
           module InstanceMethods
             def assign_attributes!(opts = {})
-              self.class.attributes.each do |attribute|
+              attributes = self.class.attributes | self.class.virtual_attributes
+              attributes.each do |attribute|
                 instance_variable_set("@#{attribute}", opts[attribute])
               end
             end
@@ -60,6 +61,17 @@ module Aws
               ->(v) { v.transform_keys(&:to_sym) }
             end
 
+            def computed_property(attribute, callable)
+              mapping[attribute] = attribute
+              attr_writer(attribute)
+
+              # dynamically memoize the result
+              define_method(attribute) do
+                instance_variable_get("@#{attribute}") ||
+                  instance_variable_set("@#{attribute}", callable.call(self))
+              end
+            end
+
             def required(attribute, opts = {})
               property(attribute, opts.merge(allow_nil: false))
             end
@@ -76,7 +88,12 @@ module Aws
 
               attr_accessor(attribute)
 
-              mapping[attribute] = from
+              if opts.fetch(:virtual) { false }
+                virtual_attributes << attribute
+              else
+                mapping[attribute] = from
+              end
+
               translate(attribute => params)
             end
 
@@ -84,6 +101,10 @@ module Aws
               @attributes ||= mapping.keys
             end
 
+            def virtual_attributes
+              @virtual_attributes ||= []
+            end
+
             def mapping
               @mapping ||= {}
             end

data/lib/aws/lex/conversation/type/current_intent.rb

@@ -8,22 +8,35 @@ module Aws
           include Base
 
           required :name
-          required :slots
+          required :raw_slots, from: :slots, virtual: true
           required :slot_details
           required :confirmation_status
 
+          computed_property :slots, ->(instance) do
+            instance.raw_slots.each_with_object({}) do |(key, value), hash|
+              hash[key.to_sym] = Slot.shrink_wrap(
+                name: key,
+                value: value,
+                # pass a reference to the parent down to the slot so that each slot
+                # instance can view a broader scope such as slot_details/resolutions
+                current_intent: instance
+              )
+            end
+          end
+
           class << self
             def slot_details!
-              ->(v) do
-                v.each_with_object({}) do |(key, value), hash|
-                  hash[key.to_sym] = SlotDetail.shrink_wrap(value)
-                end
+              ->(val) do
+                val
+                  .reject { |_, v| v.nil? }
+                  .each_with_object({}) do |(key, value), hash|
+                    hash[key.to_sym] = SlotDetail.shrink_wrap(value)
+                  end
               end
             end
           end
 
           coerce(
-            slots: symbolize_hash!,
             slot_details: slot_details!,
             confirmation_status: ConfirmationStatus
           )

data/lib/aws/lex/conversation/type/slot.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Type
+        class Slot
+          include Base
+
+          required :current_intent, from: :current_intent, virtual: true
+          required :name
+          required :value
+
+          def as_json(_opts = {})
+            to_lex
+          end
+
+          def to_lex
+            value
+          end
+
+          def filled?
+            value.to_s != ''
+          end
+
+          def resolve!(index: 0)
+            self.value = resolved(index: index)
+          end
+
+          def resolved(index: 0)
+            details.resolutions.fetch(index) { SlotResolution.new(value: value) }.value
+          end
+
+          def original_value
+            details.original_value
+          end
+
+          def resolvable?
+            details.resolutions.any?
+          end
+
+          def details
+            @details ||= current_intent.slot_details.fetch(name.to_sym) do
+              SlotDetail.new(name: name, resolutions: [], original_value: value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/lex/conversation/version.rb

@@ -3,7 +3,7 @@
 module Aws
   module Lex
     class Conversation
-      VERSION = '0.5.0'
+      VERSION = '1.2.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-lex-conversation
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jesse Doyle
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrink_wrap
@@ -64,8 +64,11 @@ files:
 - lib/aws/lex/conversation/response/delegate.rb
 - lib/aws/lex/conversation/response/elicit_intent.rb
 - lib/aws/lex/conversation/response/elicit_slot.rb
+- lib/aws/lex/conversation/slot/elicitation.rb
+- lib/aws/lex/conversation/slot/elicitor.rb
 - lib/aws/lex/conversation/support/inflector.rb
-- lib/aws/lex/conversation/support/responses.rb
+- lib/aws/lex/conversation/support/mixins/responses.rb
+- lib/aws/lex/conversation/support/mixins/slot_elicitation.rb
 - lib/aws/lex/conversation/type/base.rb
 - lib/aws/lex/conversation/type/bot.rb
 - lib/aws/lex/conversation/type/confirmation_status.rb
@@ -87,6 +90,7 @@ files:
 - lib/aws/lex/conversation/type/sentiment_label.rb
 - lib/aws/lex/conversation/type/sentiment_response.rb
 - lib/aws/lex/conversation/type/sentiment_score.rb
+- lib/aws/lex/conversation/type/slot.rb
 - lib/aws/lex/conversation/type/slot_detail.rb
 - lib/aws/lex/conversation/type/slot_resolution.rb
 - lib/aws/lex/conversation/version.rb

data/lib/aws/lex/conversation/support/responses.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Aws
-  module Lex
-    class Conversation
-      module Support
-        module Responses
-          def close(opts = {})
-            params = {
-              session_attributes: lex.session_attributes,
-              recent_intent_summary_view: lex.recent_intent_summary_view
-            }.merge(opts)
-            Response::Close.new(params).to_lex
-          end
-
-          def confirm_intent(opts = {})
-            params = {
-              session_attributes: lex.session_attributes,
-              recent_intent_summary_view: lex.recent_intent_summary_view,
-              intent_name: lex.current_intent.name,
-              slots: lex.current_intent.slots
-            }.merge(opts)
-            Response::ConfirmIntent.new(params).to_lex
-          end
-
-          def delegate(opts = {})
-            params = {
-              session_attributes: lex.session_attributes,
-              recent_intent_summary_view: lex.recent_intent_summary_view,
-              slots: lex.current_intent.slots
-            }.merge(opts)
-            Response::Delegate.new(params).to_lex
-          end
-
-          def elicit_intent(opts = {})
-            params = {
-              session_attributes: lex.session_attributes,
-              recent_intent_summary_view: lex.recent_intent_summary_view
-            }.merge(opts)
-            Response::ElicitIntent.new(params).to_lex
-          end
-
-          def elicit_slot(opts = {})
-            params = {
-              session_attributes: lex.session_attributes,
-              recent_intent_summary_view: lex.recent_intent_summary_view,
-              slots: lex.current_intent.slots,
-              intent_name: lex.current_intent.name
-            }.merge(opts)
-            Response::ElicitSlot.new(params).to_lex
-          end
-        end
-      end
-    end
-  end
-end