usps_intelligent_barcode 1.0.0 → 1.1.0

data/examples/generate_pdf.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+require 'usps_intelligent_barcode'
+
+begin
+  require 'prawn'
+rescue LoadError
+  puts "This example requires the 'prawn' gem."
+  puts "Install it with: gem install prawn"
+  exit 1
+end
+
+# Generate a PDF using a USPS Intelligent Mail Barcode font
+#
+# Uses bundled USPS IMB fonts - no installation required.
+
+class BarcodeToPDFFont
+  OUTPUT_FILENAME = 'barcode_font.pdf'
+  FONT_NAME = 'USPSIMBStandard'
+  FONT_FILE = Imb::UspsFonts.standard_font_path
+  FONT_SIZE = Imb::UspsFonts.font_size
+
+  def initialize(barcode)
+    @barcode = barcode
+    @letters = barcode.barcode_letters
+  end
+
+  def generate(path)
+    Prawn::Document.generate(path, page_size: 'LETTER') do |pdf|
+      pdf.text "USPS Intelligent Mail Barcode (Font-Based)", size: 16, style: :bold
+      pdf.move_down 10
+      pdf.text "Barcode ID: #{@barcode.barcode_id.to_s}"
+      pdf.text "Service Type: #{@barcode.service_type.to_s}"
+      pdf.text "Mailer ID: #{@barcode.mailer_id.to_s}"
+      pdf.text "Serial Number: #{@barcode.serial_number.to_s}"
+      pdf.text "Routing Code: #{@barcode.routing_code.to_s}"
+      pdf.text "\n"
+      pdf.text "Barcode string: #{@letters}", size: 8
+      pdf.text "\n"
+      pdf.text "Barcode string printed with font #{FONT_NAME} #{FONT_SIZE}"
+      render_barcode(pdf)
+      pdf.move_down 10
+    end
+  end
+
+  private
+
+  def render_barcode(pdf)
+    pdf.font_families.update(FONT_NAME => { normal: FONT_FILE })
+    pdf.font(FONT_NAME) do
+      pdf.text @letters, size: FONT_SIZE
+    end
+  end
+end
+
+# Example usage
+barcode = Imb::Barcode.new(
+  '01',           # barcode_id
+  '234',          # service_type
+  '567094',       # mailer_id
+  '987654321',    # serial_number
+  '01234567891'   # routing_code
+)
+
+pdf_generator = BarcodeToPDFFont.new(barcode)
+path = "/tmp/barcode_to_pdf.pdf"
+pdf_generator.generate(path)
+puts "Generated #{path}"

data/fonts/LICENSE

@@ -0,0 +1,47 @@
+USPS Intelligent Mail Barcode Fonts License
+============================================
+
+Copyright © US Postal Service 2009
+
+LICENSE GRANT
+
+The Postal Service grants you a world-wide, royalty-free, non-exclusive license
+to use the Software, Documentation, and Fonts in the mailing industry without
+paying a royalty or other fee, including rights to reproduce, display, merge,
+sell, distribute, sublicense, and translate them; and the right to create
+derivative works.
+
+CONDITIONS
+
+Redistribution of the Software, Documentation, and/or Fonts must contain:
+(a) the copyright notice set forth above
+(b) this list of conditions
+(c) the disclaimer noted below
+
+You may redistribute your versions of the Software and/or Fonts if your versions
+were created by making modifications or improvements for a legitimate purpose in
+furtherance of your or another's business.
+
+The US Postal Service reserves the right to change this License in any manner
+within reason at its discretion.
+
+DISCLAIMER
+
+THE POSTAL SERVICE DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. IN NO EVENT SHALL THE POSTAL SERVICE BE LIABLE FOR ANY SPECIAL,
+INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+FONTS INCLUDED
+
+- USPSIMBStandard.ttf - Primary USPS Intelligent Mail Barcode font
+- USPSIMBCompact.ttf - Compact variant of the USPS Intelligent Mail Barcode font
+
+OFFICIAL SOURCE
+
+Official USPS font downloads and documentation:
+https://postalpro.usps.com/mailing/encoder-software-and-fonts
+https://postalpro.usps.com/onecodesolution

data/lib/usps_intelligent_barcode/barcode.rb

@@ -6,7 +6,8 @@ require 'usps_intelligent_barcode/crc'
 # The namespace for everything in this library.
 module Imb
 
-  # This class represents a barcode.
+  # This class turns a collection of fields into a string of symbols
+  # for printing using a barcode font.
   class Barcode
 
     include Memoizer
@@ -26,8 +27,6 @@ module Imb
     # @return [RoutingCode]
     attr_reader :routing_code
 
-    # @param 
-
     # Create a new barcode
     #
     # @param barcode_id [String] Nominally a String, but can be
@@ -65,34 +64,8 @@ module Imb
     def barcode_letters
       symbols.map(&:letter).join
     end
-    
-    private
-
-    # :stopdoc:
-    BAR_MAP = BarMap.new
-    CODEWORD_MAP = CodewordMap.new
-    CRC = Crc.new
-    # :startdoc:
-
-    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
+    # @!group Algorithm Steps - Public for testing
 
     # The components ("fields" in the spec) are turned into a single
     # number that the spec calls "binary_data").  This is done through
@@ -181,6 +154,36 @@ module Imb
       end
     end
 
+    # @!endgroup
+
+    private
+
+    # :stopdoc:
+    BAR_MAP = BarMap.new
+    CODEWORD_MAP = CodewordMap.new
+    CRC = Crc.new
+    # :startdoc:
+
+    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
+
     # Map the "characters" to symbols.  Here is where the barcode is made.
     #
     # @return [Array<BarSymbol>]

data/lib/usps_intelligent_barcode/barcode_id.rb

@@ -52,6 +52,11 @@ module Imb
       @value
     end
 
+    # @return [String] The string value of the barcode ID
+    def to_s
+      "%02d" % @value
+    end
+
     # @!group Internal
 
     # Validate the value.

data/lib/usps_intelligent_barcode/mailer_id.rb

@@ -47,11 +47,16 @@ module Imb
       false
     end
 
-    # @return [Integer] The value of the mailer ID
+    # @return [Integer] The integer value of the mailer ID
     def to_i
       @value
     end
 
+    # @return [String] The string value of the mailer ID
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Return true if this is a long (9 digit) mailer ID

data/lib/usps_intelligent_barcode/project_dirs.rb

@@ -0,0 +1,19 @@
+module Imb
+
+  # Provides paths to gem directories
+  module ProjectDirs
+
+    # Returns the root directory of the gem
+    # @return [String] absolute path to gem root
+    def self.project_dir
+      File.expand_path('../..', __dir__)
+    end
+
+    # Returns the bundled fonts directory
+    # @return [String] absolute path to fonts/ directory
+    def self.font_dir
+      File.join(project_dir, 'fonts')
+    end
+
+  end
+end

data/lib/usps_intelligent_barcode/routing_code.rb

@@ -101,23 +101,25 @@ module Imb
 
     # @!endgroup
 
-    protected
-
     # Convert to an array of [zip, plus4, delivery point]
+    # @return [Array<Integer, Integer, Integer>]
+    # @note Public for testing
     def to_a
       [@zip, @plus4, @delivery_point]
     end
 
-    private
-
-    NUM_DIGITS = 11 #:nodoc:
-
-    def arg_to_i(o)
-      o.andand.to_i
+    # Convert to a string
+    def to_s
+      "%05d%04d%02d" % [
+        @zip,
+        @plus4,
+        @delivery_point,
+      ]
     end
-    
-    # Convert to an integer value
 
+    # Convert to an integer value
+    # @return [Integer]
+    # @note Public for testing
     def convert
       if @zip && @plus4 && @delivery_point
         @zip * 1000000 + @plus4 * 100 + @delivery_point + 1000100001
@@ -130,6 +132,14 @@ module Imb
       end
     end
 
+    private
+
+    NUM_DIGITS = 11 #:nodoc:
+
+    def arg_to_i(o)
+      o.andand.to_i
+    end
+
   end
 
 end

data/lib/usps_intelligent_barcode/serial_number.rb

@@ -37,11 +37,16 @@ module Imb
       false
     end
 
-    # @return [Integer] The value of the serial number
+    # @return [Integer] The integer value of the serial number
     def to_i
       @value
     end
 
+    # @return [String] The string value of the serial number
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Validate the value.

data/lib/usps_intelligent_barcode/service_type.rb

@@ -36,11 +36,16 @@ module Imb
       false
     end
 
-    # @return [Integer] The value of the service type
+    # @return [Integer] The integer value of the service type
     def to_i
       @value
     end
 
+    # @return [Integer] The string value of the service type
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Validate the value.

data/lib/usps_intelligent_barcode/usps_fonts.rb

@@ -0,0 +1,48 @@
+module Imb
+
+  # Provides access to bundled USPS Intelligent Mail Barcode fonts
+  class UspsFonts
+
+    # USPS recommended font size in points (16pt for standard fonts per spec)
+    STANDARD_FONT_SIZE = 16
+
+    # Returns path to the standard USPS IMB font (recommended for most use)
+    # USPSIMBStandard is the primary USPS Intelligent Mail Barcode font
+    # @return [String] absolute path to USPSIMBStandard.ttf
+    def self.standard_font_path
+      font_path('USPSIMBStandard.ttf')
+    end
+
+    # Returns path to the compact USPS IMB font
+    # USPSIMBCompact provides a more compact barcode rendering
+    # @return [String] absolute path to USPSIMBCompact.ttf
+    def self.compact_font_path
+      font_path('USPSIMBCompact.ttf')
+    end
+
+    # Returns paths to all bundled USPS fonts
+    # @return [Hash<Symbol, String>] font name symbols to file paths
+    def self.all_font_paths
+      {
+        standard: standard_font_path,
+        compact: compact_font_path
+      }
+    end
+
+    # Returns the USPS-recommended font size
+    # @return [Integer] font size in points (16pt)
+    def self.font_size
+      STANDARD_FONT_SIZE
+    end
+
+    private
+
+    # Returns absolute path to a font file in the bundled fonts directory
+    # @param filename [String] font filename
+    # @return [String] absolute path to font file
+    def self.font_path(filename)
+      File.join(ProjectDirs.font_dir, filename)
+    end
+
+  end
+end

data/lib/usps_intelligent_barcode.rb

@@ -12,6 +12,8 @@ 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/project_dirs'
 require 'usps_intelligent_barcode/routing_code'
 require 'usps_intelligent_barcode/serial_number'
 require 'usps_intelligent_barcode/service_type'
+require 'usps_intelligent_barcode/usps_fonts'

data/rake/bundler.rb

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/rake/version.rb

@@ -0,0 +1,33 @@
+namespace :version do
+  VERSION_FILE = 'VERSION'
+  desc "Bump major version (X.0.0)"
+  task :bump_major do
+    bump_version(:major)
+  end
+  desc "Bump minor version (x.X.0)"
+  task :bump_minor do
+    bump_version(:minor)
+  end
+  desc "Bump patch version (x.x.X)"
+  task :bump_patch do
+    bump_version(:patch)
+  end
+  def bump_version(level)
+    current = File.read(VERSION_FILE).strip
+    major, minor, patch = current.split('.').map(&:to_i)
+    case level
+    when :major
+      major += 1
+      minor = 0
+      patch = 0
+    when :minor
+      minor += 1
+      patch = 0
+    when :patch
+      patch += 1
+    end
+    new_version = "#{major}.#{minor}.#{patch}"
+    File.write(VERSION_FILE, new_version + "\n")
+    puts "Bumped version from #{current} to #{new_version}"
+  end
+end

data/rake/yard.rb

@@ -3,6 +3,7 @@ if Gem::Specification::find_all_by_name("yard").any?
   require 'yard'
 
   YARD::Rake::YardocTask.new do |t|
+    t.options = ['--output-dir', 'rdoc']
   end
 
 end

data/usps_intelligent_barcode.gemspec

@@ -1,100 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: usps_intelligent_barcode 1.0.0 ruby lib
-
 Gem::Specification.new do |s|
-  s.name = "usps_intelligent_barcode"
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Wayne Conrad"]
-  s.date = "2016-11-26"
-  s.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."
-  s.email = "wconrad@yagni.com"
-  s.extra_rdoc_files = [
-    "LICENSE.md",
-    "README.markdown"
-  ]
-  s.files = [
-    ".travis.yml",
-    "CHANGELOG.markdown",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.md",
-    "README.markdown",
-    "Rakefile",
-    "USPS-intelligent-barcode.gemspec",
-    "VERSION",
-    "examples/example.rb",
-    "lib/usps_intelligent_barcode.rb",
-    "lib/usps_intelligent_barcode/bar_map.rb",
-    "lib/usps_intelligent_barcode/bar_position.rb",
-    "lib/usps_intelligent_barcode/bar_symbol.rb",
-    "lib/usps_intelligent_barcode/bar_to_character_mapping.yml",
-    "lib/usps_intelligent_barcode/barcode.rb",
-    "lib/usps_intelligent_barcode/barcode_id.rb",
-    "lib/usps_intelligent_barcode/character_position.rb",
-    "lib/usps_intelligent_barcode/codeword_map.rb",
-    "lib/usps_intelligent_barcode/codeword_to_character_mapping.yml",
-    "lib/usps_intelligent_barcode/crc.rb",
-    "lib/usps_intelligent_barcode/mailer_id.rb",
-    "lib/usps_intelligent_barcode/numeric_conversions.rb",
-    "lib/usps_intelligent_barcode/routing_code.rb",
-    "lib/usps_intelligent_barcode/serial_number.rb",
-    "lib/usps_intelligent_barcode/service_type.rb",
-    "rake/default.rb",
-    "rake/jeweler.rb",
-    "rake/rspec.rb",
-    "rake/yard.rb",
-    "spec/bar_map_spec.rb",
-    "spec/bar_position_spec.rb",
-    "spec/bar_symbol_spec.rb",
-    "spec/barcode_id_spec.rb",
-    "spec/barcode_spec.rb",
-    "spec/character_position_spec.rb",
-    "spec/codeword_map_spec.rb",
-    "spec/crc_spec.rb",
-    "spec/mailer_id_spec.rb",
-    "spec/numeric_conversions_spec.rb",
-    "spec/routing_code_spec.rb",
-    "spec/serial_number_spec.rb",
-    "spec/service_type_spec.rb",
-    "spec/spec_helper.rb",
-    "usps_intelligent_barcode.gemspec"
-  ]
-  s.homepage = "http://github.com/wconrad/usps_intelligent_barcode"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Generates a USPS Intelligent Mail Barcode."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<andand>, ["~> 1.3"])
-      s.add_runtime_dependency(%q<memoizer>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_development_dependency(%q<rake>, ["~> 11.2"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.8.5"])
-    else
-      s.add_dependency(%q<andand>, ["~> 1.3"])
-      s.add_dependency(%q<memoizer>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_dependency(%q<rake>, ["~> 11.2"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<yard>, ["~> 0.8.5"])
-    end
-  else
-    s.add_dependency(%q<andand>, ["~> 1.3"])
-    s.add_dependency(%q<memoizer>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0"])
-    s.add_dependency(%q<rake>, ["~> 11.2"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<yard>, ["~> 0.8.5"])
+  s.name        = 'usps_intelligent_barcode'
+  s.version     = File.read('VERSION').strip
+  s.summary     = 'Generates a USPS Intelligent Mail Barcode.'
+  s.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.'
+  s.authors     = ['Wayne Conrad']
+  s.email       = 'kf7qga@gmail.com'
+  s.homepage    = 'https://github.com/wconrad/usps_intelligent_barcode'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 3.2.0'
+  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
+  s.require_paths = ['lib']
+  s.add_runtime_dependency 'andand', '~> 1.3'
+  s.add_runtime_dependency 'memoizer', '~> 1.0'
+  s.add_development_dependency 'prawn', '~> 2.5'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.12'
+  s.add_development_dependency 'rspec-its', '~> 2.0'
+  s.add_development_dependency 'simplecov', '~> 0.22'
+  s.add_development_dependency 'yard', '~> 0.9'
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/wconrad/usps_intelligent_barcode',
+    'bug_tracker_uri' => 'https://github.com/wconrad/usps_intelligent_barcode/issues'
+  }
 end
-