cdss-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15ae6061a3db3c8ead6608a242d547acec504d2eb5b2bc635c951cecb077e938
+  data.tar.gz: 3df958bf305f3323ef4439624f61e7f945c108e6b1e51f1d07f9a8d925730297
+SHA512:
+  metadata.gz: 54ed6ca04a155d58d3ad74c18425e5658b728c7b58c2d5c8289c9bc0947a103468e7b74d8bd59d056c2f6c18790ffa2e5f8eb74c973aae44bbcaca39848d4b62
+  data.tar.gz: 9dd2ba9da24e945278f265e223e687ec141d702a190efe163f0944bef3e1c2ff32a7af9a8beb18d6d0bafdc0e4509a5545063b7672e07f5f4b9657b27c29ca7b

data/.rubocop.yml

@@ -0,0 +1,86 @@
+# .rubocop.yml
+require:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.7
+  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] - 2024-10-30
+
+- 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/README.md

@@ -0,0 +1,101 @@
+# **cdss-ruby**
+
+
+[![Build Status](https://github.com/mgm702/cdss-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/mgm702/cdss-ruby/actions)
+[![Gem Version](https://badge.fury.io/rb/cdss-ruby.svg)](https://badge.fury.io/rb/cdss-ruby)
+[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
+
+[**« CDSS »**](https://dwr.state.co.us/Tools)
+
+[**CDSS REST Web**](https://dwr.state.co.us/Rest/GET/Help)
+
+
+The goal of [**`cdss-ruby`**](https://rubygems.org/gems/cdss-ruby) is to provide functions that help Ruby users to navigate, explore, and make requests to the CDSS REST API web service. 
+
+The Colorado's Decision Support Systems (CDSS) is a water management system created and developed by the Colorado Water Conservation Board (CWCB) and the Colorado Division of Water Resources (DWR).
+
+Thank you to those at CWCB and DWR for providing an accessible and well documented REST API!
+
+
+> See [**`cdssr`**](https://github.com/anguswg-ucsb/cdssr), for the **R** version of this package
+
+> See [**`cdsspy`**](https://github.com/anguswg-ucsb/cdsspy), for the **Python** version of this package
+
+---
+
+- [**cdssr (R)**](https://github.com/anguswg-ucsb/cdssr)
+
+- [**cdssr documentation**](https://anguswg-ucsb.github.io/cdssr/)
+
+- [**cdsspy (Python)**](https://github.com/anguswg-ucsb/cdsspy)
+
+- [**cdsspy documentation**](https://pypi.org/project/cdsspy/)
+
+- [**cdss-ruby (Ruby)**](https://github.com/mgm702/cdss-ruby)
+
+- [**cdss-ruby documentation**](https://mgm702.com/cdss-ruby/)
+
+---
+
+
+
+## **Installation**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cdss-ruby'
+```
+and then execute
+```ruby
+bundle install
+```
+
+or install it yourself as:
+```bash
+gem install cdss-ruby
+```
+
+## **Getting Started**
+
+Using the gem is simple. Create a client and start making requests:
+
+```ruby
+irb(main):001:0> @client = Cdss.client
+=> #<Cdss::Client:0x0000000103f757c0 @api_key=nil, @options={}>
+irb(main):002:0> @client.get_sw_stations
+```
+
+## **Available Endpoints**
+
+The `cdss-ruby` gem provides access to all CDSS API endpoints through an intuitive interface. For detailed documentation on each endpoint and its methods, please visit our [documentation site](https://mgm702.com/cdss-ruby).
+Here are some key modules:
+
+* [Cdss::AdminCalls](https://mgm702.com/cdss-ruby/Cdss/AdminCalls.html) - Access administrative calls and structure data
+* [Cdss::Climate](https://mgm702.com/cdss-ruby/Cdss/Climate.html) - Get climate station data and time series
+* [Cdss::Groundwater](https://mgm702.com/cdss-ruby/Cdss/GroundWater.html) - Access groundwater well data and measurements
+* [Cdss::ReferenceTables](https://mgm702.com/cdss-ruby/Cdss/ReferenceTables.html) - Get reference tables
+* [Cdss::SurfaceWater](https://mgm702.com/cdss-ruby/Cdss/SurfaceWater.html) - Access surface water stations and time series
+* [Cdss::Telemetry](https://mgm702.com/cdss-ruby/Cdss/Telemetry.html) - Get telemetry station data and time series
+* [Cdss::WaterRights](https://mgm702.com/cdss-ruby/Cdss/WaterRights.html) - Access water rights net amounts and transactions
+* [Cdss::Analysis](https://mgm702.com/cdss-ruby/Cdss/Analysis.html) - Perform call analysis and get source route frameworks
+
+## **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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+If you would like to contribute to this plugin, submit a Pull Request with an excellent commit message. 
+Contributions are more then welcome, however please make sure that your commit message is clear and understandable. 
+
+## License
+
+The cdss-ruby gem is licensed under the MIT license.
+
+## Like The Gem?
+
+If you like Tabtastic.vim follow the repository on [Github](https://github.com/mgm702/vim-tabtastic) and if you are feeling extra nice, follow the author [mgm702](http://mgm702.com) on [Twitter](https://twitter.com/mgm702) or [Github](https://github.com/mgm702).
+

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+require "yard"
+
+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