cdss-ruby 0.1.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 (99) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +86 -0
  3. data/CHANGELOG.md +5 -0
  4. data/CODE_OF_CONDUCT.md +84 -0
  5. data/README.md +101 -0
  6. data/Rakefile +26 -0
  7. data/docs/Cdss/AdminCalls.html +399 -0
  8. data/docs/Cdss/Analysis.html +972 -0
  9. data/docs/Cdss/Client.html +581 -0
  10. data/docs/Cdss/Climate.html +1257 -0
  11. data/docs/Cdss/Concerns/LogReadingAttributes.html +406 -0
  12. data/docs/Cdss/Concerns/WellReadingAttributes.html +414 -0
  13. data/docs/Cdss/Concerns.html +117 -0
  14. data/docs/Cdss/GroundWater.html +945 -0
  15. data/docs/Cdss/Models/AdminCall.html +252 -0
  16. data/docs/Cdss/Models/Analysis.html +397 -0
  17. data/docs/Cdss/Models/CallAnalysis.html +140 -0
  18. data/docs/Cdss/Models/ClimateStation.html +249 -0
  19. data/docs/Cdss/Models/DiversionRecord.html +248 -0
  20. data/docs/Cdss/Models/Reading.html +301 -0
  21. data/docs/Cdss/Models/ReferenceTable.html +339 -0
  22. data/docs/Cdss/Models/RouteAnalysis.html +140 -0
  23. data/docs/Cdss/Models/SourceRoute.html +140 -0
  24. data/docs/Cdss/Models/Station.html +248 -0
  25. data/docs/Cdss/Models/Structure.html +259 -0
  26. data/docs/Cdss/Models/WaterClass.html +249 -0
  27. data/docs/Cdss/Models/WaterRight.html +255 -0
  28. data/docs/Cdss/Models/Well.html +251 -0
  29. data/docs/Cdss/Models.html +117 -0
  30. data/docs/Cdss/Parser.html +2155 -0
  31. data/docs/Cdss/Parsers/AdminCallsParser.html +201 -0
  32. data/docs/Cdss/Parsers/AnalysisParser.html +296 -0
  33. data/docs/Cdss/Parsers/BaseParser.html +207 -0
  34. data/docs/Cdss/Parsers/ClimateParser.html +253 -0
  35. data/docs/Cdss/Parsers/ReadingParser.html +201 -0
  36. data/docs/Cdss/Parsers/ReferenceTablesParser.html +201 -0
  37. data/docs/Cdss/Parsers/StationParser.html +201 -0
  38. data/docs/Cdss/Parsers/StructuresParser.html +305 -0
  39. data/docs/Cdss/Parsers/WaterRightsParser.html +219 -0
  40. data/docs/Cdss/Parsers/WellParser.html +357 -0
  41. data/docs/Cdss/Parsers.html +117 -0
  42. data/docs/Cdss/ReferenceTables.html +332 -0
  43. data/docs/Cdss/Structures.html +1132 -0
  44. data/docs/Cdss/SurfaceWater.html +798 -0
  45. data/docs/Cdss/Telemetry.html +763 -0
  46. data/docs/Cdss/Utils.html +1276 -0
  47. data/docs/Cdss/WaterRights.html +634 -0
  48. data/docs/Cdss.html +292 -0
  49. data/docs/_index.html +493 -0
  50. data/docs/class_list.html +54 -0
  51. data/docs/css/common.css +1 -0
  52. data/docs/css/full_list.css +58 -0
  53. data/docs/css/style.css +503 -0
  54. data/docs/file.README.html +108 -0
  55. data/docs/file_list.html +59 -0
  56. data/docs/frames.html +22 -0
  57. data/docs/index.html +108 -0
  58. data/docs/js/app.js +344 -0
  59. data/docs/js/full_list.js +242 -0
  60. data/docs/js/jquery.js +4 -0
  61. data/docs/method_list.html +790 -0
  62. data/docs/top-level-namespace.html +110 -0
  63. data/lib/cdss/admin_calls.rb +44 -0
  64. data/lib/cdss/analysis.rb +183 -0
  65. data/lib/cdss/client.rb +121 -0
  66. data/lib/cdss/climate.rb +155 -0
  67. data/lib/cdss/concerns/log_reading_attributes.rb +48 -0
  68. data/lib/cdss/concerns/well_reading_attributes.rb +56 -0
  69. data/lib/cdss/ground_water.rb +112 -0
  70. data/lib/cdss/models/admin_call.rb +45 -0
  71. data/lib/cdss/models/analysis.rb +77 -0
  72. data/lib/cdss/models/climate_station.rb +40 -0
  73. data/lib/cdss/models/reading.rb +54 -0
  74. data/lib/cdss/models/reference_table.rb +56 -0
  75. data/lib/cdss/models/station.rb +40 -0
  76. data/lib/cdss/models/structure.rb +101 -0
  77. data/lib/cdss/models/water_right.rb +47 -0
  78. data/lib/cdss/models/well.rb +43 -0
  79. data/lib/cdss/parser.rb +172 -0
  80. data/lib/cdss/parsers/admin_calls_parser.rb +47 -0
  81. data/lib/cdss/parsers/analysis_parser.rb +124 -0
  82. data/lib/cdss/parsers/base_parser.rb +18 -0
  83. data/lib/cdss/parsers/climate_parser.rb +86 -0
  84. data/lib/cdss/parsers/reading_parser.rb +90 -0
  85. data/lib/cdss/parsers/reference_tables_parser.rb +55 -0
  86. data/lib/cdss/parsers/station_parser.rb +42 -0
  87. data/lib/cdss/parsers/structures_parser.rb +96 -0
  88. data/lib/cdss/parsers/water_rights_parser.rb +77 -0
  89. data/lib/cdss/parsers/well_parser.rb +107 -0
  90. data/lib/cdss/reference_tables.rb +147 -0
  91. data/lib/cdss/structures.rb +235 -0
  92. data/lib/cdss/surface_water.rb +186 -0
  93. data/lib/cdss/telemetry.rb +98 -0
  94. data/lib/cdss/utils.rb +152 -0
  95. data/lib/cdss/version.rb +5 -0
  96. data/lib/cdss/water_rights.rb +95 -0
  97. data/lib/cdss.rb +27 -0
  98. data/sig/cdss/ruby.rbs +6 -0
  99. metadata +272 -0
data/docs/Cdss/AdminCalls.html ADDED
@@ -0,0 +1,399 @@
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: Cdss::AdminCalls
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 = "Cdss::AdminCalls";
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 (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Cdss.html" title="Cdss (module)">Cdss</a></span></span>
41
+ &raquo;
42
+ <span class="title">AdminCalls</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: Cdss::AdminCalls
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="Cdss::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="Cdss::Client (class)">Client</a></span></dd>
85
+ </dl>
86
+
87
+
88
+
89
+ <dl>
90
+ <dt>Defined in:</dt>
91
+ <dd>lib/cdss/admin_calls.rb</dd>
92
+ </dl>
93
+
94
+ </div>
95
+
96
+ <h2>Overview</h2><div class="docstring">
97
+ <div class="discussion">
98
+
99
+ <p>Provides methods for accessing administrative calls data from the CDSS API.</p>
100
+
101
+ <p>This module includes functionality for retrieving active and historical administrative calls based on various criteria such as division, location, and date ranges.</p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+
109
+ </div>
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+ <h2>
118
+ Instance Method Summary
119
+ <small><a href="#" class="summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#get_admin_calls-instance_method" title="#get_admin_calls (instance method)">#<strong>get_admin_calls</strong>(division: nil, location_wdid: nil, call_number: nil, start_date: nil, end_date: nil, active: true) &#x21d2; Array&lt;AdminCall&gt; </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <span class="summary_desc"><div class='inline'>
142
+ <p>Fetches administrative calls based on various filtering criteria.</p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ </ul>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
161
+ <p class="inherited"><span class='object_link'><a href="Utils.html#batch_dates-instance_method" title="Cdss::Utils#batch_dates (method)">#batch_dates</a></span>, <span class='object_link'><a href="Utils.html#build_query-instance_method" title="Cdss::Utils#build_query (method)">#build_query</a></span>, <span class='object_link'><a href="Utils.html#fetch_paginated_data-instance_method" title="Cdss::Utils#fetch_paginated_data (method)">#fetch_paginated_data</a></span>, <span class='object_link'><a href="Utils.html#format_date-instance_method" title="Cdss::Utils#format_date (method)">#format_date</a></span>, <span class='object_link'><a href="Utils.html#format_query_param-instance_method" title="Cdss::Utils#format_query_param (method)">#format_query_param</a></span>, <span class='object_link'><a href="Utils.html#parse_timestamp-instance_method" title="Cdss::Utils#parse_timestamp (method)">#parse_timestamp</a></span>, <span class='object_link'><a href="Utils.html#safe_float-instance_method" title="Cdss::Utils#safe_float (method)">#safe_float</a></span>, <span class='object_link'><a href="Utils.html#safe_integer-instance_method" title="Cdss::Utils#safe_integer (method)">#safe_integer</a></span></p>
162
+
163
+
164
+ <div id="instance_method_details" class="method_details_list">
165
+ <h2>Instance Method Details</h2>
166
+
167
+
168
+ <div class="method_details first">
169
+ <h3 class="signature first" id="get_admin_calls-instance_method">
170
+
171
+ #<strong>get_admin_calls</strong>(division: nil, location_wdid: nil, call_number: nil, start_date: nil, end_date: nil, active: true) &#x21d2; <tt>Array&lt;AdminCall&gt;</tt>
172
+
173
+
174
+
175
+
176
+
177
+ </h3><div class="docstring">
178
+ <div class="discussion">
179
+
180
+ <p>Fetches administrative calls based on various filtering criteria.</p>
181
+
182
+
183
+ </div>
184
+ </div>
185
+ <div class="tags">
186
+
187
+ <div class="examples">
188
+ <h4 class="tag_title">Examples:</h4>
189
+
190
+
191
+ <h5 class="example_title"><div class='inline'>
192
+ <p>Fetch active calls for a division</p>
193
+ </div></h5>
194
+
195
+ <pre class="example code"><code><span class='id identifier rubyid_get_admin_calls'>get_admin_calls</span><span class='lparen'>(</span><span class='label'>division:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>active:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
196
+
197
+ </div>
198
+ <p class="tag_title">Parameters:</p>
199
+ <ul class="param">
200
+
201
+ <li>
202
+
203
+ <span class='name'>division</span>
204
+
205
+
206
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
207
+
208
+
209
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
210
+
211
+
212
+ &mdash;
213
+ <div class='inline'>
214
+ <p>Water division to filter calls.</p>
215
+ </div>
216
+
217
+ </li>
218
+
219
+ <li>
220
+
221
+ <span class='name'>location_wdid</span>
222
+
223
+
224
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
225
+
226
+
227
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
228
+
229
+
230
+ &mdash;
231
+ <div class='inline'>
232
+ <p>WDID of the call location structure.</p>
233
+ </div>
234
+
235
+ </li>
236
+
237
+ <li>
238
+
239
+ <span class='name'>call_number</span>
240
+
241
+
242
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
243
+
244
+
245
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
246
+
247
+
248
+ &mdash;
249
+ <div class='inline'>
250
+ <p>Unique call identifier to query.</p>
251
+ </div>
252
+
253
+ </li>
254
+
255
+ <li>
256
+
257
+ <span class='name'>start_date</span>
258
+
259
+
260
+ <span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
261
+
262
+
263
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
264
+
265
+
266
+ &mdash;
267
+ <div class='inline'>
268
+ <p>Start date for calls data.</p>
269
+ </div>
270
+
271
+ </li>
272
+
273
+ <li>
274
+
275
+ <span class='name'>end_date</span>
276
+
277
+
278
+ <span class='type'>(<tt>Date</tt>, <tt>nil</tt>)</span>
279
+
280
+
281
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
282
+
283
+
284
+ &mdash;
285
+ <div class='inline'>
286
+ <p>End date for calls data.</p>
287
+ </div>
288
+
289
+ </li>
290
+
291
+ <li>
292
+
293
+ <span class='name'>active</span>
294
+
295
+
296
+ <span class='type'>(<tt>Boolean</tt>)</span>
297
+
298
+
299
+ <em class="default">(defaults to: <tt>true</tt>)</em>
300
+
301
+
302
+ &mdash;
303
+ <div class='inline'>
304
+ <p>Whether to fetch active (true) or historical (false) calls. Defaults to true.</p>
305
+ </div>
306
+
307
+ </li>
308
+
309
+ </ul>
310
+
311
+ <p class="tag_title">Returns:</p>
312
+ <ul class="return">
313
+
314
+ <li>
315
+
316
+
317
+ <span class='type'>(<tt>Array&lt;AdminCall&gt;</tt>)</span>
318
+
319
+
320
+
321
+ &mdash;
322
+ <div class='inline'>
323
+ <p>Array of matching administrative call objects.</p>
324
+ </div>
325
+
326
+ </li>
327
+
328
+ </ul>
329
+
330
+ </div><table class="source_code">
331
+ <tr>
332
+ <td>
333
+ <pre class="lines">
334
+
335
+
336
+ 22
337
+ 23
338
+ 24
339
+ 25
340
+ 26
341
+ 27
342
+ 28
343
+ 29
344
+ 30
345
+ 31
346
+ 32
347
+ 33
348
+ 34
349
+ 35
350
+ 36
351
+ 37
352
+ 38
353
+ 39
354
+ 40
355
+ 41
356
+ 42</pre>
357
+ </td>
358
+ <td>
359
+ <pre class="code"><span class="info file"># File 'lib/cdss/admin_calls.rb', line 22</span>
360
+
361
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_admin_calls'>get_admin_calls</span><span class='lparen'>(</span><span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>location_wdid:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>call_number:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>start_date:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>end_date:</span> <span class='kw'>nil</span><span class='comma'>,</span>
362
+ <span class='label'>active:</span> <span class='kw'>true</span><span class='rparen'>)</span>
363
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='id identifier rubyid_build_query'>build_query</span><span class='lparen'>(</span>
364
+ <span class='lbrace'>{</span>
365
+ <span class='label'>dateFormat:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>spaceSepToSeconds</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
366
+ <span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
367
+ <span class='label'>callNumber:</span> <span class='id identifier rubyid_call_number'>call_number</span><span class='comma'>,</span>
368
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>min-dateTimeSet</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_start_date'>start_date</span><span class='rparen'>)</span><span class='comma'>,</span>
369
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>max-dateTimeSet</span><span class='label_end'>&quot;:</span> <span class='id identifier rubyid_format_date'>format_date</span><span class='lparen'>(</span><span class='id identifier rubyid_end_date'>end_date</span><span class='rparen'>)</span><span class='comma'>,</span>
370
+ <span class='label'>locationWdid:</span> <span class='id identifier rubyid_location_wdid'>location_wdid</span>
371
+ <span class='rbrace'>}</span><span class='comma'>,</span>
372
+ <span class='label'>encode:</span> <span class='kw'>true</span>
373
+ <span class='rparen'>)</span>
374
+
375
+ <span class='id identifier rubyid_endpoint'>endpoint</span> <span class='op'>=</span> <span class='id identifier rubyid_active'>active</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>administrativecalls/active/</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>administrativecalls/historical/</span><span class='tstring_end'>&quot;</span></span>
376
+
377
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
378
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_endpoint'>endpoint</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
379
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
380
+ <span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Parser.html" title="Cdss::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse_admin_calls'><span class='object_link'><a href="Parser.html#parse_admin_calls-class_method" title="Cdss::Parser.parse_admin_calls (method)">parse_admin_calls</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
381
+ <span class='kw'>end</span></pre>
382
+ </td>
383
+ </tr>
384
+ </table>
385
+ </div>
386
+
387
+ </div>
388
+
389
+ </div>
390
+
391
+ <div id="footer">
392
+ Generated on Thu Feb 20 21:19:08 2025 by
393
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
394
+ 0.9.37 (ruby-3.2.2).
395
+ </div>
396
+
397
+ </div>
398
+ </body>
399
+ </html>