RubyGems - cdss-ruby - Versions diffs - 0.1.0 - Mend

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

checksums.yaml +7 -0
data/.rubocop.yml +86 -0
data/CHANGELOG.md +5 -0
data/CODE_OF_CONDUCT.md +84 -0
data/README.md +101 -0
data/Rakefile +26 -0
data/docs/Cdss/AdminCalls.html +399 -0
data/docs/Cdss/Analysis.html +972 -0
data/docs/Cdss/Client.html +581 -0
data/docs/Cdss/Climate.html +1257 -0
data/docs/Cdss/Concerns/LogReadingAttributes.html +406 -0
data/docs/Cdss/Concerns/WellReadingAttributes.html +414 -0
data/docs/Cdss/Concerns.html +117 -0
data/docs/Cdss/GroundWater.html +945 -0
data/docs/Cdss/Models/AdminCall.html +252 -0
data/docs/Cdss/Models/Analysis.html +397 -0
data/docs/Cdss/Models/CallAnalysis.html +140 -0
data/docs/Cdss/Models/ClimateStation.html +249 -0
data/docs/Cdss/Models/DiversionRecord.html +248 -0
data/docs/Cdss/Models/Reading.html +301 -0
data/docs/Cdss/Models/ReferenceTable.html +339 -0
data/docs/Cdss/Models/RouteAnalysis.html +140 -0
data/docs/Cdss/Models/SourceRoute.html +140 -0
data/docs/Cdss/Models/Station.html +248 -0
data/docs/Cdss/Models/Structure.html +259 -0
data/docs/Cdss/Models/WaterClass.html +249 -0
data/docs/Cdss/Models/WaterRight.html +255 -0
data/docs/Cdss/Models/Well.html +251 -0
data/docs/Cdss/Models.html +117 -0
data/docs/Cdss/Parser.html +2155 -0
data/docs/Cdss/Parsers/AdminCallsParser.html +201 -0
data/docs/Cdss/Parsers/AnalysisParser.html +296 -0
data/docs/Cdss/Parsers/BaseParser.html +207 -0
data/docs/Cdss/Parsers/ClimateParser.html +253 -0
data/docs/Cdss/Parsers/ReadingParser.html +201 -0
data/docs/Cdss/Parsers/ReferenceTablesParser.html +201 -0
data/docs/Cdss/Parsers/StationParser.html +201 -0
data/docs/Cdss/Parsers/StructuresParser.html +305 -0
data/docs/Cdss/Parsers/WaterRightsParser.html +219 -0
data/docs/Cdss/Parsers/WellParser.html +357 -0
data/docs/Cdss/Parsers.html +117 -0
data/docs/Cdss/ReferenceTables.html +332 -0
data/docs/Cdss/Structures.html +1132 -0
data/docs/Cdss/SurfaceWater.html +798 -0
data/docs/Cdss/Telemetry.html +763 -0
data/docs/Cdss/Utils.html +1276 -0
data/docs/Cdss/WaterRights.html +634 -0
data/docs/Cdss.html +292 -0
data/docs/_index.html +493 -0
data/docs/class_list.html +54 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +503 -0
data/docs/file.README.html +108 -0
data/docs/file_list.html +59 -0
data/docs/frames.html +22 -0
data/docs/index.html +108 -0
data/docs/js/app.js +344 -0
data/docs/js/full_list.js +242 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +790 -0
data/docs/top-level-namespace.html +110 -0
data/lib/cdss/admin_calls.rb +44 -0
data/lib/cdss/analysis.rb +183 -0
data/lib/cdss/client.rb +121 -0
data/lib/cdss/climate.rb +155 -0
data/lib/cdss/concerns/log_reading_attributes.rb +48 -0
data/lib/cdss/concerns/well_reading_attributes.rb +56 -0
data/lib/cdss/ground_water.rb +112 -0
data/lib/cdss/models/admin_call.rb +45 -0
data/lib/cdss/models/analysis.rb +77 -0
data/lib/cdss/models/climate_station.rb +40 -0
data/lib/cdss/models/reading.rb +54 -0
data/lib/cdss/models/reference_table.rb +56 -0
data/lib/cdss/models/station.rb +40 -0
data/lib/cdss/models/structure.rb +101 -0
data/lib/cdss/models/water_right.rb +47 -0
data/lib/cdss/models/well.rb +43 -0
data/lib/cdss/parser.rb +172 -0
data/lib/cdss/parsers/admin_calls_parser.rb +47 -0
data/lib/cdss/parsers/analysis_parser.rb +124 -0
data/lib/cdss/parsers/base_parser.rb +18 -0
data/lib/cdss/parsers/climate_parser.rb +86 -0
data/lib/cdss/parsers/reading_parser.rb +90 -0
data/lib/cdss/parsers/reference_tables_parser.rb +55 -0
data/lib/cdss/parsers/station_parser.rb +42 -0
data/lib/cdss/parsers/structures_parser.rb +96 -0
data/lib/cdss/parsers/water_rights_parser.rb +77 -0
data/lib/cdss/parsers/well_parser.rb +107 -0
data/lib/cdss/reference_tables.rb +147 -0
data/lib/cdss/structures.rb +235 -0
data/lib/cdss/surface_water.rb +186 -0
data/lib/cdss/telemetry.rb +98 -0
data/lib/cdss/utils.rb +152 -0
data/lib/cdss/version.rb +5 -0
data/lib/cdss/water_rights.rb +95 -0
data/lib/cdss.rb +27 -0
data/sig/cdss/ruby.rbs +6 -0
metadata +272 -0

data/docs/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.37
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Cdss.html" title="Cdss (module)">Cdss</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Thu Feb 20 21:19:08 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.2.2).
+</div>
+    </div>
+  </body>
+</html>

data/lib/cdss/admin_calls.rb ADDED Viewed

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Cdss
+  # Provides methods for accessing administrative calls data from the CDSS API.
+  #
+  # This module includes functionality for retrieving active and historical administrative
+  # calls based on various criteria such as division, location, and date ranges.
+  module AdminCalls
+    include Utils
+    # Fetches administrative calls based on various filtering criteria.
+    #
+    # @param [Integer, nil] division Water division to filter calls.
+    # @param [String, nil] location_wdid WDID of the call location structure.
+    # @param [Integer, nil] call_number Unique call identifier to query.
+    # @param [Date, nil] start_date Start date for calls data.
+    # @param [Date, nil] end_date End date for calls data.
+    # @param [Boolean] active Whether to fetch active (true) or historical (false) calls. Defaults to true.
+    # @return [Array<AdminCall>] Array of matching administrative call objects.
+    # @example Fetch active calls for a division
+    #   get_admin_calls(division: 1, active: true)
+    def get_admin_calls(division: nil, location_wdid: nil, call_number: nil, start_date: nil, end_date: nil,
+                        active: true)
+      query = build_query(
+        {
+          dateFormat: "spaceSepToSeconds",
+          division: division,
+          callNumber: call_number,
+          "min-dateTimeSet": format_date(start_date),
+          "max-dateTimeSet": format_date(end_date),
+          locationWdid: location_wdid
+        },
+        encode: true
+      )
+      endpoint = active ? "administrativecalls/active/" : "administrativecalls/historical/"
+      fetch_paginated_data(
+        endpoint: "/#{endpoint}",
+        query: query
+      ) { |data| Parser.parse_admin_calls(data) }
+    end
+  end
+end

data/lib/cdss/analysis.rb ADDED Viewed

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+module Cdss
+  # Provides methods for accessing analysis services from the CDSS API including
+  # call analysis and water source route frameworks.
+  module Analysis
+    include Utils
+    # Performs call analysis by WDID, showing daily priority percentages.
+    #
+    # @param [String] wdid DWR WDID unique structure identifier code.
+    # @param [String, Integer] admin_no Water Right Administration Number.
+    # @param [Date, nil] start_date Start date for analysis data.
+    # @param [Date, nil] end_date End date for analysis data.
+    # @param [Boolean] batch Whether to break date range into yearly batches. Defaults to false.
+    # @return [Array<CallAnalysis>] Array of call analysis records.
+    # @example Analyze calls for a specific WDID
+    #   get_call_analysis_wdid(wdid: "0301234", admin_no: "12345.00000")
+    def get_call_analysis_wdid(wdid:, admin_no:, start_date: nil, end_date: nil, batch: false)
+      admin_no = admin_no.to_s
+      if batch
+        results = []
+        date_ranges = batch_dates(start_date, end_date)
+        date_ranges.each_with_index do |range, _index|
+          results.concat(
+            fetch_call_analysis_wdid(
+              wdid: wdid,
+              admin_no: admin_no,
+              start_date: range[0],
+              end_date: range[1]
+            )
+          )
+        end
+        results
+      else
+        fetch_call_analysis_wdid(
+          wdid: wdid,
+          admin_no: admin_no,
+          start_date: start_date,
+          end_date: end_date
+        )
+      end
+    end
+    # Performs call analysis by GNIS ID, showing daily priority percentages.
+    #
+    # @param [String] gnis_id GNIS ID to analyze.
+    # @param [String, Integer] admin_no Water Right Administration Number.
+    # @param [Float] stream_mile Stream mile for the analysis point.
+    # @param [Date, nil] start_date Start date for analysis data.
+    # @param [Date, nil] end_date End date for analysis data.
+    # @param [Boolean] batch Whether to break date range into yearly batches. Defaults to false.
+    # @return [Array<CallAnalysis>] Array of call analysis records.
+    def get_call_analysis_gnisid(gnis_id:, admin_no:, stream_mile:, start_date: nil, end_date: nil, batch: false)
+      admin_no = admin_no.to_s
+      if batch
+        results = []
+        date_ranges = batch_dates(start_date, end_date)
+        date_ranges.each_with_index do |range, _index|
+          results.concat(
+            fetch_call_analysis_gnisid(
+              gnis_id: gnis_id,
+              admin_no: admin_no,
+              stream_mile: stream_mile,
+              start_date: range[0],
+              end_date: range[1]
+            )
+          )
+        end
+        results
+      else
+        fetch_call_analysis_gnisid(
+          gnis_id: gnis_id,
+          admin_no: admin_no,
+          stream_mile: stream_mile,
+          start_date: start_date,
+          end_date: end_date
+        )
+      end
+    end
+    # Retrieves the DWR source route framework reference data.
+    #
+    # @param [Integer, nil] division Water division to filter by.
+    # @param [String, nil] gnis_name GNIS Name to filter by.
+    # @param [Integer, nil] water_district Water district to filter by.
+    # @return [Array<SourceRoute>] Array of source route framework records.
+    def get_source_route_framework(division: nil, gnis_name: nil, water_district: nil)
+      query = build_query(
+        {
+          dateFormat: "spaceSepToSeconds",
+          division: division,
+          gnisName: gnis_name,
+          waterDistrict: water_district
+        }
+      )
+      fetch_paginated_data(
+        endpoint: "/analysisservices/watersourcerouteframework/",
+        query: query
+      ) { |data| Parser.parse_source_routes(data) }
+    end
+    # Analyzes water source routes between two points.
+    #
+    # @param [String] lt_gnis_id Lower terminus GNIS ID.
+    # @param [Float] lt_stream_mile Lower terminus stream mile.
+    # @param [String] ut_gnis_id Upper terminus GNIS ID.
+    # @param [Float] ut_stream_mile Upper terminus stream mile.
+    # @return [Array<RouteAnalysis>] Array of route analysis records.
+    def get_source_route_analysis(lt_gnis_id:, lt_stream_mile:, ut_gnis_id:, ut_stream_mile:)
+      query = build_query(
+        {
+          ltGnisId: lt_gnis_id,
+          ltStreamMile: lt_stream_mile,
+          utGnisId: ut_gnis_id,
+          utStreamMile: ut_stream_mile
+        }
+      )
+      fetch_paginated_data(
+        endpoint: "/analysisservices/watersourcerouteanalysis/",
+        query: query
+      ) { |data| Parser.parse_route_analyses(data) }
+    end
+    private
+    # Fetches call analysis data for a specific WDID.
+    #
+    # @param [String] wdid WDID to analyze
+    # @param [String] admin_no Water Right Administration Number
+    # @param [Date, nil] start_date Start date for analysis data
+    # @param [Date, nil] end_date End date for analysis data
+    # @return [Array<CallAnalysis>] Array of call analysis records
+    def fetch_call_analysis_wdid(wdid:, admin_no:, start_date:, end_date:)
+      query = build_query(
+        {
+          wdid: wdid,
+          adminNo: admin_no,
+          startDate: format_date(start_date),
+          endDate: format_date(end_date)
+        }
+      )
+      fetch_paginated_data(
+        endpoint: "/analysisservices/callanalysisbywdid/",
+        query: query
+      ) { |data| Parser.parse_call_analyses(data, type: :wdid) }
+    end
+    # Fetches call analysis data for a specific GNIS ID and stream mile.
+    #
+    # @param [String] gnis_id GNIS ID to analyze
+    # @param [String] admin_no Water Right Administration Number
+    # @param [Float] stream_mile Stream mile for the analysis point
+    # @param [Date, nil] start_date Start date for analysis data
+    # @param [Date, nil] end_date End date for analysis data
+    # @return [Array<CallAnalysis>] Array of call analysis records
+    def fetch_call_analysis_gnisid(gnis_id:, admin_no:, stream_mile:, start_date:, end_date:)
+      query = build_query(
+        {
+          gnisId: gnis_id,
+          adminNo: admin_no,
+          streamMile: stream_mile,
+          startDate: format_date(start_date),
+          endDate: format_date(end_date)
+        }
+      )
+      fetch_paginated_data(
+        endpoint: "/analysisservices/callanalysisbygnisid/",
+        query: query
+      ) { |data| Parser.parse_call_analyses(data, type: :gnis) }
+    end
+  end
+end

data/lib/cdss/client.rb ADDED Viewed

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+module Cdss
+  # Main client class for interacting with the CDSS API.
+  #
+  # The Client class provides access to all CDSS API endpoints and handles authentication,
+  # request configuration, and response processing.
+  #
+  # @example Create a new client
+  #   client = Cdss::Client.new(api_key: "your-api-key")
+  #   client.get_climate_stations(county: "Denver")
+  class Client
+    include HTTParty
+    base_uri Cdss.config.base_url
+    include AdminCalls
+    include Analysis
+    include Climate
+    include GroundWater
+    include Structures
+    include SurfaceWater
+    include Telemetry
+    include WaterRights
+    include ReferenceTables
+    # @return [Hash] Additional options passed to the client
+    attr_reader :options
+    # @return [String, nil] API key for authentication
+    attr_reader :api_key
+    # Initialize a new CDSS API client.
+    #
+    # @param [String, nil] api_key API key for authentication
+    # @param [Hash] options Additional options for configuring the client
+    # @return [Client] New client instance
+    def initialize(api_key: nil, **options)
+      @options = options
+      @api_key = api_key
+      setup_client
+    end
+    # Update the client's API key.
+    #
+    # @param [String] key New API key
+    # @return [String] The new API key
+    def api_key=(key)
+      @api_key = key
+      setup_client
+    end
+    private
+    # Configures the HTTP client with timeout and authorization headers.
+    # Sets the User-Agent and API token if provided.
+    #
+    # @return [void]
+    def setup_client
+      self.class.default_timeout(Cdss.config.timeout)
+      self.class.headers({
+        "User-Agent" => Cdss.config.user_agent,
+        "Token" => api_key
+      }.compact)
+    end
+    # Processes API responses and handles error conditions.
+    #
+    # @param [HTTParty::Response] response The raw API response
+    # @return [Hash] Parsed JSON response body
+    # @raise [RuntimeError] When the API request fails
+    def handle_response(response)
+      return JSON.parse(response.body) if response.success?
+      raise "API request failed with status #{response.code}: #{response.message}"
+    end
+    # Makes GET requests with debug logging support.
+    #
+    # @param [Array] args The request arguments including path and options
+    # @return [HTTParty::Response] The API response
+    def self.get(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      debug_request(args.first, options)
+      super(*args, options)
+    end
+    # Makes authenticated GET requests to the API.
+    #
+    # @param [String] path The API endpoint path
+    # @param [Hash] options Request options including query parameters
+    # @return [HTTParty::Response] The API response
+    def get(path, options = {})
+      options[:query] ||= {}
+      options[:query][:apiKey] = api_key if api_key
+      self.class.get(path, options)
+    end
+    # Logs detailed request information when debug mode is enabled.
+    #
+    # @param [String] endpoint The API endpoint being called
+    # @param [Hash] options Request options including query parameters and headers
+    # @return [void]
+    def self.debug_request(endpoint, options)
+      return unless Cdss.config.debug
+      query_string = options[:query]&.map { |k, v| "#{k}=#{v}" }&.join("&")
+      full_url = [base_uri, endpoint].join
+      full_url += "?#{query_string}" if query_string
+      puts "\n=== CDSS API Request ==="
+      puts "URL: #{full_url}"
+      puts "\nHeaders:"
+      headers = default_options[:headers] || {}
+      headers.merge!(options[:headers] || {})
+      headers.each do |key, value|
+        puts "  #{key}: #{value}"
+      end
+      puts "=====================\n"
+    end
+  end
+end

data/lib/cdss/climate.rb ADDED Viewed

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+module Cdss
+  # Provides methods for accessing climate data from the CDSS API.
+  #
+  # This module includes functionality for retrieving climate stations,
+  # frost dates, and time series data at various time scales.
+  module Climate
+    include Utils
+    # Fetches climate stations based on various filtering criteria.
+    #
+    # @param [Hash, Array, nil] aoi Area of interest for spatial searches. If hash, must contain :latitude and :longitude keys.
+    #   If array, must contain [longitude, latitude].
+    # @param [Integer, nil] radius Radius in miles for spatial search around aoi. Defaults to 20 if aoi is provided.
+    # @param [String, nil] county County name to filter stations.
+    # @param [Integer, nil] division Water division number to filter stations.
+    # @param [String, nil] station_name Name of the station to filter by.
+    # @param [String, nil] site_id Station site ID to filter by.
+    # @param [Integer, nil] water_district Water district number to filter stations.
+    # @return [Array<Station>] Array of matching climate station objects.
+    # @raise [ArgumentError] If aoi parameter is provided but invalid.
+    # @example Fetch stations in Denver county
+    #   get_climate_stations(county: 'Denver')
+    def get_climate_stations(aoi: nil, radius: nil, county: nil, division: nil, station_name: nil, site_id: nil,
+                             water_district: nil)
+      query_params = {
+        dateFormat: "spaceSepToSeconds",
+        units: "miles",
+        county: county,
+        division: division,
+        stationName: station_name,
+        siteId: site_id,
+        waterDistrict: water_district
+      }
+      if aoi
+        if aoi.is_a?(Hash) && aoi[:latitude] && aoi[:longitude]
+          query_params.merge!(longitude: aoi[:longitude], latitude: aoi[:latitude])
+        elsif aoi.is_a?(Array) && aoi.count == 2
+          query_params.merge!(longitude: aoi[0], latitude: aoi[1])
+        else
+          raise ArgumentError, "Invalid 'aoi' parameter"
+        end
+        query_params[:radius] = radius || 20
+      end
+      fetch_paginated_data(
+        endpoint: "/climatedata/climatestations/",
+        query: query_params
+      ) { |data| Parser.parse_climate_stations(data) }
+    end
+    # Fetches frost dates for a specific climate station.
+    #
+    # @param [String] station_number Station number to fetch frost dates for.
+    # @param [Date, nil] start_date Start date for frost dates data.
+    # @param [Date, nil] end_date End date for frost dates data.
+    # @return [Array<Reading>] Array of frost date readings.
+    def get_climate_frost_dates(station_number:, start_date: nil, end_date: nil)
+      query_params = {
+        dateFormat: "spaceSepToSeconds",
+        stationNum: station_number
+      }
+      query_params[:"min-calYear"] = start_date.strftime("%Y") if start_date
+      query_params[:"max-calYear"] = end_date.strftime("%Y") if end_date
+      fetch_paginated_data(
+        endpoint: "/climatedata/climatestationfrostdates/",
+        query: query_params
+      ) { |data| Parser.parse_climate_readings(data, type: :frost_dates) }
+    end
+    # Fetches daily climate time series data.
+    #
+    # @param [String] param Climate parameter type to retrieve
+    # @param [String, nil] station_number Station number
+    # @param [String, nil] site_id Site ID
+    # @param [Date, nil] start_date Start date for time series data
+    # @param [Date, nil] end_date End date for time series data
+    # @return [Array<Reading>] Array of daily climate readings
+    def get_climate_ts_day(param:, station_number: nil, site_id: nil, start_date: nil, end_date: nil)
+      query_params = {
+        dateFormat: "spaceSepToSeconds",
+        measType: param,
+        stationNum: station_number,
+        siteId: site_id
+      }
+      query_params[:"min-measDate"] = start_date.strftime("%m-%d-%Y") if start_date
+      query_params[:"max-measDate"] = end_date.strftime("%m-%d-%Y") if end_date
+      fetch_paginated_data(
+        endpoint: "/climatedata/climatestationtsday/",
+        query: query_params
+      ) { |data| Parser.parse_climate_readings(data, type: :daily) }
+    end
+    # Fetches monthly climate time series data.
+    #
+    # @param [String] param Climate parameter type to retrieve
+    # @param [String, nil] station_number Station number
+    # @param [String, nil] site_id Site ID
+    # @param [Date, nil] start_date Start date for time series data
+    # @param [Date, nil] end_date End date for time series data
+    # @return [Array<Reading>] Array of monthly climate readings
+    def get_climate_ts_month(param:, station_number: nil, site_id: nil, start_date: nil, end_date: nil)
+      query_params = {
+        dateFormat: "spaceSepToSeconds",
+        measType: param,
+        stationNum: station_number,
+        siteId: site_id
+      }
+      query_params[:"min-calYear"] = start_date.strftime("%Y") if start_date
+      query_params[:"max-calYear"] = end_date.strftime("%Y") if end_date
+      fetch_paginated_data(
+        endpoint: "/climatedata/climatestationtsmonth/",
+        query: query_params
+      ) { |data| Parser.parse_climate_readings(data, type: :monthly) }
+    end
+    # Fetches climate time series data for specified stations.
+    #
+    # @param [String, nil] station_number Station number
+    # @param [String, nil] site_id Site ID
+    # @param [String] param Climate parameter to retrieve (Evap, FrostDate, MaxTemp, etc.)
+    # @param [Date, nil] start_date Start date for time series data
+    # @param [Date, nil] end_date End date for time series data
+    # @param [String] timescale Time interval for data aggregation ('day' or 'month'). Defaults to 'day'
+    # @return [Array<Reading>] Array of time series reading objects
+    # @raise [ArgumentError] If an invalid parameter or timescale is provided
+    def get_climate_ts(station_number: nil, site_id: nil, param: nil, start_date: nil, end_date: nil, timescale: "day")
+      valid_params = %w[Evap FrostDate MaxTemp MeanTemp MinTemp Precip Snow SnowDepth SnowSWE Solar VP Wind]
+      raise ArgumentError, "Invalid parameter: '#{param}'. Valid values are: #{valid_params.join(', ')}" unless valid_params.include?(param)
+      day_formats = %w[day days daily d]
+      month_formats = %w[month months monthly mon m]
+      timescale = timescale.to_s.downcase
+      case timescale
+      when *day_formats
+        get_climate_ts_day(station_number: station_number, site_id: site_id, param: param,
+                           start_date: start_date, end_date: end_date)
+      when *month_formats
+        get_climate_ts_month(station_number: station_number, site_id: site_id, param: param,
+                             start_date: start_date, end_date: end_date)
+      else
+        raise ArgumentError, "Invalid timescale: '#{timescale}'. Use 'day' or 'month'."
+      end
+    end
+  end
+end

data/lib/cdss/concerns/log_reading_attributes.rb ADDED Viewed

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module Cdss
+  module Concerns
+    # A concern module that adds log reading-related attributes to classes.
+    #
+    # This module provides a set of standardized attributes for log reading data,
+    # including aquifer information, depth measurements, elevation, and comments.
+    # When included in a class, it dynamically adds accessor methods for these attributes.
+    #
+    # @example Adding log reading attributes to a class
+    #   class WellLog
+    #     include Cdss::Concerns::LogReadingAttributes
+    #   end
+    module LogReadingAttributes
+      # Predefined list of log reading attributes
+      #
+      # @return [Array<Symbol>] List of attributes related to log readings
+      LOG_ATTRIBUTES = %i[
+        aquifer
+        g_log_top_depth
+        g_log_base_depth
+        g_log_top_elev
+        g_log_base_elev
+        g_log_thickness
+        comment
+      ].freeze
+      # Dynamically adds accessor methods when the module is included in a class
+      #
+      # @param [Class] base The class including this module
+      def self.included(base)
+        base.class_eval do
+          attr_accessor(*LOG_ATTRIBUTES)
+        end
+      end
+      # Checks if the instance has log reading data
+      #
+      # @return [Boolean] true if aquifer or log thickness is present, false otherwise
+      # @example Check if a well log has reading data
+      #   well_log.log_reading? # => true or false
+      def log_reading?
+        !aquifer.nil? || !g_log_thickness.nil?
+      end
+    end
+  end
+end