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/WaterRights.html ADDED
@@ -0,0 +1,634 @@
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::WaterRights
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::WaterRights";
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 (W)</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">WaterRights</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::WaterRights
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/water_rights.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 water rights data from the CDSS API.</p>
100
+
101
+ <p>This module includes functionality for retrieving water rights net amounts and transactions data based on various spatial and attribute-based searches.</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_water_rights_net_amounts-instance_method" title="#get_water_rights_net_amounts (instance method)">#<strong>get_water_rights_net_amounts</strong>(aoi: nil, radius: nil, county: nil, division: nil, water_district: nil, wdid: nil) &#x21d2; Array&lt;WaterRight&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 water rights net amounts data based on various filtering criteria.</p>
143
+ </div></span>
144
+
145
+ </li>
146
+
147
+
148
+ <li class="public ">
149
+ <span class="summary_signature">
150
+
151
+ <a href="#get_water_rights_transactions-instance_method" title="#get_water_rights_transactions (instance method)">#<strong>get_water_rights_transactions</strong>(aoi: nil, radius: nil, county: nil, division: nil, water_district: nil, wdid: nil) &#x21d2; Array&lt;WaterRight&gt; </a>
152
+
153
+
154
+
155
+ </span>
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+ <span class="summary_desc"><div class='inline'>
166
+ <p>Fetches water rights transactions data based on various filtering criteria.</p>
167
+ </div></span>
168
+
169
+ </li>
170
+
171
+
172
+ </ul>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
185
+ <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>
186
+
187
+
188
+ <div id="instance_method_details" class="method_details_list">
189
+ <h2>Instance Method Details</h2>
190
+
191
+
192
+ <div class="method_details first">
193
+ <h3 class="signature first" id="get_water_rights_net_amounts-instance_method">
194
+
195
+ #<strong>get_water_rights_net_amounts</strong>(aoi: nil, radius: nil, county: nil, division: nil, water_district: nil, wdid: nil) &#x21d2; <tt>Array&lt;WaterRight&gt;</tt>
196
+
197
+
198
+
199
+
200
+
201
+ </h3><div class="docstring">
202
+ <div class="discussion">
203
+
204
+ <p>Fetches water rights net amounts data based on various filtering criteria.</p>
205
+
206
+
207
+ </div>
208
+ </div>
209
+ <div class="tags">
210
+ <p class="tag_title">Parameters:</p>
211
+ <ul class="param">
212
+
213
+ <li>
214
+
215
+ <span class='name'>aoi</span>
216
+
217
+
218
+ <span class='type'>(<tt>Hash</tt>, <tt>Array</tt>, <tt>nil</tt>)</span>
219
+
220
+
221
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
222
+
223
+
224
+ &mdash;
225
+ <div class='inline'>
226
+ <p>Area of interest for spatial searches. If hash, must contain :latitude and :longitude keys. If array, must contain [longitude, latitude].</p>
227
+ </div>
228
+
229
+ </li>
230
+
231
+ <li>
232
+
233
+ <span class='name'>radius</span>
234
+
235
+
236
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
237
+
238
+
239
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
240
+
241
+
242
+ &mdash;
243
+ <div class='inline'>
244
+ <p>Radius in miles for spatial search around aoi. Defaults to 20 if aoi is provided.</p>
245
+ </div>
246
+
247
+ </li>
248
+
249
+ <li>
250
+
251
+ <span class='name'>county</span>
252
+
253
+
254
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
255
+
256
+
257
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
258
+
259
+
260
+ &mdash;
261
+ <div class='inline'>
262
+ <p>County name to filter rights.</p>
263
+ </div>
264
+
265
+ </li>
266
+
267
+ <li>
268
+
269
+ <span class='name'>division</span>
270
+
271
+
272
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
273
+
274
+
275
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
276
+
277
+
278
+ &mdash;
279
+ <div class='inline'>
280
+ <p>Water division number to filter rights.</p>
281
+ </div>
282
+
283
+ </li>
284
+
285
+ <li>
286
+
287
+ <span class='name'>water_district</span>
288
+
289
+
290
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
291
+
292
+
293
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
294
+
295
+
296
+ &mdash;
297
+ <div class='inline'>
298
+ <p>Water district number to filter rights.</p>
299
+ </div>
300
+
301
+ </li>
302
+
303
+ <li>
304
+
305
+ <span class='name'>wdid</span>
306
+
307
+
308
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
309
+
310
+
311
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
312
+
313
+
314
+ &mdash;
315
+ <div class='inline'>
316
+ <p>WDID code of water right.</p>
317
+ </div>
318
+
319
+ </li>
320
+
321
+ </ul>
322
+
323
+ <p class="tag_title">Returns:</p>
324
+ <ul class="return">
325
+
326
+ <li>
327
+
328
+
329
+ <span class='type'>(<tt>Array&lt;WaterRight&gt;</tt>)</span>
330
+
331
+
332
+
333
+ &mdash;
334
+ <div class='inline'>
335
+ <p>Array of water right objects with net amounts.</p>
336
+ </div>
337
+
338
+ </li>
339
+
340
+ </ul>
341
+ <p class="tag_title">Raises:</p>
342
+ <ul class="raise">
343
+
344
+ <li>
345
+
346
+
347
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
348
+
349
+
350
+
351
+ &mdash;
352
+ <div class='inline'>
353
+ <p>If aoi parameter is provided but invalid.</p>
354
+ </div>
355
+
356
+ </li>
357
+
358
+ </ul>
359
+
360
+ </div><table class="source_code">
361
+ <tr>
362
+ <td>
363
+ <pre class="lines">
364
+
365
+
366
+ 22
367
+ 23
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</pre>
382
+ </td>
383
+ <td>
384
+ <pre class="code"><span class="info file"># File 'lib/cdss/water_rights.rb', line 22</span>
385
+
386
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_water_rights_net_amounts'>get_water_rights_net_amounts</span><span class='lparen'>(</span><span class='label'>aoi:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>radius:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wdid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
387
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
388
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
389
+ <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>
390
+ <span class='label'>units:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>miles</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
391
+ <span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='comma'>,</span>
392
+ <span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
393
+ <span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
394
+ <span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span>
395
+ <span class='rbrace'>}</span>
396
+ <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_process_aoi'>process_aoi</span><span class='lparen'>(</span><span class='id identifier rubyid_aoi'>aoi</span><span class='comma'>,</span> <span class='id identifier rubyid_radius'>radius</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_aoi'>aoi</span>
397
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
398
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/waterrights/netamount/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
399
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
400
+ <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_water_rights'><span class='object_link'><a href="Parser.html#parse_water_rights-class_method" title="Cdss::Parser.parse_water_rights (method)">parse_water_rights</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:net_amount</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
401
+ <span class='kw'>end</span></pre>
402
+ </td>
403
+ </tr>
404
+ </table>
405
+ </div>
406
+
407
+ <div class="method_details ">
408
+ <h3 class="signature " id="get_water_rights_transactions-instance_method">
409
+
410
+ #<strong>get_water_rights_transactions</strong>(aoi: nil, radius: nil, county: nil, division: nil, water_district: nil, wdid: nil) &#x21d2; <tt>Array&lt;WaterRight&gt;</tt>
411
+
412
+
413
+
414
+
415
+
416
+ </h3><div class="docstring">
417
+ <div class="discussion">
418
+
419
+ <p>Fetches water rights transactions data based on various filtering criteria.</p>
420
+
421
+
422
+ </div>
423
+ </div>
424
+ <div class="tags">
425
+ <p class="tag_title">Parameters:</p>
426
+ <ul class="param">
427
+
428
+ <li>
429
+
430
+ <span class='name'>aoi</span>
431
+
432
+
433
+ <span class='type'>(<tt>Hash</tt>, <tt>Array</tt>, <tt>nil</tt>)</span>
434
+
435
+
436
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
437
+
438
+
439
+ &mdash;
440
+ <div class='inline'>
441
+ <p>Area of interest for spatial searches. If hash, must contain :latitude and :longitude keys. If array, must contain [longitude, latitude].</p>
442
+ </div>
443
+
444
+ </li>
445
+
446
+ <li>
447
+
448
+ <span class='name'>radius</span>
449
+
450
+
451
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
452
+
453
+
454
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
455
+
456
+
457
+ &mdash;
458
+ <div class='inline'>
459
+ <p>Radius in miles for spatial search around aoi. Defaults to 20 if aoi is provided.</p>
460
+ </div>
461
+
462
+ </li>
463
+
464
+ <li>
465
+
466
+ <span class='name'>county</span>
467
+
468
+
469
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
470
+
471
+
472
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
473
+
474
+
475
+ &mdash;
476
+ <div class='inline'>
477
+ <p>County name to filter transactions.</p>
478
+ </div>
479
+
480
+ </li>
481
+
482
+ <li>
483
+
484
+ <span class='name'>division</span>
485
+
486
+
487
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
488
+
489
+
490
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
491
+
492
+
493
+ &mdash;
494
+ <div class='inline'>
495
+ <p>Water division number to filter transactions.</p>
496
+ </div>
497
+
498
+ </li>
499
+
500
+ <li>
501
+
502
+ <span class='name'>water_district</span>
503
+
504
+
505
+ <span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
506
+
507
+
508
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
509
+
510
+
511
+ &mdash;
512
+ <div class='inline'>
513
+ <p>Water district number to filter transactions.</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ <li>
519
+
520
+ <span class='name'>wdid</span>
521
+
522
+
523
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
524
+
525
+
526
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
527
+
528
+
529
+ &mdash;
530
+ <div class='inline'>
531
+ <p>WDID code of water right.</p>
532
+ </div>
533
+
534
+ </li>
535
+
536
+ </ul>
537
+
538
+ <p class="tag_title">Returns:</p>
539
+ <ul class="return">
540
+
541
+ <li>
542
+
543
+
544
+ <span class='type'>(<tt>Array&lt;WaterRight&gt;</tt>)</span>
545
+
546
+
547
+
548
+ &mdash;
549
+ <div class='inline'>
550
+ <p>Array of water right objects with transactions.</p>
551
+ </div>
552
+
553
+ </li>
554
+
555
+ </ul>
556
+ <p class="tag_title">Raises:</p>
557
+ <ul class="raise">
558
+
559
+ <li>
560
+
561
+
562
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
563
+
564
+
565
+
566
+ &mdash;
567
+ <div class='inline'>
568
+ <p>If aoi parameter is provided but invalid.</p>
569
+ </div>
570
+
571
+ </li>
572
+
573
+ </ul>
574
+
575
+ </div><table class="source_code">
576
+ <tr>
577
+ <td>
578
+ <pre class="lines">
579
+
580
+
581
+ 50
582
+ 51
583
+ 52
584
+ 53
585
+ 54
586
+ 55
587
+ 56
588
+ 57
589
+ 58
590
+ 59
591
+ 60
592
+ 61
593
+ 62
594
+ 63
595
+ 64
596
+ 65</pre>
597
+ </td>
598
+ <td>
599
+ <pre class="code"><span class="info file"># File 'lib/cdss/water_rights.rb', line 50</span>
600
+
601
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_water_rights_transactions'>get_water_rights_transactions</span><span class='lparen'>(</span><span class='label'>aoi:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>radius:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>county:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>division:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>water_district:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wdid:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
602
+ <span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='lbrace'>{</span>
603
+ <span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>json</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
604
+ <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>
605
+ <span class='label'>units:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>miles</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
606
+ <span class='label'>county:</span> <span class='id identifier rubyid_county'>county</span><span class='comma'>,</span>
607
+ <span class='label'>division:</span> <span class='id identifier rubyid_division'>division</span><span class='comma'>,</span>
608
+ <span class='label'>waterDistrict:</span> <span class='id identifier rubyid_water_district'>water_district</span><span class='comma'>,</span>
609
+ <span class='label'>wdid:</span> <span class='id identifier rubyid_wdid'>wdid</span>
610
+ <span class='rbrace'>}</span>
611
+ <span class='id identifier rubyid_query'>query</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_process_aoi'>process_aoi</span><span class='lparen'>(</span><span class='id identifier rubyid_aoi'>aoi</span><span class='comma'>,</span> <span class='id identifier rubyid_radius'>radius</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_aoi'>aoi</span>
612
+ <span class='id identifier rubyid_fetch_paginated_data'>fetch_paginated_data</span><span class='lparen'>(</span>
613
+ <span class='label'>endpoint:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/waterrights/transaction/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
614
+ <span class='label'>query:</span> <span class='id identifier rubyid_query'>query</span>
615
+ <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_water_rights'><span class='object_link'><a href="Parser.html#parse_water_rights-class_method" title="Cdss::Parser.parse_water_rights (method)">parse_water_rights</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:transaction</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
616
+ <span class='kw'>end</span></pre>
617
+ </td>
618
+ </tr>
619
+ </table>
620
+ </div>
621
+
622
+ </div>
623
+
624
+ </div>
625
+
626
+ <div id="footer">
627
+ Generated on Thu Feb 20 21:19:08 2025 by
628
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
629
+ 0.9.37 (ruby-3.2.2).
630
+ </div>
631
+
632
+ </div>
633
+ </body>
634
+ </html>