twilio-rails 1.0.0 → 1.1.0

data/lib/twilio/rails/phone.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
       # Base error class for errors relating to Twilio phone interactions.
-      class Error < ::Twilio::Rails::Error ; end
+      class Error < ::Twilio::Rails::Error; end
 
       # Error raised when attempting to build a phone tree.
-      class InvalidTreeError < Error ; end
+      class InvalidTreeError < Error; end
     end
   end
 end

data/lib/twilio/rails/phone_number.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     # A phone number object that includes the country and some optional metadata.
@@ -10,8 +11,8 @@ module Twilio
       # @param label [String, nil] an optional label for the phone number, such as its source or purpose.
       # @param project [String, nil] an optional project identifier for grouping phone numbers.
       def initialize(number:, country:, label: nil, project: nil)
-        @number = Twilio::Rails::Formatter.coerce_to_valid_phone_number(number)
-        raise Twilio::Rails::Phone::Error, "Invalid phone number '#{ number }'" unless @number
+        @number = Twilio::Rails::PhoneNumberFormatter.coerce(number)
+        raise Twilio::Rails::Phone::Error, "Invalid phone number '#{number}'" unless @number
         @country = country&.upcase
         @label = label
         @project = project.presence&.to_s
@@ -19,9 +20,9 @@ module Twilio
 
       # @return [String] a human readable string representation of the phone number and its metadata.
       def to_s
-        s = "Phone number #{ number } (#{ country })"
-        s = "#{ s } #{ label }" if label.present?
-        s = "#{ s } for #{ project }" if project.present?
+        s = "Phone number #{number} (#{country})"
+        s = "#{s} #{label}" if label.present?
+        s = "#{s} for #{project}" if project.present?
         s
       end
     end

data/lib/twilio/rails/phone_number_formatter/north_america.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Twilio
+  module Rails
+    module PhoneNumberFormatter
+      # Formats phone numbers as North American 10 digit numbers only, and treats any other number as invalid.
+      # This is the legacy behavior from 1.0 which will be the default still in 1.1 as an upgrade path.
+      class NorthAmerica
+        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/
+
+        def coerce(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?(string)
+          end
+
+          string
+        end
+
+        def valid?(string)
+          string = string.number if string.is_a?(Twilio::Rails::PhoneNumber)
+          !!string&.match?(PHONE_NUMBER_REGEX)
+        end
+
+        def to_param(string)
+          string = coerce(string)
+          return "" unless string
+          matches = string.match(PHONE_NUMBER_SEGMENTS_REGEX)
+          raise Twilio::Rails::Error, "[to_param] Phone number marked as valid but could not capture. I made a bad regex: #{string}" unless matches
+          matches.captures.join("-")
+        end
+
+        def display(string)
+          coerced_phone_number = coerce(string)
+          if coerced_phone_number
+            matches = coerced_phone_number.match(PHONE_NUMBER_SEGMENTS_REGEX)
+            raise Twilio::Rails::Error, "[display] Phone number marked as valid but could not capture. I made a bad regex: #{string}" unless matches
+            "(#{matches.captures[0]}) #{matches.captures[1]} #{matches.captures[2]}"
+          else
+            string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio/rails/phone_number_formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Twilio
+  module Rails
+    # The interface for the phone number validator and formatter that is defined in the `Twilio::Rails.config.phone_number_formatter`
+    # configuration. This delegates the methods to that instance and is used both internally to the gem and by the gem consumer.
+    module PhoneNumberFormatter
+      extend self
+      extend Forwardable
+
+      def_delegators :formatter, :coerce, :valid?, :to_param, :display
+
+      private
+
+      def formatter
+        Twilio::Rails.config.phone_number_formatter
+      end
+    end
+  end
+end

data/lib/twilio/rails/railtie.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     class Railtie < ::Rails::Railtie
       config.before_initialize do
         ActiveSupport::Inflector.inflections(:en) do |inflect|
-          inflect.acronym 'SMS'
+          inflect.acronym "SMS"
         end
       end
 
@@ -12,6 +13,10 @@ module Twilio
         # TODO: This should work but it does not. I think maybe it happens too late? The same line works if you add it directly to the `application.rb` of the app. It is needed for dev mode.
         # application.config.hosts << Twilio::Rails.config.host_domain
       end
+
+      initializer "twilio_rails.deprecator" do |app|
+        app.deprecators[:twilio_rails] = Twilio::Rails.deprecator
+      end
     end
   end
 end

data/lib/twilio/rails/sms/delegated_responder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
@@ -34,7 +35,7 @@ module Twilio
           #
           # @return [String] the name of the responder.
           def responder_name
-            self.name.demodulize.underscore.gsub(/_responder\Z/, "")
+            name.demodulize.underscore.gsub(/_responder\Z/, "")
           end
         end
 
@@ -43,22 +44,22 @@ module Twilio
           @sms_conversation = message.sms_conversation
         end
 
-        # Must be implemented by the subclass otherwise will raise a `NotImplementedError`. Returns true if this
+        # Must be implemented by the subclass otherwise will raise a `NoMethodError`. Returns true if this
         # responder should handle the given message. If true then the {#reply} method will be called to generate the
         # body of the response. It has access to the message and the conversation.
         #
         # @return [true, false] true if this responder should handle the given message.
         def handle?
-          raise NotImplementedError
+          raise NoMethodError, "#{self.class}#handle? must be implemented."
         end
 
-        # Must be implemented by the subclass otherwise will raise a `NotImplementedError`. Returns the body of the
+        # Must be implemented by the subclass otherwise will raise a `NoMethodError`. Returns the body of the
         # message to be sent in response. Will only be called if {#handle?} returns true. It has access to the message
         # and the conversation.
         #
         # @return [String, nil] the body of the response to be sent as SMS, or `nil` if no message should be sent.
         def reply
-          raise NotImplementedError
+          raise NoMethodError, "#{self.class}#reply must be implemented."
         end
 
         protected

data/lib/twilio/rails/sms/responder.rb

@@ -1,5 +1,5 @@
-
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
@@ -25,7 +25,8 @@ module Twilio
             return responder.reply if responder.handle?
           end
 
-          raise Twilio::Rails::SMS::InvalidResponderError, "No responder found for message_id=#{ message.id } : #{ message.body }"
+          raise Twilio::Rails::SMS::InvalidResponderError, "No responder found for SMS. message_id=#{message.id} " \
+            "phone_caller_id=#{sms_conversation.phone_caller&.id} from_number=\"#{sms_conversation.from_number}\" body=\"#{message.body}\""
         end
       end
     end

data/lib/twilio/rails/sms.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
       # Base error class for errors relating to Twilio phone interactions.
-      class Error < ::Twilio::Rails::Error ; end
+      class Error < ::Twilio::Rails::Error; end
 
       # Error raised when a responder is unable to handle an SMS message.
-      class InvalidResponderError < Error ; end
+      class InvalidResponderError < Error; end
     end
   end
 end

data/lib/twilio/rails/version.rb

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

data/lib/twilio/rails.rb

@@ -1,3 +1,4 @@
+require "forwardable"
 require "active_operation"
 require "twilio-ruby"
 require "faraday"
@@ -8,13 +9,15 @@ require "twilio/rails/engine"
 module Twilio
   module Rails
     # Base error class for all errors raised by the Twilio::Rails gem. Every error is a subclass of this one.
-    class Error < StandardError ; end
+    class Error < StandardError; end
   end
 end
 
 require "twilio/rails/railtie"
 require "twilio/rails/configuration"
 require "twilio/rails/formatter"
+require "twilio/rails/phone_number_formatter"
+require "twilio/rails/phone_number_formatter/north_america"
 require "twilio/rails/phone_number"
 require "twilio/rails/client"
 
@@ -40,7 +43,6 @@ require "twilio/rails/models/message"
 module Twilio
   module Rails
     class << self
-
       # Read and write accessible configuration object. In most cases this should only be read after the app has been
       # initialized. See {Twilio::Rails::Configuration} for more information.
       #
@@ -49,6 +51,14 @@ module Twilio
         @config ||= ::Twilio::Rails::Configuration.new
       end
 
+      # See the ActiveSupport::Deprecation documentation:
+      # https://api.rubyonrails.org/classes/ActiveSupport/Deprecation.html
+      #
+      # @return [ActiveSupport::Deprecation] the deprecator for the engine.
+      def deprecator
+        @deprecator ||= ActiveSupport::Deprecation.new("2.0", "Twilio::Rails")
+      end
+
       # Called in the `config/initializers/twilio_rails.rb` file to configure the engine. This yields the {.config}
       # object above and then calls {Twilio::Rails::Configuration#validate!} to ensure the configuration is valid.
       #
@@ -60,30 +70,6 @@ module Twilio
         config.validate!
         nil
       end
-
-      # Abstraction for the framework to notify of an important exception that has occurred. This safely calls the
-      # configured `config.exception_notifier` or does nothing if it is set to `nil`. This does not catch, handle, or
-      # prevent the exception from raising.
-      #
-      # @param exception [Exception] the exception that has occurred.
-      # @param message [String] a description of the exception, defaults to `exception.message` if blank.
-      # @param context [Hash] a hash of arbitrary additional context to include in the notification.
-      # @param exception_binding [Binding] the binding of where the exception is being notified.
-      # @return [true, false] if an exception has been successfully notified.
-      def notify_exception(exception, message: nil, context: {}, exception_binding: nil)
-        if config.exception_notifier
-          begin
-            message = message.presence || exception.message
-            config.exception_notifier.call(exception, message, context, exception_binding)
-            true
-          rescue => e
-            config.logger.tagged(self.class) { |l| l.error("ExceptionNotifier failed to notify of exception=#{ exception.inspect } message=#{ message.inspect } context=#{ context.inspect }") }
-            false
-          end
-        else
-          false
-        end
-      end
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twilio-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin McPhillips
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +163,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Rails engine that provides the framework to build complex phone interactions
   using the Twilio API.
 email:
@@ -201,6 +214,7 @@ files:
 - app/operations/twilio/rails/phone/twiml/base_operation.rb
 - app/operations/twilio/rails/phone/twiml/error_operation.rb
 - app/operations/twilio/rails/phone/twiml/greeting_operation.rb
+- app/operations/twilio/rails/phone/twiml/invalid_phone_number_operation.rb
 - app/operations/twilio/rails/phone/twiml/prompt_operation.rb
 - app/operations/twilio/rails/phone/twiml/prompt_response_operation.rb
 - app/operations/twilio/rails/phone/twiml/request_validation_failure_operation.rb
@@ -255,6 +269,8 @@ files:
 - lib/twilio/rails/phone/tree.rb
 - lib/twilio/rails/phone/tree_macros.rb
 - lib/twilio/rails/phone_number.rb
+- lib/twilio/rails/phone_number_formatter.rb
+- lib/twilio/rails/phone_number_formatter/north_america.rb
 - lib/twilio/rails/railtie.rb
 - lib/twilio/rails/sms.rb
 - lib/twilio/rails/sms/delegated_responder.rb
@@ -267,7 +283,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
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/twilio-rails
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -282,8 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A framework for building rich phone interactions in Rails using Twilio.
 test_files: []