aws-lex-conversation 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196357c0326b8a475650f1be193292f99818ca79b98a9957234f01b5e228caf9
-  data.tar.gz: 4acba1d9e6647752ecb57d6fed79746214fbf5dbaba2f495085a77ebb0aa2cde
+  metadata.gz: 148e207d8dcce051f2fc01244390021ae5734037a3b856462cd76ccd9e4cde8a
+  data.tar.gz: 7f019bdc51b68e037575a60784dbe76217aabccdf15e3394515d4a404dbdd85a
 SHA512:
-  metadata.gz: b66d860466c3514f7e4122dccc9545eaf98b3d0fd8a6535873f323c73366071197c6b545f67eef71d25f86ea1d4ddd02a334660087a7ec3c84e85dce00f9f82d
-  data.tar.gz: d02d3473ef14600f09d78a94bf839c80dce492943956e1afe565261eca22b33dac50c1d6699687e57d97c69e95955a81a415cc122d122f05aab9393e662bd3a1
+  metadata.gz: 856f7ab5e25ffc87f93f3ee6f2b834acdd47cbc28adf334a22af4b152b37de435f54d3715374f33acfdf4ceebca1e2945b3557b5f72c4c5873e4b8761af5758a
+  data.tar.gz: e6dff0de003696ef87460e6dfdb54b94e470d4ff5b6470f43642dd259fa13b645b276d5d88413369dcacc7368004f4c93d92f38c1c50a5a18487c6cb2210e62d

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,76 @@
+# 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? ? message : follow_up_message
+          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/current_intent.rb

@@ -13,6 +13,17 @@ module Aws
           required :confirmation_status
 
           class << self
+            def slots!
+              ->(v) do
+                v.each_with_object({}) do |(key, value), hash|
+                  hash[key.to_sym] = Slot.shrink_wrap(
+                    name: key,
+                    value: value
+                  )
+                end
+              end
+            end
+
             def slot_details!
               ->(v) do
                 v.each_with_object({}) do |(key, value), hash|
@@ -23,7 +34,7 @@ module Aws
           end
 
           coerce(
-            slots: symbolize_hash!,
+            slots: slots!,
             slot_details: slot_details!,
             confirmation_status: ConfirmationStatus
           )

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Aws
+  module Lex
+    class Conversation
+      module Type
+        class Slot
+          include Base
+
+          required :name
+          required :value
+
+          def to_lex
+            value
+          end
+
+          def filled?
+            value.to_s != ''
+          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.0.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.0.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-06-26 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