Add isSmsServiceForRegion(PhoneNumber, RegionCode) API in C++ and Java libraries (#1841)

cpp/src/phonenumbers/shortnumberinfo.cc

@@ -395,5 +395,19 @@ bool ShortNumberInfo::IsCarrierSpecificForRegion(const PhoneNumber& number,
              phone_metadata->carrier_specific());
 }
 
+bool ShortNumberInfo::IsSmsServiceForRegion(const PhoneNumber& number,
+    const string& region_dialing_from) const {
+  if (!RegionDialingFromMatchesNumber(number, region_dialing_from)) {
+    return false;
+  }
+  string national_number;
+  phone_util_.GetNationalSignificantNumber(number, &national_number);
+  const PhoneMetadata* phone_metadata =
+      GetMetadataForRegion(region_dialing_from);
+  return phone_metadata &&
+         MatchesPossibleNumberAndNationalNumber(*matcher_api_, national_number,
+             phone_metadata->sms_services());
+}
+
 }  // namespace phonenumbers
 }  // namespace i18n

cpp/src/phonenumbers/shortnumberinfo.h

@@ -162,6 +162,18 @@ class ShortNumberInfo {
       const PhoneNumber& number,
       const string& region_dialing_from) const;
 
+  // Given a valid short number, determines whether it is an SMS service
+  // (however, nothing is implied about its validity). An SMS service is where
+  // the primary or only intended usage is to receive and/or send text messages
+  // (SMSs). This includes MMS as MMS numbers downgrade to SMS if the other
+  // party isn't MMS-capable. If it is important that the number is valid, then
+  // its validity must first be checked using IsValidShortNumber or
+  // IsValidShortNumberForRegion. Returns false if the number doesn't match the
+  // region provided.
+  bool IsSmsServiceForRegion(
+      const PhoneNumber& number,
+      const string& region_dialing_from) const;
+
  private:
   const PhoneNumberUtil& phone_util_;
   const scoped_ptr<const MatcherApi> matcher_api_;

cpp/test/phonenumbers/shortnumberinfo_test.cc

@@ -123,6 +123,16 @@ TEST_F(ShortNumberInfoTest, IsCarrierSpecific) {
       carrier_specific_number_for_some_region, RegionCode::BB()));
 }
 
+TEST_F(ShortNumberInfoTest, IsSmsService) {
+  PhoneNumber sms_service_number_for_some_region;
+  sms_service_number_for_some_region.set_country_code(1);
+  sms_service_number_for_some_region.set_national_number(21234ULL);
+  EXPECT_TRUE(short_info_.IsSmsServiceForRegion(
+      sms_service_number_for_some_region, RegionCode::US()));
+  EXPECT_FALSE(short_info_.IsSmsServiceForRegion(
+      sms_service_number_for_some_region, RegionCode::BB()));
+}
+
 TEST_F(ShortNumberInfoTest, GetExpectedCost) {
   uint64 national_number;
   const string& premium_rate_example =

java/libphonenumber/src/com/google/i18n/phonenumbers/Phonemetadata.java

@@ -576,6 +576,20 @@ public final class Phonemetadata {
       return this;
     }
 
+    // optional PhoneNumberDesc sms_services = 33;
+    private boolean hasSmsServices;
+    private PhoneNumberDesc smsServices_ = null;
+    public boolean hasSmsServices() { return hasSmsServices; }
+    public PhoneNumberDesc getSmsServices() { return smsServices_; }
+    public PhoneMetadata setSmsServices(PhoneNumberDesc value) {
+      if (value == null) {
+        throw new NullPointerException();
+      }
+      hasSmsServices = true;
+      smsServices_ = value;
+      return this;
+    }
+
     // optional PhoneNumberDesc noInternationalDialling = 24;
     private boolean hasNoInternationalDialling;
     private PhoneNumberDesc noInternationalDialling_ = null;
@@ -877,6 +891,10 @@ public final class Phonemetadata {
       if (hasCarrierSpecific) {
         carrierSpecific_.writeExternal(objectOutput);
       }
+      objectOutput.writeBoolean(hasSmsServices);
+      if (hasSmsServices) {
+        smsServices_.writeExternal(objectOutput);
+      }
       objectOutput.writeBoolean(hasNoInternationalDialling);
       if (hasNoInternationalDialling) {
         noInternationalDialling_.writeExternal(objectOutput);
@@ -1029,6 +1047,12 @@ public final class Phonemetadata {
         setCarrierSpecific(desc);
       }
       hasDesc = objectInput.readBoolean();
+      if (hasDesc) {
+        PhoneNumberDesc desc = new PhoneNumberDesc();
+        desc.readExternal(objectInput);
+        setSmsServices(desc);
+      }
+      hasDesc = objectInput.readBoolean();
       if (hasDesc) {
         PhoneNumberDesc desc = new PhoneNumberDesc();
         desc.readExternal(objectInput);

java/libphonenumber/src/com/google/i18n/phonenumbers/ShortNumberInfo.java

@@ -461,9 +461,9 @@ public class ShortNumberInfo {
    * valid, then its validity must first be checked using {@link #isValidShortNumber} or
    * {@link #isValidShortNumberForRegion}.
    *
-   * @param number the valid short number to check
-   * @return whether the short number is carrier-specific (assuming the input was a valid short
-   *     number).
+   * @param number  the valid short number to check
+   * @return whether the short number is carrier-specific, assuming the input was a valid short
+   *     number
    */
   public boolean isCarrierSpecific(PhoneNumber number) {
     List<String> regionCodes = getRegionCodesForCountryCode(number.getCountryCode());
@@ -485,8 +485,8 @@ public class ShortNumberInfo {
    *
    * @param number  the valid short number to check
    * @param regionDialingFrom  the region from which the number is dialed
-   * @return  whether the short number is carrier-specific (assuming the input was a valid short
-   *     number)
+   * @return  whether the short number is carrier-specific in the provided region, assuming the
+   *     input was a valid short number
    */
   public boolean isCarrierSpecificForRegion(PhoneNumber number, String regionDialingFrom) {
     if (!regionDialingFromMatchesNumber(number, regionDialingFrom)) {
@@ -500,6 +500,30 @@ public class ShortNumberInfo {
                 phoneMetadata.getCarrierSpecific()));
   }
 
+  /**
+   * Given a valid short number, determines whether it is an SMS service (however, nothing is
+   * implied about its validity). An SMS service is where the primary or only intended usage is to
+   * receive and/or send text messages (SMSs). This includes MMS as MMS numbers downgrade to SMS if
+   * the other party isn't MMS-capable. If it is important that the number is valid, then its
+   * validity must first be checked using {@link #isValidShortNumber} or {@link
+   * #isValidShortNumberForRegion}. Returns false if the number doesn't match the region provided.
+   *
+   * @param number  the valid short number to check
+   * @param regionDialingFrom  the region from which the number is dialed
+   * @return  whether the short number is an SMS service in the provided region, assuming the input
+   *     was a valid short number
+   */
+  public boolean isSmsServiceForRegion(PhoneNumber number, String regionDialingFrom) {
+    if (!regionDialingFromMatchesNumber(number, regionDialingFrom)) {
+      return false;
+    }
+    PhoneMetadata phoneMetadata =
+        MetadataManager.getShortNumberMetadataForRegion(regionDialingFrom);
+    return phoneMetadata != null
+        && matchesPossibleNumberAndNationalNumber(getNationalSignificantNumber(number),
+            phoneMetadata.getSmsServices());
+  }
+
   /**
    * Gets the national significant number of the a phone number. Note a national significant number
    * doesn't contain a national prefix or any formatting.