tracking_number_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f46163be23243e646b981dd3e8000048948064f
+  data.tar.gz: 533f126f82f3d634b04a5a4700358b0b0d92b86a
+SHA512:
+  metadata.gz: 93d61ee87a1ab2599863af3a5988fdf2860a4e2f3ecc8192137a5e7425c6a41a429d83ee77fbd63c194c44e75f2b219131039dadefb4fd4dfec8de4c3a8cfa8c
+  data.tar.gz: 0a975d047e39c1da2d85d1ad7b516fff782ec998001fe3e07117970169c0f87da2fa451510c18123ee5aa14b4ce8d856c9cdc08294d301111027e0598e428b61

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+tracking

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tracking_number_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Hegyi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# TrackingNumberValidator
+
+Validator for DHL and FedEx Ground tracking numbers.
+
+Currently supported services: DHL and Fed Ex Ground
+
+Fed Ex Ground validator supports only the latest format
+
+More info: http://fedex.p.delivery.net/m/p/fdx/bcc/home.asp
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tracking_number_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tracking_number_validator
+
+## Usage
+
+```ruby
+require 'tracking_number_validator'
+
+validator = TrackingNumberValidator::DHLValidator.new("foo")
+validator.valid? # => false
+
+validator = TrackingNumberValidator::FedExGroundValidator.new("foo")
+validator.valid? # => false
+
+TrackingNumberValidator::Service.detect("2111111111") # => :dhl
+TrackingNumberValidator::Service.detect("9622001900005009141100548983268777") # => :fed_ex_ground
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/tracking_number_validator.rb

@@ -0,0 +1,7 @@
+require "tracking_number_validator/version"
+require "tracking_number_validator/dhl_validator"
+require "tracking_number_validator/fed_ex_ground_validator"
+require "tracking_number_validator/service"
+
+module TrackingNumberValidator
+end

data/lib/tracking_number_validator/dhl_validator.rb

@@ -0,0 +1,52 @@
+module TrackingNumberValidator
+  class DHLValidator
+    attr_reader :tracking_number
+
+    VALID_LENGTHS = [10, 12, 14]
+    WEIGHTINGS = [4, 9]
+
+    def initialize(tracking_number)
+      @tracking_number = tracking_number
+    end
+
+    def valid?
+      return false unless valid_length?
+      if tracking_number.length == 10
+        calculate_modulo_7
+      else
+        calculate_modulo_10
+      end
+    end
+
+    def name
+      :dhl
+    end
+
+    private
+
+    def calculate_modulo_7
+      characters = tracking_number.chars
+      without_checksum = characters[0..-2]
+      remainder = without_checksum.join.to_i % 7
+      characters.last.to_i == remainder
+    end
+
+    def calculate_modulo_10
+      characters = tracking_number.chars
+
+      sum = 0
+      (characters.size - 1).times do |i|
+        sum += WEIGHTINGS[i % WEIGHTINGS.size] * characters[i].to_i
+      end
+
+      check_digit = ((sum / 10.0).ceil * 10) - sum
+      characters.last.to_i == check_digit
+    end
+
+    def valid_length?
+      VALID_LENGTHS.include? tracking_number.size
+    end
+
+  end
+
+end

data/lib/tracking_number_validator/fed_ex_ground_validator.rb

@@ -0,0 +1,41 @@
+module TrackingNumberValidator
+  class FedExGroundValidator
+    WEIGHTINGS = [1, 3, 7]
+
+    attr_reader :tracking_number
+
+    def initialize(tracking_number)
+      @tracking_number = tracking_number
+    end
+
+    def valid?
+      return false unless valid_length?
+
+      reversed = tracking_number.reverse[1...14]
+
+      return false unless reversed.end_with? "00"
+      reversed = reversed[0..-3]
+
+
+      original_check_digit = tracking_number.chars.last.to_i
+
+      sum = 0
+      reversed.chars.each_with_index do |char, i|
+        sum += WEIGHTINGS[(i) % WEIGHTINGS.size] * char.to_i
+      end
+      check_digit = (sum % 11) % 10
+
+      original_check_digit == check_digit
+    end
+
+    def name
+      :fed_ex_ground
+    end
+
+    private
+
+    def valid_length?
+      tracking_number.length >= 15
+    end
+  end
+end

data/lib/tracking_number_validator/service.rb

@@ -0,0 +1,23 @@
+module TrackingNumberValidator
+  class Service
+
+    VALIDATORS = [
+      DHLValidator,
+      FedExGroundValidator
+    ]
+
+    def self.detect(tracking_number)
+      tracking_number = sanitize(tracking_number)
+      VALIDATORS.each do |validator|
+        validator = validator.new(tracking_number)
+        return validator.name if validator.valid?
+      end
+      nil
+    end
+
+    private
+    def self.sanitize(tracking_number)
+      tracking_number[/\d+/] || ""
+    end
+  end
+end

data/lib/tracking_number_validator/version.rb

@@ -0,0 +1,3 @@
+module TrackingNumberValidator
+  VERSION = "0.0.1"
+end

data/spec/lib/traking_number_validator/dhl_validator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module TrackingNumberValidator
+  describe DHLValidator do
+    [
+      "054655170637",
+      "425434057510",
+      "425434057526",
+      "054655177106",
+      "054655177099",
+      "217703557591",
+      "425434056299",
+      "425434056306",
+      "2551294465",
+      "2551295961",
+      "2551295854",
+    ].each do |tracking_number|
+      it "tracking number: #{tracking_number} should be valid" do
+        validator = DHLValidator.new(tracking_number)
+        expect(validator).to be_valid
+      end
+    end
+  end
+end

data/spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module TrackingNumberValidator
+  describe FedExGroundValidator do
+    [
+      "1010095723370011139700578986681398",
+      "1010095723370015585700578986681538",
+      "1010095723370011040100578986681527",
+      "1010095723371112913600578986681516",
+      "1010095723370963160600578986681505",
+      "1010095723370966750900578986681490",
+      "1010095723371121716100578986681480",
+      "1010095723370011129200578986681630",
+      "1010098123400001016300578986681620",
+      "1010095723370835237900578986681619",
+      "1010095723371180347700578986681608",
+      "1010095723370938231400578986681582",
+      "1010095723370011934800578986681571",
+      "1010095723370011351600578986681560",
+      "1010098123400009720400578986681550",
+      "1010095723370011108900578986681549",
+      "1010095723220011332600578986681240",
+      "1010095723220011464900578986681230",
+      "1010095723220825046800578986681229",
+      "1010095723221121716400578986681218",
+      "1010095723220011831600578986681207",
+      "1010095723220965668200578986681192",
+      "1010095723221116415900578986681300",
+      "1010095723220011330600578986681284",
+      "1010095723221132476600578986681273",
+      "1010095723220961206600578986681251",
+      "1010095723220011161600578986681310",
+      "1010095723220966750900578986681321",
+      "1010095723070937032500578986680830",
+      "1010095721120011914600578986678211",
+      "1010095723070011139700578986680895",
+      "1010095723070937599600578986680873"
+    ].each do |tracking_number|
+      it "tracking number: #{tracking_number} should be valid" do
+        validator = FedExGroundValidator.new(tracking_number)
+        expect(validator).to be_valid
+      end
+    end
+  end
+
+end

data/spec/lib/traking_number_validator/service_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module TrackingNumberValidator
+  describe Service do
+    describe "#detect" do
+      it "detects DHL" do
+        expect(Service.detect("425434056299")).to eq :dhl
+        expect(Service.detect("2551295854")).to eq :dhl
+        expect(Service.detect("1010095723370011934800578986681571")).to eq :fed_ex_ground
+        expect(Service.detect("foooo")).to eq nil
+      end
+
+      it "sanitizes the input" do
+        expect(Service.detect("   425434056299   ")).to eq :dhl
+        expect(Service.detect("_425434056299_")).to eq :dhl
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'tracking_number_validator'
+
+RSpec.configure do |config|
+end

data/tracking_number_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tracking_number_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tracking_number_validator"
+  spec.version       = TrackingNumberValidator::VERSION
+  spec.authors       = ["Adam Hegyi"]
+  spec.email         = ["a.hegyi@vdm-vsg.de"]
+  spec.description   = %q{Validator for DHL and FedEx Ground tracking numbers}
+  spec.summary       = %q{Validator for DHL and FedEx Ground tracking numbers}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: tracking_number_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Hegyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validator for DHL and FedEx Ground tracking numbers
+email:
+- a.hegyi@vdm-vsg.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tracking_number_validator.rb
+- lib/tracking_number_validator/dhl_validator.rb
+- lib/tracking_number_validator/fed_ex_ground_validator.rb
+- lib/tracking_number_validator/service.rb
+- lib/tracking_number_validator/version.rb
+- spec/lib/traking_number_validator/dhl_validator_spec.rb
+- spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb
+- spec/lib/traking_number_validator/service_spec.rb
+- spec/spec_helper.rb
+- tracking_number_validator.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Validator for DHL and FedEx Ground tracking numbers
+test_files:
+- spec/lib/traking_number_validator/dhl_validator_spec.rb
+- spec/lib/traking_number_validator/fed_ex_ground_validator_spec.rb
+- spec/lib/traking_number_validator/service_spec.rb
+- spec/spec_helper.rb