Module: Twilio::Rails::Formatter

Extended by:
Formatter
Included in:
Formatter
Defined in:
lib/twilio/rails/formatter.rb

Instance Method Summary collapse

Instance Method Details

#coerce_to_valid_phone_number(string) ⇒ String?

Takes in a string or a 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.

Parameters:

Returns:

  • (String, nil) —

    the phone number string or nil.



14
15
16
17
18
19
20
21
22
 
# File 'lib/twilio/rails/formatter.rb', line 14

def coerce_to_valid_phone_number(string)
  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.

    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

#display_phone_number(phone_number) ⇒ String, Object

Takes in a string or a PhoneNumber or something that responds to to_s and turns it into a phone number string formatted for display. If the number cannot be coerced to a valid phone number it will be passed through.

Parameters:

Returns:

  • (String, Object) —

    the phone number string or the original object if invalid.



61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio/rails/formatter.rb', line 61

def display_phone_number(phone_number)
  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

#location(city: nil, country: nil, province: nil) ⇒ String

Formats a city, province, and country into a single string, correctly handling blanks, and formatting countries.

Parameters:

  • city (String, nil) (defaults to: nil) —

    the city name.

  • province (String, nil) (defaults to: nil) —

    the province name.

  • country (String, nil) (defaults to: nil) —

    the country code.

Returns:

  • (String) —

    the formatted location string.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio/rails/formatter.rb', line 77

def location(city: nil, country: nil, province: nil)
  country_name = case country
  when "CA" then "Canada"
  when "US" then "USA"
  else
    country
  end

  [
    city.presence&.titleize,
    province,
    country_name
  ].reject(&:blank?).join(", ")
end

#to_phone_number_url_param(phone_number) ⇒ String

Takes in a string or a PhoneNumber or something that responds to to_s and turns it into a phone number formatted for URLs. Appropriate to use for #to_param in Rails or other controller concerns where a phone number or phone caller can be passed around as a URL parameter.

Parameters:

Returns:

  • (String) —

    the phone number string or empty string if invalid.



45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio/rails/formatter.rb', line 45

def to_phone_number_url_param(phone_number)
  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

#valid_north_american_phone_number?(phone_number) ⇒ true, false

Takes in a string or a PhoneNumber or something that responds to to_s and validates it matches the expected format "+15555555555" of a north american phone number.

Parameters:

Returns:

  • (true, false) 


29
30
31
32
33
34
35
36
37
 
# File 'lib/twilio/rails/formatter.rb', line 29

def valid_north_american_phone_number?(phone_number)
  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