smartystreets_ruby_sdk 0.0.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +5 -5
  2. data/.gitignore +0 -1
  3. data/{LICENSE.md → LICENSE.txt} +1 -1
  4. data/Makefile +17 -31
  5. data/README.md +6 -9
  6. data/Rakefile +2 -5
  7. data/examples/us_street_multiple_address_example.rb +15 -40
  8. data/examples/us_street_single_address_example.rb +8 -32
  9. data/examples/us_zipcode_multiple_lookup_example.rb +9 -21
  10. data/examples/us_zipcode_single_lookup_example.rb +6 -18
  11. data/lib/smartystreets_ruby_sdk/batch.rb +38 -45
  12. data/lib/smartystreets_ruby_sdk/core_client_builder.rb +56 -0
  13. data/lib/smartystreets_ruby_sdk/custom_header_sender.rb +8 -10
  14. data/lib/smartystreets_ruby_sdk/errors.rb +11 -21
  15. data/lib/smartystreets_ruby_sdk/exceptions.rb +16 -27
  16. data/lib/smartystreets_ruby_sdk/json_able.rb +11 -13
  17. data/lib/smartystreets_ruby_sdk/match_type.rb +5 -0
  18. data/lib/smartystreets_ruby_sdk/native_sender.rb +43 -65
  19. data/lib/smartystreets_ruby_sdk/native_serializer.rb +7 -9
  20. data/lib/smartystreets_ruby_sdk/request.rb +8 -11
  21. data/lib/smartystreets_ruby_sdk/response.rb +7 -9
  22. data/lib/smartystreets_ruby_sdk/retry_sender.rb +26 -32
  23. data/lib/smartystreets_ruby_sdk/shared_credentials.rb +9 -11
  24. data/lib/smartystreets_ruby_sdk/signing_sender.rb +9 -11
  25. data/lib/smartystreets_ruby_sdk/sleeper.rb +3 -5
  26. data/lib/smartystreets_ruby_sdk/static_credentials.rb +9 -11
  27. data/lib/smartystreets_ruby_sdk/status_code_sender.rb +29 -33
  28. data/lib/smartystreets_ruby_sdk/url_prefix_sender.rb +9 -11
  29. data/lib/smartystreets_ruby_sdk/us_street/analysis.rb +16 -21
  30. data/lib/smartystreets_ruby_sdk/us_street/candidate.rb +19 -23
  31. data/lib/smartystreets_ruby_sdk/us_street/client.rb +47 -60
  32. data/lib/smartystreets_ruby_sdk/us_street/client_builder.rb +15 -0
  33. data/lib/smartystreets_ruby_sdk/us_street/components.rb +27 -32
  34. data/lib/smartystreets_ruby_sdk/us_street/lookup.rb +20 -27
  35. data/lib/smartystreets_ruby_sdk/us_street/metadata.rb +23 -27
  36. data/lib/smartystreets_ruby_sdk/us_street.rb +3 -5
  37. data/lib/smartystreets_ruby_sdk/us_zipcode/city.rb +8 -14
  38. data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb +36 -51
  39. data/lib/smartystreets_ruby_sdk/us_zipcode/client_builder.rb +15 -0
  40. data/lib/smartystreets_ruby_sdk/us_zipcode/lookup.rb +9 -16
  41. data/lib/smartystreets_ruby_sdk/us_zipcode/result.rb +30 -34
  42. data/lib/smartystreets_ruby_sdk/us_zipcode/zip_code.rb +14 -32
  43. data/lib/smartystreets_ruby_sdk/us_zipcode.rb +3 -5
  44. data/lib/smartystreets_ruby_sdk/version.rb +2 -2
  45. data/lib/smartystreets_ruby_sdk.rb +1 -30
  46. data/smartystreets_ruby_sdk.gemspec +12 -3
  47. metadata +15 -61
  48. data/.github/workflows/gem-publish.yml +0 -58
  49. data/CHANGELOG.md +0 -5
  50. data/Dockerfile +0 -10
  51. data/docker-compose.yml +0 -12
  52. data/examples/international_autocomplete_example.rb +0 -47
  53. data/examples/international_example.rb +0 -53
  54. data/examples/us_autocomplete_pro_example.rb +0 -56
  55. data/examples/us_extract_example.rb +0 -63
  56. data/examples/us_reverse_geo_example.rb +0 -47
  57. data/lib/smartystreets_ruby_sdk/client_builder.rb +0 -188
  58. data/lib/smartystreets_ruby_sdk/international_autocomplete/client.rb +0 -61
  59. data/lib/smartystreets_ruby_sdk/international_autocomplete/lookup.rb +0 -21
  60. data/lib/smartystreets_ruby_sdk/international_autocomplete/suggestion.rb +0 -16
  61. data/lib/smartystreets_ruby_sdk/international_street/analysis.rb +0 -17
  62. data/lib/smartystreets_ruby_sdk/international_street/candidate.rb +0 -23
  63. data/lib/smartystreets_ruby_sdk/international_street/changes.rb +0 -15
  64. data/lib/smartystreets_ruby_sdk/international_street/client.rb +0 -63
  65. data/lib/smartystreets_ruby_sdk/international_street/components.rb +0 -58
  66. data/lib/smartystreets_ruby_sdk/international_street/language_mode.rb +0 -9
  67. data/lib/smartystreets_ruby_sdk/international_street/lookup.rb +0 -82
  68. data/lib/smartystreets_ruby_sdk/international_street/metadata.rb +0 -17
  69. data/lib/smartystreets_ruby_sdk/international_street/rootlevel.rb +0 -25
  70. data/lib/smartystreets_ruby_sdk/international_street.rb +0 -12
  71. data/lib/smartystreets_ruby_sdk/license_sender.rb +0 -15
  72. data/lib/smartystreets_ruby_sdk/logger.rb +0 -7
  73. data/lib/smartystreets_ruby_sdk/proxy.rb +0 -16
  74. data/lib/smartystreets_ruby_sdk/us_autocomplete/client.rb +0 -72
  75. data/lib/smartystreets_ruby_sdk/us_autocomplete/geolocation_type.rb +0 -9
  76. data/lib/smartystreets_ruby_sdk/us_autocomplete/lookup.rb +0 -38
  77. data/lib/smartystreets_ruby_sdk/us_autocomplete/suggestion.rb +0 -16
  78. data/lib/smartystreets_ruby_sdk/us_autocomplete.rb +0 -9
  79. data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb +0 -78
  80. data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/geolocation_type.rb +0 -8
  81. data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb +0 -63
  82. data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb +0 -18
  83. data/lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb +0 -10
  84. data/lib/smartystreets_ruby_sdk/us_extract/address.rb +0 -24
  85. data/lib/smartystreets_ruby_sdk/us_extract/client.rb +0 -49
  86. data/lib/smartystreets_ruby_sdk/us_extract/lookup.rb +0 -22
  87. data/lib/smartystreets_ruby_sdk/us_extract/metadata.rb +0 -17
  88. data/lib/smartystreets_ruby_sdk/us_extract/result.rb +0 -21
  89. data/lib/smartystreets_ruby_sdk/us_extract.rb +0 -10
  90. data/lib/smartystreets_ruby_sdk/us_reverse_geo/address.rb +0 -16
  91. data/lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb +0 -38
  92. data/lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb +0 -25
  93. data/lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb +0 -21
  94. data/lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb +0 -20
  95. data/lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb +0 -17
  96. data/lib/smartystreets_ruby_sdk/us_reverse_geo.rb +0 -12
  97. data/lib/smartystreets_ruby_sdk/us_street/match_type.rb +0 -10
  98. data/lib/smartystreets_ruby_sdk/us_zipcode/alternate_county.rb +0 -15
  99. data/ruby-sdk-demo.json +0 -354
data/ruby-sdk-demo.json DELETED
@@ -1,354 +0,0 @@
1
- {
2
- "version": 1,
3
- "width": 100,
4
- "height": 45,
5
- "duration": 21.834346,
6
- "command": null,
7
- "title": null,
8
- "env": {
9
- "TERM": "xterm-256color",
10
- "SHELL": "/bin/bash"
11
- },
12
- "stdout": [
13
- [
14
- 0.00095,
15
- "\u001b[?1034hbash-3.2$ "
16
- ],
17
- [
18
- 1.0,
19
- "g"
20
- ],
21
- [
22
- 0.14488,
23
- "e"
24
- ],
25
- [
26
- 0.175927,
27
- "m"
28
- ],
29
- [
30
- 0.128232,
31
- " "
32
- ],
33
- [
34
- 0.135528,
35
- "i"
36
- ],
37
- [
38
- 0.11217,
39
- "n"
40
- ],
41
- [
42
- 0.375507,
43
- "s"
44
- ],
45
- [
46
- 0.135337,
47
- "t"
48
- ],
49
- [
50
- 0.121159,
51
- "a"
52
- ],
53
- [
54
- 0.183897,
55
- "l"
56
- ],
57
- [
58
- 0.14409,
59
- "l"
60
- ],
61
- [
62
- 0.393336,
63
- " "
64
- ],
65
- [
66
- 0.50259,
67
- "s"
68
- ],
69
- [
70
- 0.128145,
71
- "m"
72
- ],
73
- [
74
- 0.135902,
75
- "a"
76
- ],
77
- [
78
- 0.159904,
79
- "r"
80
- ],
81
- [
82
- 0.207946,
83
- "t"
84
- ],
85
- [
86
- 0.199214,
87
- "y"
88
- ],
89
- [
90
- 0.160182,
91
- "s"
92
- ],
93
- [
94
- 0.184664,
95
- "t"
96
- ],
97
- [
98
- 0.071914,
99
- "r"
100
- ],
101
- [
102
- 0.24962,
103
- "e"
104
- ],
105
- [
106
- 0.150388,
107
- "e"
108
- ],
109
- [
110
- 0.103991,
111
- "t"
112
- ],
113
- [
114
- 0.367511,
115
- "s"
116
- ],
117
- [
118
- 0.608296,
119
- "_"
120
- ],
121
- [
122
- 0.31945,
123
- "r"
124
- ],
125
- [
126
- 0.2168,
127
- "u"
128
- ],
129
- [
130
- 0.367931,
131
- "b"
132
- ],
133
- [
134
- 0.303857,
135
- "y"
136
- ],
137
- [
138
- 0.720391,
139
- "_"
140
- ],
141
- [
142
- 0.575703,
143
- "s"
144
- ],
145
- [
146
- 0.111963,
147
- "d"
148
- ],
149
- [
150
- 0.799985,
151
- "k"
152
- ],
153
- [
154
- 0.935086,
155
- "\r\n"
156
- ],
157
- [
158
- 0.497465,
159
- "Fetching: smartystreets_ruby_sdk-4.0.0.gem"
160
- ],
161
- [
162
- 4.7e-05,
163
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 8%)"
164
- ],
165
- [
166
- 0.000132,
167
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 19%)"
168
- ],
169
- [
170
- 0.000123,
171
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 29%)"
172
- ],
173
- [
174
- 0.000941,
175
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 40%)"
176
- ],
177
- [
178
- 0.002169,
179
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 51%)"
180
- ],
181
- [
182
- 0.014076,
183
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 61%)"
184
- ],
185
- [
186
- 0.000382,
187
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 72%)"
188
- ],
189
- [
190
- 0.001468,
191
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 83%)"
192
- ],
193
- [
194
- 0.001077,
195
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem ( 93%)"
196
- ],
197
- [
198
- 0.000778,
199
- "\rFetching: smartystreets_ruby_sdk-4.0.0.gem (100%)\rFetching: smartystreets_ruby_sdk-4.0.0.gem (100%)\r\n"
200
- ],
201
- [
202
- 0.03245,
203
- "Successfully installed smartystreets_ruby_sdk-4.0.0\r\n"
204
- ],
205
- [
206
- 0.092602,
207
- "Parsing documentation for smartystreets_ruby_sdk-4.0.0\r\n"
208
- ],
209
- [
210
- 0.233087,
211
- "Installing ri documentation for smartystreets_ruby_sdk-4.0.0\r\n"
212
- ],
213
- [
214
- 0.091585,
215
- "Done installing documentation for smartystreets_ruby_sdk after 0 seconds\r\n1 gem installed\r\n"
216
- ],
217
- [
218
- 0.015211,
219
- "bash-3.2$ "
220
- ],
221
- [
222
- 1.0,
223
- "\r\n"
224
- ],
225
- [
226
- 7e-05,
227
- "bash-3.2$ "
228
- ],
229
- [
230
- 0.15999,
231
- "\r\n"
232
- ],
233
- [
234
- 0.000102,
235
- "bash-3.2$ "
236
- ],
237
- [
238
- 1.0,
239
- "c"
240
- ],
241
- [
242
- 0.08051,
243
- "a"
244
- ],
245
- [
246
- 0.191263,
247
- "t"
248
- ],
249
- [
250
- 0.200297,
251
- " "
252
- ],
253
- [
254
- 0.159047,
255
- "e"
256
- ],
257
- [
258
- 0.744749,
259
- "x"
260
- ],
261
- [
262
- 0.287948,
263
- "a"
264
- ],
265
- [
266
- 0.167355,
267
- "m"
268
- ],
269
- [
270
- 0.247893,
271
- "ple.rb "
272
- ],
273
- [
274
- 0.871485,
275
- "\r\n"
276
- ],
277
- [
278
- 0.002848,
279
- "require 'smartystreets_ruby_sdk/client_builder'\r\nrequire 'smartystreets_ruby_sdk/static_credentials'\r\nrequire 'smartystreets_ruby_sdk/us_street'\r\n\r\n\r\nclass Example\r\n def run\r\n # This keypair will have been deleted by the time you are watching this video... \r\n auth_id = 'f2ad739f-1f49-c201-b770-4625c7f84fe4'\r\n auth_token = '4RK9lhEJ66Xt6ucDzbrU'\r\n credentials = SmartyStreets::StaticCredentials.new(auth_id, auth_token)\r\n\r\n puts 'Step 0. Wire up the client with your keypair.'\r\n client = SmartyStreets::ClientBuilder.new(credentials).build_us_street_api_client\r\n\r\n puts 'Step 1. Make a lookup. (BTW, you can also send entire batches of lookups...)'\r\n lookup = SmartyStreets::USStreet::Lookup.new\r\n lookup.street = '1 Rosedale'\r\n lookup.lastline = 'Baltimore MD'\r\n lookup.candidates = 10\r\n\r\n puts 'Step 2. Send the lookup.'\r\n client.send_lookup(lookup)\r\n\r\n puts 'Step 3. Show the resulting candidate addresses:'\r\n lookup.result.each_with_index do |candidate, c|\r\n puts \"- #"
280
- ],
281
- [
282
- 3.1e-05,
283
- "{c}: #{candidate.delivery_line_1}, #{candidate.last_line}\\n\"\r\n end\r\n end\r\nend\r\n\r\nExample.new.run"
284
- ],
285
- [
286
- 0.000304,
287
- "bash-3.2$ "
288
- ],
289
- [
290
- 1.0,
291
- "\r\n"
292
- ],
293
- [
294
- 0.000115,
295
- "bash-3.2$ "
296
- ],
297
- [
298
- 0.167817,
299
- "\r\n"
300
- ],
301
- [
302
- 0.000102,
303
- "bash-3.2$ "
304
- ],
305
- [
306
- 1.0,
307
- "r"
308
- ],
309
- [
310
- 0.160298,
311
- "u"
312
- ],
313
- [
314
- 0.215638,
315
- "b"
316
- ],
317
- [
318
- 0.152017,
319
- "y"
320
- ],
321
- [
322
- 0.136009,
323
- " "
324
- ],
325
- [
326
- 0.231998,
327
- "e"
328
- ],
329
- [
330
- 0.399875,
331
- "x"
332
- ],
333
- [
334
- 0.279121,
335
- "ample.rb "
336
- ],
337
- [
338
- 1.0,
339
- "\r\n"
340
- ],
341
- [
342
- 0.075529,
343
- "Step 0. Wire up the client with your keypair.\r\nStep 1. Make a lookup. (BTW, you can also send entire batches of lookups...)\r\nStep 2. Send the lookup.\r\n"
344
- ],
345
- [
346
- 0.247698,
347
- "Step 3. Show the resulting candidate addresses:\r\n- 0: 1 N Rosedale St, Baltimore MD 21229-3737\r\n- 1: 1 S Rosedale St, Baltimore MD 21229-3739\r\n"
348
- ],
349
- [
350
- 0.00718,
351
- "bash-3.2$ "
352
- ]
353
- ]
354
- }