twilio-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf947f0ddeb9ea673be2d9ce93cfcdff8e96290c231655c1ae724343bd699bff
-  data.tar.gz: 701c404e5d513947077e189797643694cddf2db51c87356095330295fbda5871
+  metadata.gz: da8b95ee1335c01291ebff65ac9a32b77b7fc749057878b849a1638b477e52db
+  data.tar.gz: 5c67a75eb4a2bf6ff43a71d3c6528540219698dea50e68b7d96b3d3f79b13224
 SHA512:
-  metadata.gz: 5259e6b131007ef2079977e1dc701c0b1636176242f3c935e1c95feee6dfa610890d8793eb0539eccdaad466a032ee8dab067bdccdbbee9ca6f3f22930e8bcf2
-  data.tar.gz: 5d798cd90d9575e25cbe2fcf67c79c57ad6154f83a834b90fb24daa329f033061305b195af6696f7b2b8d1b0d2c7488eb9151ede45de083cce42949e879bd26a
+  metadata.gz: 78aa3a4b1a34ff2d574bac9b5d9ec0f1e10ae298150a2649e147ad98234e9449e371a8329acb9c9b3cbf104208a8c4950c7d70166ae488e5ca1aa0bb3d5d84d9
+  data.tar.gz: 20703a2e24787e490321ae035b09f0f6c15613063839767e531f2e3f2bf48c18e3b3708208c7c81f3517e182ee4b637dab54c5e7b093bb8ff6cbb2b034641c45

data/README.md

@@ -1,6 +1,7 @@
 # Twilio Rails
 
 [![RSpec Tests](https://github.com/kmcphillips/twilio-rails/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kmcphillips/twilio-rails/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/twilio-rails.svg)](https://badge.fury.io/rb/twilio-rails)
 
 The `twilio-rails` gem is an opinionated Rails engine and a framework for building complex, realtime, stateful phone interactions in Rails without needing to directly interact with the Twilio API or use TwiML. It is not a replacement for the [`twilio-ruby` gem](https://github.com/twilio/twilio-ruby), but is rather built on top of it.
 
@@ -12,7 +13,7 @@ What does this mean in practice? **Call and find out!**
 
 ## Documentation
 
-On [RubyDoc](https://rubydoc.info/github/kmcphillips/twilio-rails/main) or [Github pages](https://twilio-rails.kev.cool/).
+On [RubyDoc](https://rubydoc.info/gems/twilio-rails) or [Github pages](https://twilio-rails.kev.cool/).
 
 
 ## Getting started
@@ -262,7 +263,6 @@ prompt :record_your_feedback,
   gather: {
     type: :voice,
     length: 30,
-    beep: true,
     transcribe: true,
     profanity_filter: true
   },
@@ -272,7 +272,7 @@ prompt :record_your_feedback,
   }
 ```
 
-The above `gather:` with `type: :voice` example will finish reading the message, play a beep, and then record the phone caller's speech for 30 seconds or until they press the `#` pound key. The phone tree will then immediately execute the `after:`, while the framework continues to handle the audio recording asynchronously. When Twilio makes it available, the audio file of the recording will be downloaded and stored as an ActiveStorage attachment in a `Recording` model as `response.recording`. If the `transcribe:` option is set to `true`, the voice in the recording will also attempt to be transcribed as text and stored as `response.transcription`. Importantly though, **neither are guaranteed to arrive or will arrive immediately**. In practice they both usually arrive within a few seconds, but can sometimes be blank or missing if the caller is silent or garbled. There is a cost to transcription so it can be disabled, and the `profanity_filter:` defaults to false and will just *** out any profanity in the transcription.
+The above `gather:` with `type: :voice` example will finish reading the message and then record the phone caller's speech for 30 seconds or until they press the `#` pound key. The phone tree will then immediately execute the `after:`, while the framework continues to handle the audio recording asynchronously. When Twilio makes it available, the audio file of the recording will be downloaded and stored as an ActiveStorage attachment in a `Recording` model as `response.recording`. If the `transcribe:` option is set to `true`, the voice in the recording will also attempt to be transcribed as text and stored as `response.transcription`. Importantly though, **neither are guaranteed to arrive or will arrive immediately**. In practice they both usually arrive within a few seconds, but can sometimes be blank or missing if the caller is silent or garbled. There is a cost to transcription so it can be disabled, and the `profanity_filter:` defaults to false and will just *** out any profanity in the transcription.
 
 Finally, the `gather:` can also accept `type: :speech` which is a specialzed model designed to identify voice in realtime. It will provide the `response.transcription` field immediately, making it available in the `after:` proc or in the next prompt. But the tradeoffs are that it does not provide a recording, there is a time gap of a few seconds between prompts, and it is more expensive. See the [Twilio documentation for specifics](https://www.twilio.com/docs/voice/twiml/gather#speechmodel). The keys it expects match the documentation, `speech_model:`, `speech_timeout:`, `language:` (defaults to "en-US"), and `encanced:` (defaults to false).
 

data/app/operations/twilio/rails/phone/twiml/prompt_operation.rb

@@ -48,7 +48,6 @@ module Twilio
               when :voice
                 args = {
                   max_length: prompt.gather.args[:length],
-                  play_beep: prompt.gather.args[:beep],
                   # trim: "trim-silence",
                   timeout: prompt.gather.args[:timeout],
                   action: ::Twilio::Rails::Engine.routes.url_helpers.phone_prompt_response_path(

data/lib/twilio/rails/configuration.rb

@@ -16,8 +16,8 @@ module Twilio
         @spam_filter = nil
         @exception_notifier = nil
         @attach_recordings = true
-        @yes_responses = [ "yes", "accept", "ya", "yeah", "true", "ok", "okay" ]
-        @no_responses = [ "no", "naw", "nah", "reject", "decline", "negative", "not", "false" ]
+        @yes_responses = [ "yes", "accept", "ya", "yeah", "true", "ok", "okay", "yep", "yup", "yes please" ]
+        @no_responses = [ "no", "naw", "nah", "reject", "decline", "negative", "not", "false", "nope", "no thank you", "know" ]
         @message_class_name = "Message"
         @message_class = nil
         @phone_call_class_name = "PhoneCall"
@@ -95,12 +95,14 @@ module Twilio
       # @return [true, false, Proc] a boolean or a proc that will be called to return a boolean to determine if reordings will be downloaded.
       attr_accessor :attach_recordings
 
-      # A list of strings to be interpreted as yes or acceptance to a question.
+      # A list of strings to be interpreted as yes or acceptance to a question. Pairs with the
+      # {Twilio::Rails::Phone::TreeMacros#answer_yes?} method.
       #
       # @return [Array<String>] a list of strings to be interpreted as yes or acceptance to a question.
       attr_accessor :yes_responses
 
-      # A list of strings to be interpreted as no or rejection to a question.
+      # A list of strings to be interpreted as no or rejection to a question. Pairs with the
+      # {Twilio::Rails::Phone::TreeMacros#answer_no?} method.
       #
       # @return [Array<String>] a list of strings to be interpreted as no or rejection to a question.
       attr_accessor :no_responses

data/lib/twilio/rails/phone/base_tree.rb

@@ -122,7 +122,6 @@ module Twilio
           #   response instance. However, this all happens asynchronously with no guarantee of time or success. Voice
           #   accepts the following configuration keys:
           #   * `:length`: The number of seconds to record. The default is 10.
-          #   * `:beep`: A boolean if the gather is preceeded by a beep. The default is `true`.
           #   * `:transcribe`: A boolean if Twilio should attempt to transcribe the audio and send it back as text. The
           #     framework handles this all asynchronously and will update the `transcription` field. Default is `false`.
           #   * `:profanity_filter`: Replaces any profanity in the transcription with ***. Default is `false`.

data/lib/twilio/rails/phone/tree.rb

@@ -102,7 +102,6 @@ module Twilio
                 @args[:number] ||= 1
               elsif voice?
                 @args[:length] ||= 10
-                @args[:beep] = true unless @args.key?(:beep)
                 @args[:transcribe] = false unless @args.key?(:transcribe)
                 @args[:profanity_filter] = false unless @args.key?(:profanity_filter)
               elsif speech?

data/lib/twilio/rails/phone/tree_macros.rb

@@ -90,6 +90,15 @@ module Twilio
           Twilio::Rails.config.yes_responses
         end
 
+        # Matches if the entire passed in string is included in the {Twilio::Rails::Configuration#yes_responses} and is
+        # considered a "yes".
+        #
+        # @param filename [String] the string to match against.
+        # @return [true, false] if the passed in string matches.
+        def answer_yes?(string)
+          answers_yes.include?((string || "").downcase.strip.gsub(/[.,!?]/, ""))
+        end
+
         # The list of configured answers that are considered "no" from {Twilio::Rails::Configuration#no_responses}.
         #
         # @return [Array<String>] the list of configured answers that are considered "no".
@@ -97,6 +106,16 @@ module Twilio
           Twilio::Rails.config.no_responses
         end
 
+        # Matches if the entire passed in string is included in the {Twilio::Rails::Configuration#no_responses} and is
+        # considered a "no".
+        #
+        # @param filename [String] the string to match against.
+        # @return [true, false] if the passed in string matches.
+        def answer_no?(string)
+          answers_no.include?((string || "").downcase.strip.gsub(/[.,!?]/, ""))
+        end
+
+
         # Finds and validates the existence of a file in the `public` folder. Formats that link to include the
         # configured hose from {Twilio::Rails::Configuration#host}, and returns a fully qualified URL to the file. This
         # is useful for playing audio files in a `message:` block. If the file is not found

data/lib/twilio/rails/version.rb

@@ -1,5 +1,5 @@
 module Twilio
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2023-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -267,6 +267,8 @@ metadata:
   homepage_uri: https://github.com/kmcphillips/twilio-rails
   source_code_uri: https://github.com/kmcphillips/twilio-rails
   changelog_uri: https://github.com/kmcphillips/twilio-rails/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/twilio-rails
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: