cdss-ruby 0.1.0

data/lib/cdss/concerns/well_reading_attributes.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Concerns
+    # A concern module that adds well reading-related attributes to classes.
+    #
+    # This module provides a comprehensive set of standardized attributes for well reading data,
+    # including identification, location, measurement, and publication information.
+    # When included in a class, it dynamically adds accessor methods for these attributes.
+    #
+    # @example Adding well reading attributes to a class
+    #   class WellReading
+    #     include Cdss::Concerns::WellReadingAttributes
+    #   end
+    module WellReadingAttributes
+      # Predefined list of well reading attributes
+      #
+      # @return [Array<Symbol>] List of attributes related to well readings
+      WELL_ATTRIBUTES = %i[
+        well_id
+        well_name
+        division
+        water_district
+        county
+        management_district
+        designated_basin
+        publication
+        depth_to_water
+        measuring_point_above_land_surface
+        measurement_date
+        depth_water_below_land_surface
+        elevation_of_water
+        delta
+        published
+      ].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(*WELL_ATTRIBUTES)
+        end
+      end
+
+      # Checks if the instance has a valid well reading
+      #
+      # @return [Boolean] true if a well ID is present, false otherwise
+      # @example Check if a well reading is valid
+      #   well_reading.well_reading? # => true or false
+      def well_reading?
+        !well_id.nil?
+      end
+    end
+  end
+end

data/lib/cdss/ground_water.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Cdss
+  module GroundWater
+    include Utils
+
+    # Fetches groundwater water level wells based on filters.
+    #
+    # @param [String, nil] county County to filter wells
+    # @param [String, nil] designated_basin Designated basin to filter wells
+    # @param [Integer, nil] division Division to filter wells
+    # @param [String, nil] management_district Management district to filter wells
+    # @param [Integer, nil] water_district Water district number to filter wells
+    # @param [String, nil] wellid Well ID to filter specific well
+    # @return [Array<Well>] An array of groundwater well objects
+    # @example Fetch wells in Denver county
+    #   client.get_water_level_wells(county: 'Denver')
+    def get_water_level_wells(county: nil, designated_basin: nil, division: nil, management_district: nil,
+                              water_district: nil, wellid: nil)
+      query = {
+        format: "json",
+        dateFormat: "spaceSepToSeconds",
+        county: county&.upcase&.gsub(" ", "+"),
+        designatedBasin: designated_basin&.upcase&.gsub(" ", "+"),
+        division: division,
+        managementDistrict: management_district&.upcase&.gsub(" ", "+"),
+        waterDistrict: water_district,
+        wellId: wellid
+      }
+
+      fetch_paginated_data(
+        endpoint: "/groundwater/waterlevels/wells/",
+        query: query
+      ) { |data| Parser.parse_wells(data) }
+    end
+
+    # Fetches water level measurements for a specific well
+    #
+    # @param [String] wellid Well ID to fetch measurements for
+    # @param [Date, nil] start_date Start date for the data range
+    # @param [Date, nil] end_date End date for the data range
+    # @return [Array<Reading>] An array of water level measurements
+    # @example Fetch measurements for a specific well
+    #   client.get_well_measurements(wellid: '1234', start_date: Date.parse('2021-01-01'))
+    def get_well_measurements(wellid:, start_date: nil, end_date: nil)
+      query = {
+        format: "json",
+        dateFormat: "spaceSepToSeconds",
+        wellId: wellid,
+        "min-measurementDate": start_date&.strftime("%m-%d-%Y"),
+        "max-measurementDate": end_date&.strftime("%m-%d-%Y")
+      }
+
+      fetch_paginated_data(
+        endpoint: "/groundwater/waterlevels/wellmeasurements/",
+        query: query
+      ) { |data| Parser.parse_well_measurements(data) }
+    end
+
+    # Fetches groundwater geophysical log wells based on filters
+    #
+    # @param [String, nil] county County to filter wells
+    # @param [String, nil] designated_basin Designated basin to filter wells
+    # @param [Integer, nil] division Division to filter wells
+    # @param [String, nil] management_district Management district to filter wells
+    # @param [Integer, nil] water_district Water district number to filter wells
+    # @param [String, nil] wellid Well ID to filter specific well
+    # @return [Array<Well>] An array of geophysical log well objects
+    # @example Fetch geophysical log wells in Denver county
+    #   client.get_geophysical_log_wells(county: 'Denver')
+    def get_geophysical_log_wells(county: nil, designated_basin: nil, division: nil, management_district: nil,
+                                  water_district: nil, wellid: nil)
+      query = {
+        format: "json",
+        dateFormat: "spaceSepToSeconds",
+        county: county&.upcase&.gsub(" ", "+"),
+        designatedBasin: designated_basin&.upcase&.gsub(" ", "+"),
+        division: division,
+        managementDistrict: management_district&.upcase&.gsub(" ", "+"),
+        waterDistrict: water_district,
+        wellId: wellid
+      }
+
+      fetch_paginated_data(
+        endpoint: "/groundwater/geophysicallogs/wells/",
+        query: query
+      ) { |data| Parser.parse_geophysical_wells(data) }
+    end
+
+    # Fetches geophysical log picks for a specific well
+    #
+    # @param [String] wellid Well ID to fetch log picks for
+    # @return [Array<LogPick>] An array of geophysical log pick objects
+    # @raise [ArgumentError] if wellid is nil
+    # @example Fetch log picks for a specific well
+    #   client.get_geophysical_log_picks(wellid: '1234')
+    def get_geophysical_log_picks(wellid:)
+      raise ArgumentError, "wellid is required" if wellid.nil?
+
+      query = {
+        format: "json",
+        dateFormat: "spaceSepToSeconds",
+        wellId: wellid
+      }
+
+      fetch_paginated_data(
+        endpoint: "/groundwater/geophysicallogs/geoplogpicks/",
+        query: query
+      ) { |data| Parser.parse_log_picks(data) }
+    end
+  end
+end

data/lib/cdss/models/admin_call.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class AdminCall
+      ATTRIBUTES = %i[
+        call_number
+        call_type
+        date_time_set
+        date_time_released
+        water_source_name
+        location_wdid
+        location_wdid_streammile
+        location_structure_name
+        priority_wdid
+        priority_structure_name
+        priority_admin_number
+        priority_order_number
+        priority_date
+        priority_number
+        bounding_wdid
+        bounding_structure_name
+        set_comments
+        release_comment
+        division
+        location_structure_latitude
+        location_structure_longitude
+        bounding_structure_latitude
+        bounding_structure_longitude
+        modified
+        more_information
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/analysis.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    # Base class for analysis-related models with shared functionality.
+    # Provides dynamic attribute handling for call analysis, source routes,
+    # and route analysis data.
+    class Analysis
+      class << self
+        def attributes(*attrs)
+          @attributes = attrs
+          attr_accessor(*attrs)
+        end
+
+        def inherited(subclass)
+          subclass.attributes(*@attributes) if @attributes
+        end
+
+        def attribute_list
+          @attributes || []
+        end
+      end
+
+      def initialize(**kwargs)
+        kwargs[:metadata] ||= {}
+        self.class.attribute_list.each do |attr|
+          instance_variable_set(:"@#{attr}", kwargs[attr]) if kwargs.key?(attr)
+        end
+      end
+    end
+
+    class CallAnalysis < Analysis
+      attributes :analysis_date,
+                 :wdid,
+                 :gnis_id,
+                 :stream_mile,
+                 :admin_number,
+                 :percent_time_out_of_priority,
+                 :downstream_call_wdid,
+                 :downstream_call_right,
+                 :downstream_call_stream_mile,
+                 :downstream_call_admin_number,
+                 :downstream_call_decreed_amount,
+                 :downstream_call_decreed_unit,
+                 :downstream_call_appropriation_date,
+                 :downstream_call_status,
+                 :modified,
+                 :metadata
+    end
+
+    class SourceRoute < Analysis
+      attributes :gnis_id,
+                 :gnis_name,
+                 :division,
+                 :water_district,
+                 :stream_length,
+                 :tributary_to_level,
+                 :tributary_to_gnis_id,
+                 :tributary_gnis_name,
+                 :tributary_to_stream_mile,
+                 :metadata
+    end
+
+    class RouteAnalysis < Analysis
+      attributes :wdid,
+                 :structure_name,
+                 :stream_mile,
+                 :structure_type,
+                 :decreed_amount,
+                 :decreed_unit,
+                 :appropriation_date,
+                 :admin_number,
+                 :modified,
+                 :metadata
+    end
+  end
+end

data/lib/cdss/models/climate_station.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class ClimateStation
+      ATTRIBUTES = %i[
+        station_number
+        station_name
+        site_id
+        division
+        water_district
+        county
+        state
+        latitude
+        longitude
+        utm_x
+        utm_y
+        elevation
+        data_source
+        start_date
+        end_date
+        modified
+        more_information
+        parameter_types
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+        attrs[:parameter_types] ||= []
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/reading.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class Reading
+      include Cdss::Concerns::WellReadingAttributes
+      include Cdss::Concerns::LogReadingAttributes
+
+      BASE_ATTRIBUTES = %i[
+        station_num
+        station_number
+        station_name
+        site_id
+        abbrev
+        parameter
+        usgs_site_id
+        meas_type
+        data_source
+        modified
+        metadata
+        flags
+        meas_date
+        value
+        meas_unit
+        meas_value
+        meas_date_time
+        cal_year
+        cal_month_num
+        water_year
+        min_q_cfs
+        max_q_cfs
+        avg_q_cfs
+        total_q_af
+        meas_count
+        frost_date_32f_fall
+        frost_date_32f_spring
+        frost_date_28f_fall
+        frost_date_28f_spring
+      ].freeze
+
+      ATTRIBUTES = (BASE_ATTRIBUTES + WELL_ATTRIBUTES + LOG_ATTRIBUTES).freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+        attrs[:flags] ||= {}
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr) && attrs[attr]
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/reference_table.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class ReferenceTable
+      ATTRIBUTES = %i[
+        name
+        code
+        description
+        division
+        water_district
+        water_district_name
+        division_name
+        county
+        management_district
+        management_district_name
+        designated_basin
+        designated_basin_name
+        parameter
+        flag
+        flag_column
+        divrectype
+        div_rec_type_long
+        additional_info
+        data_source
+        publication_name
+        action_name
+        action_descr
+        ciu_code
+        ciu_code_long
+        obs_code
+        obs_code_long
+        obs_descr
+        start_iyr
+        end_iyr
+        not_used_code
+        not_used_code_descr
+        submission_type
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr) && !blank_or_nil?(attrs[attr])
+        end
+      end
+
+      def blank_or_nil?(value)
+        value.nil? || value.to_s.strip.empty?
+      end
+    end
+  end
+end

data/lib/cdss/models/station.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class Station
+      ATTRIBUTES = %i[
+        station_num
+        abbrev
+        usgs_site_id
+        name
+        agency
+        latitude
+        longitude
+        division
+        water_district
+        county
+        state
+        utm_x
+        utm_y
+        location_accuracy
+        start_date
+        end_date
+        modified
+        more_information
+        meas_unit
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr) && attrs[attr]
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/structure.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class Structure
+      ATTRIBUTES = %i[
+        wdid
+        structure_name
+        structure_type
+        water_source
+        location_wdid
+        location_name
+        location_stream_mile
+        gnis_id
+        division
+        water_district
+        county
+        designated_basin
+        management_district
+        latitude
+        longitude
+        utm_x
+        utm_y
+        stream_num
+        structure_num
+        ciu_code
+        ciucode_desc
+        modified
+        stage_volume
+        usgs_id
+        data_source
+        more_information
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+
+    class DiversionRecord < Structure
+      ATTRIBUTES = %i[
+        wdid
+        water_class_num
+        wc_identifier
+        meas_interval
+        meas_count
+        data_meas_date
+        data_value
+        meas_units
+        obs_code
+        approval_status
+        modified
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        super
+        attrs[:metadata] ||= {}
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+
+    class WaterClass < Structure
+      ATTRIBUTES = %i[
+        wc_identifier
+        por_start
+        por_end
+        div_type
+        timestep
+        units
+        source_code
+        use_code
+        op_code
+        modified
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        super
+        attrs[:metadata] ||= {}
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/water_right.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class WaterRight
+      ATTRIBUTES = %i[
+        wdid
+        water_right_name
+        admin_number
+        appropriation_date
+        padj_date
+        adj_type
+        adj_date
+        order_number
+        prior_cases
+        status
+        trans_id
+        trans_type
+        case_number
+        decreed_uses
+        decreed_amount
+        decreed_units
+        action_comment
+        action_update
+        county
+        water_district
+        division
+        stream_mile
+        structure_type
+        latitude
+        longitude
+        modified
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr)
+        end
+      end
+    end
+  end
+end

data/lib/cdss/models/well.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Cdss
+  module Models
+    class Well
+      ATTRIBUTES = %i[
+        well_id
+        well_name
+        latitude
+        longitude
+        location_accuracy
+        county
+        designated_basin
+        management_district
+        division
+        water_district
+        depth
+        elevation
+        start_date
+        end_date
+        modified
+        data_source
+        more_information
+        total_depth
+        ground_elevation
+        utm_x
+        utm_y
+        state
+        metadata
+      ].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      def initialize(**attrs)
+        attrs[:metadata] ||= {}
+
+        ATTRIBUTES.each do |attr|
+          instance_variable_set(:"@#{attr}", attrs[attr]) if attrs.key?(attr) && attrs[attr]
+        end
+      end
+    end
+  end
+end