twilio-rails 1.0.0 → 1.1.0

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
@@ -20,12 +21,12 @@ module Twilio
                 twiml.hangup
               end
 
-              Twilio::Rails.config.logger.info("final timeout on phone_call##{ phone_call.id }")
-              Twilio::Rails.config.logger.info("timeout_twiml: #{twiml_response.to_s}")
+              Twilio::Rails.config.logger.info("final timeout on phone_call##{phone_call.id}")
+              Twilio::Rails.config.logger.info("timeout_twiml: #{twiml_response}")
               twiml_response.to_s
             else
               prompt = tree.prompts[response.prompt_handle]
-              raise Twilio::Rails::Phone::InvalidTreeError, "cannot find #{ response.prompt_handle } in #{ tree.name }" unless prompt
+              raise Twilio::Rails::Phone::InvalidTreeError, "cannot find #{response.prompt_handle} in #{tree.name}" unless prompt
 
               after = prompt.after
               after = Twilio::Rails::Phone::Tree::After.new(after.proc.call(response)) if after.proc
@@ -36,7 +37,7 @@ module Twilio
 
           private
 
-          def final_timeout?(last_response, count: )
+          def final_timeout?(last_response, count:)
             responses = phone_call.responses.final_timeout_check(count: count, prompt_handle: last_response.prompt_handle)
 
             responses.count == count && responses.all? { |r| r.timeout? }

data/app/operations/twilio/rails/phone/unanswered_call_operation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module Phone
@@ -13,7 +14,7 @@ module Twilio
             Twilio::Rails.config.logger.tagged(self.class) { |l| l.warn("Skipping duplicate unanswered call job") }
           else
             phone_call.update!(unanswered: true)
-            phone_call.tree.unanswered_call.call(phone_call) if phone_call.tree.unanswered_call
+            phone_call.tree.unanswered_call&.call(phone_call)
           end
         end
       end

data/app/operations/twilio/rails/phone/update_operation.rb

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

data/app/operations/twilio/rails/phone/update_response_operation.rb

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

data/app/operations/twilio/rails/sms/base_operation.rb

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

data/app/operations/twilio/rails/sms/create_operation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
@@ -12,7 +13,7 @@ module Twilio
             from_number: params["From"].presence,
             from_city: params["FromCity"].presence,
             from_province: params["FromState"].presence,
-            from_country: params["FromCountry"].presence,
+            from_country: params["FromCountry"].presence
           )
           conversation.save!
           conversation

data/app/operations/twilio/rails/sms/find_message_operation.rb

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

data/app/operations/twilio/rails/sms/find_operation.rb

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

data/app/operations/twilio/rails/sms/send_operation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
@@ -19,7 +20,7 @@ module Twilio
         input :messages, accepts: Array, type: :keyword, required: true
         input :from_number, accepts: [String, Twilio::Rails::PhoneNumber], type: :keyword, required: false
 
-        TWILIO_UNSUBSCRIBED_ERROR_CODES = [ 21610 ].freeze
+        TWILIO_UNSUBSCRIBED_ERROR_CODES = [21610].freeze
 
         # @param phone_caller_id [Integer] the id of the phone caller to send the message to.
         # @param messages [Array<String>] the messages to send to the phone caller. It may be empty.
@@ -29,14 +30,14 @@ module Twilio
         # @return [Twilio::Rails::Models::SMSConversation] the SMS conversation that was created and sent.
         def execute
           return nil if messages.blank?
-          raise Twilio::Rails::SMS::Error, "from_number=#{ from_number } is not a valid phone number" if from_number.present? && !Twilio::Rails::Formatter.coerce_to_valid_phone_number(from_number)
+          raise Twilio::Rails::SMS::Error, "from_number=#{from_number} is not a valid phone number" if from_number.present? && !Twilio::Rails::PhoneNumberFormatter.coerce(from_number)
 
           conversation = ::Twilio::Rails.config.sms_conversation_class.new(
             number: calculated_from_number,
             from_number: calculated_to_number,
             from_city: phone_call&.from_city,
             from_province: phone_call&.from_province,
-            from_country: phone_call&.from_country,
+            from_country: phone_call&.from_country
           )
           conversation.save!
 
@@ -46,21 +47,20 @@ module Twilio
               sid = Twilio::Rails::Client.send_message(
                 message: body,
                 to: calculated_to_number,
-                from: calculated_from_number,
+                from: calculated_from_number
               )
             rescue Twilio::REST::RestError => e
               if TWILIO_UNSUBSCRIBED_ERROR_CODES.include?(e.code)
-                Twilio::Rails.config.logger.tagged(self.class) { |l| l.warn("tried to send to unsubscribed and got Twilio::REST::RestError code=21610 phone_caller_id=#{ phone_caller.id } phone_number=#{ calculated_to_number } message=#{ body }") }
+                Twilio::Rails.config.logger.tagged(self.class) { |l| l.warn("tried to send to unsubscribed and got Twilio::REST::RestError code=21610 phone_caller_id=#{phone_caller.id} phone_number=#{calculated_to_number} message=#{body}") }
               else
-                Twilio::Rails.notify_exception(e,
-                  message: "Failed to send Twilio message. Got REST error response.",
+                ::Rails.error.report(e,
+                  handled: false,
                   context: {
+                    message: "Failed to send Twilio message. Got REST error response.",
                     to: calculated_to_number,
                     from: calculated_from_number,
-                    phone_call_id: phone_call&.id,
-                  },
-                  exception_binding: binding
-                )
+                    phone_call_id: phone_call&.id
+                  })
                 raise
               end
             end
@@ -85,7 +85,7 @@ module Twilio
 
         def calculated_from_number
           if from_number.present?
-            Twilio::Rails::Formatter.coerce_to_valid_phone_number(from_number)
+            Twilio::Rails::PhoneNumberFormatter.coerce(from_number)
           elsif phone_call
             phone_call.number
           else

data/app/operations/twilio/rails/sms/twiml/base_operation.rb

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

data/app/operations/twilio/rails/sms/twiml/error_operation.rb

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

data/app/operations/twilio/rails/sms/twiml/message_operation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     module SMS
@@ -20,7 +21,7 @@ module Twilio
             if body.present?
               message = conversation.messages.build(
                 direction: "outbound",
-                body: body,
+                body: body
               )
 
               message.save!
@@ -32,11 +33,11 @@ module Twilio
                 )
               end
 
-              Twilio::Rails.config.logger.info("message_twiml: #{twiml_response.to_s}")
+              Twilio::Rails.config.logger.info("message_twiml: #{twiml_response}")
               twiml_response.to_s
             else
               Twilio::Rails.config.logger.info("resply is blank, not sending message in response")
-              Twilio::Rails.config.logger.info("message_twiml: #{twiml_response.to_s}")
+              Twilio::Rails.config.logger.info("message_twiml: #{twiml_response}")
 
               twiml = Twilio::TwiML::MessagingResponse.new
               twiml.to_s

data/app/operations/twilio/rails/sms/update_message_operation.rb

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

data/lib/generators/twilio/rails/install/install_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Twilio::Rails::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path("templates", __dir__)
 

data/lib/generators/twilio/rails/install/templates/initializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Twilio::Rails.setup do |config|
   # These are the Twilio account credentials used to access the Twilio API. These should likely be configured in the
   # encrypted Rails credentials or loaded from an ENV variable.
@@ -45,14 +46,6 @@ Twilio::Rails.setup do |config|
   #   [ "Bad text" ].any? { |regex| regex.match?(params["Body"]) }
   # }
 
-  # 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.
-  # config.exception_notifier = ->(exception, message, context, exception_binding) {
-  #   MyChatClient.send_message("Error: #{ message } #{ exception.message } #{ context }")
-  # }
-
   # 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. if reordings will be downloaded.
@@ -66,6 +59,10 @@ Twilio::Rails.setup do |config|
   # the phone macros. Defaults to a list of common responses.
   # config.no_responses = ["no"]
 
+  # An instance of class that will be used to format phone numbers. Defaults to `Twilio::Rails::PhoneNumberFormatter::NorthAmerica`
+  # for now but in the next major version it will be set to a formatter that can handle all countries.
+  # config.phone_number_formatter = Twilio::Rails::PhoneNumberFormatter::NorthAmerica.new
+
   # The name of the model classes, as strings, that this application uses to represent the concepts stored in the DB.
   # The generators will generate the models with the default names below, but they can be changed as the application
   # may need.

data/lib/generators/twilio/rails/install/templates/message.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Message < ApplicationRecord
   include Twilio::Rails::Models::Message
 end

data/lib/generators/twilio/rails/install/templates/phone_call.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class PhoneCall < ApplicationRecord
   include Twilio::Rails::Models::PhoneCall
 end

data/lib/generators/twilio/rails/install/templates/phone_caller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class PhoneCaller < ApplicationRecord
   include Twilio::Rails::Models::PhoneCaller
 end

data/lib/generators/twilio/rails/install/templates/recording.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Recording < ApplicationRecord
   include Twilio::Rails::Models::Recording
 end

data/lib/generators/twilio/rails/install/templates/response.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Response < ApplicationRecord
   include Twilio::Rails::Models::Response
 end

data/lib/generators/twilio/rails/install/templates/sms_conversation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SMSConversation < ApplicationRecord
   include Twilio::Rails::Models::SMSConversation
 end

data/lib/generators/twilio/rails/phone_tree/phone_tree_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Twilio::Rails::PhoneTreeGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 

data/lib/generators/twilio/rails/sms_responder/sms_responder_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Twilio::Rails::SmsResponderGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 

data/lib/generators/twilio/rails/sms_responder/templates/responder.rb.erb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 class <%= class_name %>Responder < Twilio::Rails::SMS::DelegatedResponder
   def handle?
-    raise NotImplementedError, "Implement #{ self.class }#handle?"
+    raise NoMethodError, "#{ self.class }#handle? must be implemented."
   end
 
   def reply
-    raise NotImplementedError, "Implement #{ self.class }#reply"
+    raise NoMethodError, "#{ self.class }#reply must be implemented."
   end
 end

data/lib/tasks/rails_tasks.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 namespace :twilio do
   namespace :rails do
     desc "Show the available values to config in Twilio"
@@ -9,7 +10,7 @@ namespace :twilio do
         puts "Twilio::Rails.config.host is set to a test value. Set it in the `config/initializers/twilio_rails.rb` file."
       else
         http_methods = if Twilio::Rails.config.controller_http_methods.length == 1
-          "HTTP #{ Twilio::Rails.config.controller_http_methods.first.to_s.upcase }"
+          "HTTP #{Twilio::Rails.config.controller_http_methods.first.to_s.upcase}"
         else
           "HTTP POST or HTTP GET"
         end
@@ -22,18 +23,18 @@ namespace :twilio do
           puts "You cannot yet configure `Voice & Fax' because There are no phone trees registered in this application."
           puts "Register them in the `config/initializers/twilio_rails.rb` file if you want to handle phone calls, and run this task again to help configure Twilio."
         else
-          puts "Under 'Voice & Fax' set 'A CALL COMES IN' to 'Webhook' with #{ http_methods } and one of the following URLs:"
+          puts "Under 'Voice & Fax' set 'A CALL COMES IN' to 'Webhook' with #{http_methods} and one of the following URLs:"
           Twilio::Rails.config.phone_trees.all.each do |name, tree|
             puts "  #{tree.inbound_url}"
           end
           puts ""
           puts "Under 'Voice & Fax' set 'CALL STATUS CHANGES' to following URL:"
-          puts "  #{ ::Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml) }"
+          puts "  #{::Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml)}"
         end
 
         puts ""
-        puts "Under 'Messaging' set 'A MESSAGE COMES IN' to 'Webhook' with #{ http_methods } and the following URL:"
-        puts "  #{ ::Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.sms_message_path(format: :xml) }"
+        puts "Under 'Messaging' set 'A MESSAGE COMES IN' to 'Webhook' with #{http_methods} and the following URL:"
+        puts "  #{::Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.sms_message_path(format: :xml)}"
 
         if Twilio::Rails.config.sms_responders.all.length == 0
           puts "There are no SMS responders registered so they will not be handled."

data/lib/twilio/rails/client.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     # An abstraction over top of the `Twilio::REST` API client. Used to send SMS messages and start calls, as well as
@@ -10,7 +11,7 @@ module Twilio
       def client
         @twilio_client ||= Twilio::REST::Client.new(
           Twilio::Rails.config.account_sid,
-          Twilio::Rails.config.auth_token,
+          Twilio::Rails.config.auth_token
         )
       end
 
@@ -23,12 +24,12 @@ module Twilio
       # @param from [String] the phone number to send the message from.
       # @return [String] the SID returned from Twilio for the sent SMS message.
       def send_message(message:, to:, from:)
-        Twilio::Rails.config.logger.tagged(self) { |l| l.info("[send_message] to=#{ to } from=#{ from } body='#{ message }'") }
+        Twilio::Rails.config.logger.tagged(self) { |l| l.info("[send_message] to=#{to} from=#{from} body='#{message}'") }
         client.messages.create(
           from: from,
           to: to,
           body: message,
-          status_callback: "#{ Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.sms_status_path(format: :xml) }",
+          status_callback: "#{Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.sms_status_path(format: :xml)}"
         ).sid
       end
 
@@ -55,18 +56,18 @@ module Twilio
       # @param answering_machine_detection [true, false] whether or not to enable answering machine detection.
       # @return [String] the SID returned from Twilio for the started call.
       def start_call(url:, to:, from:, answering_machine_detection: true)
-        Twilio::Rails.config.logger.tagged(self) { |l| l.info("[start_call] to=#{ to } from=#{ from } url=#{ url } answering_machine_detection=#{ !!answering_machine_detection }") }
+        Twilio::Rails.config.logger.tagged(self) { |l| l.info("[start_call] to=#{to} from=#{from} url=#{url} answering_machine_detection=#{!!answering_machine_detection}") }
         client.calls.create(
           from: from,
           to: to,
           url: url,
-          machine_detection: ( answering_machine_detection ? "Enable" : "Disable" ),
+          machine_detection: (answering_machine_detection ? "Enable" : "Disable"),
           async_amd: true,
-          async_amd_status_callback: "#{ Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml, async_amd: "true") }",
+          async_amd_status_callback: "#{Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml, async_amd: "true")}",
           async_amd_status_callback_method: "POST",
-          status_callback: "#{ Twilio::Rails.config.host }#{ ::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml) }",
+          status_callback: "#{Twilio::Rails.config.host}#{::Twilio::Rails::Engine.routes.url_helpers.phone_status_path(format: :xml)}",
           status_callback_method: "POST",
-          status_callback_event: ["completed", "no-answer"],
+          status_callback_event: ["completed", "no-answer"]
           # timeout: 30,
         ).sid
       end

data/lib/twilio/rails/concerns/has_direction.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     # Provides scopes, validations, and convenience methods for a model that has an attribute `direction` with
@@ -7,7 +8,7 @@ module Twilio
       extend ActiveSupport::Concern
 
       included do
-        validates :direction, inclusion: { in: ["outbound", "inbound"] }
+        validates :direction, inclusion: {in: ["outbound", "inbound"]}
 
         scope :outbound, -> { where(direction: "outbound") }
         scope :inbound, -> { where(direction: "inbound") }

data/lib/twilio/rails/concerns/has_phone_number.rb

@@ -1,26 +1,35 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     # Provides validations and reformatting on validation for a model that has an attribute `phone_number` that is
-    # that is unique and that matches {Twilio::Rails::Formatter.coerce_to_valid_phone_number}.
+    # that is unique and that matches {Twilio::Rails::PhoneNumberFormatter.coerce}.
     module HasPhoneNumber
       extend ActiveSupport::Concern
 
       included do
-        validates :phone_number, uniqueness: { allow_blank: true, message: "already exists" }
+        validates :phone_number, uniqueness: {allow_blank: true, message: "already exists"}
 
         before_validation :reformat_phone_number
       end
 
       def reformat_phone_number
-        current = Twilio::Rails::Formatter.coerce_to_valid_phone_number(phone_number)
+        current = Twilio::Rails::PhoneNumberFormatter.coerce(phone_number)
         self.phone_number = current if current
 
         true
       end
 
       def valid_north_american_phone_number?
-        Twilio::Rails::Formatter.valid_north_american_phone_number?(phone_number)
+        Twilio::Rails.deprecator.warn(<<~DEPRECATION.strip)
+          valid_north_american_phone_number? is deprecated and will be removed in the next major version.
+          Use valid_phone_number? instead. The configured phone_number_formatter can manage the region of the phone number.
+        DEPRECATION
+        Twilio::Rails::PhoneNumberFormatter.valid?(phone_number)
+      end
+
+      def valid_phone_number?
+        Twilio::Rails::PhoneNumberFormatter.valid?(phone_number)
       end
     end
   end

data/lib/twilio/rails/concerns/has_time_scopes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Twilio
   module Rails
     # Provides convenience scopes for a model that has a `created_at` attribute.