tracking_number_validator 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +46 -0
- data/Rakefile +6 -0
- data/lib/tracking_number_validator.rb +7 -0
- data/lib/tracking_number_validator/dhl_validator.rb +52 -0
- data/lib/tracking_number_validator/fed_ex_ground_validator.rb +41 -0
- data/lib/tracking_number_validator/service.rb +23 -0
- data/lib/tracking_number_validator/version.rb +3 -0
- data/spec/lib/traking_number_validator/dhl_validator_spec.rb +24 -0
- data/spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb +46 -0
- data/spec/lib/traking_number_validator/service_spec.rb +19 -0
- data/spec/spec_helper.rb +6 -0
- data/tracking_number_validator.gemspec +24 -0
- metadata +107 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 5f46163be23243e646b981dd3e8000048948064f
|
4
|
+
data.tar.gz: 533f126f82f3d634b04a5a4700358b0b0d92b86a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 93d61ee87a1ab2599863af3a5988fdf2860a4e2f3ecc8192137a5e7425c6a41a429d83ee77fbd63c194c44e75f2b219131039dadefb4fd4dfec8de4c3a8cfa8c
|
7
|
+
data.tar.gz: 0a975d047e39c1da2d85d1ad7b516fff782ec998001fe3e07117970169c0f87da2fa451510c18123ee5aa14b4ce8d856c9cdc08294d301111027e0598e428b61
|
data/.gitignore
ADDED
data/.ruby-gemset
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
tracking
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.0.0-p247
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Adam Hegyi
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# TrackingNumberValidator
|
2
|
+
|
3
|
+
Validator for DHL and FedEx Ground tracking numbers.
|
4
|
+
|
5
|
+
Currently supported services: DHL and Fed Ex Ground
|
6
|
+
|
7
|
+
Fed Ex Ground validator supports only the latest format
|
8
|
+
|
9
|
+
More info: http://fedex.p.delivery.net/m/p/fdx/bcc/home.asp
|
10
|
+
|
11
|
+
## Installation
|
12
|
+
|
13
|
+
Add this line to your application's Gemfile:
|
14
|
+
|
15
|
+
gem 'tracking_number_validator'
|
16
|
+
|
17
|
+
And then execute:
|
18
|
+
|
19
|
+
$ bundle
|
20
|
+
|
21
|
+
Or install it yourself as:
|
22
|
+
|
23
|
+
$ gem install tracking_number_validator
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'tracking_number_validator'
|
29
|
+
|
30
|
+
validator = TrackingNumberValidator::DHLValidator.new("foo")
|
31
|
+
validator.valid? # => false
|
32
|
+
|
33
|
+
validator = TrackingNumberValidator::FedExGroundValidator.new("foo")
|
34
|
+
validator.valid? # => false
|
35
|
+
|
36
|
+
TrackingNumberValidator::Service.detect("2111111111") # => :dhl
|
37
|
+
TrackingNumberValidator::Service.detect("9622001900005009141100548983268777") # => :fed_ex_ground
|
38
|
+
```
|
39
|
+
|
40
|
+
## Contributing
|
41
|
+
|
42
|
+
1. Fork it
|
43
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
44
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
45
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
46
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
module TrackingNumberValidator
|
2
|
+
class DHLValidator
|
3
|
+
attr_reader :tracking_number
|
4
|
+
|
5
|
+
VALID_LENGTHS = [10, 12, 14]
|
6
|
+
WEIGHTINGS = [4, 9]
|
7
|
+
|
8
|
+
def initialize(tracking_number)
|
9
|
+
@tracking_number = tracking_number
|
10
|
+
end
|
11
|
+
|
12
|
+
def valid?
|
13
|
+
return false unless valid_length?
|
14
|
+
if tracking_number.length == 10
|
15
|
+
calculate_modulo_7
|
16
|
+
else
|
17
|
+
calculate_modulo_10
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
def name
|
22
|
+
:dhl
|
23
|
+
end
|
24
|
+
|
25
|
+
private
|
26
|
+
|
27
|
+
def calculate_modulo_7
|
28
|
+
characters = tracking_number.chars
|
29
|
+
without_checksum = characters[0..-2]
|
30
|
+
remainder = without_checksum.join.to_i % 7
|
31
|
+
characters.last.to_i == remainder
|
32
|
+
end
|
33
|
+
|
34
|
+
def calculate_modulo_10
|
35
|
+
characters = tracking_number.chars
|
36
|
+
|
37
|
+
sum = 0
|
38
|
+
(characters.size - 1).times do |i|
|
39
|
+
sum += WEIGHTINGS[i % WEIGHTINGS.size] * characters[i].to_i
|
40
|
+
end
|
41
|
+
|
42
|
+
check_digit = ((sum / 10.0).ceil * 10) - sum
|
43
|
+
characters.last.to_i == check_digit
|
44
|
+
end
|
45
|
+
|
46
|
+
def valid_length?
|
47
|
+
VALID_LENGTHS.include? tracking_number.size
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
module TrackingNumberValidator
|
2
|
+
class FedExGroundValidator
|
3
|
+
WEIGHTINGS = [1, 3, 7]
|
4
|
+
|
5
|
+
attr_reader :tracking_number
|
6
|
+
|
7
|
+
def initialize(tracking_number)
|
8
|
+
@tracking_number = tracking_number
|
9
|
+
end
|
10
|
+
|
11
|
+
def valid?
|
12
|
+
return false unless valid_length?
|
13
|
+
|
14
|
+
reversed = tracking_number.reverse[1...14]
|
15
|
+
|
16
|
+
return false unless reversed.end_with? "00"
|
17
|
+
reversed = reversed[0..-3]
|
18
|
+
|
19
|
+
|
20
|
+
original_check_digit = tracking_number.chars.last.to_i
|
21
|
+
|
22
|
+
sum = 0
|
23
|
+
reversed.chars.each_with_index do |char, i|
|
24
|
+
sum += WEIGHTINGS[(i) % WEIGHTINGS.size] * char.to_i
|
25
|
+
end
|
26
|
+
check_digit = (sum % 11) % 10
|
27
|
+
|
28
|
+
original_check_digit == check_digit
|
29
|
+
end
|
30
|
+
|
31
|
+
def name
|
32
|
+
:fed_ex_ground
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
def valid_length?
|
38
|
+
tracking_number.length >= 15
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module TrackingNumberValidator
|
2
|
+
class Service
|
3
|
+
|
4
|
+
VALIDATORS = [
|
5
|
+
DHLValidator,
|
6
|
+
FedExGroundValidator
|
7
|
+
]
|
8
|
+
|
9
|
+
def self.detect(tracking_number)
|
10
|
+
tracking_number = sanitize(tracking_number)
|
11
|
+
VALIDATORS.each do |validator|
|
12
|
+
validator = validator.new(tracking_number)
|
13
|
+
return validator.name if validator.valid?
|
14
|
+
end
|
15
|
+
nil
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
def self.sanitize(tracking_number)
|
20
|
+
tracking_number[/\d+/] || ""
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
module TrackingNumberValidator
|
4
|
+
describe DHLValidator do
|
5
|
+
[
|
6
|
+
"054655170637",
|
7
|
+
"425434057510",
|
8
|
+
"425434057526",
|
9
|
+
"054655177106",
|
10
|
+
"054655177099",
|
11
|
+
"217703557591",
|
12
|
+
"425434056299",
|
13
|
+
"425434056306",
|
14
|
+
"2551294465",
|
15
|
+
"2551295961",
|
16
|
+
"2551295854",
|
17
|
+
].each do |tracking_number|
|
18
|
+
it "tracking number: #{tracking_number} should be valid" do
|
19
|
+
validator = DHLValidator.new(tracking_number)
|
20
|
+
expect(validator).to be_valid
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
module TrackingNumberValidator
|
4
|
+
describe FedExGroundValidator do
|
5
|
+
[
|
6
|
+
"1010095723370011139700578986681398",
|
7
|
+
"1010095723370015585700578986681538",
|
8
|
+
"1010095723370011040100578986681527",
|
9
|
+
"1010095723371112913600578986681516",
|
10
|
+
"1010095723370963160600578986681505",
|
11
|
+
"1010095723370966750900578986681490",
|
12
|
+
"1010095723371121716100578986681480",
|
13
|
+
"1010095723370011129200578986681630",
|
14
|
+
"1010098123400001016300578986681620",
|
15
|
+
"1010095723370835237900578986681619",
|
16
|
+
"1010095723371180347700578986681608",
|
17
|
+
"1010095723370938231400578986681582",
|
18
|
+
"1010095723370011934800578986681571",
|
19
|
+
"1010095723370011351600578986681560",
|
20
|
+
"1010098123400009720400578986681550",
|
21
|
+
"1010095723370011108900578986681549",
|
22
|
+
"1010095723220011332600578986681240",
|
23
|
+
"1010095723220011464900578986681230",
|
24
|
+
"1010095723220825046800578986681229",
|
25
|
+
"1010095723221121716400578986681218",
|
26
|
+
"1010095723220011831600578986681207",
|
27
|
+
"1010095723220965668200578986681192",
|
28
|
+
"1010095723221116415900578986681300",
|
29
|
+
"1010095723220011330600578986681284",
|
30
|
+
"1010095723221132476600578986681273",
|
31
|
+
"1010095723220961206600578986681251",
|
32
|
+
"1010095723220011161600578986681310",
|
33
|
+
"1010095723220966750900578986681321",
|
34
|
+
"1010095723070937032500578986680830",
|
35
|
+
"1010095721120011914600578986678211",
|
36
|
+
"1010095723070011139700578986680895",
|
37
|
+
"1010095723070937599600578986680873"
|
38
|
+
].each do |tracking_number|
|
39
|
+
it "tracking number: #{tracking_number} should be valid" do
|
40
|
+
validator = FedExGroundValidator.new(tracking_number)
|
41
|
+
expect(validator).to be_valid
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
module TrackingNumberValidator
|
4
|
+
describe Service do
|
5
|
+
describe "#detect" do
|
6
|
+
it "detects DHL" do
|
7
|
+
expect(Service.detect("425434056299")).to eq :dhl
|
8
|
+
expect(Service.detect("2551295854")).to eq :dhl
|
9
|
+
expect(Service.detect("1010095723370011934800578986681571")).to eq :fed_ex_ground
|
10
|
+
expect(Service.detect("foooo")).to eq nil
|
11
|
+
end
|
12
|
+
|
13
|
+
it "sanitizes the input" do
|
14
|
+
expect(Service.detect(" 425434056299 ")).to eq :dhl
|
15
|
+
expect(Service.detect("_425434056299_")).to eq :dhl
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'tracking_number_validator/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "tracking_number_validator"
|
8
|
+
spec.version = TrackingNumberValidator::VERSION
|
9
|
+
spec.authors = ["Adam Hegyi"]
|
10
|
+
spec.email = ["a.hegyi@vdm-vsg.de"]
|
11
|
+
spec.description = %q{Validator for DHL and FedEx Ground tracking numbers}
|
12
|
+
spec.summary = %q{Validator for DHL and FedEx Ground tracking numbers}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_development_dependency "rspec"
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,107 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: tracking_number_validator
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Adam Hegyi
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-11-27 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Validator for DHL and FedEx Ground tracking numbers
|
56
|
+
email:
|
57
|
+
- a.hegyi@vdm-vsg.de
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- .gitignore
|
63
|
+
- .ruby-gemset
|
64
|
+
- .ruby-version
|
65
|
+
- Gemfile
|
66
|
+
- LICENSE.txt
|
67
|
+
- README.md
|
68
|
+
- Rakefile
|
69
|
+
- lib/tracking_number_validator.rb
|
70
|
+
- lib/tracking_number_validator/dhl_validator.rb
|
71
|
+
- lib/tracking_number_validator/fed_ex_ground_validator.rb
|
72
|
+
- lib/tracking_number_validator/service.rb
|
73
|
+
- lib/tracking_number_validator/version.rb
|
74
|
+
- spec/lib/traking_number_validator/dhl_validator_spec.rb
|
75
|
+
- spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb
|
76
|
+
- spec/lib/traking_number_validator/service_spec.rb
|
77
|
+
- spec/spec_helper.rb
|
78
|
+
- tracking_number_validator.gemspec
|
79
|
+
homepage: ''
|
80
|
+
licenses:
|
81
|
+
- MIT
|
82
|
+
metadata: {}
|
83
|
+
post_install_message:
|
84
|
+
rdoc_options: []
|
85
|
+
require_paths:
|
86
|
+
- lib
|
87
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - '>='
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 2.0.3
|
100
|
+
signing_key:
|
101
|
+
specification_version: 4
|
102
|
+
summary: Validator for DHL and FedEx Ground tracking numbers
|
103
|
+
test_files:
|
104
|
+
- spec/lib/traking_number_validator/dhl_validator_spec.rb
|
105
|
+
- spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb
|
106
|
+
- spec/lib/traking_number_validator/service_spec.rb
|
107
|
+
- spec/spec_helper.rb
|