tracking_number 0.10.5 → 3.0.0

data/lib/data/couriers/speedee.json

@@ -0,0 +1,26 @@
+{
+  "name": "Spee-Dee Delivery",
+  "courier_code": "speedee",
+  "tracking_numbers": [
+    {
+      "name": "Spee-Dee (20)",
+      "id": "speedee",
+      "regex": "\\s*S\\s*P\\s*(?<SerialNumber>([0-9]\\s*){18})\\s*",
+      "validation": {},
+      "tracking_url": "https://www.speedeedelivery.com/track/?tracking=%s",
+      "test_numbers": {
+        "valid": [
+          "SP029692510000920746",
+          "SP029692510000901479",
+          "SP029692510000688332",
+          "SP029692510000279301",
+          "SP029692450001607639"
+        ],
+        "invalid": [
+          "029692510000920746",
+          "SX029692510000920746"
+        ]
+      }
+    }
+  ]
+}

data/lib/data/couriers/ups.json

@@ -0,0 +1,197 @@
+{
+  "name": "UPS",
+  "courier_code": "ups",
+  "tracking_numbers": [
+    {
+      "name": "UPS",
+      "id": "ups",
+      "regex": [
+        "\\s*1\\s*Z\\s*(?<SerialNumber>",
+        "(?<ShipperId>(?:[A-Z0-9]\\s*){6,6})",
+        "(?<ServiceType>(?:[A-Z0-9]\\s*){2,2})",
+        "(?<PackageId>(?:[A-Z0-9]\\s*){7,7}))",
+        "(?<CheckDigit>[0-9]\\s*)"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 1,
+          "odds_multiplier": 2,
+          "reverse": false
+        }
+      },
+      "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=%s",
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            {
+              "matches": "01",
+              "name": "UPS United States Next Day Air (Red)"
+            },
+            {
+              "matches": "02",
+              "name": "UPS United States Second Day Air (Blue)"
+            },
+            {
+              "matches": "03",
+              "name": "UPS United States Ground"
+            },
+            {
+              "matches": "12",
+              "name": "UPS United States Third Day Select"
+            },
+            {
+              "matches": "13",
+              "name": "UPS United States Next Day Air Saver (Red Saver)"
+            },
+            {
+              "matches": "15",
+              "name": "UPS United States Next Day Air Early A.M."
+            },
+            {
+              "matches": "22",
+              "name": "UPS United States Ground - Returns Plus - Three Pickup Attempts"
+            },
+            {
+              "matches": "32",
+              "name": "UPS United States Next Day Air Early A.M. - COD"
+            },
+            {
+              "matches": "33",
+              "name": "UPS United States Next Day Air Early A.M. - Saturday Delivery, COD"
+            },
+            {
+              "matches": "41",
+              "name": "UPS United States Next Day Air Early A.M. - Saturday Delivery"
+            },
+            {
+              "matches": "42",
+              "name": "UPS United States Ground - Signature Required"
+            },
+            {
+              "matches": "44",
+              "name": "UPS United States Next Day Air - Saturday Delivery"
+            },
+            {
+              "matches": "66",
+              "name": "UPS United States Worldwide Express"
+            },
+            {
+              "matches": "72",
+              "name": "UPS United States Ground - Collect on Delivery"
+            },
+            {
+              "matches": "78",
+              "name": "UPS United States Ground - Returns Plus - One Pickup Attempt"
+            },
+            {
+              "matches": "90",
+              "name": "UPS United States Ground - Returns - UPS Prints and Mails Label"
+            },
+            {
+              "matches": "A0",
+              "name": "UPS United States Next Day Air Early A.M. - Adult Signature Required"
+            },
+            {
+              "matches": "A1",
+              "name": "UPS United States Next Day Air Early A.M. - Saturday Delivery, Adult Signature Required"
+            },
+            {
+              "matches": "A2",
+              "name": "UPS United States Next Day Air - Adult Signature Required"
+            },
+            {
+              "matches": "A8",
+              "name": "UPS United States Ground - Adult Signature Required"
+            },
+            {
+              "matches": "A9",
+              "name": "UPS United States Next Day Air Early A.M. - Adult Signature Required, COD"
+            },
+            {
+              "matches": "AA",
+              "name": "UPS United States Next Day Air Early A.M. - Saturday Delivery, Adult Signature Required, COD"
+            },
+            {
+              "matches": "YW",
+              "name": "UPS SurePost - Delivered by the USPS"
+            }
+          ]
+        }
+      ],
+      "test_numbers": {
+        "valid": [
+          "1Z5R89390357567127",
+          "1Z879E930346834440",
+          "1Z410E7W0392751591",
+          "1Z8V92A70367203024",
+          " 1 Z 8 V 9 2 A 7 0 3 6 7 2 0 3 0 2 4 ",
+          "1ZXX3150YW44070023"
+        ],
+        "invalid": [
+          "2Z5R89390357567127",
+          "1A5R89390357567127",
+          "1Z1111111111111111"
+        ]
+      }
+    },
+    {
+      "name": "UPS Waybill",
+      "regex": [
+        "\\s*(?<ServiceType>([AHJKTV]\\s*){1})",
+        "(?<SerialNumber>(?:[0-9]\\s*){9})",
+        "(?<CheckDigit>[0-9]\\s*){1}"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 1,
+          "odds_multiplier": 2,
+          "reverse": false
+        }
+      },
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            {
+              "matches": "J",
+              "name": "UPS Next Day Express"
+            },
+            {
+              "matches": "K",
+              "name": "UPS Ground"
+            },
+            {
+              "matches": "V",
+              "name": "UPS WorldWide Express Saver"
+            }
+          ]
+        }
+      ],
+      "tracking_url": "https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=%s",
+      "test_numbers": {
+        "valid": [
+          "K1506235620",
+          "K 150 623 562 0",
+          "K2479825491",
+          "J4603636537",
+          "V0490119172",
+          "V0431105627"
+        ],
+        "invalid": [
+          "K1506235622",
+          "K2479825492",
+          "J4603636538",
+          "V0411335627",
+          "V0423305841"
+        ]
+      }
+    }
+  ]
+}

data/lib/data/couriers/usps.json

@@ -0,0 +1,272 @@
+{
+  "name": "United States Postal Service",
+  "courier_code": "usps",
+  "tracking_numbers": [
+    {
+      "name": "USPS 20",
+      "id": "usps_20",
+      "description": "Delivery and Signature Confirmation numbers, printed without the application identifier",
+      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
+      "regex": [
+        "\\s*(?<SerialNumber>",
+        "(?<ServiceType>([0-9]\\s*){2})",
+        "(?<ShipperId>([0-9]\\s*){9})",
+        "(?<PackageId>([0-9]\\s*){8})",
+        ")",
+        "(?<CheckDigit>[0-9]\\s*)"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 3,
+          "odds_multiplier": 1,
+          "reverse": false
+        }
+      },
+      "test_numbers": {
+        "valid": [
+          "0307 1790 0005 2348 3741",
+          " 0 3 0 7   1 7 9 0   0 0 0 5   2 3 4 8   3 7 4 1 ",
+          "7112 3456 7891 2345 6787"
+        ],
+        "invalid": [
+          "0307 1790 0005 2348 3742"
+        ]
+      },
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            { "matches": "01", "name": "Delivery Confirmation", "description": "Priority Mail or First-Class Mail Parcels" },
+            { "matches": "02", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels" },
+            { "matches_regex": "0[34]", "name": "Delivery Confirmation", "description": "Retail" },
+            { "matches": "05", "name": "Delivery Confirmation", "description": "Priority Mail or First-Class Mail Parcels, insured over $50" },
+            { "matches": "06", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured over $50" },
+            { "matches": "07", "name": "Delivery Confirmation", "description": "Priority Mail, insured $50 or under" },
+            { "matches": "08", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured $50 or under" },
+            { "matches": "14", "name": "Delivery Confirmation", "description": "Software vendors only, by approval" },
+            { "matches": "21", "name": "Signature Confirmation", "description": "Priority Mail or First-Class Mail Parcels" },
+            { "matches": "22", "name": "Signature Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels" },
+            { "matches_regex": "2[34]", "name": "Signature Confirmation", "description": "Retail" },
+            { "matches": "25", "name": "Signature Confirmation", "description": "Priority Mail or First-Class Mail Parcels, insured, all values" },
+            { "matches": "26", "name": "Signature Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured, all values" },
+            { "matches": "34", "name": "Signature Confirmation", "description": "Software vendors only, by approval" },
+            { "matches": "50", "name": "Electronic File Header", "description": "Used in the file header record only, never on a package" },
+            { "matches": "56", "name": "Passive Enroute Scan", "description": "A free scan as the parcel passes through a sorting plant, with no confirmation service attached" },
+            { "matches": "73", "name": "Insured Mail", "description": "Insured only, value over $50" },
+            { "matches": "82", "name": "Merchandise Return", "description": "With Delivery Confirmation" },
+            { "matches": "83", "name": "Merchandise Return", "description": "With Delivery Confirmation, insured value $50 or under" },
+            { "matches": "85", "name": "Merchandise Return", "description": "With Delivery Confirmation, insured value over $50" }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "USPS IMpb N",
+      "id": "usps_impb_n",
+      "description": "IMpb constructs N01 through N10, issued online or by a vendor or meter",
+      "glossary": {
+        "ShipperId": { "description": "The company that holds the postal permit the package was mailed under, which Publication 199 calls the Mailer ID. Nine digits when it starts with 9, six otherwise." }
+      },
+      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
+      "regex": [
+        "\\s*((?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5}(?=([0-9]\\s*){22}(?![0-9])|([0-9]\\s*){26}(?![0-9])))(?<DestinationZipPlus4>([0-9]\\s*){4}(?=([0-9]\\s*){22}(?![0-9])))?)?",
+        "(?<SerialNumber>",
+        "(?<ApplicationIdentifier>9\\s*4\\s*)",
+        "(?<ServiceType>([0-9]\\s*){3})",
+        "(?=9\\s*([0-9]\\s*){8}(([0-9]\\s*){15}|([0-9]\\s*){11}|([0-9]\\s*){7})[0-9]\\s*(?![0-9])",
+        "|[0-8]\\s*([0-9]\\s*){5}(([0-9]\\s*){14}|([0-9]\\s*){10})[0-9]\\s*(?![0-9]))",
+        "(?<ShipperId>9\\s*([0-9]\\s*){8}|[0-8]\\s*([0-9]\\s*){5})",
+        "(?<PackageId>([0-9]\\s*){15}|([0-9]\\s*){14}|([0-9]\\s*){11}|([0-9]\\s*){10}|([0-9]\\s*){7})",
+        ")",
+        "(?<CheckDigit>[0-9]\\s*)"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 3,
+          "odds_multiplier": 1,
+          "reverse": true
+        }
+      },
+      "test_numbers": {
+        "valid": [
+          "420787459400111206206406260787",
+          "9400111206206406260787",
+          "9400 1112 0108 0805 4830 16",
+          "9405803699300124287899",
+          "9434611206206406227577",
+          "9434611206206407667136",
+          "9400111206206407628746",
+          "9400111206206407628845"
+        ],
+        "invalid": [
+          "9434611206206407667131",
+          "9434611306206407667222",
+          "2334611306206407667222"
+        ]
+      },
+      "additional": [
+        {
+          "name": "Application Identifier",
+          "regex_group_name": "ApplicationIdentifier",
+          "lookup": [
+            { "matches": "94", "name": "Online or vendor label", "description": "Issued through USPS WebTools, or an authorized PC Postage provider" }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "USPS Legacy",
+      "id": "usps_legacy",
+      "description": "Delivery and Signature Confirmation numbers, carrying the 91 application identifier",
+      "glossary": {
+        "ApplicationIdentifier": { "description": "Present only when the barcode is UCC/EAN Code 128." }
+      },
+      "regex": [
+        "\\s*(?:(?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5})(?<DestinationZipPlus4>([0-9]\\s*){4})?)?",
+        "(?<SerialNumber>",
+        "(?<ApplicationIdentifier>9\\s*1\\s*)?",
+        "(?<ServiceType>([0-9]\\s*){2})",
+        "(?<ShipperId>([0-9]\\s*){9})",
+        "(?<PackageId>([0-9]\\s*){8})",
+        ")",
+        "(?<CheckDigit>[0-9]\\s*)"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 3,
+          "odds_multiplier": 1,
+          "reverse": false
+        },
+        "serial_number_format": {
+          "prepend_if": {
+            "matches_regex": "^(?!9\\s*1).+",
+            "content": "91"
+          }
+        }
+      },
+      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
+      "test_numbers": {
+        "valid": [
+          "420 22153 9101026837331000039521",
+          "9101 1234 5678 9000 0000 13",
+          "7196 9010 7560 0307 7385"
+        ],
+        "invalid": [
+          "9101 1234 5678 9000 0000 14",
+          "7196 9010 7560 0307 7386"
+        ]
+      },
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            { "matches": "01", "name": "Delivery Confirmation", "description": "Priority Mail or First-Class Mail Parcels" },
+            { "matches": "02", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels" },
+            { "matches_regex": "0[34]", "name": "Delivery Confirmation", "description": "Retail" },
+            { "matches": "05", "name": "Delivery Confirmation", "description": "Priority Mail or First-Class Mail Parcels, insured over $50" },
+            { "matches": "06", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured over $50" },
+            { "matches": "07", "name": "Delivery Confirmation", "description": "Priority Mail, insured $50 or under" },
+            { "matches": "08", "name": "Delivery Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured $50 or under" },
+            { "matches": "14", "name": "Delivery Confirmation", "description": "Software vendors only, by approval" },
+            { "matches": "21", "name": "Signature Confirmation", "description": "Priority Mail or First-Class Mail Parcels" },
+            { "matches": "22", "name": "Signature Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels" },
+            { "matches_regex": "2[34]", "name": "Signature Confirmation", "description": "Retail" },
+            { "matches": "25", "name": "Signature Confirmation", "description": "Priority Mail or First-Class Mail Parcels, insured, all values" },
+            { "matches": "26", "name": "Signature Confirmation", "description": "Package Services, Parcel Select or Standard Mail Parcels, insured, all values" },
+            { "matches": "34", "name": "Signature Confirmation", "description": "Software vendors only, by approval" },
+            { "matches": "50", "name": "Electronic File Header", "description": "Used in the file header record only, never on a package" },
+            { "matches": "56", "name": "Passive Enroute Scan", "description": "A free scan as the parcel passes through a sorting plant, with no confirmation service attached" },
+            { "matches": "73", "name": "Insured Mail", "description": "Insured only, value over $50" },
+            { "matches": "82", "name": "Merchandise Return", "description": "With Delivery Confirmation" },
+            { "matches": "83", "name": "Merchandise Return", "description": "With Delivery Confirmation, insured value $50 or under" },
+            { "matches": "85", "name": "Merchandise Return", "description": "With Delivery Confirmation, insured value over $50" }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "USPS IMpb C",
+      "id": "usps_impb_c",
+      "description": "IMpb constructs C01 through C10, plus USPS retail",
+      "glossary": {
+        "ShipperId": { "description": "The company that holds the postal permit the package was mailed under, which Publication 199 calls the Mailer ID. Nine digits when it starts with 9, six otherwise." }
+      },
+      "regex": [
+        "\\s*(?:(?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5})(?<DestinationZipPlus4>([0-9]\\s*){4}(?=([0-9]\\s*){22}(?![0-9])))?)?",
+        "(?<SerialNumber>",
+        "(?<ApplicationIdentifier>9\\s*2\\s*(?=([0-9]\\s*){3}9)|9\\s*3\\s*(?=([0-9]\\s*){3}[0-8])|9\\s*5\\s*)",
+        "(?<ServiceType>([0-9]\\s*){3})",
+        "(?=9\\s*([0-9]\\s*){8}(([0-9]\\s*){11}|([0-9]\\s*){7})[0-9]\\s*(?![0-9])",
+        "|[0-8]\\s*([0-9]\\s*){5}(([0-9]\\s*){14}|([0-9]\\s*){10})[0-9]\\s*(?![0-9]))",
+        "(?<ShipperId>9\\s*([0-9]\\s*){8}|[0-8]\\s*([0-9]\\s*){5})",
+        "(?<PackageId>([0-9]\\s*){14}|([0-9]\\s*){11}|([0-9]\\s*){10}|([0-9]\\s*){7})",
+        ")",
+        "(?<CheckDigit>[0-9]\\s*)"
+      ],
+      "validation": {
+        "checksum": {
+          "name": "mod10",
+          "modulo": 10,
+          "evens_multiplier": 3,
+          "odds_multiplier": 1,
+          "reverse": false
+        }
+      },
+      "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
+      "test_numbers": {
+        "valid": [
+          "4201002334249200190132607600833457",
+          "4201028200009261290113185417468510",
+          " 4 2 0 1 0 2 8 2 0 0 0 0 9 2 6 1 2 9 0 1 1 3 1 8 5 4 1 7 4 6 8 5 1 0 ",
+          "9505 5110 6960 5048 6006 24",
+          "92748931507708513018050063",
+          "92001903060085300042901077",
+          "9361 2898 7870 0317 6337 95",
+          "9261292700768711948021",
+          "420 11213 92 6129098349792366623 8",
+          "92 6129098349792366623 8",
+          "420902459261290336128704042634",
+          "420941179261290336128704062441",
+          "420926029261290336128704067248",
+          "420902729261290336128704124163",
+          "420950549261290336128704133837",
+          "420193809261290336128704280838",
+          "420900469261290336128704216936"
+        ],
+        "invalid": [
+          "61299998820821171811",
+          "9200000000000000000000",
+          "420000000000000000000000000000",
+          "420000009200000000000000000000",
+          "4201028200009261290113185417468511"
+        ]
+      },
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            { "matches": "612", "name": "Parcel Select" }
+          ]
+        },
+        {
+          "name": "Application Identifier",
+          "regex_group_name": "ApplicationIdentifier",
+          "lookup": [
+            { "matches": "92", "name": "Commercial mailer", "description": "Nine digit mailer ID, and may have been carried by another company before USPS" },
+            { "matches": "93", "name": "Commercial mailer", "description": "Six digit mailer ID, and may have been carried by another company before USPS" },
+            { "matches": "95", "name": "USPS Retail", "description": "Issued at a post office counter, an automated postal center, or a self-service kiosk" }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/lib/data/couriers/yodel.json

@@ -0,0 +1,29 @@
+{
+  "name": "Yodel",
+  "courier_code": "yodel",
+  "tracking_numbers": [
+    {
+      "name": "Yodel",
+      "id": "yodel",
+      "description": "Yodel's UK domestic numbers, carried on a JD or JJD prefix. Numbers entering the Yodel network from other carriers can take other formats.",
+      "regex": [
+        "\\s*J\\s*(J\\s*)?D\\s*(?<SerialNumber>([0-9]\\s*){16})\\s*"
+      ],
+      "validation": {},
+      "tracking_url": "https://www.yodel.co.uk/tracking/%s",
+      "test_numbers": {
+        "valid": [
+          "JJD0002257639032011",
+          "JJD0002255380054291",
+          "JD0002242617644732",
+          "JD0002254405060992",
+          "J J D 0 0 0 2 2 5 7 6 3 9 0 3 2 0 2 0"
+        ],
+        "invalid": [
+          "JD000225440506099",
+          "JC0002254405060992"
+        ]
+      }
+    }
+  ]
+}

data/lib/data/couriers/yunexpress.json

@@ -0,0 +1,25 @@
+{
+  "name": "YunExpress",
+  "courier_code": "yunexpress",
+  "tracking_numbers": [
+    {
+      "name": "YunExpress",
+      "id": "yunexpress",
+      "tracking_url": "https://www.yuntrack.com/parcelTracking?id=%s",
+      "regex": [
+        "\\s*Y\\s*T\\s*(?<SerialNumber>([0-9]\\s*){16})\\s*"
+      ],
+      "validation": {},
+      "test_numbers": {
+        "valid": [
+          "YT2229521272164446",
+          "YT2229521272164447",
+          " Y T 2 2 2 9 5 2 1 2 7 2 1 6 4 4 4 7 "
+        ],
+        "invalid": [
+          "YT123456789012345"
+        ]
+      }
+    }
+  ]
+}

data/lib/tracking_number/active_model_validator.rb

@@ -6,7 +6,7 @@ class TrackingNumberValidator < ActiveModel::EachValidator
     elsif TrackingNumber.new(value).valid?
       # looks good to me
     else
-      record.errors[attribute] << (options[:message] || 'is not a valid tracking number')
+      record.errors.add(attribute, options[:message] || 'is not a valid tracking number')
     end
   end
 end