feat: generate real USA state or territory zip code

[garrettgregor]

Motivation / Background

This Pull Request has been created because in a prior application I had been using Faker to generate zip codes for US states and was running into issues where the zip codes provided by Faker were causing my application to crash. At that point, I determined that the reason for this was that the zip codes being generated were random, and I needed real data for the call to a weather API to work correctly. I thought that for future users of Faker, it would be useful to have the ability to generate either fake or real US zip codes, so I brought in real US states and territories zips to allow for that possibility.

Additional information

• There are also more real zips for states and territories that haven't yet been included in Faker, but have been included here in the case that they are added in the future.
• Ran into flakey test for omniauth that may need to be looked at in the future, but currently everytjhing is passing

Checklist

Before submitting the PR make sure the following are checked:

• [x] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
• [x] Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
• [x] Tests are added or updated if you fix a bug, refactor something, or add a feature.
• [x] Tests and Rubocop are passing before submitting your proposed changes.

If you're proposing a new generator or locale:

• [x] Double-check the existing generators documentation to make sure the new generator you want to add doesn't already exist.
• [x] You've reviewed and followed the Contributing guidelines.

[stefannibrasil]

hi @garrettgregor thanks for contributing to faker but we're not a library that generates any real data. We can't maintain valid data for any generators as we are used for generating random data. If your app relies on valid zip codes, I would recommend not using any sort of random generated values at all and using another library that validates ZIP codes. Thanks.

[garrettgregor]

Hi Stefanni!

Thanks for getting back to me so quickly - sounds like we might have just missed each other at RailsConf! While I understand your perspective, I would kindly ask for reconsideration as not all of the data within Faker is "fake". For instance, the states and state abbreviations are not "fake" and this lack of clarity within what is being produced can often lead to confusion when using faker generating what one thought was simply a random zip code from a specified state.

All the best,

[stefannibrasil]

Hi @garrettgregor please say hi next time :)

Yeah, I understand there is some confusion right now with how the generators work and what is fake and whatnot. Now that RailsConf is over, we'll work on restructuring the library to make it more maintainable and easier to use. Right now, we'll have to deal with the inconsistencies, unfortunately.

One thing we can think from this for now is to update the docs to mention the ZIP codes are not real to keep that clear for others, if you're up for it.

[garrettgregor]

If you're suggesting submitting a pull request to add to the documentation I would absolutely be willing to help with that!

[stefannibrasil]

yes, you're correct. that'd be great, thank you!

[garrettgregor]

Submitted! Thanks for the suggestion Stefanni!