diff --git a/CHANGELOG.md b/CHANGELOG.md index f9a41e8..56d8495 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,4 +2,8 @@ ## [0.1.0] - 2024-10-30 +- First commit + +## [1.0.0] - 2025-2-27 + - Initial release diff --git a/README.md b/README.md index 05c8b11..67a8034 100644 --- a/README.md +++ b/README.md @@ -97,5 +97,5 @@ 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). +If you like Tabtastic.vim follow the repository on [Github](https://github.com/mgm702/cdss-ruby) 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). diff --git a/cdss-ruby.gemspec b/cdss-ruby.gemspec index abaebfb..d215040 100644 --- a/cdss-ruby.gemspec +++ b/cdss-ruby.gemspec @@ -18,7 +18,7 @@ Gem::Specification.new do |spec| "homepage_uri" => spec.homepage, "source_code_uri" => "https://github.com/mgm702/cdss-ruby", "changelog_uri" => "https://github.com/mgm702/cdss-ruby/blob/main/CHANGELOG.md", - "documentation_uri" => "https://github.com/mgm702/cdss-ruby/blob/main/README.md", + "documentation_uri" => "https://mgm702.com/cdss-ruby/", "rubygems_mfa_required" => "true" } diff --git a/docs/Cdss.html b/docs/Cdss.html index 02c69e9..d94d9b7 100644 --- a/docs/Cdss.html +++ b/docs/Cdss.html @@ -114,7 +114,7 @@

VERSION =
- 
"0.1.0"
+ 
"1.0.0"
@@ -282,7 +282,7 @@

diff --git a/docs/Cdss/AdminCalls.html b/docs/Cdss/AdminCalls.html index e6f1f38..a433f4b 100644 --- a/docs/Cdss/AdminCalls.html +++ b/docs/Cdss/AdminCalls.html @@ -389,7 +389,7 @@

diff --git a/docs/Cdss/Analysis.html b/docs/Cdss/Analysis.html index 1d0f0d5..ab9551f 100644 --- a/docs/Cdss/Analysis.html +++ b/docs/Cdss/Analysis.html @@ -962,7 +962,7 @@

diff --git a/docs/Cdss/Client.html b/docs/Cdss/Client.html index b27f5f8..ff95f9f 100644 --- a/docs/Cdss/Client.html +++ b/docs/Cdss/Client.html @@ -571,7 +571,7 @@

diff --git a/docs/Cdss/Climate.html b/docs/Cdss/Climate.html index 4609227..d6eb594 100644 --- a/docs/Cdss/Climate.html +++ b/docs/Cdss/Climate.html @@ -1247,7 +1247,7 @@

diff --git a/docs/Cdss/Concerns.html b/docs/Cdss/Concerns.html index 6f3dc32..57c5afb 100644 --- a/docs/Cdss/Concerns.html +++ b/docs/Cdss/Concerns.html @@ -107,7 +107,7 @@

Defined Under Namespace

diff --git a/docs/Cdss/Concerns/LogReadingAttributes.html b/docs/Cdss/Concerns/LogReadingAttributes.html index acf2952..507ff76 100644 --- a/docs/Cdss/Concerns/LogReadingAttributes.html +++ b/docs/Cdss/Concerns/LogReadingAttributes.html @@ -396,7 +396,7 @@
diff --git a/docs/Cdss/Concerns/WellReadingAttributes.html b/docs/Cdss/Concerns/WellReadingAttributes.html index e3bf079..6f3f510 100644 --- a/docs/Cdss/Concerns/WellReadingAttributes.html +++ b/docs/Cdss/Concerns/WellReadingAttributes.html @@ -404,7 +404,7 @@
diff --git a/docs/Cdss/GroundWater.html b/docs/Cdss/GroundWater.html index 5a1b0c2..dca54e4 100644 --- a/docs/Cdss/GroundWater.html +++ b/docs/Cdss/GroundWater.html @@ -935,7 +935,7 @@
diff --git a/docs/Cdss/Models.html b/docs/Cdss/Models.html index 1f9d4c8..409b9d8 100644 --- a/docs/Cdss/Models.html +++ b/docs/Cdss/Models.html @@ -107,7 +107,7 @@

Defined Under Namespace

diff --git a/docs/Cdss/Models/AdminCall.html b/docs/Cdss/Models/AdminCall.html index ed2fa40..e16c19f 100644 --- a/docs/Cdss/Models/AdminCall.html +++ b/docs/Cdss/Models/AdminCall.html @@ -242,7 +242,7 @@

diff --git a/docs/Cdss/Models/Analysis.html b/docs/Cdss/Models/Analysis.html index 0a88a86..ba441a0 100644 --- a/docs/Cdss/Models/Analysis.html +++ b/docs/Cdss/Models/Analysis.html @@ -387,7 +387,7 @@

diff --git a/docs/Cdss/Models/CallAnalysis.html b/docs/Cdss/Models/CallAnalysis.html index a3228ae..5311c42 100644 --- a/docs/Cdss/Models/CallAnalysis.html +++ b/docs/Cdss/Models/CallAnalysis.html @@ -130,7 +130,7 @@

Constructor Details

diff --git a/docs/Cdss/Models/ClimateStation.html b/docs/Cdss/Models/ClimateStation.html index 5b1378d..aa94f5f 100644 --- a/docs/Cdss/Models/ClimateStation.html +++ b/docs/Cdss/Models/ClimateStation.html @@ -239,7 +239,7 @@

diff --git a/docs/Cdss/Models/DiversionRecord.html b/docs/Cdss/Models/DiversionRecord.html index 3f85713..cdd0f68 100644 --- a/docs/Cdss/Models/DiversionRecord.html +++ b/docs/Cdss/Models/DiversionRecord.html @@ -238,7 +238,7 @@

diff --git a/docs/Cdss/Models/Reading.html b/docs/Cdss/Models/Reading.html index 6bd8283..91a2638 100644 --- a/docs/Cdss/Models/Reading.html +++ b/docs/Cdss/Models/Reading.html @@ -291,7 +291,7 @@

diff --git a/docs/Cdss/Models/ReferenceTable.html b/docs/Cdss/Models/ReferenceTable.html index c0f1015..25f95da 100644 --- a/docs/Cdss/Models/ReferenceTable.html +++ b/docs/Cdss/Models/ReferenceTable.html @@ -329,7 +329,7 @@

diff --git a/docs/Cdss/Models/RouteAnalysis.html b/docs/Cdss/Models/RouteAnalysis.html index abee287..7ba6eec 100644 --- a/docs/Cdss/Models/RouteAnalysis.html +++ b/docs/Cdss/Models/RouteAnalysis.html @@ -130,7 +130,7 @@

Constructor Details

diff --git a/docs/Cdss/Models/SourceRoute.html b/docs/Cdss/Models/SourceRoute.html index da3226a..24c2511 100644 --- a/docs/Cdss/Models/SourceRoute.html +++ b/docs/Cdss/Models/SourceRoute.html @@ -130,7 +130,7 @@

Constructor Details

diff --git a/docs/Cdss/Models/Station.html b/docs/Cdss/Models/Station.html index 3e22250..180f65c 100644 --- a/docs/Cdss/Models/Station.html +++ b/docs/Cdss/Models/Station.html @@ -238,7 +238,7 @@

diff --git a/docs/Cdss/Models/Structure.html b/docs/Cdss/Models/Structure.html index 9f851f0..67e5ade 100644 --- a/docs/Cdss/Models/Structure.html +++ b/docs/Cdss/Models/Structure.html @@ -249,7 +249,7 @@

diff --git a/docs/Cdss/Models/WaterClass.html b/docs/Cdss/Models/WaterClass.html index 5ecb695..7fbcc1b 100644 --- a/docs/Cdss/Models/WaterClass.html +++ b/docs/Cdss/Models/WaterClass.html @@ -239,7 +239,7 @@

diff --git a/docs/Cdss/Models/WaterRight.html b/docs/Cdss/Models/WaterRight.html index e05c1b0..f1a4a5c 100644 --- a/docs/Cdss/Models/WaterRight.html +++ b/docs/Cdss/Models/WaterRight.html @@ -245,7 +245,7 @@

diff --git a/docs/Cdss/Models/Well.html b/docs/Cdss/Models/Well.html index 1ee8233..2db67dc 100644 --- a/docs/Cdss/Models/Well.html +++ b/docs/Cdss/Models/Well.html @@ -241,7 +241,7 @@

diff --git a/docs/Cdss/Parser.html b/docs/Cdss/Parser.html index 82f0d4a..89afc7c 100644 --- a/docs/Cdss/Parser.html +++ b/docs/Cdss/Parser.html @@ -2145,7 +2145,7 @@

diff --git a/docs/Cdss/Parsers.html b/docs/Cdss/Parsers.html index 44d784e..327ef04 100644 --- a/docs/Cdss/Parsers.html +++ b/docs/Cdss/Parsers.html @@ -107,7 +107,7 @@

Defined Under Namespace

diff --git a/docs/Cdss/Parsers/AdminCallsParser.html b/docs/Cdss/Parsers/AdminCallsParser.html index ae93f4b..85f3932 100644 --- a/docs/Cdss/Parsers/AdminCallsParser.html +++ b/docs/Cdss/Parsers/AdminCallsParser.html @@ -191,7 +191,7 @@

diff --git a/docs/Cdss/Parsers/AnalysisParser.html b/docs/Cdss/Parsers/AnalysisParser.html index 43d90f8..13a91d0 100644 --- a/docs/Cdss/Parsers/AnalysisParser.html +++ b/docs/Cdss/Parsers/AnalysisParser.html @@ -286,7 +286,7 @@

diff --git a/docs/Cdss/Parsers/BaseParser.html b/docs/Cdss/Parsers/BaseParser.html index c531f29..8c8a199 100644 --- a/docs/Cdss/Parsers/BaseParser.html +++ b/docs/Cdss/Parsers/BaseParser.html @@ -197,7 +197,7 @@

diff --git a/docs/Cdss/Parsers/ClimateParser.html b/docs/Cdss/Parsers/ClimateParser.html index bd92596..461a3fe 100644 --- a/docs/Cdss/Parsers/ClimateParser.html +++ b/docs/Cdss/Parsers/ClimateParser.html @@ -243,7 +243,7 @@

diff --git a/docs/Cdss/Parsers/ReadingParser.html b/docs/Cdss/Parsers/ReadingParser.html index c150a15..9cdf854 100644 --- a/docs/Cdss/Parsers/ReadingParser.html +++ b/docs/Cdss/Parsers/ReadingParser.html @@ -191,7 +191,7 @@

diff --git a/docs/Cdss/Parsers/ReferenceTablesParser.html b/docs/Cdss/Parsers/ReferenceTablesParser.html index ce0e07e..cf41a7c 100644 --- a/docs/Cdss/Parsers/ReferenceTablesParser.html +++ b/docs/Cdss/Parsers/ReferenceTablesParser.html @@ -191,7 +191,7 @@

diff --git a/docs/Cdss/Parsers/StationParser.html b/docs/Cdss/Parsers/StationParser.html index fd8723b..4b6c83f 100644 --- a/docs/Cdss/Parsers/StationParser.html +++ b/docs/Cdss/Parsers/StationParser.html @@ -191,7 +191,7 @@

diff --git a/docs/Cdss/Parsers/StructuresParser.html b/docs/Cdss/Parsers/StructuresParser.html index 115f9b8..2c9179d 100644 --- a/docs/Cdss/Parsers/StructuresParser.html +++ b/docs/Cdss/Parsers/StructuresParser.html @@ -295,7 +295,7 @@

diff --git a/docs/Cdss/Parsers/WaterRightsParser.html b/docs/Cdss/Parsers/WaterRightsParser.html index baee94d..a56f48a 100644 --- a/docs/Cdss/Parsers/WaterRightsParser.html +++ b/docs/Cdss/Parsers/WaterRightsParser.html @@ -209,7 +209,7 @@

diff --git a/docs/Cdss/Parsers/WellParser.html b/docs/Cdss/Parsers/WellParser.html index 3887156..aa6dc5f 100644 --- a/docs/Cdss/Parsers/WellParser.html +++ b/docs/Cdss/Parsers/WellParser.html @@ -347,7 +347,7 @@

diff --git a/docs/Cdss/ReferenceTables.html b/docs/Cdss/ReferenceTables.html index ae5cc3e..0e88599 100644 --- a/docs/Cdss/ReferenceTables.html +++ b/docs/Cdss/ReferenceTables.html @@ -322,7 +322,7 @@

diff --git a/docs/Cdss/Structures.html b/docs/Cdss/Structures.html index ef7e65d..bb586cb 100644 --- a/docs/Cdss/Structures.html +++ b/docs/Cdss/Structures.html @@ -1122,7 +1122,7 @@

diff --git a/docs/Cdss/SurfaceWater.html b/docs/Cdss/SurfaceWater.html index 1a0a5a9..192015e 100644 --- a/docs/Cdss/SurfaceWater.html +++ b/docs/Cdss/SurfaceWater.html @@ -788,7 +788,7 @@

diff --git a/docs/Cdss/Telemetry.html b/docs/Cdss/Telemetry.html index b7ee97e..3e9da1e 100644 --- a/docs/Cdss/Telemetry.html +++ b/docs/Cdss/Telemetry.html @@ -753,7 +753,7 @@
diff --git a/docs/Cdss/Utils.html b/docs/Cdss/Utils.html index 2a678a1..bdb7bcc 100644 --- a/docs/Cdss/Utils.html +++ b/docs/Cdss/Utils.html @@ -1266,7 +1266,7 @@
diff --git a/docs/Cdss/WaterRights.html b/docs/Cdss/WaterRights.html index 355b94d..46db23a 100644 --- a/docs/Cdss/WaterRights.html +++ b/docs/Cdss/WaterRights.html @@ -624,7 +624,7 @@

diff --git a/docs/_index.html b/docs/_index.html index 7775fb4..4326d6d 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -483,7 +483,7 @@

Namespace Listing A-Z

diff --git a/docs/file.README.html b/docs/file.README.html index 8207831..9236853 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -57,52 +57,124 @@
-
-

Cdss::Ruby

+

cdss-ruby

-

TODO: Delete this and the text below, and describe your gem

+

Build Status +Gem Version +MIT license

-

Welcome to your new gem! In this directory, you’ll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/cdss/ruby. To experiment with that code, run bin/console for an interactive prompt.

+

« CDSS »

-

Installation

+

CDSS REST Web

-

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don’t plan to release to RubyGems.org.

+

The goal of cdss-ruby is to provide functions that help Ruby users to navigate, explore, and make requests to the CDSS REST API web service.

-

Install the gem and add to the application’s Gemfile by executing:

+

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).

-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
+

Thank you to those at CWCB and DWR for providing an accessible and well documented REST API!

-

If bundler is not being used to manage dependencies, install the gem by executing:

+
+

See cdssr, for the R version of this package

+
-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
+
+

See cdsspy, for the Python version of this package

+
-

Usage

+
-

TODO: Write usage instructions here

+ -

Development

+
+ +

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. +Here are some key modules:

+ + + +

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.

-

Contributing

+

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

-

Bug reports and pull requests are welcome on GitHub at github.com/mgm702/cdss-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

+

The cdss-ruby gem is licensed under the MIT license.

-

Code of Conduct

+

Like The Gem?

-

Everyone interacting in the Cdss::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

+

If you like Tabtastic.vim follow the repository on Github and if you are feeling extra nice, follow the author mgm702 on Twitter or Github.

- + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 8a67e58..95224fb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -57,48 +57,120 @@
-
-

Cdss::Ruby

+

cdss-ruby

-

TODO: Delete this and the text below, and describe your gem

+

Build Status +Gem Version +MIT license

-

Welcome to your new gem! In this directory, you’ll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/cdss/ruby. To experiment with that code, run bin/console for an interactive prompt.

+

« CDSS »

-

Installation

+

CDSS REST Web

-

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don’t plan to release to RubyGems.org.

+

The goal of cdss-ruby is to provide functions that help Ruby users to navigate, explore, and make requests to the CDSS REST API web service.

-

Install the gem and add to the application’s Gemfile by executing:

+

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).

-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
+

Thank you to those at CWCB and DWR for providing an accessible and well documented REST API!

-

If bundler is not being used to manage dependencies, install the gem by executing:

+
+

See cdssr, for the R version of this package

+
-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
+
+

See cdsspy, for the Python version of this package

+
-

Usage

+
-

TODO: Write usage instructions here

+ -

Development

+
+ +

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. +Here are some key modules:

+ + + +

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.

-

Contributing

+

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

-

Bug reports and pull requests are welcome on GitHub at github.com/mgm702/cdss-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

+

The cdss-ruby gem is licensed under the MIT license.

-

Code of Conduct

+

Like The Gem?

-

Everyone interacting in the Cdss::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

+

If you like Tabtastic.vim follow the repository on Github and if you are feeling extra nice, follow the author mgm702 on Twitter or Github.

diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html index d6c9b33..7979bfa 100644 --- a/docs/top-level-namespace.html +++ b/docs/top-level-namespace.html @@ -100,7 +100,7 @@

Defined Under Namespace