usgs-ruby 1.0.0

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.
Files changed (57) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +87 -0
  3. data/CHANGELOG.md +5 -0
  4. data/CODE_OF_CONDUCT.md +84 -0
  5. data/LICENSE.txt +21 -0
  6. data/README.md +256 -0
  7. data/Rakefile +24 -0
  8. data/docs/Usgs/Client.html +563 -0
  9. data/docs/Usgs/DailyValues.html +338 -0
  10. data/docs/Usgs/InstantaneousValues.html +329 -0
  11. data/docs/Usgs/Models/Reading.html +1124 -0
  12. data/docs/Usgs/Models/Site.html +2030 -0
  13. data/docs/Usgs/Models/Statistic.html +3981 -0
  14. data/docs/Usgs/Models.html +117 -0
  15. data/docs/Usgs/Parser.html +346 -0
  16. data/docs/Usgs/Parsers/RdbParser.html +354 -0
  17. data/docs/Usgs/Parsers/SiteParser.html +174 -0
  18. data/docs/Usgs/Parsers/StatisticsParser.html +228 -0
  19. data/docs/Usgs/Parsers/TimeSeriesParser.html +189 -0
  20. data/docs/Usgs/Parsers.html +117 -0
  21. data/docs/Usgs/Site.html +445 -0
  22. data/docs/Usgs/Statistics.html +335 -0
  23. data/docs/Usgs/Utils.html +357 -0
  24. data/docs/Usgs.html +303 -0
  25. data/docs/_index.html +286 -0
  26. data/docs/class_list.html +54 -0
  27. data/docs/css/common.css +1 -0
  28. data/docs/css/full_list.css +58 -0
  29. data/docs/css/style.css +503 -0
  30. data/docs/file.README.html +111 -0
  31. data/docs/file_list.html +59 -0
  32. data/docs/frames.html +22 -0
  33. data/docs/index.html +111 -0
  34. data/docs/js/app.js +344 -0
  35. data/docs/js/full_list.js +242 -0
  36. data/docs/js/jquery.js +4 -0
  37. data/docs/method_list.html +598 -0
  38. data/docs/top-level-namespace.html +110 -0
  39. data/lib/usgs/client.rb +62 -0
  40. data/lib/usgs/daily_values.rb +38 -0
  41. data/lib/usgs/instantaneous_values.rb +35 -0
  42. data/lib/usgs/models/reading.rb +43 -0
  43. data/lib/usgs/models/site.rb +61 -0
  44. data/lib/usgs/models/statistic.rb +95 -0
  45. data/lib/usgs/parser.rb +23 -0
  46. data/lib/usgs/parsers/rdb_parser.rb +55 -0
  47. data/lib/usgs/parsers/site_parser.rb +13 -0
  48. data/lib/usgs/parsers/statistics_parser.rb +40 -0
  49. data/lib/usgs/parsers/time_series_parser.rb +54 -0
  50. data/lib/usgs/site.rb +50 -0
  51. data/lib/usgs/statistics.rb +42 -0
  52. data/lib/usgs/utils.rb +50 -0
  53. data/lib/usgs/version.rb +5 -0
  54. data/lib/usgs.rb +28 -0
  55. data/sig/usgs/ruby.rbs +6 -0
  56. data/usgs-ruby.gemspec +48 -0
  57. metadata +231 -0
data/docs/Usgs/Site.html ADDED
@@ -0,0 +1,445 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Usgs::Site
8
+
9
+ &mdash; Documentation by YARD 0.9.37
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Usgs::Site";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Usgs.html" title="Usgs (module)">Usgs</a></span></span>
41
+ &raquo;
42
+ <span class="title">Site</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Usgs::Site
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dl>
75
+ <dt>Includes:</dt>
76
+ <dd><span class='object_link'><a href="Utils.html" title="Usgs::Utils (module)">Utils</a></span></dd>
77
+ </dl>
78
+
79
+
80
+
81
+
82
+ <dl>
83
+ <dt>Included in:</dt>
84
+ <dd><span class='object_link'><a href="Client.html" title="Usgs::Client (class)">Client</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/usgs/site.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <h2>
105
+ Instance Method Summary
106
+ <small><a href="#" class="summary_toggle">collapse</a></small>
107
+ </h2>
108
+
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#get_sites-instance_method" title="#get_sites (instance method)">#<strong>get_sites</strong>(state_cd: nil, county_cd: nil, huc: nil, bBox: nil, site_name: nil, site_type: nil, site_status: &quot;all&quot;, parameter_cd: nil) &#x21d2; Array&lt;Usgs::Models::Site&gt; </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <span class="summary_desc"><div class='inline'>
129
+ <p>Fetch USGS monitoring locations (sites).</p>
130
+ </div></span>
131
+
132
+ </li>
133
+
134
+
135
+ </ul>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Usgs::Utils (module)">Utils</a></span></h3>
148
+ <p class="inherited"><span class='object_link'><a href="Utils.html#format_date-instance_method" title="Usgs::Utils#format_date (method)">#format_date</a></span>, <span class='object_link'><a href="Utils.html#format_datetime-instance_method" title="Usgs::Utils#format_datetime (method)">#format_datetime</a></span>, <span class='object_link'><a href="Utils.html#resolve_parameter_codes-instance_method" title="Usgs::Utils#resolve_parameter_codes (method)">#resolve_parameter_codes</a></span></p>
149
+
150
+
151
+ <div id="instance_method_details" class="method_details_list">
152
+ <h2>Instance Method Details</h2>
153
+
154
+
155
+ <div class="method_details first">
156
+ <h3 class="signature first" id="get_sites-instance_method">
157
+
158
+ #<strong>get_sites</strong>(state_cd: nil, county_cd: nil, huc: nil, bBox: nil, site_name: nil, site_type: nil, site_status: &quot;all&quot;, parameter_cd: nil) &#x21d2; <tt>Array&lt;<span class='object_link'><a href="Models/Site.html" title="Usgs::Models::Site (class)">Usgs::Models::Site</a></span>&gt;</tt>
159
+
160
+
161
+
162
+
163
+
164
+ </h3><div class="docstring">
165
+ <div class="discussion">
166
+
167
+ <p>Fetch USGS monitoring locations (sites)</p>
168
+
169
+
170
+ </div>
171
+ </div>
172
+ <div class="tags">
173
+
174
+ <div class="examples">
175
+ <h4 class="tag_title">Examples:</h4>
176
+
177
+
178
+ <pre class="example code"><code><span class='const'><span class='object_link'><a href="../Usgs.html" title="Usgs (module)">Usgs</a></span></span><span class='period'>.</span><span class='id identifier rubyid_client'><span class='object_link'><a href="../Usgs.html#client-class_method" title="Usgs.client (method)">client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get_sites'>get_sites</span><span class='lparen'>(</span><span class='label'>state_cd:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CO</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>parameter_cd:</span> <span class='symbol'>:discharge</span><span class='rparen'>)</span></code></pre>
179
+
180
+ </div>
181
+ <p class="tag_title">Parameters:</p>
182
+ <ul class="param">
183
+
184
+ <li>
185
+
186
+ <span class='name'>state_cd</span>
187
+
188
+
189
+ <span class='type'>(<tt>String</tt>)</span>
190
+
191
+
192
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
193
+
194
+
195
+ &mdash;
196
+ <div class='inline'>
197
+ <p>Two-letter state code (e.g., “CO”)</p>
198
+ </div>
199
+
200
+ </li>
201
+
202
+ <li>
203
+
204
+ <span class='name'>county_cd</span>
205
+
206
+
207
+ <span class='type'>(<tt>String</tt>)</span>
208
+
209
+
210
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
211
+
212
+
213
+ &mdash;
214
+ <div class='inline'>
215
+ <p>FIPS county code (e.g., “08013”)</p>
216
+ </div>
217
+
218
+ </li>
219
+
220
+ <li>
221
+
222
+ <span class='name'>huc</span>
223
+
224
+
225
+ <span class='type'>(<tt>String</tt>)</span>
226
+
227
+
228
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
229
+
230
+
231
+ &mdash;
232
+ <div class='inline'>
233
+ <p>2-16 digit Hydrologic Unit Code</p>
234
+ </div>
235
+
236
+ </li>
237
+
238
+ <li>
239
+
240
+ <span class='name'>bBox</span>
241
+
242
+
243
+ <span class='type'>(<tt>String</tt>)</span>
244
+
245
+
246
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
247
+
248
+
249
+ &mdash;
250
+ <div class='inline'>
251
+ <p>“west,south,east,north” in decimal degrees</p>
252
+ </div>
253
+
254
+ </li>
255
+
256
+ <li>
257
+
258
+ <span class='name'>site_name</span>
259
+
260
+
261
+ <span class='type'>(<tt>String</tt>)</span>
262
+
263
+
264
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
265
+
266
+
267
+ &mdash;
268
+ <div class='inline'>
269
+ <p>Text search in station name</p>
270
+ </div>
271
+
272
+ </li>
273
+
274
+ <li>
275
+
276
+ <span class='name'>site_type</span>
277
+
278
+
279
+ <span class='type'>(<tt>String</tt>)</span>
280
+
281
+
282
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
283
+
284
+
285
+ &mdash;
286
+ <div class='inline'>
287
+ <p>e.g., “ST” (stream), “GW”, “LK”, “WE”</p>
288
+ </div>
289
+
290
+ </li>
291
+
292
+ <li>
293
+
294
+ <span class='name'>site_status</span>
295
+
296
+
297
+ <span class='type'>(<tt>String</tt>)</span>
298
+
299
+
300
+ <em class="default">(defaults to: <tt>&quot;all&quot;</tt>)</em>
301
+
302
+
303
+ &mdash;
304
+ <div class='inline'>
305
+ <p>“active”, “inactive”, “all” (default: “all”)</p>
306
+ </div>
307
+
308
+ </li>
309
+
310
+ <li>
311
+
312
+ <span class='name'>parameter_cd</span>
313
+
314
+
315
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>, <tt>Array</tt>)</span>
316
+
317
+
318
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
319
+
320
+
321
+ &mdash;
322
+ <div class='inline'>
323
+ <p>e.g. :discharge, “00060”, or [:discharge, :gage_height]</p>
324
+ </div>
325
+
326
+ </li>
327
+
328
+ </ul>
329
+
330
+ <p class="tag_title">Returns:</p>
331
+ <ul class="return">
332
+
333
+ <li>
334
+
335
+
336
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="Models/Site.html" title="Usgs::Models::Site (class)">Usgs::Models::Site</a></span>&gt;</tt>)</span>
337
+
338
+
339
+
340
+ </li>
341
+
342
+ </ul>
343
+ <p class="tag_title">Raises:</p>
344
+ <ul class="raise">
345
+
346
+ <li>
347
+
348
+
349
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
350
+
351
+
352
+
353
+ &mdash;
354
+ <div class='inline'>
355
+ <p>if no major filter is provided</p>
356
+ </div>
357
+
358
+ </li>
359
+
360
+ </ul>
361
+
362
+ </div><table class="source_code">
363
+ <tr>
364
+ <td>
365
+ <pre class="lines">
366
+
367
+
368
+ 24
369
+ 25
370
+ 26
371
+ 27
372
+ 28
373
+ 29
374
+ 30
375
+ 31
376
+ 32
377
+ 33
378
+ 34
379
+ 35
380
+ 36
381
+ 37
382
+ 38
383
+ 39
384
+ 40
385
+ 41
386
+ 42
387
+ 43
388
+ 44
389
+ 45
390
+ 46
391
+ 47
392
+ 48
393
+ 49
394
+ 50
395
+ 51</pre>
396
+ </td>
397
+ <td>
398
+ <pre class="code"><span class="info file"># File 'lib/usgs/site.rb', line 24</span>
399
+
400
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_sites'>get_sites</span><span class='lparen'>(</span><span class='label'>state_cd:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>county_cd:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>huc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bBox:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>site_name:</span> <span class='kw'>nil</span><span class='comma'>,</span>
401
+ <span class='label'>site_type:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>site_status:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>all</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>parameter_cd:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
402
+
403
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
404
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>rdb,1.0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
405
+ <span class='label'>stateCd:</span> <span class='id identifier rubyid_state_cd'>state_cd</span><span class='comma'>,</span>
406
+ <span class='label'>countyCd:</span> <span class='id identifier rubyid_county_cd'>county_cd</span><span class='comma'>,</span>
407
+ <span class='label'>huc:</span> <span class='id identifier rubyid_huc'>huc</span><span class='comma'>,</span>
408
+ <span class='label'>bBox:</span> <span class='id identifier rubyid_bBox'>bBox</span><span class='comma'>,</span>
409
+ <span class='label'>siteName:</span> <span class='id identifier rubyid_site_name'>site_name</span><span class='comma'>,</span>
410
+ <span class='label'>siteType:</span> <span class='id identifier rubyid_site_type'>site_type</span><span class='comma'>,</span>
411
+ <span class='label'>siteStatus:</span> <span class='id identifier rubyid_site_status'>site_status</span>
412
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
413
+
414
+ <span class='kw'>if</span> <span class='id identifier rubyid_parameter_cd'>parameter_cd</span>
415
+ <span class='id identifier rubyid_resolved'>resolved</span> <span class='op'>=</span> <span class='id identifier rubyid_resolve_parameter_codes'>resolve_parameter_codes</span><span class='lparen'>(</span><span class='id identifier rubyid_parameter_cd'>parameter_cd</span><span class='rparen'>)</span>
416
+ <span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='symbol'>:parameterCd</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_resolved'>resolved</span> <span class='kw'>if</span> <span class='id identifier rubyid_resolved'>resolved</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_resolved'>resolved</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
417
+ <span class='kw'>end</span>
418
+
419
+ <span class='comment'># Validate for at least one major filter
420
+ </span> <span class='id identifier rubyid_major_keys'>major_keys</span> <span class='op'>=</span> <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>stateCd</span><span class='words_sep'> </span><span class='tstring_content'>countyCd</span><span class='words_sep'> </span><span class='tstring_content'>huc</span><span class='words_sep'> </span><span class='tstring_content'>bBox</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span>
421
+ <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='op'>&amp;</span> <span class='id identifier rubyid_major_keys'>major_keys</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
422
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You must provide at least one major filter: state_cd, county_cd, huc or bBox</span><span class='tstring_end'>&quot;</span></span>
423
+ <span class='kw'>end</span>
424
+
425
+ <span class='id identifier rubyid_raw'>raw</span> <span class='op'>=</span> <span class='id identifier rubyid_api_get'>api_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/site/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_query'>query</span><span class='rparen'>)</span>
426
+ <span class='const'><span class='object_link'><a href="Parser.html" title="Usgs::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_sites'><span class='object_link'><a href="Parser.html#parse_sites-class_method" title="Usgs::Parser.parse_sites (method)">parse_sites</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_raw'>raw</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_row'>row</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Models.html" title="Usgs::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Models/Site.html" title="Usgs::Models::Site (class)">Site</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Models/Site.html#initialize-instance_method" title="Usgs::Models::Site#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_row'>row</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
427
+ <span class='kw'>end</span></pre>
428
+ </td>
429
+ </tr>
430
+ </table>
431
+ </div>
432
+
433
+ </div>
434
+
435
+ </div>
436
+
437
+ <div id="footer">
438
+ Generated on Mon Dec 15 21:52:18 2025 by
439
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
440
+ 0.9.37 (ruby-3.2.2).
441
+ </div>
442
+
443
+ </div>
444
+ </body>
445
+ </html>