twilio-rails 1.0.0 → 1.1.0

data/lib/twilio/rails/configuration.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     class Configuration
       # Raised in initialization if the configuration is invalid.
-      class Error < StandardError ; end
+      class Error < StandardError; end
 
       def initialize
         @finalized = false
@@ -14,10 +15,9 @@ module Twilio
         @account_sid = nil
         @auth_token = nil
         @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"
@@ -33,12 +33,11 @@ module Twilio
         @phone_trees = PhoneTreeRegistry.new
         @sms_responders = SMSResponderRegistry.new
         @host = if ::Rails.configuration&.action_controller&.default_url_options
-          "#{ ::Rails.configuration.action_controller.default_url_options[:protocol] }://#{ ::Rails.configuration.action_controller.default_url_options[:host] }"
-        else
-          nil
+          "#{::Rails.configuration.action_controller.default_url_options[:protocol]}://#{::Rails.configuration.action_controller.default_url_options[:host]}"
         end
         @controller_http_methods = [:get, :post]
         @include_phone_macros = []
+        @phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
       end
 
       # This is the phone number that will be used to send SMS messages or start Phone Calls. It must be first configured
@@ -75,14 +74,6 @@ module Twilio
       # @return [Proc] a proc that will be called to filter messages, or `nil` if no filter is set.
       attr_accessor :spam_filter
 
-      # A proc that will be called when an exception is raised in certain key points in the framework. This will never
-      # capture the exception, it will raise regardless, but it is a good spot to send an email or notify in chat
-      # if desired. The proc needs to accept `(exception, message, context, exception_binding)` as arguments. The
-      # default is `nil`, which means no action will be taken.
-      #
-      # @return [Proc] a proc that will be called when an exception is raised in certain key points in the framework.
-      attr_accessor :exception_notifier
-
       # Controls if recordings will be downloaded and attached to the `Recording` model in an ActiveStorage attachment.
       # This is `true` by default, but can be set to `false` to disable all downloads. It can also be set to a `Proc` or
       # callable that will receive the `Recording` instance and return a boolean for this specific instance. A typical
@@ -95,12 +86,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
@@ -153,8 +146,7 @@ module Twilio
       def host_domain
         return nil unless host.present?
         value = host.gsub(/\Ahttps?:\/\//, "")
-        value = value.gsub(/:\d+\z/, "")
-        value
+        value.gsub(/:\d+\z/, "")
       end
 
       # The HTTP methods that Twilio will use to call into the app. Defaults to `[:get, :post]` but can be restricted
@@ -193,6 +185,19 @@ module Twilio
         end
       end
 
+      # An instance of the class which will validate and format phone numbers. This is used internally to decide what
+      # phone numbers are valid, how to format them, how to parse them, how to display them, and what country assumptions
+      # to make.
+      #
+      # This class must implement four methods:
+      #   * coerce(string)
+      #   * valid?(string)
+      #   * to_param(string)
+      #   * display(string)
+      #
+      # @return [Object]
+      attr_accessor :phone_number_formatter
+
       # Flags that the configuration has been setup and should be validated and finalized.
       # If this is not called, the framework will not work, but the Railtie will not prevent
       # the application from starting.
@@ -215,12 +220,12 @@ module Twilio
         raise Error, "`auth_token` must be set" if @auth_token.blank?
         raise Error, "`logger` must be set" if @logger.blank?
         raise Error, "`spam_filter` must be callable" if @spam_filter && !@spam_filter.respond_to?(:call)
-        raise Error, "`exception_notifier` must be callable" if @exception_notifier && !@exception_notifier.respond_to?(:call)
-        raise Error, '`yes_responses` must be an array' unless @yes_responses.is_a?(Array)
-        raise Error, '`no_responses` must be an array' unless @no_responses.is_a?(Array)
-        raise Error, "`host` #{ @host.inspect } is not a valid URL of the format https://example.com without the trailing slash" unless @host =~ /\Ahttps?:\/\/[a-z0-9\-\.:]+\Z/i
-        raise Error, "`controller_http_methods` must be an array containing one or both of `:get` and `:post` but was #{ @controller_http_methods.inspect }" unless @controller_http_methods.is_a?(Array) && @controller_http_methods.sort == [:get, :post].sort || @controller_http_methods == [:get] || @controller_http_methods == [:post]
-        raise Error, "`include_phone_macros` must be a module, but received #{ @include_phone_macros.inspect }" unless @include_phone_macros.all? { |mod| mod.is_a?(Module) }
+        raise Error, "`yes_responses` must be an array" unless @yes_responses.is_a?(Array)
+        raise Error, "`no_responses` must be an array" unless @no_responses.is_a?(Array)
+        raise Error, "`host` #{@host.inspect} is not a valid URL of the format https://example.com without the trailing slash" unless /\Ahttps?:\/\/[a-z0-9\-\.:]+\Z/i.match?(@host)
+        raise Error, "`controller_http_methods` must be an array containing one or both of `:get` and `:post` but was #{@controller_http_methods.inspect}" unless [[:get], [:post], [:get, :post], [:post, :get]].any? { |v| @controller_http_methods == v }
+        raise Error, "`include_phone_macros` must be a module, but received #{@include_phone_macros.inspect}" unless @include_phone_macros.all? { |mod| mod.is_a?(Module) }
+        raise Error, "`phone_number_formatter` must be set" unless @phone_number_formatter
         nil
       end
 
@@ -239,13 +244,13 @@ module Twilio
           :response_class_name,
           :sms_conversation_class_name,
           :message_class_name,
-          :recording_class_name,
+          :recording_class_name
         ].each do |attribute|
-          value = self.send(attribute)
+          value = send(attribute)
           raise Error, "`#{attribute}` must be set to a string name" if value.blank? || !value.is_a?(String)
           begin
             klass = value.constantize
-            instance_variable_set("@#{ attribute.to_s.gsub("_name", "") }", klass)
+            instance_variable_set("@#{attribute.to_s.gsub("_name", "")}", klass)
           rescue NameError
             raise Error, "`#{attribute}` must be a valid class name but could not be found or constantized"
           end
@@ -288,7 +293,7 @@ module Twilio
         # @yield [nil] if a block is passed, it will be called and the result will be used as the value.
         # @yieldreturn [Class, String, Proc] containing the Class to be lazily initialized when {#finalize!} is called.
         # @return [nil]
-        def register(klass_or_proc=nil, &block)
+        def register(klass_or_proc = nil, &block)
           raise Error, "Must pass either a param or a block" unless klass_or_proc.present? ^ block.present?
           value = klass_or_proc || block
 
@@ -303,7 +308,7 @@ module Twilio
         # @param [String, Symbol] name of the phone tree or SMS responder to find.
         # @return [Class] the phone tree or SMS responder class.
         def for(name)
-          @registry[name.to_s] || raise(error_class, "No responder registered for '#{ name }'")
+          @registry[name.to_s] || raise(error_class, "Name '#{name}' has not been registered and cannot be found.")
         end
 
         # Returns all the phone trees or SMS responders as a read-only hash, keyed by name.
@@ -316,7 +321,7 @@ module Twilio
         private
 
         def add_to_registry(value)
-          raise NotImplementedError
+          raise NoMethodError
         end
 
         def error_class
@@ -333,14 +338,14 @@ module Twilio
           value = value.call if value.respond_to?(:call)
           begin
             value = value.constantize if value.is_a?(String)
-          rescue NameError => e
-            raise(error_class, "Responder class '#{ value }' could not be constantized")
+          rescue NameError
+            raise(error_class, "Responder class '#{value}' could not be constantized")
           end
           raise(error_class, "Responder cannot be blank") unless value.present?
-          raise(error_class, "Responder must be a class but got #{ value.inspect }") unless value.is_a?(Class)
+          raise(error_class, "Responder must be a class but got #{value.inspect}") unless value.is_a?(Class)
           name = value.responder_name
           raise(error_class, "Responder name cannot be blank") unless name.present?
-          raise(error_class, "Responder name '#{ name }' is already registered") if @registry[name]
+          raise(error_class, "Responder name '#{name}' is already registered") if @registry[name]
           @registry[name] = value
         end
 
@@ -358,16 +363,15 @@ module Twilio
           value = value.call if value.respond_to?(:call)
           begin
             value = value.constantize if value.is_a?(String)
-          rescue NameError => e
-            raise(error_class, "Tree class '#{ value }' could not be constantized")
+          rescue NameError
+            raise(error_class, "Tree class '#{value}' could not be constantized")
           end
-          raise(error_class, "Tree cannot be blank #{ value }") unless value.present?
-          raise(error_class, "Tree is not a Twilio::Rails::Phone::BaseTree class #{ value }") unless value.is_a?(Class)
-          raise(error_class, "Tree is not a Twilio::Rails::Phone::BaseTree #{ value }") unless value.ancestors.include?(Twilio::Rails::Phone::BaseTree)
+          raise(error_class, "Tree cannot be blank #{value}") unless value.present?
+          raise(error_class, "Tree is not a Twilio::Rails::Phone::BaseTree class #{value}") unless value.is_a?(Class)
+          raise(error_class, "Tree is not a Twilio::Rails::Phone::BaseTree #{value}") unless value.ancestors.include?(Twilio::Rails::Phone::BaseTree)
           name = value.tree_name
           raise(error_class, "Tree name cannot be blank") unless name.present?
-          raise(error_class, "Tree name '#{ name }' is already registered") if @registry[name]
-          klass = klass.constantize if klass.is_a?(String)
+          raise(error_class, "Tree name '#{name}' is already registered") if @registry[name]
           @registry[name] = value.tree
         end
 

data/lib/twilio/rails/formatter.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Formatter
       extend self
 
-      PHONE_NUMBER_REGEX = /\A\+1[0-9]{10}\Z/
-      PHONE_NUMBER_SEGMENTS_REGEX = /\A\+1([0-9]{3})([0-9]{3})([0-9]{4})\Z/
-
       # Takes in a string or a {Twilio::Rails::PhoneNumber} or something that responds to `to_s` and turns it into a
       # consistently formatted valid north american 10 digit phone number prefixed with 1 and plus. It uses the format
       # Twilio expects which is "+15555555555" or returns `nil` if it cannot be coerced.
@@ -14,17 +12,13 @@ module Twilio
       # @param string [String, Twilio::Rails::PhoneNumber, nil, Object] the input to turn into a phone number string.
       # @return [String, nil] the phone number string or nil.
       def coerce_to_valid_phone_number(string)
-        string = string.number if string.is_a?(Twilio::Rails::PhoneNumber)
-        string = string.to_s.presence
-
-        if string
-          string = string.gsub(/[^0-9]/, "")
-          string = "1#{ string }" unless string.starts_with?("1")
-          string = "+#{ string }"
-          string = nil unless valid_north_american_phone_number?(string)
-        end
+        Twilio::Rails.deprecator.warn(<<~DEPRECATION.strip)
+          Twilio::Rails::Formatter#coerce_to_valid_phone_number(s) is deprecated and will be removed in the next major version.
 
-        string
+          Set Twilio::Rails.config.phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+          and use Twilio::Rails.config.phone_number_formatter.coerce(s) instead.
+        DEPRECATION
+        north_america_formatter.coerce(string)
       end
 
       # Takes in a string or a {Twilio::Rails::PhoneNumber} or something that responds to `to_s` and validates it
@@ -33,8 +27,13 @@ module Twilio
       # @param phone_number [String, Twilio::Rails::PhoneNumber, nil] the input to validate as a phone number.
       # @return [true, false]
       def valid_north_american_phone_number?(phone_number)
-        phone_number = phone_number.number if phone_number.is_a?(Twilio::Rails::PhoneNumber)
-        !!phone_number&.match?(PHONE_NUMBER_REGEX)
+        Twilio::Rails.deprecator.warn(<<~DEPRECATION.strip)
+          Twilio::Rails::Formatter#valid_north_american_phone_number?(s) is deprecated and will be removed in the next major version.
+
+          Set Twilio::Rails.config.phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+          and use Twilio::Rails.config.phone_number_formatter.valid?(s) instead.
+        DEPRECATION
+        north_america_formatter.valid?(phone_number)
       end
 
       # Takes in a string or a {Twilio::Rails::PhoneNumber} or something that responds to `to_s` and turns it into
@@ -44,11 +43,13 @@ module Twilio
       # @param phone_number [String, Twilio::Rails::PhoneNumber, nil] the input to turn into a phone number string.
       # @return [String] the phone number string or empty string if invalid.
       def to_phone_number_url_param(phone_number)
-        phone_number = coerce_to_valid_phone_number(phone_number)
-        return "" unless phone_number
-        matches = phone_number.match(PHONE_NUMBER_SEGMENTS_REGEX)
-        raise Twilio::Rails::Error, "[to_phone_number_url_param] Phone number marked as valid but could not capture. I made a bad regex: #{ phone_number }" unless matches
-        matches.captures.join("-")
+        Twilio::Rails.deprecator.warn(<<~DEPRECATION.strip)
+          Twilio::Rails::Formatter#to_phone_number_url_param(s) is deprecated and will be removed in the next major version.
+
+          Set Twilio::Rails.config.phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+          and use Twilio::Rails.config.phone_number_formatter.to_param(s) instead.
+        DEPRECATION
+        north_america_formatter.to_param(phone_number)
       end
 
       # Takes in a string or a {Twilio::Rails::PhoneNumber} or something that responds to `to_s` and turns it into a
@@ -58,14 +59,13 @@ module Twilio
       # @param phone_number [String, Twilio::Rails::PhoneNumber, nil] the input to turn into a phone number string.
       # @return [String, Object] the phone number string or the original object if invalid.
       def display_phone_number(phone_number)
-        coerced_phone_number = coerce_to_valid_phone_number(phone_number)
-        if coerced_phone_number
-          matches = coerced_phone_number.match(PHONE_NUMBER_SEGMENTS_REGEX)
-          raise Twilio::Rails::Error, "[display_phone_number] Phone number marked as valid but could not capture. I made a bad regex: #{ phone_number }" unless matches
-          "(#{ matches.captures[0] }) #{ matches.captures[1] } #{ matches.captures[2] }"
-        else
-          phone_number
-        end
+        Twilio::Rails.deprecator.warn(<<~DEPRECATION.strip)
+          Twilio::Rails::Formatter#display_phone_number(s) is deprecated and will be removed in the next major version.
+
+          Set Twilio::Rails.config.phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+          and use Twilio::Rails.config.phone_number_formatter.display(s) instead.
+        DEPRECATION
+        north_america_formatter.display(phone_number)
       end
 
       # Formats a city, province, and country into a single string, correctly handling blanks, and formatting countries.
@@ -85,9 +85,15 @@ module Twilio
         [
           city.presence&.titleize,
           province,
-          country_name,
+          country_name
         ].reject(&:blank?).join(", ")
       end
+
+      private
+
+      def north_america_formatter
+        @north_america_formatter ||= Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+      end
     end
   end
 end

data/lib/twilio/rails/models/message.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models

data/lib/twilio/rails/models/phone_call.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models

data/lib/twilio/rails/models/phone_caller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models
@@ -21,7 +22,7 @@ module Twilio
           # @param phone_number_string [String, Twilio::Rails::PhoneNumber] The phone number to find the record.
           # @return [Twilio::Rails::Models::PhoneCaller, nil] The phone caller record or `nil` if not found.
           def for(phone_number_string)
-            phone_number = Twilio::Rails::Formatter.coerce_to_valid_phone_number(phone_number_string)
+            phone_number = Twilio::Rails::PhoneNumberFormatter.coerce(phone_number_string)
             find_by(phone_number: phone_number) if phone_number.present?
           end
         end
@@ -45,11 +46,11 @@ module Twilio
 
         # @return [Array<Twilio::Rails::Models::SmsConversation>] All SMS conversations for the phone caller.
         def sms_conversations
-          Twilio::Rails.config.sms_conversation_class.phone_number(self.phone_number)
+          Twilio::Rails.config.sms_conversation_class.phone_number(phone_number)
         end
 
         # Returns the digits as a `String` as entered through the keypad during a phone call as `gather:`. Returns
-        #`nil` if the response is not found, if the response has no digits, or if the response was a timeout. Can
+        # `nil` if the response is not found, if the response has no digits, or if the response was a timeout. Can
         # include both `*` and `#` characters if the caller pressed them.
         #
         # @param prompt [String, Symbol] The prompt handle to query.

data/lib/twilio/rails/models/recording.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models

data/lib/twilio/rails/models/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models
@@ -19,11 +20,11 @@ module Twilio
           delegate :phone_caller, to: :phone_call
 
           scope :completed, -> { where(timeout: false) }
-          scope :recent_transcriptions, ->(number=5) { completed.order(created_at: :desc).where.not(transcription: nil).limit(number) }
+          scope :recent_transcriptions, ->(number = 5) { completed.order(created_at: :desc).where.not(transcription: nil).limit(number) }
           scope :final_timeout_check, ->(count:, prompt_handle:) {
             prompt(prompt_handle).order(created_at: :desc).limit(count)
           }
-          scope :tree, ->(name) { joins(:phone_call).where(phone_calls: { tree_name: name }) }
+          scope :tree, ->(name) { joins(:phone_call).where(phone_calls: {tree_name: name}) }
           scope :prompt, ->(prompt_handle) { where(prompt_handle: prompt_handle) }
           scope :in_order, -> { reorder(created_at: :asc) }
           scope :transcribed, -> { where(transcribed: true) }
@@ -37,9 +38,9 @@ module Twilio
         # @param prompt [String, Symbol, Array] The prompt handle or an array of them.
         # @return [true, false] true if the response is for the given prompt and tree.
         def is?(tree:, prompt:)
-          trees = Array(tree).map { |t| t.is_a?(Twilio::Rails::Phone::Tree) ? t.name : t.to_s }
+          Array(tree).map { |t| t.is_a?(Twilio::Rails::Phone::Tree) ? t.name : t.to_s }
 
-          from?(tree: tree) && Array(prompt).map(&:to_s).reject(&:blank?).include?(self.prompt_handle)
+          from?(tree: tree) && Array(prompt).map(&:to_s).reject(&:blank?).include?(prompt_handle)
         end
 
         # Checks if the response is for a given tree or trees or tree names.
@@ -49,7 +50,7 @@ module Twilio
         def from?(tree:)
           trees = Array(tree).map { |t| t.is_a?(Twilio::Rails::Phone::Tree) ? t.name : t.to_s }
 
-          trees.include?(self.phone_call.tree_name)
+          trees.include?(phone_call.tree_name)
         end
 
         # Returns the digits as an `Integer` entered through the keypad during a phone call as `gather:`. Returns `nil`
@@ -59,7 +60,7 @@ module Twilio
         # @return [Integer, nil] The digits as entered by the caller or `nil` if not found or not present.
         def integer_digits
           return nil unless digits.present?
-          return nil unless digits =~ /\A[0-9]+\Z/
+          return nil unless /\A[0-9]+\Z/.match?(digits)
           digits.to_i
         end
 

data/lib/twilio/rails/models/sms_conversation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Models

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
@@ -85,7 +86,7 @@ module Twilio
           # @param message [String, Hash, Array, Proc] The message to play to the caller.
           # @param prompt [Symbol, Hash, Proc] The name of the next prompt.
           # @return [nil]
-          def greeting(message: nil, prompt:)
+          def greeting(prompt:, message: nil)
             tree.greeting = Twilio::Rails::Phone::Tree::After.new(message: message, prompt: prompt)
             nil
           end
@@ -122,7 +123,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`.
@@ -154,7 +154,7 @@ module Twilio
           # * `Proc`: A proc that will be called after the message and gather have been called. The proc will receive
           #   the current {Twilio::Rails::Models::Response} instance as an argument. The proc must return one of the
           #   above.
-          def prompt(prompt_name, message: nil, gather: nil, after:)
+          def prompt(prompt_name, after:, message: nil, gather: nil)
             tree.prompts[prompt_name] = Twilio::Rails::Phone::Tree::Prompt.new(name: prompt_name, message: message, gather: gather, after: after)
             nil
           end
@@ -185,10 +185,10 @@ module Twilio
             nil
           end
 
-          # The `message:` object that played to the caller if a call from an invalid phone number is received. The
-          # important case here is a number from outside of North America. This is currently a limitation of the
-          # framework. The default is `nil` and no action is taken. See the documentation for {.prompt} for what a
-          # message object can contain.
+          # The `message:` object that played to the caller if a call from an invalid phone number is received. This can
+          # be an empty or "Unknown" number, but the important case here is a number from outside of North America. This
+          # is currently a limitation of theframework. The default is `nil` and no action is taken. See the
+          # documentation for {.prompt} for what a message object can contain.
           #
           # @param message [String, Hash, Array, Proc] The message to play to the caller.
           def invalid_phone_number(message)
@@ -201,7 +201,7 @@ module Twilio
           #
           # @return [String] the name of the tree.
           def tree_name
-            self.name.demodulize.underscore.sub(/_tree\z/, "")
+            name.demodulize.underscore.sub(/_tree\z/, "")
           end
 
           # The instance of {Twilio::Rails::Phone::Tree} built from the DSL. Should be treated as read-only. Used

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
@@ -24,14 +25,14 @@ module Twilio
         #
         # @return [String] The outbound URL for the phone tree.
         def outbound_url
-          "#{ ::Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.phone_outbound_path(tree_name: name, format: :xml) }"
+          "#{::Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.phone_outbound_path(tree_name: name, format: :xml)}"
         end
 
         # The fully qualified URL for the tree used by Twilio to be configured in the dashboard.
         #
         # @return [String] The inbound URL for the phone tree.
         def inbound_url
-          "#{ ::Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.phone_inbound_path(tree_name: name, format: :xml) }"
+          "#{::Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.phone_inbound_path(tree_name: name, format: :xml)}"
         end
 
         class Prompt
@@ -102,7 +103,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?
@@ -137,7 +137,7 @@ module Twilio
         end
 
         class Message
-          attr_reader :value, :voice, :block
+          attr_reader :voice, :block
 
           def initialize(say: nil, play: nil, pause: nil, voice: nil, &block)
             @say = say.presence
@@ -150,8 +150,8 @@ module Twilio
             raise Twilio::Rails::Phone::InvalidTreeError, "must only have one of say: play: pause:" if (@say && @play) || (@say && @pause) || (@play && @pause)
             raise Twilio::Rails::Phone::InvalidTreeError, "say: must be a string or proc" if @say && !(@say.is_a?(String) || @say.is_a?(Proc))
             raise Twilio::Rails::Phone::InvalidTreeError, "play: must be a string or proc" if @play && !(@play.is_a?(String) || @play.is_a?(Proc))
-            raise Twilio::Rails::Phone::InvalidTreeError, "play: be a valid url but is #{ @play }" if @play && @play.is_a?(String) && !@play.match(/^https?:\/\/.+/)
-            raise Twilio::Rails::Phone::InvalidTreeError, "pause: must be over zero but is #{ @pause }" if @pause && @pause <= 0
+            raise Twilio::Rails::Phone::InvalidTreeError, "play: be a valid url but is #{@play}" if @play&.is_a?(String) && !@play.match(/^https?:\/\/.+/)
+            raise Twilio::Rails::Phone::InvalidTreeError, "pause: must be over zero but is #{@pause}" if @pause && @pause <= 0
             raise Twilio::Rails::Phone::InvalidTreeError, "block is only valid for say:" if block_given? && (@play || @pause)
           end
 
@@ -184,7 +184,7 @@ module Twilio
             if set.is_a?(Hash)
               set = set.symbolize_keys
               if set.key?(:message)
-                raise Twilio::Rails::Phone::InvalidTreeError, "MessageSet should never receive a hash with any key other than :message but received #{ set }" if set.keys != [:message]
+                raise Twilio::Rails::Phone::InvalidTreeError, "MessageSet should never receive a hash with any key other than :message but received #{set}" if set.keys != [:message]
                 set = set[:message]
               end
             end
@@ -202,7 +202,7 @@ module Twilio
               elsif message.is_a?(Hash)
                 @messages << Twilio::Rails::Phone::Tree::Message.new(**message.symbolize_keys)
               else
-                raise Twilio::Rails::Phone::InvalidTreeError, "message value #{ message } is not valid"
+                raise Twilio::Rails::Phone::InvalidTreeError, "message value #{message} is not valid"
               end
             end
           end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
@@ -21,7 +22,7 @@ module Twilio
             timeout: timeout.to_i.presence || 6,
             number: 1,
             interrupt: true,
-            finish_on_key: "",
+            finish_on_key: ""
           }
         end
 
@@ -34,16 +35,16 @@ module Twilio
         # @return [String] the digits joined with commas.
         def digits(num)
           return "" if num.blank?
-          num.to_s.split("").join(", ")
+          num.to_s.chars.join(", ")
         end
 
         # Pause for a number of seconds, defaults to 1 second. Useful when putting space between segments of speech.
         #
         # @param seconds [Integer] the number of seconds to pause for, defaults to 1 second.
         # @return [Hash] formatted to pass to `message:`.
-        def pause(seconds=nil)
+        def pause(seconds = nil)
           {
-            pause: (seconds.presence || 1),
+            pause: seconds.presence || 1
           }
         end
 
@@ -66,7 +67,7 @@ module Twilio
           raise Twilio::Rails::Phone::Error, "`numbered_choices` macro got an empty array" if choices.empty?
           raise Twilio::Rails::Phone::Error, "`numbered_choices` macro cannot be more than 9" if choices.length > 9
           prefix ||= "For"
-          choices.each_with_index.map { |choice, index| "#{ prefix } #{ choice }, press #{ index + 1 }." }.join(" ")
+          choices.each_with_index.map { |choice, index| "#{prefix} #{choice}, press #{index + 1}." }.join(" ")
         end
 
         # Validates if the response object includes a digit that is within the range of the choices array. This pairs
@@ -90,6 +91,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 +107,15 @@ 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
@@ -109,9 +128,9 @@ module Twilio
           local_path = ::Rails.public_path.join(filename)
 
           if File.exist?(local_path)
-            "#{ ::Twilio::Rails.config.host }/#{ filename }"
+            "#{::Twilio::Rails.config.host}/#{filename}"
           else
-            raise Twilio::Rails::Phone::Error, "Cannot find public file '#{ filename }' at #{ local_path }"
+            raise Twilio::Rails::Phone::Error, "Cannot find public file '#{filename}' at #{local_path}"
           end
         end
 
@@ -120,7 +139,7 @@ module Twilio
         # @param filename [String] the filename of the file to play located in the `public` folder.
         # @return [Hash] formatted to pass to `message:`.
         def play_public_file(filename)
-          { play: public_file(filename) }
+          {play: public_file(filename)}
         end
 
         # Expose a {Twilio::TwiML::Say} node to be used in a `message:` block. This can be used to form Speech Synthesis