usps-ruby-client 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905fbeac9ca32a16da34b2d05b5fff6f8da6a6be7c43a106e21ed211baba6009
-  data.tar.gz: 55d68eb569dc6fdf59936325ced2c66a7126f89387858155f6da8101fbfffa1c
+  metadata.gz: d043c38b987945e397288c72d37999ec2cd48feafcfa2ad36e5bf8384f4f3b3f
+  data.tar.gz: efdd9aadfd5e17502a72ceed2c5dee89d2c395cb0e784bb77ec6f230a6b5eb5c
 SHA512:
-  metadata.gz: 6635afa2a146f0aaf2fd4343894123ae4f0f726d61988127642c0c73d4c391ca16d93d30dc80281071050ddfafed997143e37138d842f6b4646a3c7d513a7839
-  data.tar.gz: 5252edd86fec07850f0f6f08a4c0b1105fe7155c34607a6824705587733e5bfc4043fc0adc62c62ba2714838d6db053d0785c3f39e60c0079fef1d53390b8dc0
+  metadata.gz: 28240a6e23dc9d489e8d8dcf93925e1a71bba85b6e4e78eae4962705aca039abcdbaf3797bcc832c3618646ff47700dad9c71da97e90df54cf3812d08a714a14
+  data.tar.gz: bf52634627bd132fffae3c5c493f9c1e29366ebe9e576905ac4c69710cb005f0021ea33ed85113e22e0ce6e23877166efe1abc6e15d85bfcc79c58d7dae7112c

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    usps-ruby-client (0.1.3)
+      activesupport (~> 7.0)
+      builder (~> 3.2)
+      faraday (~> 0.17)
+      faraday_middleware (~> 0.14)
+      multi_xml (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    amazing_print (1.4.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubis (2.7.0)
+    faraday (0.17.5)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 1.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazing_print (~> 1.2)
+  erubis (~> 2.7)
+  nokogiri (~> 1.10)
+  pry (~> 0.13)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-performance (~> 1.9)
+  rubocop-rspec (~> 2.1)
+  simplecov (~> 0.21)
+  usps-ruby-client!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.3.5

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** 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/tasks/api.rake

@@ -25,7 +25,7 @@ namespace :usps do
           row_data = {}
           columns.each_with_index do |k, i|
             row_data[k.to_s.gsub(/[[:space:]]+/, ' ').strip] =
-              row[i].is_a? String ? row[i].to_s.gsub(/[[:space:]]+/, ' ').strip : row[i]
+              row[i].is_a?(String) ? row[i].to_s.gsub(/[[:space:]]+/, ' ').strip : row[i]
           end
           row_data
         end

data/lib/usps/api/endpoints/carrier_pickup_schedule.rb

@@ -6,57 +6,32 @@ module Usps
 	module Api
 		module Endpoints
 			module CarrierPickupSchedule
-				#
-				# Package Pickup Schedule API
-				#
 				# The Package Pickup Schedule API schedules a
 				# Package Pickup and provides the user a confirmation number for the scheduled
 				# pickup. Prior to making a Pickup Schedule call, it is recommended to use
 				# the Pickup Availability API to confirm that service is available.
-				#
-				# @option option [(Alias)] :CarrierPickupScheduleRequest (Required)
-				#   @option option [String] :FirstName (Required)
-				#   - Only alpha characters, apostrophes, spaces, periods, and hyphens "-" may be used. For example: <FirstName>John</FirstName>
-				#   @option option [String] :LastName (Required)
-				#   - Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used. For example: <LastName>Doe</LastName>
-				#   @option option [String] :FirmName (Optional)
-				#   - Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used. Use this tag for a firm or company name. Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address. Note: FirmName is Optional except if the First Name and Last Name tags are null. For example: <FirmName>ABC Company</FirmName>
-				#   @option option [String] :SuiteOrApt (Required)
-				#   - Apartment or suite number. Optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building. For example: <SuiteOrApt>Suite 777</SuiteOrApt>
-				#   @option option [String] :Address2 (Required)
-				#   - Street address. For example: <Address2>1390 Market Street</Address2>
-				#   @option option [String] :Urbanization (Required)
-				#   - Use this tag for Urbanization (for Puerto Rico only). ZIP Code prefixes 006 to 009, if area is so designated.
-				#   @option option [String] :City (Required)
-				#   - City name. Either ZIP5 or City and State are required. For example: <City>Houston</City>
-				#   @option option [String] :State (Required)
-				#   - State abbreviation. Either ZIP5 or City and State are required. For example: <State>TX</State>
-				#   @option option [String] :ZIP5 (Required)
-				#   - 5-digit ZIP Code. Either ZIP5 or City and State are required. For example: <ZIP5>77058</ZIP5>
-				#   @option option [String] :ZIP4 (Required)
-				#   - Use this tag for a 4 digit ZIP Code. For example: <ZIP4>1234</ZIP4>
-				#   @option option [String] :Phone (Required)
-				#   - Two formats are allowed: (###) 123-4567 or ###-123-4567. For example: <Phone>5555551234</Phone> or <Phone>555-555-1234</Phone>
-				#   @option option [String] :Extension (Optional)
-				#   - Optional value for Phone Extension. For example: <Extension>201</Extension>
-				#   @option option [(Group)] :Package (Required)
-				#   - No values entered with this tag. <ServiceType> and <Count> tags are embedded under this. Refer to the XML request example section, below, to see how these embedded tags are formatted. If the <Count> for a service type is zero, you do not need to encode a <Package> but you must have at least one <Package> with embedded <ServiceType> and <Count> tags.
-				#     @option option [String] :ServiceType (Required)
-				#     - This tag is embedded under the <Package> tag. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML Request Example below to see how these embedded tags are formatted. For example: <ServiceType>PriorityMailExpress</ServiceType>
-				#     @option option [String] :Count (Required)
-				#     - This tag is embedded under the <Package> tag. Enter the number of packages for the accompanying <ServiceType> tag. Maximum characters allowed: 3 or 999 packages. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML request example section, below, to see how these embedded tags are formatted. For example: <Count>2</Count>
-				#     @option option [String] :EstimatedWeight (Required)
-				#     - Enter the estimated aggregate weight (in pounds) of all packages being picked up. For example: <EstimatedWeight>14</EstimatedWeight>
-				#     @option option [String] :PackageLocation (Required)
-				#     - Enter one of the following values: Note: "Other" requires information in the value for the <SpecialInstructions> tag. For example: <PackageLocation>Front Door</PackageLocation>
-				#     @option option [String] :SpecialInstructions (Optional)
-				#     - Value Required when PackageLocation is “Other”. Only alpha, numeric, commas, periods, apostrophes, _, &, -, ( ), ?, #, / +, @ and space characters may be used. For example: <SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>
-				#     @option option [String] :EmailAddress (Optional)
-				#     - If provided, email notifications will be sent confirming package pickup, or request changes and cancellations. Maximum characters allowed: 50. For example: <EmailAddress>cpapple@email.com</EmailAddress>
-
-				#
-				# @see 
-				def carrier_pickup_schedule(options = {})
+				# @param [Hash] options
+				# @option options [required, Hash] carrier_pickup_schedule_request 
+				#  * *:first_name* (required, String) — Only alpha characters, apostrophes, spaces, periods, and hyphens "-" may be used. For example: <FirstName>John</FirstName>
+				#  * *:last_name* (required, String) — Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used. For example: <LastName>Doe</LastName>
+				#  * *:firm_name* (String) — Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used. Use this tag for a firm or company name. Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address. Note: FirmName is Optional except if the First Name and Last Name tags are null. For example: <FirmName>ABC Company</FirmName>
+				#  * *:suite_or_apt* (required, String) — Apartment or suite number. Optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building. For example: <SuiteOrApt>Suite 777</SuiteOrApt>
+				#  * *:address2* (required, String) — Street address. For example: <Address2>1390 Market Street</Address2>
+				#  * *:urbanization* (required, String) — Use this tag for Urbanization (for Puerto Rico only). ZIP Code prefixes 006 to 009, if area is so designated.
+				#  * *:city* (required, String) — City name. Either ZIP5 or City and State are required. For example: <City>Houston</City>
+				#  * *:state* (required, String) — State abbreviation. Either ZIP5 or City and State are required. For example: <State>TX</State>
+				#  * *:zip5* (required, String) — 5-digit ZIP Code. Either ZIP5 or City and State are required. For example: <ZIP5>77058</ZIP5>
+				#  * *:zip4* (required, String) — Use this tag for a 4 digit ZIP Code. For example: <ZIP4>1234</ZIP4>
+				#  * *:phone* (required, String) — Two formats are allowed: (###) 123-4567 or ###-123-4567. For example: <Phone>5555551234</Phone> or <Phone>555-555-1234</Phone>
+				#  * *:extension* (String) — Optional value for Phone Extension. For example: <Extension>201</Extension>
+				#  * *:package* (required, Hash) — No values entered with this tag. <ServiceType> and <Count> tags are embedded under this. Refer to the XML request example section, below, to see how these embedded tags are formatted. If the <Count> for a service type is zero, you do not need to encode a <Package> but you must have at least one <Package> with embedded <ServiceType> and <Count> tags.
+				#    * *:service_type* (required, String) — This tag is embedded under the <Package> tag. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML Request Example below to see how these embedded tags are formatted. For example: <ServiceType>PriorityMailExpress</ServiceType>
+				#    * *:count* (required, String) — This tag is embedded under the <Package> tag. Enter the number of packages for the accompanying <ServiceType> tag. Maximum characters allowed: 3 or 999 packages. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML request example section, below, to see how these embedded tags are formatted. For example: <Count>2</Count>
+				#    * *:estimated_weight* (required, String) — Enter the estimated aggregate weight (in pounds) of all packages being picked up. For example: <EstimatedWeight>14</EstimatedWeight>
+				#    * *:package_location* (required, String) — Enter one of the following values: Note: "Other" requires information in the value for the <SpecialInstructions> tag. For example: <PackageLocation>Front Door</PackageLocation>
+				#    * *:special_instructions* (String) — Value Required when PackageLocation is “Other”. Only alpha, numeric, commas, periods, apostrophes, _, &, -, ( ), ?, #, / +, @ and space characters may be used. For example: <SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>
+				#    * *:email_address* (String) — If provided, email notifications will be sent confirming package pickup, or request changes and cancellations. Maximum characters allowed: 50. For example: <EmailAddress>cpapple@email.com</EmailAddress>
+def carrier_pickup_schedule(options = {})
 					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request missing') if options[:carrier_pickup_schedule_request].nil?
 					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :first_name missing') if options[:carrier_pickup_schedule_request][:first_name].nil?
 					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :last_name missing') if options[:carrier_pickup_schedule_request][:last_name].nil?

data/lib/usps/api/endpoints/city_state_lookup.rb

@@ -6,20 +6,13 @@ module Usps
 	module Api
 		module Endpoints
 			module CityStateLookup
-				#
-				# CityStateLookup API
-				#
 				# City/State Lookup API
 				# returns the city and state corresponding to the given ZIP Code. The CityStateLookup API processes up to five lookups per request.
-				#
-				# @option option [(Alias)] :CityStateLookupRequest (Required)
-				# - API= CityStateLookupRequest
-				#   @option option [(Group)] :ZipCode (Required)
-				#     @option option [Integer] :Zip5 (Required)
-
-				#
-				# @see 
-				def city_state_lookup(options = {})
+				# @param [Hash] options
+				# @option options [required, Hash] city_state_lookup_request API= CityStateLookupRequest
+				#  * *:zip_code* (required, Hash) — 
+				#    * *:zip5* (required, Integer) — 
+def city_state_lookup(options = {})
 					throw ArgumentError.new('Required arguments :city_state_lookup_request missing') if options[:city_state_lookup_request].nil?
 					throw ArgumentError.new('Required arguments :city_state_lookup_request, :zip_code missing') if options[:city_state_lookup_request][:zip_code].nil?
 					throw ArgumentError.new('Required arguments :city_state_lookup_request, :zip_code, :zip5 missing') if options[:city_state_lookup_request][:zip_code][:zip5].nil?