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/Client.html ADDED
@@ -0,0 +1,581 @@
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
+ Class: Cdss::Client
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::Client";
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 (C)</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">Client</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>Class: Cdss::Client
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Cdss::Client</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+ <dl>
91
+ <dt>Includes:</dt>
92
+ <dd><span class='object_link'><a href="AdminCalls.html" title="Cdss::AdminCalls (module)">AdminCalls</a></span>, <span class='object_link'><a href="Analysis.html" title="Cdss::Analysis (module)">Analysis</a></span>, <span class='object_link'><a href="Climate.html" title="Cdss::Climate (module)">Climate</a></span>, <span class='object_link'><a href="GroundWater.html" title="Cdss::GroundWater (module)">GroundWater</a></span>, <span class='object_link'><a href="ReferenceTables.html" title="Cdss::ReferenceTables (module)">ReferenceTables</a></span>, <span class='object_link'><a href="Structures.html" title="Cdss::Structures (module)">Structures</a></span>, <span class='object_link'><a href="SurfaceWater.html" title="Cdss::SurfaceWater (module)">SurfaceWater</a></span>, <span class='object_link'><a href="Telemetry.html" title="Cdss::Telemetry (module)">Telemetry</a></span>, <span class='object_link'><a href="WaterRights.html" title="Cdss::WaterRights (module)">WaterRights</a></span>, HTTParty</dd>
93
+ </dl>
94
+
95
+
96
+
97
+
98
+
99
+
100
+ <dl>
101
+ <dt>Defined in:</dt>
102
+ <dd>lib/cdss/client.rb</dd>
103
+ </dl>
104
+
105
+ </div>
106
+
107
+ <h2>Overview</h2><div class="docstring">
108
+ <div class="discussion">
109
+
110
+ <p>Main client class for interacting with the CDSS API.</p>
111
+
112
+ <p>The Client class provides access to all CDSS API endpoints and handles authentication, request configuration, and response processing.</p>
113
+
114
+
115
+ </div>
116
+ </div>
117
+ <div class="tags">
118
+
119
+ <div class="examples">
120
+ <h4 class="tag_title">Examples:</h4>
121
+
122
+
123
+ <h5 class="example_title"><div class='inline'>
124
+ <p>Create a new client</p>
125
+ </div></h5>
126
+
127
+ <pre class="example code"><code><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Cdss.html" title="Cdss (module)">Cdss</a></span></span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Cdss::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>your-api-key</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
128
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_climate_stations'>get_climate_stations</span><span class='lparen'>(</span><span class='label'>county:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Denver</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></code></pre>
129
+
130
+ </div>
131
+
132
+
133
+ </div>
134
+
135
+
136
+ <h2>Constant Summary</h2>
137
+
138
+ <h3 class="inherited">Constants included
139
+ from <span class='object_link'><a href="ReferenceTables.html" title="Cdss::ReferenceTables (module)">ReferenceTables</a></span></h3>
140
+ <p class="inherited"><span class='object_link'><a href="ReferenceTables.html#VALID_TABLES-constant" title="Cdss::ReferenceTables::VALID_TABLES (constant)">ReferenceTables::VALID_TABLES</a></span></p>
141
+
142
+
143
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
144
+ <ul class="summary">
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#api_key-instance_method" title="#api_key (instance method)">#<strong>api_key</strong> &#x21d2; String<sup>?</sup> </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'>
167
+ <p>API key for authentication.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; Hash </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+ <span class="note title readonly">readonly</span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+ <span class="summary_desc"><div class='inline'>
196
+ <p>Additional options passed to the client.</p>
197
+ </div></span>
198
+
199
+ </li>
200
+
201
+
202
+ </ul>
203
+
204
+
205
+
206
+
207
+
208
+ <h2>
209
+ Instance Method Summary
210
+ <small><a href="#" class="summary_toggle">collapse</a></small>
211
+ </h2>
212
+
213
+ <ul class="summary">
214
+
215
+ <li class="public ">
216
+ <span class="summary_signature">
217
+
218
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key: nil, **options) &#x21d2; Client </a>
219
+
220
+
221
+
222
+ </span>
223
+
224
+
225
+ <span class="note title constructor">constructor</span>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'>
235
+ <p>Initialize a new CDSS API client.</p>
236
+ </div></span>
237
+
238
+ </li>
239
+
240
+
241
+ </ul>
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="ReferenceTables.html" title="Cdss::ReferenceTables (module)">ReferenceTables</a></span></h3>
254
+ <p class="inherited"><span class='object_link'><a href="ReferenceTables.html#get_reference_table-instance_method" title="Cdss::ReferenceTables#get_reference_table (method)">#get_reference_table</a></span></p>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Utils.html" title="Cdss::Utils (module)">Utils</a></span></h3>
265
+ <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>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="WaterRights.html" title="Cdss::WaterRights (module)">WaterRights</a></span></h3>
276
+ <p class="inherited"><span class='object_link'><a href="WaterRights.html#get_water_rights_net_amounts-instance_method" title="Cdss::WaterRights#get_water_rights_net_amounts (method)">#get_water_rights_net_amounts</a></span>, <span class='object_link'><a href="WaterRights.html#get_water_rights_transactions-instance_method" title="Cdss::WaterRights#get_water_rights_transactions (method)">#get_water_rights_transactions</a></span></p>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Telemetry.html" title="Cdss::Telemetry (module)">Telemetry</a></span></h3>
287
+ <p class="inherited"><span class='object_link'><a href="Telemetry.html#get_telemetry_stations-instance_method" title="Cdss::Telemetry#get_telemetry_stations (method)">#get_telemetry_stations</a></span>, <span class='object_link'><a href="Telemetry.html#get_telemetry_ts-instance_method" title="Cdss::Telemetry#get_telemetry_ts (method)">#get_telemetry_ts</a></span></p>
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="SurfaceWater.html" title="Cdss::SurfaceWater (module)">SurfaceWater</a></span></h3>
298
+ <p class="inherited"><span class='object_link'><a href="SurfaceWater.html#get_sw_stations-instance_method" title="Cdss::SurfaceWater#get_sw_stations (method)">#get_sw_stations</a></span>, <span class='object_link'><a href="SurfaceWater.html#get_sw_ts-instance_method" title="Cdss::SurfaceWater#get_sw_ts (method)">#get_sw_ts</a></span></p>
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Structures.html" title="Cdss::Structures (module)">Structures</a></span></h3>
309
+ <p class="inherited"><span class='object_link'><a href="Structures.html#get_diversion_records_ts-instance_method" title="Cdss::Structures#get_diversion_records_ts (method)">#get_diversion_records_ts</a></span>, <span class='object_link'><a href="Structures.html#get_stage_volume_ts-instance_method" title="Cdss::Structures#get_stage_volume_ts (method)">#get_stage_volume_ts</a></span>, <span class='object_link'><a href="Structures.html#get_structures-instance_method" title="Cdss::Structures#get_structures (method)">#get_structures</a></span>, <span class='object_link'><a href="Structures.html#get_water_classes-instance_method" title="Cdss::Structures#get_water_classes (method)">#get_water_classes</a></span></p>
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="GroundWater.html" title="Cdss::GroundWater (module)">GroundWater</a></span></h3>
320
+ <p class="inherited"><span class='object_link'><a href="GroundWater.html#get_geophysical_log_picks-instance_method" title="Cdss::GroundWater#get_geophysical_log_picks (method)">#get_geophysical_log_picks</a></span>, <span class='object_link'><a href="GroundWater.html#get_geophysical_log_wells-instance_method" title="Cdss::GroundWater#get_geophysical_log_wells (method)">#get_geophysical_log_wells</a></span>, <span class='object_link'><a href="GroundWater.html#get_water_level_wells-instance_method" title="Cdss::GroundWater#get_water_level_wells (method)">#get_water_level_wells</a></span>, <span class='object_link'><a href="GroundWater.html#get_well_measurements-instance_method" title="Cdss::GroundWater#get_well_measurements (method)">#get_well_measurements</a></span></p>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Climate.html" title="Cdss::Climate (module)">Climate</a></span></h3>
331
+ <p class="inherited"><span class='object_link'><a href="Climate.html#get_climate_frost_dates-instance_method" title="Cdss::Climate#get_climate_frost_dates (method)">#get_climate_frost_dates</a></span>, <span class='object_link'><a href="Climate.html#get_climate_stations-instance_method" title="Cdss::Climate#get_climate_stations (method)">#get_climate_stations</a></span>, <span class='object_link'><a href="Climate.html#get_climate_ts-instance_method" title="Cdss::Climate#get_climate_ts (method)">#get_climate_ts</a></span>, <span class='object_link'><a href="Climate.html#get_climate_ts_day-instance_method" title="Cdss::Climate#get_climate_ts_day (method)">#get_climate_ts_day</a></span>, <span class='object_link'><a href="Climate.html#get_climate_ts_month-instance_method" title="Cdss::Climate#get_climate_ts_month (method)">#get_climate_ts_month</a></span></p>
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Analysis.html" title="Cdss::Analysis (module)">Analysis</a></span></h3>
342
+ <p class="inherited"><span class='object_link'><a href="Analysis.html#get_call_analysis_gnisid-instance_method" title="Cdss::Analysis#get_call_analysis_gnisid (method)">#get_call_analysis_gnisid</a></span>, <span class='object_link'><a href="Analysis.html#get_call_analysis_wdid-instance_method" title="Cdss::Analysis#get_call_analysis_wdid (method)">#get_call_analysis_wdid</a></span>, <span class='object_link'><a href="Analysis.html#get_source_route_analysis-instance_method" title="Cdss::Analysis#get_source_route_analysis (method)">#get_source_route_analysis</a></span>, <span class='object_link'><a href="Analysis.html#get_source_route_framework-instance_method" title="Cdss::Analysis#get_source_route_framework (method)">#get_source_route_framework</a></span></p>
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="AdminCalls.html" title="Cdss::AdminCalls (module)">AdminCalls</a></span></h3>
353
+ <p class="inherited"><span class='object_link'><a href="AdminCalls.html#get_admin_calls-instance_method" title="Cdss::AdminCalls#get_admin_calls (method)">#get_admin_calls</a></span></p>
354
+
355
+ <div id="constructor_details" class="method_details_list">
356
+ <h2>Constructor Details</h2>
357
+
358
+ <div class="method_details first">
359
+ <h3 class="signature first" id="initialize-instance_method">
360
+
361
+ #<strong>initialize</strong>(api_key: nil, **options) &#x21d2; <tt><span class='object_link'><a href="" title="Cdss::Client (class)">Client</a></span></tt>
362
+
363
+
364
+
365
+
366
+
367
+ </h3><div class="docstring">
368
+ <div class="discussion">
369
+
370
+ <p>Initialize a new CDSS API client.</p>
371
+
372
+
373
+ </div>
374
+ </div>
375
+ <div class="tags">
376
+ <p class="tag_title">Parameters:</p>
377
+ <ul class="param">
378
+
379
+ <li>
380
+
381
+ <span class='name'>api_key</span>
382
+
383
+
384
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
385
+
386
+
387
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
388
+
389
+
390
+ &mdash;
391
+ <div class='inline'>
392
+ <p>API key for authentication</p>
393
+ </div>
394
+
395
+ </li>
396
+
397
+ <li>
398
+
399
+ <span class='name'>options</span>
400
+
401
+
402
+ <span class='type'>(<tt>Hash</tt>)</span>
403
+
404
+
405
+
406
+ &mdash;
407
+ <div class='inline'>
408
+ <p>Additional options for configuring the client</p>
409
+ </div>
410
+
411
+ </li>
412
+
413
+ </ul>
414
+
415
+
416
+ </div><table class="source_code">
417
+ <tr>
418
+ <td>
419
+ <pre class="lines">
420
+
421
+
422
+ 37
423
+ 38
424
+ 39
425
+ 40
426
+ 41</pre>
427
+ </td>
428
+ <td>
429
+ <pre class="code"><span class="info file"># File 'lib/cdss/client.rb', line 37</span>
430
+
431
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
432
+ <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span>
433
+ <span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_api_key'>api_key</span>
434
+ <span class='id identifier rubyid_setup_client'>setup_client</span>
435
+ <span class='kw'>end</span></pre>
436
+ </td>
437
+ </tr>
438
+ </table>
439
+ </div>
440
+
441
+ </div>
442
+
443
+ <div id="instance_attr_details" class="attr_details">
444
+ <h2>Instance Attribute Details</h2>
445
+
446
+
447
+ <span id="api_key=-instance_method"></span>
448
+ <div class="method_details first">
449
+ <h3 class="signature first" id="api_key-instance_method">
450
+
451
+ #<strong>api_key</strong> &#x21d2; <tt>String</tt><sup>?</sup>
452
+
453
+
454
+
455
+
456
+
457
+ </h3><div class="docstring">
458
+ <div class="discussion">
459
+
460
+ <p>Returns API key for authentication.</p>
461
+
462
+
463
+ </div>
464
+ </div>
465
+ <div class="tags">
466
+
467
+ <p class="tag_title">Returns:</p>
468
+ <ul class="return">
469
+
470
+ <li>
471
+
472
+
473
+ <span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
474
+
475
+
476
+
477
+ &mdash;
478
+ <div class='inline'>
479
+ <p>API key for authentication</p>
480
+ </div>
481
+
482
+ </li>
483
+
484
+ </ul>
485
+
486
+ </div><table class="source_code">
487
+ <tr>
488
+ <td>
489
+ <pre class="lines">
490
+
491
+
492
+ 30
493
+ 31
494
+ 32</pre>
495
+ </td>
496
+ <td>
497
+ <pre class="code"><span class="info file"># File 'lib/cdss/client.rb', line 30</span>
498
+
499
+ <span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
500
+ <span class='ivar'>@api_key</span>
501
+ <span class='kw'>end</span></pre>
502
+ </td>
503
+ </tr>
504
+ </table>
505
+ </div>
506
+
507
+
508
+ <span id=""></span>
509
+ <div class="method_details ">
510
+ <h3 class="signature " id="options-instance_method">
511
+
512
+ #<strong>options</strong> &#x21d2; <tt>Hash</tt> <span class="extras">(readonly)</span>
513
+
514
+
515
+
516
+
517
+
518
+ </h3><div class="docstring">
519
+ <div class="discussion">
520
+
521
+ <p>Returns Additional options passed to the client.</p>
522
+
523
+
524
+ </div>
525
+ </div>
526
+ <div class="tags">
527
+
528
+ <p class="tag_title">Returns:</p>
529
+ <ul class="return">
530
+
531
+ <li>
532
+
533
+
534
+ <span class='type'>(<tt>Hash</tt>)</span>
535
+
536
+
537
+
538
+ &mdash;
539
+ <div class='inline'>
540
+ <p>Additional options passed to the client</p>
541
+ </div>
542
+
543
+ </li>
544
+
545
+ </ul>
546
+
547
+ </div><table class="source_code">
548
+ <tr>
549
+ <td>
550
+ <pre class="lines">
551
+
552
+
553
+ 27
554
+ 28
555
+ 29</pre>
556
+ </td>
557
+ <td>
558
+ <pre class="code"><span class="info file"># File 'lib/cdss/client.rb', line 27</span>
559
+
560
+ <span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
561
+ <span class='ivar'>@options</span>
562
+ <span class='kw'>end</span></pre>
563
+ </td>
564
+ </tr>
565
+ </table>
566
+ </div>
567
+
568
+ </div>
569
+
570
+
571
+ </div>
572
+
573
+ <div id="footer">
574
+ Generated on Thu Feb 20 21:19:08 2025 by
575
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
576
+ 0.9.37 (ruby-3.2.2).
577
+ </div>
578
+
579
+ </div>
580
+ </body>
581
+ </html>