aws-lex-conversation 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a4b4cc2a28aa4251723f715953de0a102e7cabb0268db095e50470e49e2772
-  data.tar.gz: a5bd7550ef4a7391c0d9221ac86b3c1760053b03dda9932d8416778f4ea319e5
+  metadata.gz: fa157d03f135f23dbb377c404c89d946dffc0439351be55426e30fdb5f77f503
+  data.tar.gz: 309f7a91e31d11ef76fa53170cfa64baf78ba444ee092cb4244104501e26860f
 SHA512:
-  metadata.gz: 48883e2e7ce637dc0b6a327bdf839b9e233a3a1bc06f99b318f5bdbf83e91c762fb8c2bbe1ffc597ac8a6900d7a01ee4dfab7a67a52c2f941595754e13f8cb06
-  data.tar.gz: 3bf93255a75da95213ffc74a7a3a86785bba94ea70d758c53dbad1c351b3567f5bb6f23adffafbf67e7581ad9f4a9ece31a489ef35b9cd3ad31311121a209105
+  metadata.gz: eb6c81ac0fa0372aa686fbdd2ce14aba638c3ef304601e3658413d365148bd57b62d2a4020e2e8aa84d53d66ee2130dbf9a892834258c5692d71afe8756270eb
+  data.tar.gz: 10fe3f5e93bdfdd13c7a5aee638e6820a73b9f1f55190ce10795ce28df78ec3ecef8395c9ac92495b1b7352826cc8bf1e4d865590c5bf984005d66d3911cc048

data/lib/aws/lex/conversation.rb

@@ -57,6 +57,55 @@ module Aws
       def session
         lex.session_attributes
       end
+
+      # rubocop:disable Metrics/AbcSize
+      def checkpoint!(opts = {})
+        label = opts.fetch(:label)
+        intent = opts.fetch(:intent_name) { intent_name }
+        params = {
+          checkpoint_label: label,
+          confirmation_status: opts.fetch(:confirmation_status) { lex.current_intent.confirmation_status },
+          dialog_action_type: opts.fetch(:dialog_action_type),
+          fulfillment_state: opts[:fulfillment_state],
+          intent_name: intent,
+          slots: opts.fetch(:slots) { lex.current_intent.raw_slots },
+          slot_to_elicit: opts[:slot_to_elicit]
+        }.compact
+
+        # flag that we need to send a new checkpoint back in the response
+        stash[:checkpoint_pending] = true
+
+        if checkpoint?(label: label)
+          # update the existing checkpoint
+          checkpoint(label: label).assign_attributes!(params)
+        else
+          # push a new checkpoint to the recent_intent_summary_view
+          lex.recent_intent_summary_view.unshift(
+            Type::RecentIntentSummaryView.new(params)
+          )
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def checkpoint?(label:)
+        lex.recent_intent_summary_view.any? { |v| v.checkpoint_label == label }
+      end
+
+      def checkpoint(label:)
+        lex.recent_intent_summary_view.find { |v| v.checkpoint_label == label }
+      end
+
+      # NOTE: lex responses should only include a recent_intent_summary_view
+      # block if we want to change/add an existing checkpoint. If we don't
+      # send a recent_intent_summary_view back in the response, lex retains
+      # the previous intent history.
+      def pending_checkpoints
+        stash[:checkpoint_pending] && lex.recent_intent_summary_view
+      end
+
+      def stash
+        @stash ||= {}
+      end
     end
   end
 end

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

@@ -9,7 +9,7 @@ module Aws
             def close(opts = {})
               params = {
                 active_contexts: lex.active_contexts,
-                recent_intent_summary_view: lex.recent_intent_summary_view,
+                recent_intent_summary_view: pending_checkpoints,
                 session_attributes: lex.session_attributes
               }.merge(opts)
               Response::Close.new(params).to_lex
@@ -19,7 +19,7 @@ module Aws
               params = {
                 active_contexts: lex.active_contexts,
                 intent_name: lex.current_intent.name,
-                recent_intent_summary_view: lex.recent_intent_summary_view,
+                recent_intent_summary_view: pending_checkpoints,
                 session_attributes: lex.session_attributes,
                 slots: lex.current_intent.slots
               }.merge(opts)
@@ -29,7 +29,7 @@ module Aws
             def delegate(opts = {})
               params = {
                 active_contexts: lex.active_contexts,
-                recent_intent_summary_view: lex.recent_intent_summary_view,
+                recent_intent_summary_view: pending_checkpoints,
                 session_attributes: lex.session_attributes,
                 slots: lex.current_intent.slots
               }.merge(opts)
@@ -39,7 +39,7 @@ module Aws
             def elicit_intent(opts = {})
               params = {
                 active_contexts: lex.active_contexts,
-                recent_intent_summary_view: lex.recent_intent_summary_view,
+                recent_intent_summary_view: pending_checkpoints,
                 session_attributes: lex.session_attributes
               }.merge(opts)
               Response::ElicitIntent.new(params).to_lex
@@ -49,7 +49,7 @@ module Aws
               params = {
                 active_contexts: lex.active_contexts,
                 intent_name: lex.current_intent.name,
-                recent_intent_summary_view: lex.recent_intent_summary_view,
+                recent_intent_summary_view: pending_checkpoints,
                 session_attributes: lex.session_attributes,
                 slots: lex.current_intent.slots
               }.merge(opts)

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

@@ -17,7 +17,7 @@ module Aws
           required :output_dialog_mode
           required :message_version
           required :session_attributes
-          required :recent_intent_summary_view
+          required :recent_intent_summary_view, default: -> { [] }
           optional :request_attributes
           optional :sentiment_response
           optional :kendra_response

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

@@ -14,8 +14,14 @@ module Aws
           optional :nlu_intent_confidence_score
 
           computed_property :slots, ->(instance) do
-            instance.raw_slots.each_with_object({}) do |(key, value), hash|
+            # any keys indexed without a value will return an empty Slot instance
+            default_hash = Hash.new do |_hash, key|
+              Slot.new(active: false, name: key.to_sym, value: nil, current_intent: instance)
+            end
+
+            instance.raw_slots.each_with_object(default_hash) do |(key, value), hash|
               hash[key.to_sym] = Slot.shrink_wrap(
+                active: true,
                 name: key,
                 value: value,
                 # pass a reference to the parent down to the slot so that each slot

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

@@ -11,10 +11,10 @@ module Aws
           required :slots
           required :confirmation_status
           required :dialog_action_type
-          required :slot_to_elicit
 
-          optional :fulfillment_state
           optional :checkpoint_label
+          optional :fulfillment_state
+          optional :slot_to_elicit
 
           coerce(
             slots: symbolize_hash!,
@@ -22,6 +22,47 @@ module Aws
             dialog_action_type: DialogActionType,
             fulfillment_state: FulfillmentState
           )
+
+          # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          def restore(conversation, opts = {})
+            case dialog_action_type.raw
+            when 'Close'
+              conversation.close(
+                fulfillment_state: opts.fetch(:fulfillment_state) { fulfillment_state },
+                message: opts.fetch(:message),
+                response_card: opts[:response_card]
+              )
+            when 'ConfirmIntent'
+              conversation.confirm_intent(
+                intent_name: intent_name,
+                message: opts.fetch(:message),
+                response_card: opts[:response_card],
+                slots: slots
+              )
+            when 'Delegate'
+              conversation.delegate(
+                kendra_query_request_payload: opts[:kendra_query_request_payload],
+                kendra_query_filter_string: opts[:kendra_query_filter_string],
+                slots: slots
+              )
+            when 'ElicitIntent'
+              conversation.elicit_intent(
+                message: opts.fetch(:message),
+                response_card: opts[:response_card]
+              )
+            when 'ElicitSlot'
+              conversation.elicit_slot(
+                intent_name: intent_name,
+                message: opts.fetch(:message),
+                response_card: opts[:response_card],
+                slots: slots,
+                slot_to_elicit: slot_to_elicit
+              )
+            else
+              raise ArgumentError, "invalid DialogActionType: `#{dialog_action_type.raw}`"
+            end
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
         end
       end
     end

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

@@ -10,6 +10,7 @@ module Aws
           required :current_intent, from: :current_intent, virtual: true
           required :name
           required :value
+          optional :active, virtual: true
 
           def as_json(_opts = {})
             to_lex
@@ -19,10 +20,23 @@ module Aws
             value
           end
 
+          def active?
+            @active
+          end
+
           def filled?
             value.to_s != ''
           end
 
+          def blank?
+            !filled?
+          end
+
+          def value=(other)
+            @value = other
+            current_intent.raw_slots[name] = @value
+          end
+
           def resolve!(index: 0)
             self.value = resolved(index: index)
           end
@@ -39,6 +53,10 @@ module Aws
             details.resolutions.any?
           end
 
+          def requestable?
+            active? && blank?
+          end
+
           def details
             @details ||= current_intent.slot_details.fetch(name.to_sym) do
               SlotDetail.new(name: name, resolutions: [], original_value: value)

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

@@ -3,7 +3,7 @@
 module Aws
   module Lex
     class Conversation
-      VERSION = '2.1.0'
+      VERSION = '3.0.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-lex-conversation
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jesse Doyle
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shrink_wrap
@@ -120,7 +120,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project:
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: AWS Lex Conversation Dialog Management