usps-ruby-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93b3177558290889727e879ad55a26317fee396d90d85708a080f98c574cc89c
-  data.tar.gz: 646fff5b3dfac909b958bc73bc947b65009f4722e7d768c0dd7a5f4098ad7cc3
+  metadata.gz: bda222f685fe930e4ce9b2757ae71d1192c6c701c4893392ef0e7f1e203b0d35
+  data.tar.gz: d939bd4bb4f5251aadceddff614c75841f5aacb9ccbc7141b1351a4f08bdefa2
 SHA512:
-  metadata.gz: 664deaf1f138db490a4e2b3e031affdba7278f52bf9ddd43c690e858467d402411d06e02c9701c156433ba382af78c8e64a2648974d0519705ef6ab00e5d514c
-  data.tar.gz: acbb29769273646f8e4e4d973e0ded3884024c3fea04fa5acc7f3159b04e37f9b30cc5366a525b97f1ab068d34ed0961c7fc25d828ff2771f464c690038ca89d
+  metadata.gz: 3b3420a098dd281bb1c301b263439f345685b4ac5bc1c06af151e683ab84f13157e858058b98590d0b50f262711127a4a56472fd41320fbe1b3cbe3b62f8377a
+  data.tar.gz: f094de62fabf1bd7dcc8ee56ff2501b1ef5bb28b642b363a7f5051a54edfae6ddda65c57e5c5aab9a6e8ec08834bcc70cc319851475cdde2afc5946649ebed04

data/README.md

@@ -6,7 +6,7 @@ USPS Ruby Client
 
 An unofficial Ruby client for The United Sates Postal Service Web Tools API.
 
-**Disclaimer** This gem is mostly auto-generated from the [USPS API User Guides](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). Because of inconsistencies and innacurracies in the user guides some end points may not work as expected, or may not be consistent with other methods in this gem.
+**Disclaimer** This gem is mostly auto-generated from the [USPS API User Guides](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). Because of inconsistencies and inaccuracies in the user guides, some endpoints may not work as expected or may not be consistent with other methods in this gem.
 
 ## Installation
 
@@ -52,26 +52,31 @@ client.city_state_lookup({
 }
 ```
 
+## RubyDoc Automatic Documentation
+The generator also creates [documentation](https://rubydoc.info/gems/usps-ruby-client) to help you navigate the available methods. It has the same issues presented in the disclaimer above.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ### Updating the auto-generated methods
 
-Because the USPS website does not allow scripts to make requests against their website you must [download the API User Guide HTML files manually](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). I recommend right-clicking the **HTM** and selecting *Save Link As...* to prevent any browser extensions from injecting their code and breaking the parsing.
+Because the USPS website does not allow scripts to make requests against their website, you must [download the API User Guide HTML files manually](https://www.usps.com/business/web-tools-apis/documentation-updates.htm). I recommend right-clicking the **HTM** link and selecting *Save Link As...* to prevent any browser extensions from injecting their code and breaking the parsing.
+
+Place just the `.htm` files in `lib/data/api` (and remove any that may no longer be active) and run `rake usps:api:update`. This task will recreate all the appropriate methods and some basic spec tests.
 
-Place just the `.htm` files in `lib/data/api` (and remove any they may no longer be active) and run `rake usps:api:update`. This task will recreate all the relevant methods and some basic spec tests.
+We might be able to automate this with a headless browser tool like Watir, but only if we can do that in a way that doesn't bloat the gem as a whole.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joeyparis/usps-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).
 
-This is still an early work-in-progress so any additional help is definitely appreciated!
+This project is still an early work-in-progress, so any additional help is greatly appreciated!
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Usps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Usps project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/joeyparis/usps-ruby-client/blob/master/CODE_OF_CONDUCT.md).

data/lib/usps/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Usps
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/usps-ruby-client.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '~> 6.1'
   spec.add_dependency 'builder', '~> 3.2'
-  spec.add_dependency 'faraday', '~> 0.17'
-  spec.add_dependency 'faraday_middleware', '~> 0.14'
+  spec.add_dependency 'faraday', '~> 1'
+  spec.add_dependency 'faraday_middleware', '~> 1'
   spec.add_dependency 'multi_xml', '~> 0.6'
   spec.add_development_dependency 'amazing_print', '~> 1.2'
   spec.add_development_dependency 'erubis', '~> 2.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usps-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Joey Paris
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -300,7 +300,7 @@ licenses:
 metadata:
   homepage_uri: https://www.usps.com/business/web-tools-apis/documentation-updates.htm
   source_code_uri: https://github.com/joeyparis/usps-ruby-client
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -316,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: An automatically generated USPS API Client
 test_files: []