cdss-ruby

« CDSS »

CDSS REST Web

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.

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, for the R version of this package

See cdsspy, for the Python version of this package

• cdssr (R)

• cdssr documentation

• cdsspy (Python)

• cdsspy documentation

• cdss-ruby (Ruby)

• cdss-ruby documentation

Add this line to your application's Gemfile:

gem 'cdss-ruby'

and then execute

bundle install

or install it yourself as:

gem install cdss-ruby

Using the gem is simple. Create a client and start making requests:

irb(main):001:0> @client = Cdss.client
=> #<Cdss::Client:0x0000000103f757c0 @api_key=nil, @options={}>
irb(main):002:0> @client.get_sw_stations

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:

• Cdss::AdminCalls - Access administrative calls and structure data
• Cdss::Climate - Get climate station data and time series
• Cdss::Groundwater - Access groundwater well data and measurements
• Cdss::ReferenceTables - Get reference tables
• Cdss::SurfaceWater - Access surface water stations and time series
• Cdss::Telemetry - Get telemetry station data and time series
• Cdss::WaterRights - Access water rights net amounts and transactions
• Cdss::Analysis - Perform call analysis and get source route frameworks

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.

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.

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

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.