Wrapper for isPossibleNumber & isValidNumber

pom.xml

@@ -23,7 +23,7 @@
     <artifactId>normalizer</artifactId>
     <name>Phonenumber Normalizer</name>
     <description>Library to work with phonenumbers, especially to fix googles PhoneLib ignoring German Landline specifics.</description>
-    <version>1.1.16-SNAPSHOT</version>
+    <version>1.1.25-SNAPSHOT</version>
     <packaging>jar</packaging>
     <url>https://github.com/telekom/phonenumber-normalizer</url>
 
@@ -86,7 +86,7 @@
         <dependency>
             <groupId>com.googlecode.libphonenumber</groupId>
             <artifactId>libphonenumber</artifactId>
-            <version>8.13.26</version>
+            <version>8.13.35</version>
         </dependency>
 
         <dependency>
@@ -95,10 +95,13 @@
             <scope>provided</scope> <!-- must be provided, see docs -->
             <version>${lombok.version}</version>
         </dependency>
+        <!--
+        TODO: need to upgrade spring context to 6.x
+        -->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
-            <version>5.3.27</version>
+            <version>5.3.32</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
@@ -136,10 +139,18 @@
             <version>1.3.2</version>
         </dependency>
         <!-- For Testing only -->
+        <!--
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>2.0.7</version>
+            <scope>test</scope>
+        </dependency>
+        -->
         <dependency>
             <groupId>com.googlecode.libphonenumber</groupId>
             <artifactId>geocoder</artifactId>
-            <version>2.220</version>
+            <version>2.229</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -175,10 +186,11 @@
             <scope>test</scope>
         </dependency>
         <!--Replaces Version 3.5.1 which has https://devhub.checkmarx.com/cve-details/CVE-2007-2379/?utm_source=jetbrains&utm_medium=referral&utm_campaign=idea -->
+        <!--Not using Version 3.7.1 which has other vulnerabilities -->
         <dependency>
             <groupId>org.webjars</groupId>
             <artifactId>jquery</artifactId>
-            <version>3.6.4</version>
+            <version>3.7.0</version>
             <scope>test</scope>
         </dependency>
 

src/main/java/de/telekom/phonenumbernormalizer/PhoneNumberNormalizerImpl.java

@@ -45,7 +45,7 @@ public class PhoneNumberNormalizerImpl implements PhoneNumberNormalizer {
 
     @Override
     public void setFallbackRegionCode(String fallBackRegionCode) {
-        if (PhoneLibWrapper.getCountryCodeForRegion(fallBackRegionCode) > 0) {
+        if (fallBackRegionCode != null && !fallBackRegionCode.isEmpty() && PhoneLibWrapper.getCountryCodeForRegion(fallBackRegionCode) > 0) {
             this.fallbackRegionCode = fallBackRegionCode;
         } else {
             this.fallbackRegionCode = null; //invalid region code!

src/main/java/de/telekom/phonenumbernormalizer/numberplans/PhoneNumberValidationResult.java

@@ -0,0 +1,173 @@
+/*
+ * Copyright © 2024 Deutsche Telekom AG ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.telekom.phonenumbernormalizer.numberplans;
+
+import com.google.i18n.phonenumbers.PhoneNumberUtil.ValidationResult;
+
+/**
+ * Wrapper around the PhoneLib enum {@link ValidationResult} from Google
+ * <p>
+ * When the PhoneLib is validating a phone number it returns a value of the enum {@link ValidationResult}.
+ * </p><p>
+ * It differentiates two possible positive and five possible negative results. The value
+ * {@link ValidationResult#INVALID_LENGTH} is for any negative case, which is not explicitly covered by any of the other
+ * four values.
+ * While most of the values for negative cases are focused on the number length, the value
+ * {@link ValidationResult#INVALID_COUNTRY_CODE} explicitly focuses on a specific number part - the Country Code.
+ * </p><p>
+ *  This wrapper introduces explicit INVALID_ reason codes for currently undifferentiated number parts IDP, NAC and NDC.
+ *  Lastly there is also {@link PhoneNumberValidationResult#INVALID_DRAMA_NUMBER} reason code for the whole number if it
+ *  is reserved as a fictional number in arts.
+ *  </p><p>
+ *  Furthermore it introduces additional IS_POSSIBLE_ values, to hint for more specific calling restrictions of the
+ *  validated number besides {@link PhoneNumberValidationResult#IS_POSSIBLE_LOCAL_ONLY}.
+ * </p>
+ * @see ValidationResult
+ */
+
+public enum PhoneNumberValidationResult {
+
+    /** The number length matches that of valid numbers for this region or used NDC without any identified calling
+     * restrictions. */
+    IS_POSSIBLE(ValidationResult.IS_POSSIBLE),
+
+    /**
+     * The number length/pattern matches that of local numbers for this region only (i.e. numbers that may
+     * be able to be dialled within an area, but does not have all the information e.g. NDC or is not allowed to be
+     * dialled from anywhere inside or outside the country).
+     */
+    IS_POSSIBLE_LOCAL_ONLY(ValidationResult.IS_POSSIBLE_LOCAL_ONLY),
+
+    /**
+     * The number length/pattern matches that of national numbers for this region only (i.e. numbers that may
+     * be able to be dialled within an area or the region itself, but is not allowed to be dialled from
+     * anywhere outside the country using CC).
+     */
+    IS_POSSIBLE_NATIONAL_ONLY(ValidationResult.IS_POSSIBLE_LOCAL_ONLY),
+
+    /**
+     * The number length/pattern matches that of international number for this region only (i.e. number is not allowed
+     * to be call from within the region, even if CC of the regions is used).
+     */
+    IS_POSSIBLE_INTERNATIONAL_ONLY(ValidationResult.IS_POSSIBLE),
+
+    /**
+     * The number length/pattern matches that of national VPN number for this region only (i.e. number is only allowed
+     * to be call from other numbers of same VPN within this region and not by users of the public telephony network).
+     */
+    IS_POSSIBLE_NATIONAL_VPN_ONLY(ValidationResult.IS_POSSIBLE_LOCAL_ONLY),
+
+    /**
+     * The number length/pattern matches that of VPN number for this region only (i.e. number is only allowed to be call
+     * from other numbers of same VPN even internationally but not by users of the public telephony network).
+     */
+    IS_POSSIBLE_VPN_ONLY(ValidationResult.IS_POSSIBLE),
+
+    /**
+     * The number length/pattern matches that of national operator traffic control numbers for this region only
+     * (i.e. number is only allowed to be call between national operators for call routing and not directly by users of
+     * the public telephony network).
+     */
+    IS_POSSIBLE_NATIONAL_OPERATOR_ONLY(ValidationResult.IS_POSSIBLE_LOCAL_ONLY),
+
+    /**
+     * The number length/pattern matches that of operator traffic control numbers for this region only (i.e. number is
+     * only allowed to be call between operators for call routing and not directly by users of the public telephony
+     * network).
+     */
+    IS_POSSIBLE_OPERATOR_ONLY(ValidationResult.IS_POSSIBLE),
+
+    /** The number has an invalid international dialing prefix (aka IDP) for this region. */
+    INVALID_INTERNATIONAL_DIALING_PREFIX(ValidationResult.INVALID_LENGTH),
+
+    /** The number has an invalid country calling code (aka CC). */
+    INVALID_COUNTRY_CODE(ValidationResult.INVALID_COUNTRY_CODE),
+
+    /** The number has an invalid national access code (aka NAC). */
+    INVALID_NATIONAL_ACCESS_CODE(ValidationResult.INVALID_LENGTH),
+
+    /** The number has an invalid national destination code (aka NDC) for this region. */
+    INVALID_NATIONAL_DESTINATION_CODE(ValidationResult.INVALID_LENGTH),
+
+    /** The number is shorter than all valid numbers for this region or used NDC. */
+    TOO_SHORT(ValidationResult.TOO_SHORT),
+
+    /**
+     * The number is longer than the shortest valid numbers for this region or used NDC, shorter than the
+     * longest valid numbers for this region or used NDC, and does not itself have a number length that matches
+     * valid numbers for this region. This can also be returned in the case where
+     * isPossibleNumberForTypeWithReason was called, and there are no numbers of this type at all
+     * for this region or used NDC while none of the other INVALID values would match.
+     */
+    INVALID_LENGTH(ValidationResult.INVALID_LENGTH),
+
+    /** The number is longer than all valid numbers for this region, or for the used NDC. */
+    TOO_LONG(ValidationResult.TOO_LONG),
+
+    /** The number is matching a drama number range, which simulates valid number for this region only used in movies or
+     *  other fictional story telling. */
+    INVALID_DRAMA_NUMBER(ValidationResult.INVALID_LENGTH);
+
+    /**
+     * storing the corresponding enum value of {@link ValidationResult}
+     */
+    private final ValidationResult phoneLibResult;
+
+    /**
+     * Initializing a PhoneNumberValidationResult enum value with a corresponding {@link ValidationResult} enum value
+     * @param phoneLibResult corresponding {@link ValidationResult} enum value
+     */
+    PhoneNumberValidationResult(ValidationResult phoneLibResult) {
+        this.phoneLibResult = phoneLibResult;
+    }
+
+    /**
+     * Returns best matching corresponding {@link ValidationResult} enum value for an instance of a
+     * {@link PhoneNumberValidationResult} enum value
+     * @return corresponding {@link ValidationResult} enum value
+     */
+    public ValidationResult getPhoneLibValidationResult() {
+        return phoneLibResult;
+    }
+
+    /**
+     * Returns if the validation result identifies a possible number regardless of calling limitations
+     * @return boolean true for any IS_POSSIBLE(_xxx) enum value
+     */
+    public boolean isSomeHowValid() {
+        return (   (this == IS_POSSIBLE)
+                || (this == IS_POSSIBLE_LOCAL_ONLY)
+                || (this == IS_POSSIBLE_NATIONAL_ONLY)
+                || (this == IS_POSSIBLE_NATIONAL_VPN_ONLY)
+                || (this == IS_POSSIBLE_NATIONAL_OPERATOR_ONLY)
+                || (this == IS_POSSIBLE_INTERNATIONAL_ONLY)
+                || (this == IS_POSSIBLE_VPN_ONLY)
+                || (this == IS_POSSIBLE_OPERATOR_ONLY));
+    }
+
+    /**
+     * Returns if the validation result identifies a possible number regardless of calling limitations
+     * @return boolean true for any IS_POSSIBLE(_xxx) enum value except ending with _OPERATOR_ONLY or _VPN_ONLY
+     */
+    public boolean isPubliclyValid() {
+        return (   (this == IS_POSSIBLE)
+                || (this == IS_POSSIBLE_LOCAL_ONLY)
+                || (this == IS_POSSIBLE_NATIONAL_ONLY)
+                || (this == IS_POSSIBLE_INTERNATIONAL_ONLY));
+
+    }
+
+}

src/main/resources/arealabels/nationallabels/de.json

@@ -317,7 +317,7 @@
     "2623": "Ransbach Baumbach",
     "2624": "Höhr Grenzhausen",
     "2625": "Ochtendung",
-    "2626": "Selters Westferwald",
+    "2626": "Selters Westerwald",
     "2627": "Braubach",
     "2628": "Rhens",
     "2630": "Mülheim Kärlich",

src/test/groovy/de/telekom/phonenumbernormalizer/PhoneNumberNormalizerImplTest.groovy

@@ -19,6 +19,8 @@ import de.telekom.phonenumbernormalizer.dto.DeviceContext
 import de.telekom.phonenumbernormalizer.dto.DeviceContextDto
 import de.telekom.phonenumbernormalizer.dto.DeviceContextLineType
 import de.telekom.phonenumbernormalizer.numberplans.PhoneLibWrapper
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 import spock.lang.Specification
 
 
@@ -87,6 +89,10 @@ class PhoneNumberNormalizerImplTest extends Specification {
         "0176 3 0 6 9 6544"       | "DE"        | "+4917630696544"
         "0203556677"              | "DE"        | "+49203556677"
         "203556677"               | "DE"        | "203556677"
+        "55"                      | "DE"        | "55"
+        "556"                     | "DE"        | "556"
+        "5566"                    | "DE"        | "5566"
+        "55667"                   | "DE"        | "55667"
         "556677"                  | "DE"        | "556677"
         "5566778"                 | "DE"        | "5566778"
         "55667789"                | "DE"        | "55667789"
@@ -201,6 +207,7 @@ class PhoneNumberNormalizerImplTest extends Specification {
         "116000"                  | "49"        | "203"    | "116000"
         "1160001"                 | "49"        | "203"    | "+492031160001"
         //New Logic, inside german fixed-line non short numbers
+        "55"                      | "49"        | "203"    | "+4920355"
         "556"                     | "49"        | "203"    | "+49203556"
         "5566"                    | "49"        | "203"    | "+492035566"
         "55667"                   | "49"        | "203"    | "+4920355667"

src/test/groovy/de/telekom/phonenumbernormalizer/extern/libphonenumber/PhoneNumberOfflineGeocoderTest.groovy

@@ -28,6 +28,7 @@ class PhoneNumberOfflineGeocoderTest extends Specification {
 
     Logger logger = Logger.getLogger(PhoneNumberOfflineGeocoderTest.class.toString())
 
+    static final boolean LOGONLYUNEXPECTED = true
 
     def "setup"() {
         this.phoneUtil = PhoneNumberUtil.getInstance()
@@ -48,7 +49,9 @@ class PhoneNumberOfflineGeocoderTest extends Specification {
         then: "is number expected: $expectedResult"
         if ((result != expectedResult) && (result2 != expectedResult)){
             if (expectingFail) {
-                logger.info("PhoneLib is still not correctly labeling $areacode to $expectedResult by giving $result")
+                if (!LOGONLYUNEXPECTED) {
+                    logger.info("PhoneLib is still not correctly labeling $areacode to $expectedResult by giving $result")
+                }
             } else {
                 logger.warning("PhoneLib is suddenly not correctly labeling $areacode to $expectedResult by giving $result")
             }
@@ -379,7 +382,7 @@ class PhoneNumberOfflineGeocoderTest extends Specification {
         "2623"   | "Ransbach Baumbach"                      | false
         "2624"   | "Höhr Grenzhausen"                       | false
         "2625"   | "Ochtendung"                             | false
-        "2626"   | "Selters Westferwald"                    | false
+        "2626"   | "Selters Westerwald"                     | false
         "2627"   | "Braubach"                               | false
         "2628"   | "Rhens"                                  | false
         "2630"   | "Mülheim Kärlich"                        | false