USPS-intelligent-barcode 0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gem 'andand', '~> 1.3'
+gem 'memoizer', '~> 1.0'
+
+group :development do
+  gem 'rspec', '~> 2.12'
+  gem 'jeweler', '~> 1.8'
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    andand (1.3.3)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    memoizer (1.0.1)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  andand (~> 1.3)
+  jeweler (~> 1.8)
+  memoizer (~> 1.0)
+  rspec (~> 2.12)

data/LICENSE.md

@@ -0,0 +1,11 @@
+Copyright 2012 Ryan Taylor Long
+Copyright 2012 Wayne Conrad
+
+This software is distributed under the [MIT License](http://opensource.org/licenses/MIT):
+
+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,56 @@
+# USPS-intelligent-barcode
+
+USPS-intelligent-barcode is a pure ruby gem to generate a USPS
+Intelligent Mail Barcode.  More specifically, it generates the string
+of characters you should print using one of the [USPS Intelligent
+Barcode fonts](https://ribbs.usps.gov/onecodesolution/download.cfm).
+
+## FORKED FROM
+
+This project was forked from :
+
+[rtlong/USPS-intellient-barcode](https://github.com/rtlong/USPS-intelligent-barcode)
+(github) by Ryan Taylor, in order to add tests and refactor.  It is
+_not_ a drop-in replacement: I renamed most methods and classes, and
+eliminated the #draw method.
+
+## INSTALL
+
+    $ gem install USPS-intelligent-barcode
+
+## EXAMPLE
+
+    #!/usr/bin/env ruby
+    
+    require 'imb'
+    
+    barcode_id = '01'
+    service_type = '234'
+    mailer_id = '567094'
+    serial_number = '987654321'
+    routing_code = '01234567891'
+    barcode = Imb::Barcode.new(barcode_id,
+                               service_type,
+                               mailer_id,
+                               serial_number,
+                               routing_code)
+    p barcode.barcode_letters
+    # => "AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA"
+
+## STANDARD
+
+This gem is based upon standard
+[USPS-B-3200G](https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/SPUSPSG.pdf)
+
+## RUBY VERSIONS
+
+The tests are known to pass in MRI 1.8.7 and MRI 1.9.3
+
+## WHOAMI
+
+Wayne Conrad <wconrad@yagni.com>
+
+## CREDITS
+
+Thanks to Ryan Taylor for his original work, without which I would
+have been lost in the USPS specification.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "USPS-intelligent-barcode"
+  gem.homepage = "http://github.com/wconrad/USPS-intelligent-barcode"
+  gem.license = "MIT"
+  gem.summary = %Q{Generates a USPS Intelligent Mail Barcode.}
+  gem.description =
+    ("A pure Ruby gem to generate a USPS Intelligent "\
+     "Mail barcode.  It generates the string of characters "\
+     "to print with one of the USPS Intelligent Mail barcode "\
+     "fonts.")
+  gem.email = "wayne@databill.com"
+  gem.authors = ["Wayne Conrad"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "USPS-intelligent-barcode #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/example.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'USPS-intelligent-barcode'
+
+barcode_id = '01'
+service_type = '234'
+mailer_id = '567094'
+serial_number = '987654321'
+routing_code = '01234567891'
+barcode = Imb::Barcode.new(barcode_id,
+                           service_type,
+                           mailer_id,
+                           serial_number,
+                           routing_code)
+p barcode.barcode_letters
+# => "AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA"

data/lib/USPS-intelligent-barcode.rb

@@ -0,0 +1,5 @@
+require 'andand'
+require 'memoizer'
+require 'yaml'
+
+require 'USPS-intelligent-barcode/autoload.rb'

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

@@ -0,0 +1,40 @@
+module Imb
+
+  class BarMap
+
+    def initialize
+      @mapping = load_mapping
+    end
+
+    def barcode(characters)
+      @mapping.map do |bar_position|
+        bar_position.map(characters)
+      end
+    end
+
+    private
+
+    def load_mapping
+      convert_mapping_data(load_mapping_data)
+    end
+
+    def convert_mapping_data(mapping_data)
+      mapping_data.map do |descender, ascender|
+        descender_character_position = CharacterPosition.new(*descender)
+        ascender_character_position = CharacterPosition.new(*ascender)
+        BarPosition.new(descender_character_position,
+                        ascender_character_position)
+      end
+    end
+
+    def load_mapping_data
+      YAML.load_file(mapping_path)
+    end
+
+    def mapping_path
+      File.expand_path('bar_to_character_mapping.yml', File.dirname(__FILE__))
+    end
+
+  end
+
+end

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

@@ -0,0 +1,26 @@
+module Imb
+
+  class BarPosition
+
+    def initialize(descender_character_position, ascender_character_position)
+      @descender_character_position = descender_character_position
+      @ascender_character_position = ascender_character_position
+    end
+
+    def map(characters)
+      2 * ascender_bit(characters) + descender_bit(characters)
+    end
+
+    private
+
+    def descender_bit(characters)
+      @descender_character_position.extract_bit_from_characters(characters)
+    end
+
+    def ascender_bit(characters)
+      @ascender_character_position.extract_bit_from_characters(characters)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,110 @@
+module Imb
+
+  class Barcode
+
+    include Memoizer
+
+    attr_reader :barcode_id
+    attr_reader :service_type
+    attr_reader :mailer_id
+    attr_reader :serial_number
+    attr_reader :routing_code
+
+    def initialize(barcode_id,
+                   service_type,
+                   mailer_id,
+                   serial_number,
+                   routing_code)
+      @barcode_id = BarcodeId.coerce(barcode_id)
+      @service_type = ServiceType.coerce(service_type)
+      @mailer_id = MailerId.coerce(mailer_id)
+      @serial_number = SerialNumber.coerce(serial_number)
+      @routing_code = RoutingCode.coerce(routing_code)
+      validate_components
+    end
+    
+    def barcode_letters
+      barcode.map { |bar| "TDAF"[bar..bar] }.join
+    end
+    
+    private
+
+    BAR_MAP = BarMap.new
+    CODEWORD_MAP = CodewordMap.new
+
+    def validate_components
+      components.each do |component|
+        component.validate(long_mailer_id?)
+      end
+    end
+
+    def components
+      [
+        @routing_code,
+        @barcode_id,
+        @service_type,
+        @mailer_id,
+        @serial_number,
+      ]
+    end
+
+    def long_mailer_id?
+      @mailer_id.long?
+    end
+
+    def binary_data
+      components.inject(0) do |data, component|
+        component.shift_and_add_to(data, long_mailer_id?)
+      end
+    end
+    memoize :binary_data
+
+    def frame_check_sequence
+      Crc.crc(binary_data)
+    end
+    memoize :frame_check_sequence
+
+    def codewords
+      codewords = []
+      data = binary_data
+      data, codewords[9] = data.divmod 636
+      8.downto(0) do |i|
+        data, codewords[i] = data.divmod 1365
+      end
+      codewords
+    end
+    memoize :codewords
+
+    def codewords_with_orientation_in_character_j
+      result = codewords.dup
+      result[9] *= 2
+      result
+    end
+
+    def codewords_with_fcs_bit_in_character_a
+      result = codewords_with_orientation_in_character_j.dup
+      result[0] += 659 if frame_check_sequence[10] == 1
+      result
+    end      
+
+    def characters
+      CODEWORD_MAP.characters(codewords_with_fcs_bit_in_character_a)
+    end
+
+    def characters_with_fcs_bits_0_through_9
+      characters.each_with_index.map do |character, i|
+        if frame_check_sequence[i] == 1
+          character ^ 0b1111111111111
+        else
+          character
+        end
+      end
+    end
+
+    def barcode
+      BAR_MAP.barcode(characters_with_fcs_bits_0_through_9)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,66 @@
+module Imb
+
+  class BarcodeId
+
+    def self.coerce(o)
+      case o
+      when BarcodeId
+        o
+      when String
+        new(o.to_i)
+      when Integer
+        new(o)
+      else
+        raise ArgumentError, 'Cannot coerce to BarcodeId'
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def validate(long_mailer_id)
+      unless RANGE === @value
+        raise ArgumentError, "Must be #{RANGE}"
+      end
+      unless LSB_RANGE === least_significant_digit
+        raise ArgumentError, "Least significant digit must be #{LSB_RANGE}"
+      end
+    end
+
+    def ==(o)
+      BarcodeId.coerce(o).to_i == to_i
+    rescue ArgumentError
+      false
+    end
+
+    def most_significant_digit
+      @value / 10
+    end
+
+    def least_significant_digit
+      @value % 10
+    end
+
+    def shift_and_add_to(target, long_mailer_id)
+      target *= 10
+      target += most_significant_digit
+      target *= 5
+      target += least_significant_digit
+      target
+    end
+
+    protected
+
+    def to_i
+      @value
+    end
+
+    private
+
+    RANGE = 0..94
+    LSB_RANGE = 0..4
+
+  end
+
+end

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

@@ -0,0 +1,16 @@
+module Imb
+
+  class CharacterPosition
+
+    def initialize(character_index, bit_number)
+      @character_index = character_index
+      @bit_number = bit_number
+    end
+
+    def extract_bit_from_characters(characters)
+      characters[@character_index][@bit_number]
+    end
+
+  end
+
+end