usps_intelligent_barcode 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cdeac04e1071c96dc596d2bec3e84ece73cf2291
-  data.tar.gz: 451155bce2c3da38ce4477268f27edcf74c252d8
+SHA256:
+  metadata.gz: '0488d46d6920cd4e667e2afdaf5df62b5be305f7f528136c54378e9be41642c1'
+  data.tar.gz: 60c369c9e7a2d28b179c3dc50515eb60d3dc2a835de213b8679c483ec2c91b0c
 SHA512:
-  metadata.gz: 330b9a3c194405b63ac36a84cfadff64a3656fe769d0cda0f5edfeaa0478d72611812baae70b1f0e10404f9f421520f0c09f14ae41f0ce172cf1f1e10d538d8d
-  data.tar.gz: 7d067d53ea00a44f1334f1791c877b4a57f0e36282419b74addb8499c9d77f7548698a3fab0c4d83782decf0a068995de31775f6fdd6532db75251e82ec8433c
+  metadata.gz: 5b3dbdcae467309c93c980928ffb87fe733decbc677c1e135edc8b5ac85289f9c16ebce88af9caa476b3c1c39213ddc2310218903c16608a9841bec8a3d02eb0
+  data.tar.gz: f468bbb917890d2ce64125ce192f91b78a8756d9958e3870ae8a47a43c78784a09eb92bd6fdf491d58bab88f665ea9ffc15ffac134d8c74319044815daaa1b89

data/.gitignore

@@ -0,0 +1,6 @@
+*~
+.yardoc
+coverage
+rdoc
+pkg
+.claude/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-4.0.0

data/{CHANGELOG.markdown → CHANGELOG.md}

@@ -1,20 +1,35 @@
+-*- mode: fundamental -*-
+
 # Development
 
-* Fixed leftovers from old name
+* Supports Ruby 4.0, 3.4, 3.3, 3.2
+* Support for Ruby 3.1 and earlier dropped
+* Add #to_s methods to component classes
+  (e.g. `barcode.barcode_id.to_s`)
+* Bundle USPS IMBC fonts.  Use Imb::UspsFonts to access them
+* Include example that creates a PDF
+
+# 1.0.0 - 2016-11-26
 
-# 0.3.0
+* Switch to semantic versioning.  Version 1.0.0 has the same API as
+  version 0.3.1.
+* Ruby 2.3 supported
+* Improved comments
+
+# 0.3.1 - 2015-06-13
+# 0.3.0 - 2015-06-13
 
 * 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
+
+# 0.2.5 - 2013-02-28
 
 Enhancements
 
 * Support MRI 2.0
 
-# 0.2.4
+# 0.2.4 - 2013-01-05
 
 Bug fixes
 
@@ -24,36 +39,36 @@ Enhancements
 
 * Refactoring
 
-# 0.2.3
+# 0.2.3 - 2012-12-31
 
 Enhancements
 
 * Switch docs from rdoc to yard
 
-# 0.2.2
+# 0.2.2 - 2012-12-30
 
 Enhancements
 
 * Added code coverage to test suite
 
-# 0.2.1
+# 0.2.1 - 2012-12-28
 
 * Removed autoload
 
-# 0.2.0
+# 0.2.0 - 2012-12-27
 
 Enhancements
 
 * Many comments
 * Refactoring
 
-# 0.1.2
+# 0.1.2 - 2012-12-27
 
 Bug fixes
 
 * Corrected Ryan Taylor Long's name in README
 
-# 0.1.1
+# 0.1.1 - 2012-12-27
 
 Bug fixes
 
@@ -64,7 +79,7 @@ API Changes
 
 * Renamed imb to USPS-intelligent-barcode to be consistent with gem name
 
-# 0.1.0
+# 0.1.0 - 2012-12-26
 
 Enhancements
 

data/Gemfile

@@ -1,17 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
-gem 'andand', '~> 1.3'
-gem 'memoizer', '~> 1.0'
-
-group :test do
-  gem 'rake', '~> 11.2'
-  gem 'rspec', '~> 3.3'
-  gem 'rspec-its', '~> 1.0'
-end
-
-group :development do
-  gem 'jeweler', '~> 2.0'
-  gem 'rake', '~> 11.2'
-  gem 'simplecov'
-  gem 'yard', '~> 0.8.5'
-end
+gemspec

data/Gemfile.lock

@@ -1,97 +1,86 @@
+PATH
+  remote: .
+  specs:
+    usps_intelligent_barcode (1.1.0)
+      andand (~> 1.3)
+      memoizer (~> 1.0)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
     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.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (3.4.6)
-    highline (1.7.8)
-    jeweler (2.1.2)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api (~> 0.11.0)
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    json (2.0.2)
-    json (2.0.2-java)
-    jwt (1.5.6)
-    memoizer (1.0.1)
-    mini_portile2 (2.1.0)
-    multi_json (1.12.1)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    nokogiri (1.6.8.1-java)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    public_suffix (2.0.4)
-    rack (2.0.1)
-    rake (11.3.0)
-    rdoc (5.0.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    bigdecimal (3.3.1)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    matrix (0.4.3)
+    memoizer (1.0.3)
+    pdf-core (0.10.0)
+    prawn (2.5.0)
+      matrix (~> 0.4)
+      pdf-core (~> 0.10.0)
+      ttfunk (~> 1.8)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-its (1.2.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.13.0)
+    rspec-its (2.0.0)
+      rspec-core (>= 3.13.0)
+      rspec-expectations (>= 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    semver (1.0.1)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      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)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    ttfunk (1.8.0)
+      bigdecimal (~> 3.1)
+    yard (0.9.38)
 
 PLATFORMS
-  java
   ruby
+  x86_64-linux
 
 DEPENDENCIES
-  andand (~> 1.3)
-  jeweler (~> 2.0)
-  memoizer (~> 1.0)
-  rake (~> 11.2)
-  rspec (~> 3.3)
-  rspec-its (~> 1.0)
-  simplecov
-  yard (~> 0.8.5)
+  prawn (~> 2.5)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rspec-its (~> 2.0)
+  simplecov (~> 0.22)
+  usps_intelligent_barcode!
+  yard (~> 0.9)
+
+CHECKSUMS
+  andand (1.3.3) sha256=483d8a01e0d02dfc55de7759527d20c167edf0607983fc4e50a7c3583709346c
+  bigdecimal (3.3.1) sha256=eaa01e228be54c4f9f53bf3cc34fe3d5e845c31963e7fcc5bedb05a4e7d52218
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
+  matrix (0.4.3) sha256=a0d5ab7ddcc1973ff690ab361b67f359acbb16958d1dc072b8b956a286564c5b
+  memoizer (1.0.3) sha256=790d924ec13ea376aced58a88c0216e075762166e92080ac8b658859ae4e2945
+  pdf-core (0.10.0) sha256=0a5d101e2063c01e3f941e1ee47cbb97f1adfc1395b58372f4f65f1300f3ce91
+  prawn (2.5.0) sha256=f4e20e3b4f30bf5b9ae37dad15eb421831594553aa930b2391b0fa0a99c43cb6
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-its (2.0.0) sha256=a88e8bc38149f2835e93533591ec4f5c829aacbfd41269a2e6f9f5b82f5260df
+  rspec-mocks (3.13.7) sha256=0979034e64b1d7a838aaaddf12bf065ea4dc40ef3d4c39f01f93ae2c66c62b1c
+  rspec-support (3.13.6) sha256=2e8de3702427eab064c9352fe74488cc12a1bfae887ad8b91cba480ec9f8afb2
+  simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
+  simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
+  simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
+  ttfunk (1.8.0) sha256=a7cbc7e489cc46e979dde04d34b5b9e4f5c8f1ee5fc6b1a7be39b829919d20ca
+  usps_intelligent_barcode (1.1.0)
+  yard (0.9.38) sha256=721fb82afb10532aa49860655f6cc2eaa7130889df291b052e1e6b268283010f
 
 BUNDLED WITH
-   1.13.6
+  4.0.3

data/LICENSE.md

@@ -9,3 +9,10 @@ The above copyright notice and this permission notice shall be included in all c
 
 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.
 
+## Bundled Fonts
+
+The USPS Intelligent Mail Barcode fonts included in the `fonts/` directory are:
+
+Copyright © US Postal Service 2009
+
+These fonts are licensed separately under the USPS license (see `fonts/LICENSE`). The USPS grants a world-wide, royalty-free license to use, reproduce, display, distribute, and sublicense these fonts.

data/{README.markdown → README.md}

@@ -9,64 +9,84 @@ string of characters you should print using one of the [USPS
 Intelligent Barcode
 fonts](https://ribbs.usps.gov/onecodesolution/download.cfm).
 
-# ORIGIN
+# 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
+# Install
 
-    $ gem install USPS-intelligent-barcode
+    gem install usps_intelligent_barcode
 
-# EXAMPLE
+Note: This gem was previously named `USPS-intelligent-barcode`. If
+you're migrating from the old gem name, see
+[MIGRATION.md](MIGRATION.md).
 
-    #!/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"
+# Example
 
-# STANDARD
+```ruby
+#!/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'
+
+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"
+```
+
+# Generating Barcode PDFs
+
+The gem includes bundled USPS Intelligent Mail Barcode fonts. To generate a
+PDF with a barcode:
+
+```ruby
+gem install prawn
+ruby examples/generate_pdf.rb
+```
+
+This creates `/tmp/barcode_to_pdf.pdf` with the barcode and its component
+fields. The USPS fonts (USPSIMBStandard and USPSIMBCompact) are included
+in the `fonts/` directory - no installation required.
+
+# Standard
 
 This gem is based upon standard
 [USPS-B-3200H](https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/USPSB3200IntelligentMailBarcode4State.pdf),
 which is linked to from [Intelligent Mail Barcode for
 Mailpieces](https://ribbs.usps.gov/index.cfm?page=intellmailmailpieces)
 
-# RUBY VERSIONS
-
-These Ruby versions are supported (these are the rvm platform names):
+# Supported Ruby Versions
 
-* jruby-1.7
-* ruby-1.9.3
-* ruby-2.0
-* ruby-2.1
-* ruby-2.2
-* ruby-2.3
+This gem is tested and supported on:
 
-For ruby-1.8.7 please see the deprecated
-[USPS-intelligent-barcode](https://rubygems.org/gems/USPS-intelligent-barcode)
-gem.
+* ruby-3.2
+* ruby-3.3
+* ruby-3.4
+* ruby-4.0
 
-# WHOAMI
+# whoami
 
 Wayne Conrad <kf7qga@gmail.com>
 
-# CREDITS
+# Gem versioning
+
+This library uses [Semantic Versioning](http://semver.org/).  It
+promises not to make breaking changes to its API without bumping the
+major version.
+
+# Credits
 
 Thanks to Ryan Taylor Long for his original work, without which I
 would have been lost in the USPS specification.

data/VERSION

@@ -1 +1 @@
-0.3.1
+1.1.0

data/doc/font_installation.md

@@ -0,0 +1,55 @@
+# Installing USPS Intelligent Mail Barcode Fonts
+
+## Bundled Fonts (Recommended)
+
+The USPS fonts are bundled with this gem - no installation required!
+
+The PDF generation example automatically uses the bundled fonts:
+
+```bash
+gem install prawn
+ruby examples/generate_pdf.rb
+```
+
+The bundled fonts are located in the gem's `fonts/` directory and are
+licensed by USPS for royalty-free use (see `fonts/LICENSE`).
+
+The example embeds the bundled font into the generated PDF, so the PDF will
+display correctly on any system without requiring font installation. If you
+create your own PDF that does not embed the font, you will need to install
+the font system-wide to view the generated PDF.
+
+## System Installation (Optional)
+
+If you prefer to install the fonts system-wide for use in other applications,
+follow these instructions.
+
+### Download the Font
+
+Official USPS Source (Free):
+
+1. Visit https://postalpro.usps.com/onecodesolution
+2. Download `uspsFontsNonAFP-1.4.0.zip` (TrueType format)
+3. Extract and navigate to `fonts/scalable/trueType/` folder
+
+## Installation on Linux
+
+```
+cd ~/Downloads
+mkdir uspsFontsNonAFP-1.4.0.zip.d
+cd uspsFontsNonAFP-1.4.0.zip.d
+unzip ../uspsFontsNonAFP-1.4.0.zip
+cd fonts/scalable/trueType/
+sudo mkdir -p /usr/share/fonts/truetype/usps
+sudo cp *.ttf /usr/share/fonts/truetype/usps/
+sudo fc-cache -f
+fc-list | grep -i usps
+```
+
+## Available Fonts
+
+The package includes several fonts:
+
+- USPSIMBStandard.ttf (recommended, used in examples)
+- USPSIMBCompact.ttf (alternative)
+- USPSIMB.ttf (same as Standard)

data/doc/migration.md

@@ -0,0 +1,47 @@
+# Migration Guide
+
+## Gem Rename: USPS-intelligent-barcode → usps_intelligent_barcode
+
+### Background
+
+In June 2015 (version 0.3.0), this gem was renamed from `USPS-intelligent-barcode` to `usps_intelligent_barcode` to follow Ruby gem naming conventions.
+
+### What Changed
+
+**Old name (deprecated):**
+```ruby
+gem 'USPS-intelligent-barcode'
+```
+
+**New name (current):**
+```ruby
+gem 'usps_intelligent_barcode'
+```
+
+### Migration Steps
+
+1. Update your `Gemfile`:
+   ```ruby
+   # Replace this:
+   gem 'USPS-intelligent-barcode'
+
+   # With this:
+   gem 'usps_intelligent_barcode'
+   ```
+
+2. Run `bundle update`
+
+3. No code changes required - the API remains identical
+
+### Compatibility Period
+
+For backward compatibility, both gem names were published simultaneously:
+
+- `USPS-intelligent-barcode` (v0.2.7) - Deprecated, with post-install warning
+- `usps_intelligent_barcode` (v0.3.0+) - Current version
+
+The deprecated `USPS-intelligent-barcode` gem was maintained through 2015-2016 to allow users time to migrate.
+
+### Current Status
+
+As of 2025, only `usps_intelligent_barcode` is actively maintained. The old `USPS-intelligent-barcode` gem name should not be used for new projects.

data/doc/publishing.md

@@ -0,0 +1,75 @@
+# Publishing a New Release
+
+## Checklist
+
+* Bump the version in VERSION file:
+   ```
+   rake version:bump_patch   # For bug fixes (1.1.0 -> 1.1.1)
+   rake version:bump_minor   # For new features (1.1.0 -> 1.2.0)
+   rake version:bump_major   # For breaking changes (1.1.0 -> 2.0.0)
+   ```
+
+* Update CHANGELOG.md with version and date
+
+* Update Gemfile.lock for the new version
+  ```
+  bundle install
+  ```
+
+* Run tests:
+   ```
+   rake
+   ```
+
+* Check code coverage (optional):
+   ```
+   open coverage/index.html
+   ```
+
+* Commit the version bump:
+   ```
+   git commit -am "Bump version to X.X.X"
+   ```
+
+* Release:
+   ```
+   rake release
+   ```
+
+* Verify at https://rubygems.org/gems/usps_intelligent_barcode
+
+## Notes
+
+Semantic Versioning: MAJOR.MINOR.PATCH (breaking.feature.bugfix)
+
+What `rake release` does:
+- Builds the gem
+- Creates git tag vX.X.X
+- Pushes tag to GitHub
+- Publishes gem to rubygems.org
+
+Dry run: `gem_push=no rake release` (tags but doesn't publish)
+
+Test locally before releasing:
+```
+rake install
+gem list usps_intelligent_barcode
+```
+
+## Troubleshooting
+
+No RubyGems credentials: `gem signin`
+
+Release failed mid-way:
+```
+git tag -d vX.X.X              # Delete local tag
+git push origin :vX.X.X        # Delete remote tag
+# Fix VERSION file if needed
+rake release                   # Try again
+```
+
+Manual publish (if rake release fails):
+```
+gem build usps_intelligent_barcode.gemspec
+gem push usps_intelligent_barcode-X.X.X.gem
+```

data/examples/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-
-require 'rubygems'
+lib_dir = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'usps_intelligent_barcode'
 
 barcode_id = '01'
@@ -13,5 +13,5 @@ barcode = Imb::Barcode.new(barcode_id,
                            mailer_id,
                            serial_number,
                            routing_code)
-p barcode.barcode_letters
-# => "AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA"
+puts barcode.barcode_letters
+# => AADTFFDFTDADTAADAATFDTDDAAADDTDTTDAFADADDDTFFFDDTTTADFAAADFTDAADA