usgs-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90c31d4e2da0bfbeda5ed5e6b5ae37b358df9432740c7b55bb730e445600c07f
+  data.tar.gz: 9f8ec80140d27872755ae841a8022d4590590dcd8b8ca0520b19bb8ad2ec48ae
+SHA512:
+  metadata.gz: f14971c5157e372bcf0fdbae4272aa3477a49a44c417a7ae8951fd04447ef7457bed798e32024921893ca545d952e1bf6492cf47cab7c444c04de19e4052617d
+  data.tar.gz: 9941d12c94c95e9e2a0e009ea026c93de0b2dc288241c07d421febfce5e2090657f7288c875a83287e750d9cdb4dbf3ca09131350c06b0dae9c3461283e85247

data/.rubocop.yml

@@ -0,0 +1,87 @@
+# .rubocop.yml
+require:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+# Allow development dependencies in gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Make documentation optional for most files
+Style/Documentation:
+  Enabled: false
+
+# Allow unused arguments (often needed for API compatibility)
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Allow missing super in inherited callbacks
+Lint/MissingSuper:
+  Enabled: false
+
+# Allow private class methods to be defined normally
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+
+# Allow longer classes and modules for better organization
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ModuleLength:
+  Max: 200
+
+# Allow more reasonable method lengths
+Metrics/MethodLength:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+
+Metrics/AbcSize:
+  Max: 50
+  Exclude:
+    - 'test/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Allow longer parameter lists for API methods
+Metrics/ParameterLists:
+  Max: 10
+  CountKeywordArgs: false
+
+# Allow longer lines, especially for documentation
+Layout/LineLength:
+  Max: 150
+  Exclude:
+    - 'test/**/*'
+
+# Allow larger blocks in tests
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+    - '*.gemspec'
+
+# Other style preferences
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Lint/DuplicateMethods:
+  Exclude:
+    - 'test/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Lint/Void:
+  Exclude:
+    - test/cdss/test_analysis.rb
+    - test/cdss/test_structures.rb
+

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mattm3646@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Matt Michnal 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,256 @@
+# **usgs-ruby**
+
+[![Build Status](https://github.com/YOUR_USERNAME/usgs-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/YOUR_USERNAME/usgs-ruby/actions)
+[![Gem Version](https://badge.fury.io/rb/usgs-ruby.svg)](https://badge.fury.io/rb/usgs-ruby)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+
+[**« USGS »**](https://www.usgs.gov/)
+
+[**USGS Water Services**](https://waterservices.usgs.gov/)
+
+The goal of [**`usgs-ruby`**](https://rubygems.org/gems/usgs-ruby) is to provide functions that help Ruby users to navigate, explore, and make requests to the USGS Water Services API. 
+
+The United States Geological Survey (USGS) Water Services provides access to water resources data collected at approximately 1.9 million sites across the United States. This includes real-time and historical data for streamflow, groundwater levels, water quality, and more.
+
+Thank you to the USGS for providing an accessible and well-documented API!
+
+---
+
+## **Installation**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'usgs-ruby'
+```
+
+and then execute:
+
+```bash
+bundle install
+```
+
+or install it yourself as:
+
+```bash
+gem install usgs-ruby
+```
+
+## **Getting Started**
+
+Using the gem is simple. Create a client and start making requests:
+
+```ruby
+require 'usgs'
+
+# Create a client
+client = Usgs.client
+
+# Get site information
+sites = client.get_sites(state_cd: "CO", parameter_cd: :discharge)
+
+# Get daily values (last 24 hours by default)
+readings = client.get_dv(sites: "06754000", parameter_cd: :discharge)
+
+# Get instantaneous values
+iv_readings = client.get_iv(sites: "06754000", parameter_cd: :discharge)
+
+# Get statistics
+stats = client.get_stats(sites: "06754000", report_type: :daily)
+```
+
+## **Available Endpoints**
+
+The `usgs-ruby` gem provides access to all major USGS Water Services endpoints through an intuitive interface. For detailed documentation on each endpoint and its methods, please visit our [documentation site](https://YOUR_USERNAME.github.io/usgs-ruby).
+
+### Key Modules:
+
+* **Daily Values (DV)** - Access daily streamflow, groundwater, and water quality data
+  ```ruby
+  client.get_dv(sites: "06754000", parameter_cd: :discharge, 
+                start_date: "2023-01-01", end_date: "2023-12-31")
+  ```
+
+* **Instantaneous Values (IV)** - Get real-time water data (15-minute intervals)
+  ```ruby
+  client.get_iv(sites: "06754000", parameter_cd: :discharge)
+  ```
+
+* **Site Information** - Search and retrieve monitoring location metadata
+  ```ruby
+  client.get_sites(state_cd: "CO", site_type: "ST", parameter_cd: :discharge)
+  ```
+
+* **Statistics** - Access statistical summaries (daily, monthly, annual)
+  ```ruby
+  client.get_stats(sites: "06754000", report_type: :annual, 
+                   stat_year_type: "water")
+  ```
+
+### Supported Parameter Codes:
+
+The gem includes convenient symbols for common parameters:
+
+- `:discharge` - Streamflow (cubic feet per second)
+- `:gage_height` - Gage height (feet)
+- `:temperature` - Water temperature (°C)
+- `:precipitation` - Precipitation (inches)
+- `:do` - Dissolved oxygen (mg/L)
+- `:conductivity` - Specific conductance (µS/cm)
+- `:ph` - pH
+
+You can also use USGS parameter codes directly (e.g., `"00060"` for discharge).
+
+## **Examples**
+
+### Finding Sites
+
+```ruby
+# Search by state
+sites = client.get_sites(state_cd: "CO")
+
+# Search by bounding box (west, south, east, north)
+sites = client.get_sites(bBox: "-105.5,39.5,-105.0,40.0")
+
+# Search by site name
+sites = client.get_sites(site_name: "Boulder Creek")
+
+# Filter by site type and parameter
+sites = client.get_sites(state_cd: "CO", site_type: "ST", 
+                         parameter_cd: :discharge)
+```
+
+### Retrieving Data
+
+```ruby
+# Get recent daily values
+readings = client.get_dv(sites: "06754000", parameter_cd: :discharge)
+
+# Get historical daily values
+readings = client.get_dv(
+  sites: "06754000",
+  parameter_cd: :discharge,
+  start_date: Date.parse("2020-01-01"),
+  end_date: Date.parse("2023-12-31")
+)
+
+# Get multiple parameters
+readings = client.get_dv(
+  sites: "06754000",
+  parameter_cd: [:discharge, :gage_height]
+)
+
+# Get data from multiple sites
+readings = client.get_dv(
+  sites: ["06754000", "06752000"],
+  parameter_cd: :discharge
+)
+```
+
+### Working with Statistics
+
+```ruby
+# Daily statistics
+stats = client.get_stats(sites: "06754000", report_type: :daily)
+
+# Monthly statistics
+stats = client.get_stats(sites: "06754000", report_type: :monthly)
+
+# Annual statistics (water year)
+stats = client.get_stats(
+  sites: "06754000", 
+  report_type: :annual,
+  stat_year_type: "water"
+)
+```
+
+## **Configuration**
+
+You can configure the client with custom options:
+
+```ruby
+Usgs.configure do |config|
+  config.user_agent = "MyApp/1.0 (contact@example.com)"
+end
+
+client = Usgs.client
+```
+
+## **Development**
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+### Running Tests
+
+```bash
+bundle exec rake test
+```
+
+### Generating Documentation
+
+```bash
+bundle exec yard doc
+open doc/index.html
+```
+
+### Running RuboCop
+
+```bash
+bundle exec rubocop
+```
+
+## **Testing**
+
+This gem uses VCR for recording HTTP interactions during testing. When writing tests:
+
+1. Tests will record real API responses on first run
+2. Subsequent runs use cached responses (cassettes)
+3. Cassettes are stored in `test/fixtures/vcr_cassettes/`
+
+## **Contributing**
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-new-feature`)
+3. Write tests for your changes
+4. Make your changes and ensure tests pass (`rake test`)
+5. Run RuboCop and fix any violations (`rubocop`)
+6. Commit your changes with clear, descriptive messages
+7. Push to your branch (`git push origin feature/my-new-feature`)
+8. Create a Pull Request
+
+Please make sure that your commit messages are clear and understandable.
+
+## **Documentation**
+
+Full API documentation is available at [https://YOUR_USERNAME.github.io/usgs-ruby](https://YOUR_USERNAME.github.io/usgs-ruby)
+
+## **Resources**
+
+- [USGS Water Services](https://waterservices.usgs.gov/)
+- [USGS Water Services REST API Documentation](https://waterservices.usgs.gov/rest/Site-Service.html)
+- [USGS Parameter Codes](https://help.waterdata.usgs.gov/parameter_cd?group_cd=%)
+
+## **License**
+
+The usgs-ruby gem is licensed under the MIT license. See [LICENSE](LICENSE) for details.
+
+## **Acknowledgments**
+
+- Thanks to the USGS for maintaining an excellent public API
+- Inspired by similar projects in other languages
+
+## **Support**
+
+If you encounter any issues or have questions:
+
+1. Check the [documentation](https://YOUR_USERNAME.github.io/usgs-ruby)
+2. Search existing [GitHub Issues](https://github.com/YOUR_USERNAME/usgs-ruby/issues)
+3. Open a new issue with a clear description and example code
+
+---
+
+**Like the gem?** Star the repository on [GitHub](https://github.com/YOUR_USERNAME/usgs-ruby)!

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+require "yard"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--output-dir", "docs"]
+end
+
+task :publish_docs do
+  sh "git subtree push --prefix docs origin gh-pages"
+end