feature Us Census Bureau#118
Conversation
chadly
left a comment
chadly
left a comment
There was a problem hiding this comment.
I haven't had a chance to dig deep into this yet. But could you also update the README documentation to include this new geocoder, how it works, how to set it up. and any caveats?
sure i'll get back to you when I do. |
|
@chadly done, added to readme |
|
Also note, it doesnt support reverse geocoding & is US only... I added that to readme |
seanat280
left a comment
seanat280
left a comment
There was a problem hiding this comment.
My team has been using this for a substantial period of time at this point with no issues. Can this get merged?
|
@RodneyRichardson can you take a look? |
RodneyRichardson
left a comment
RodneyRichardson
left a comment
There was a problem hiding this comment.
I've not be able to test, but generally it looks like it might work, but there are a few improvements that could be made (such as not swallowing errors).
I don't have authority to approve merge requests.
| private readonly string _format; | ||
| private readonly HttpClient _client; | ||
|
|
||
| public UsCensusBureauGeocoder(int benchmark = 4, string format = "json") |
There was a problem hiding this comment.
What is the magic number "4" (benchmark)? Can this be made into a (string) constant?
| private readonly string _format; | ||
| private readonly HttpClient _client; | ||
|
|
||
| public UsCensusBureauGeocoder(int benchmark = 4, string format = "json") |
There was a problem hiding this comment.
Remove the format parameter - the code only supports JSON, so hardcode it.
| @@ -0,0 +1,98 @@ | |||
| using System; | |||
There was a problem hiding this comment.
Formatting in this file could be improved - Visual Studio autoformat should be sufficient.
| /// </summary> | ||
| public class UsCensusBureauGeocoder : IGeocoder | ||
| { | ||
| private readonly int _benchmark; |
There was a problem hiding this comment.
API defines benchmark as a string, and the example use, for example, "Public_AR_Census2020". Should this be a string? It might be worth referencing https://geocoding.geo.census.gov/geocoder/benchmarks for the list of available benchmarks.
|
|
||
| var errors = json[UsCensusBureauConstants.ErrorsKey]; | ||
| if (errors != null) | ||
| return new UsCensusBureauAddress[] {}; |
There was a problem hiding this comment.
Don't swallow errors. Create and throw a UsCensusBureauGeocodingException (wow, that's a long name - how about Ucb?) to wrap and expose the error.
| /// - https://geocoding.geo.census.gov/ | ||
| /// - https://geocoding.geo.census.gov/geocoder/Geocoding_Services_API.pdf | ||
| /// </summary> | ||
| public class UsCensusBureauGeocoder : IGeocoder |
There was a problem hiding this comment.
Consider adding an IBatchGeocoder, as this looks to be supported by the API.
| namespace Geocoding.Tests | ||
| { | ||
| [Collection("Settings")] | ||
| public class UsCensusBureauTest : GeocoderTest |
There was a problem hiding this comment.
Add tests for other "benchmark" values.
| using Geocoding.UsCensusBureau; | ||
| using Xunit; | ||
|
|
||
| namespace Geocoding.Tests |
There was a problem hiding this comment.
Don't skip tests. Assert that they behave as expected (such as throwing NotSupportedException, or returning/throwing an appropriate error).
| sb.Append("street=").Append(WebUtility.UrlEncode(street)) | ||
| .Append("&city=").Append(WebUtility.UrlEncode(city)) | ||
| .Append("&state=").Append(WebUtility.UrlEncode(state)) | ||
| .Append("&zip=").Append(WebUtility.UrlEncode(postalCode)) |
There was a problem hiding this comment.
Does this work if any parameters are omitted? Perhaps add a test for partial address.
I'm obviously busy and neglecting things here. Do you want write access to the repo @RodneyRichardson. I would appreciate the help for this project. |
5 participants
No description provided.