usps_intelligent_barcode 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 239fb7cda63e325a8d915502dbdc1c067d91fde0
+  data.tar.gz: 8e356a3daa59ced936401d0a0c8e61a4ec3ace98
+SHA512:
+  metadata.gz: 4246dcea3fdfd322e15f0a3cae0a52e94caa66db9f467c1e48964f6e2b12ff4066541ca4aeabddb962a4ee5d9dd055af0a2a87d372376fb0b9ce45483813b77e
+  data.tar.gz: 232ac8d641c696b678eac49bf6a7bc7d763fcc67c25c0926ebef445f10663b3f4bc290502de5c7f73302c661e38a8aad8dc2972b58bd390adc180f63509ae76f

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- rbx-2.5
+- jruby-1.7
+- ruby-1.9.3
+- ruby-2.0
+- ruby-2.1
+- ruby-2.2

data/CHANGELOG.markdown

@@ -0,0 +1,67 @@
+# 0.3.0
+
+* Ruby 2.1 and 2.2 supported
+* Ruby 1.8.7 no longer supported
+* Renamed gem from USPS-intelligent-barcode to usps_intelligent_barcode
+	
+# 0.2.5
+
+Enhancements
+
+* Support MRI 2.0
+
+# 0.2.4
+
+Bug fixes
+
+* Correct author's email address
+
+Enhancements
+
+* Refactoring
+
+# 0.2.3
+
+Enhancements
+
+* Switch docs from rdoc to yard
+
+# 0.2.2
+
+Enhancements
+
+* Added code coverage to test suite
+
+# 0.2.1
+
+* Removed autoload
+
+# 0.2.0
+
+Enhancements
+
+* Many comments
+* Refactoring
+
+# 0.1.2
+
+Bug fixes
+
+* Corrected Ryan Taylor Long's name in README
+
+# 0.1.1
+
+Bug fixes
+
+* Correct example in README
+* Fix example for 1.8.7
+
+API Changes
+
+* Renamed imb to USPS-intelligent-barcode to be consistent with gem name
+
+# 0.1.0
+
+Enhancements
+
+* Turned into a gem

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'andand', '~> 1.3'
+gem 'memoizer', '~> 1.0'
+
+group :development do
+  gem 'jeweler', '~> 2.0'
+  gem 'rspec', '~> 3.3'
+  gem 'rspec-its', '~> 1.0'
+  gem 'simplecov', '~> 0.10.0'
+  gem 'yard', '~> 0.8.5'
+  gem 'rake', '~> 10.0'
+end

data/Gemfile.lock

@@ -0,0 +1,90 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    andand (1.3.3)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.0)
+    memoizer (1.0.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nokogiri (1.6.6.2-java)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.1)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    thread_safe (0.3.5-java)
+    yard (0.8.7.6)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  andand (~> 1.3)
+  jeweler (~> 2.0)
+  memoizer (~> 1.0)
+  rake (~> 10.0)
+  rspec (~> 3.3)
+  rspec-its (~> 1.0)
+  simplecov (~> 0.10.0)
+  yard (~> 0.8.5)

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.markdown

@@ -0,0 +1,64 @@
+USPS-intelligent-barcode is a pure ruby gem to generate a USPS IMB
+(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).
+
+# ORIGIN
+
+This project was forked from Ryan Taylor's
+https://github.com/rtlong/USPS-intelligent-barcode Long, 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 '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"
+
+# STANDARD
+
+This gem is based upon standard
+[USPS-B-3200G](https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/SPUSPSG.pdf)
+
+# RUBY VERSIONS
+
+These Ruby versions are supported (these are the rvm platform names):
+
+* jruby-1.7
+* ruby-1.9.3
+* ruby-2.0
+* ruby-2.1
+* ruby-2.2
+
+For ruby-1.8.7 please see the deprecated
+[USPS-intelligent-barcode](https://rubygems.org/gems/USPS-intelligent-barcode)
+gem.
+
+# WHOAMI
+
+Wayne Conrad <kf7qga@gmail.com>
+
+# CREDITS
+
+Thanks to Ryan Taylor Long for his original work, without which I
+would have been lost in the USPS specification.

data/Rakefile

@@ -0,0 +1,40 @@
+# 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 library 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 = "wconrad@yagni.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 'yard'
+YARD::Rake::YardocTask.new do |t|
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.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,17 @@
+require 'andand'
+require 'memoizer'
+require 'yaml'
+
+require 'USPS-intelligent-barcode/bar_map'
+require 'USPS-intelligent-barcode/bar_position'
+require 'USPS-intelligent-barcode/bar_symbol'
+require 'USPS-intelligent-barcode/barcode'
+require 'USPS-intelligent-barcode/barcode_id'
+require 'USPS-intelligent-barcode/character_position'
+require 'USPS-intelligent-barcode/codeword_map'
+require 'USPS-intelligent-barcode/crc'
+require 'USPS-intelligent-barcode/mailer_id'
+require 'USPS-intelligent-barcode/numeric_conversions'
+require 'USPS-intelligent-barcode/routing_code'
+require 'USPS-intelligent-barcode/serial_number'
+require 'USPS-intelligent-barcode/service_type'

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

@@ -0,0 +1,52 @@
+require 'USPS-intelligent-barcode/character_position'
+
+# @!group Internal
+
+module Imb
+
+  # Maps intelligent barcode "characters" to codes that indicate what
+  # type of bar to print at each given position.
+
+  class BarMap
+
+    def initialize
+      @mapping = load_mapping
+    end
+
+    # Given an array of intelligent barcode "characters", return an
+    # the symbols for each position.
+    # @param [[Integer]] characters array of characters
+    # @return [[BarSymbol]] array of symbols
+
+    def symbols(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/bar_position.rb

@@ -0,0 +1,40 @@
+module Imb
+
+  # @!group Internal
+
+  # Represents a position (one line) in the barcode.  This class is
+  # internal and may change.
+
+  class BarPosition
+
+    # @param [CharacterPosition] descender_character_position
+    # @param [CharacterPosition] ascender_character_position
+
+    def initialize(descender_character_position, ascender_character_position)
+      @descender_character_position = descender_character_position
+      @ascender_character_position = ascender_character_position
+    end
+
+    # Given an array of characters, return a symbol for this
+    # barcode position.
+    # @param [[Integer]] characters character codes
+    # @return [BarSymbol] symbol code
+
+    def map(characters)
+      BarSymbol.make(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/bar_symbol.rb

@@ -0,0 +1,49 @@
+module Imb
+
+  # @!group Internal
+
+  # Represents a symbol in the barcode.
+
+  class BarSymbol
+
+    # @param [Integer] ascender_bit (0..1)
+    # @param [Integer] descender_bit (0..1)
+    # @return [BarSymbol]
+
+    def self.make(ascender_bit, descender_bit)
+      case [ascender_bit, descender_bit]
+      when [0, 0]
+        TRACKER
+      when [0, 1]
+        DESCENDER
+      when [1, 0]
+        ASCENDER
+      when [1, 1]
+        FULL
+      end
+    end
+
+    # @return [Integer] the code for this symbol
+    attr_reader :code
+
+    # @return [String] the letter for this symbol
+    attr_reader :letter
+
+    # @param [Integer] code (0..3)
+    # @param [String] letter
+
+    def initialize(code, letter)
+      @code = code
+      @letter = letter
+    end
+
+    private
+
+    TRACKER = BarSymbol.new(0, 'T')
+    DESCENDER = BarSymbol.new(1, 'D')
+    ASCENDER = BarSymbol.new(2, 'A')
+    FULL = BarSymbol.new(3, 'F')
+
+  end
+
+end