usps-ruby-client 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -6
- data/lib/usps/version.rb +1 -1
- data/usps-ruby-client.gemspec +2 -2
- metadata +9 -9
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bda222f685fe930e4ce9b2757ae71d1192c6c701c4893392ef0e7f1e203b0d35
|
|
4
|
+
data.tar.gz: d939bd4bb4f5251aadceddff614c75841f5aacb9ccbc7141b1351a4f08bdefa2
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3b3420a098dd281bb1c301b263439f345685b4ac5bc1c06af151e683ab84f13157e858058b98590d0b50f262711127a4a56472fd41320fbe1b3cbe3b62f8377a
|
|
7
|
+
data.tar.gz: f094de62fabf1bd7dcc8ee56ff2501b1ef5bb28b642b363a7f5051a54edfae6ddda65c57e5c5aab9a6e8ec08834bcc70cc319851475cdde2afc5946649ebed04
|
data/README.md
CHANGED
|
@@ -6,7 +6,7 @@ USPS Ruby Client
|
|
|
6
6
|
|
|
7
7
|
An unofficial Ruby client for The United Sates Postal Service Web Tools API.
|
|
8
8
|
|
|
9
|
-
**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
|
|
9
|
+
**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.
|
|
10
10
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
@@ -52,26 +52,31 @@ client.city_state_lookup({
|
|
|
52
52
|
}
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
+
## RubyDoc Automatic Documentation
|
|
56
|
+
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.
|
|
57
|
+
|
|
55
58
|
## Development
|
|
56
59
|
|
|
57
60
|
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.
|
|
58
61
|
|
|
59
62
|
### Updating the auto-generated methods
|
|
60
63
|
|
|
61
|
-
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.
|
|
64
|
+
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.
|
|
65
|
+
|
|
66
|
+
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.
|
|
62
67
|
|
|
63
|
-
|
|
68
|
+
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.
|
|
64
69
|
|
|
65
70
|
## Contributing
|
|
66
71
|
|
|
67
72
|
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).
|
|
68
73
|
|
|
69
|
-
This is still an early work-in-progress so any additional help is
|
|
74
|
+
This project is still an early work-in-progress, so any additional help is greatly appreciated!
|
|
70
75
|
|
|
71
76
|
## License
|
|
72
77
|
|
|
73
|
-
The gem is available as open
|
|
78
|
+
The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
74
79
|
|
|
75
80
|
## Code of Conduct
|
|
76
81
|
|
|
77
|
-
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).
|
|
82
|
+
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
CHANGED
data/usps-ruby-client.gemspec
CHANGED
|
@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
|
|
|
31
31
|
|
|
32
32
|
spec.add_dependency 'activesupport', '~> 6.1'
|
|
33
33
|
spec.add_dependency 'builder', '~> 3.2'
|
|
34
|
-
spec.add_dependency 'faraday', '~>
|
|
35
|
-
spec.add_dependency 'faraday_middleware', '~>
|
|
34
|
+
spec.add_dependency 'faraday', '~> 1'
|
|
35
|
+
spec.add_dependency 'faraday_middleware', '~> 1'
|
|
36
36
|
spec.add_dependency 'multi_xml', '~> 0.6'
|
|
37
37
|
spec.add_development_dependency 'amazing_print', '~> 1.2'
|
|
38
38
|
spec.add_development_dependency 'erubis', '~> 2.7'
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: usps-ruby-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Joey Paris
|
|
8
|
-
autorequire:
|
|
8
|
+
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activesupport
|
|
@@ -44,28 +44,28 @@ dependencies:
|
|
|
44
44
|
requirements:
|
|
45
45
|
- - "~>"
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: '
|
|
47
|
+
version: '1'
|
|
48
48
|
type: :runtime
|
|
49
49
|
prerelease: false
|
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
51
|
requirements:
|
|
52
52
|
- - "~>"
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: '
|
|
54
|
+
version: '1'
|
|
55
55
|
- !ruby/object:Gem::Dependency
|
|
56
56
|
name: faraday_middleware
|
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
|
58
58
|
requirements:
|
|
59
59
|
- - "~>"
|
|
60
60
|
- !ruby/object:Gem::Version
|
|
61
|
-
version: '
|
|
61
|
+
version: '1'
|
|
62
62
|
type: :runtime
|
|
63
63
|
prerelease: false
|
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
65
|
requirements:
|
|
66
66
|
- - "~>"
|
|
67
67
|
- !ruby/object:Gem::Version
|
|
68
|
-
version: '
|
|
68
|
+
version: '1'
|
|
69
69
|
- !ruby/object:Gem::Dependency
|
|
70
70
|
name: multi_xml
|
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -300,7 +300,7 @@ licenses:
|
|
|
300
300
|
metadata:
|
|
301
301
|
homepage_uri: https://www.usps.com/business/web-tools-apis/documentation-updates.htm
|
|
302
302
|
source_code_uri: https://github.com/joeyparis/usps-ruby-client
|
|
303
|
-
post_install_message:
|
|
303
|
+
post_install_message:
|
|
304
304
|
rdoc_options: []
|
|
305
305
|
require_paths:
|
|
306
306
|
- lib
|
|
@@ -316,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
316
316
|
version: '0'
|
|
317
317
|
requirements: []
|
|
318
318
|
rubygems_version: 3.1.2
|
|
319
|
-
signing_key:
|
|
319
|
+
signing_key:
|
|
320
320
|
specification_version: 4
|
|
321
321
|
summary: An automatically generated USPS API Client
|
|
322
322
|
test_files: []
|