USPS-intelligent-barcode 0.1.0

data/lib/USPS-intelligent-barcode/CodewordMap.rb

@@ -0,0 +1,28 @@
+module Imb
+
+  class CodewordMap
+
+    def initialize
+      @characters = load_characters
+    end
+
+    def characters(codewords)
+      codewords.map do |codeword|
+        @characters[codeword]
+      end
+    end
+
+    private
+
+    def load_characters
+      YAML.load_file(characters_path)
+    end
+
+    def characters_path
+      File.expand_path('codeword_to_character_mapping.yml',
+                       File.dirname(__FILE__))
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/Crc.rb

@@ -0,0 +1,42 @@
+module Imb
+
+  class Crc
+
+    extend NumericConversions
+    
+    def self.crc(binary_data)
+      crc = MASK
+      bytes = numeric_to_bytes(binary_data, NUM_INPUT_BYTES)
+      crc = crc_byte(crc, bytes.first, LEADING_BITS_TO_IGNORE)
+      for byte in bytes[1...NUM_INPUT_BYTES]
+        crc = crc_byte(crc, byte, 0)
+      end
+      crc
+    end
+
+    private
+
+    LEADING_BITS_TO_IGNORE = 2
+    CRC_BITS = 11
+    CRC_MSB_MASK = 1 << (CRC_BITS - 1)
+    BITS_PER_BYTE = 8
+    POLYNOMIAL = 0x0F35
+    MASK = (1 << CRC_BITS) - 1
+    NUM_INPUT_BYTES = 13
+
+    def self.crc_byte(crc, byte, leading_bits_to_ignore)
+      num_bits = BITS_PER_BYTE - leading_bits_to_ignore
+      data = byte << CRC_BITS - BITS_PER_BYTE + leading_bits_to_ignore
+      num_bits.times do
+        use_polynomial = (crc ^ data) & CRC_MSB_MASK
+        crc <<= 1 
+        crc ^= POLYNOMIAL if use_polynomial != 0
+        crc &= MASK
+        data <<= 1
+      end
+      crc
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/MailerId.rb

@@ -0,0 +1,70 @@
+module Imb
+
+  class MailerId
+
+    def self.coerce(o)
+      case o
+      when MailerId
+        o
+      when String
+        new(o.to_i)
+      when Integer
+        new(o)
+      else
+        raise ArgumentError, 'Cannot coerce to MailerId'
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def validate(long_mailer_id)
+      unless in_range?
+        raise ArgumentError, "Must be #{RANGES.join(' or ')}"
+      end
+    end
+
+    def ==(o)
+      MailerId.coerce(o).to_i == to_i
+    rescue ArgumentError
+      false
+    end
+
+    def long?
+      LONG_RANGE === @value
+    end
+    
+    def shift_and_add_to(target, long_mailer_id)
+      target * 10 ** num_digits + to_i
+    end
+
+    protected
+
+    def to_i
+      @value
+    end
+
+    private
+
+    SHORT_RANGE = 0..899_999
+    LONG_RANGE = 900_000_000..999_999_999
+    RANGES = [SHORT_RANGE, LONG_RANGE]
+
+    def in_range?
+      RANGES.any? do |range|
+        range === @value
+      end
+    end
+
+    def num_digits
+      if long?
+        9
+      else
+        6
+      end
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/NumericConversions.rb

@@ -0,0 +1,13 @@
+module Imb
+
+  module NumericConversions
+
+    def numeric_to_bytes(n, min_bytes=0)
+      n.to_s(16).rjust(2 * min_bytes, '0').scan(/../).map do |s|
+        s.to_i(16)
+      end
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/RoutingCode.rb

@@ -0,0 +1,77 @@
+module Imb
+
+  class RoutingCode
+
+    def self.coerce(o)
+      case o
+      when nil
+        coerce('')
+      when RoutingCode
+        o
+      when Array
+        RoutingCode.new(*o)
+      when String
+        RoutingCode.new(*string_to_array(o))
+      else
+        raise ArgumentError, 'Cannot coerce to RoutingCode'
+      end
+    end
+
+    def self.string_to_array(s)
+      s = s.gsub(/[\D]/, '')
+      match = /^(?:(\d{5})(?:(\d{4})(\d{2})?)?)?$/.match(s)
+      unless match
+        raise ArgumentError, "Bad routing code: #{s.inspect}"
+      end
+      zip, plus4, delivery_point = match.to_a[1..-1]
+      [zip, plus4, delivery_point]
+    end
+
+    attr_accessor :zip, :plus4, :delivery_point
+    
+    def initialize(zip, plus4, delivery_point)
+      @zip = arg_to_i(zip)
+      @plus4 = arg_to_i(plus4)
+      @delivery_point = arg_to_i(delivery_point)
+    end
+
+    def validate(long_mailer_id)
+    end
+    
+    def convert
+      if @zip && @plus4 && @delivery_point
+        @zip * 1000000 + @plus4 * 100 + @delivery_point + 1000100001
+      elsif @zip && @plus4
+        @zip * 10000 + @plus4 + 100001
+      elsif @zip
+        @zip + 1
+      else
+        0
+      end
+    end
+
+    def to_a
+      [@zip, @plus4, @delivery_point]
+    end
+
+    def ==(o)
+      RoutingCode.coerce(o).to_a == to_a
+    rescue ArgumentError
+      false
+    end
+
+    def shift_and_add_to(target, long_mailer_id)
+      target * 10 ** NUM_DIGITS + convert
+    end
+
+    private
+
+    NUM_DIGITS = 11
+
+    def arg_to_i(o)
+      o.andand.to_i
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/SerialNumber.rb

@@ -0,0 +1,61 @@
+module Imb
+
+  class SerialNumber
+
+    def self.coerce(o)
+      case o
+      when SerialNumber
+        o
+      when String
+        new(o.to_i)
+      when Integer
+        new(o)
+      else
+        raise ArgumentError, 'Cannot coerce to SerialNumber'
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def validate(long_mailer_id)
+      range = 0..max_value(long_mailer_id)
+      unless range === @value
+        raise ArgumentError, "Must be #{range}"
+      end
+    end
+
+    def ==(o)
+      SerialNumber.coerce(o).to_i == to_i
+    rescue ArgumentError
+      false
+    end
+
+    def shift_and_add_to(target, long_mailer_id)
+      target * 10 ** num_digits(long_mailer_id) + to_i
+    end
+
+    protected
+
+    def to_i
+      @value
+    end
+
+    private
+
+    def max_value(long_mailer_id)
+      max_value = 10 ** num_digits(long_mailer_id) - 1
+    end
+
+    def num_digits(long_mailer_id)
+      if long_mailer_id
+        6
+      else
+        9
+      end
+    end
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/ServiceType.rb

@@ -0,0 +1,51 @@
+module Imb
+
+  class ServiceType
+
+    def self.coerce(o)
+      case o
+      when ServiceType
+        o
+      when String
+        new(o.to_i)
+      when Integer
+        new(o)
+      else
+        raise ArgumentError, 'Cannot coerce to ServiceType'
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def validate(long_mailer_id)
+      unless (RANGE) === @value
+        raise ArgumentError, "Must be #{RANGE}"
+      end
+    end
+
+    def ==(o)
+      ServiceType.coerce(o).to_i == to_i
+    rescue ArgumentError
+      false
+    end
+
+    def shift_and_add_to(target, long_mailer_id)
+      target * 10 ** NUM_DIGITS + to_i
+    end
+
+    protected
+
+    def to_i
+      @value
+    end
+
+    private
+
+    RANGE = 0..999
+    NUM_DIGITS = 3
+
+  end
+
+end

data/lib/USPS-intelligent-barcode/autoload.rb

@@ -0,0 +1,61 @@
+# class Autoload courtesy of www.databill.com
+
+class Autoload
+
+  def self.setup(*args)
+    new(*args).setup
+  end
+
+  def initialize(namespace, path)
+    @namespace = namespace
+    @path = path
+  end
+
+  def setup
+    autoload_classes_and_modules
+    require_utilities
+  end
+
+  private
+
+  def require_utilities
+    utility_paths.each do |path|
+      require File.expand_path(path)
+    end
+  end
+
+  def autoload_classes_and_modules
+    class_and_module_paths.each do |path|
+      module_name = File.basename(path).chomp('.rb')
+      @namespace.instance_eval do
+        autoload(module_name, File.expand_path(path))
+      end
+    end
+  end
+
+  def utility_paths
+    ruby_paths - class_and_module_paths - [@path]
+  end
+
+  def ruby_paths
+    dirname = File.directory?(@path) ? @path : File.dirname(@path)
+    paths = Dir[File.join(dirname, '*.rb')]
+    paths.reject do |path|
+      File.basename(path) == File.basename(@path)
+    end
+    # Force require statements to happen in a random order to discover
+    # missing direct dependencies
+    paths.sort_by {rand}
+  end
+
+  def class_and_module_paths
+    ruby_paths.find_all do |path|
+      File.basename(path) =~ /[A-Z]/
+    end
+  end
+
+end
+
+module Imb ; end
+
+Autoload.setup(Imb, __FILE__)

data/lib/USPS-intelligent-barcode/bar_to_character_mapping.yml

@@ -0,0 +1,66 @@
+---
+- [[7, 2], [4, 3]]
+- [[1, 10], [0, 0]]
+- [[9, 12], [2, 8]]
+- [[5, 5], [6, 11]]
+- [[8, 9], [3, 1]]
+- [[0, 1], [5, 12]]
+- [[2, 5], [1, 8]]
+- [[4, 4], [9, 11]]
+- [[6, 3], [8, 10]]
+- [[3, 9], [7, 6]]
+- [[5, 11], [1, 4]]
+- [[8, 5], [2, 12]]
+- [[9, 10], [0, 2]]
+- [[7, 1], [6, 7]]
+- [[3, 6], [4, 9]]
+- [[0, 3], [8, 6]]
+- [[6, 4], [2, 7]]
+- [[1, 1], [9, 9]]
+- [[7, 10], [5, 2]]
+- [[4, 0], [3, 8]]
+- [[6, 2], [0, 4]]
+- [[8, 11], [1, 0]]
+- [[9, 8], [3, 12]]
+- [[2, 6], [7, 7]]
+- [[5, 1], [4, 10]]
+- [[1, 12], [6, 9]]
+- [[7, 3], [8, 0]]
+- [[5, 8], [9, 7]]
+- [[4, 6], [2, 10]]
+- [[3, 4], [0, 5]]
+- [[8, 4], [5, 7]]
+- [[7, 11], [1, 9]]
+- [[6, 0], [9, 6]]
+- [[0, 6], [4, 8]]
+- [[2, 1], [3, 2]]
+- [[5, 9], [8, 12]]
+- [[4, 11], [6, 1]]
+- [[9, 5], [7, 4]]
+- [[3, 3], [1, 2]]
+- [[0, 7], [2, 0]]
+- [[1, 3], [4, 1]]
+- [[6, 10], [3, 5]]
+- [[8, 7], [9, 4]]
+- [[2, 11], [5, 6]]
+- [[0, 8], [7, 12]]
+- [[4, 2], [8, 1]]
+- [[5, 10], [3, 0]]
+- [[9, 3], [0, 9]]
+- [[6, 5], [2, 4]]
+- [[7, 8], [1, 7]]
+- [[5, 0], [4, 5]]
+- [[2, 3], [0, 10]]
+- [[6, 12], [9, 2]]
+- [[3, 11], [1, 6]]
+- [[8, 8], [7, 9]]
+- [[5, 4], [0, 11]]
+- [[1, 5], [2, 2]]
+- [[9, 1], [4, 12]]
+- [[8, 3], [6, 6]]
+- [[7, 0], [3, 7]]
+- [[4, 7], [7, 5]]
+- [[0, 12], [1, 11]]
+- [[2, 9], [9, 0]]
+- [[6, 8], [5, 3]]
+- [[3, 10], [8, 2]]