Skip to content

Commit 0e402c0

Browse files
mgm702mgm702
authored
Merge pull request #11 from mgm702/develop
Develop --> Main
2 parents 8ae5f95 + 5bca4b4 commit 0e402c0

2 files changed

Lines changed: 88 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 81 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,101 @@
1-
# Cdss::Ruby
1+
# **cdss-ruby**
22

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

5-
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.
4+
[![Build Status](https://github.com/mgm702/cdss-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/mgm702/cdss-ruby/actions)
5+
[![Gem Version](https://badge.fury.io/rb/cdss-ruby.svg)](https://badge.fury.io/rb/cdss-ruby)
6+
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
67

7-
## Installation
8+
[**« CDSS »**](https://dwr.state.co.us/Tools)
89

9-
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.
10+
[**CDSS REST Web**](https://dwr.state.co.us/Rest/GET/Help)
1011

11-
Install the gem and add to the application's Gemfile by executing:
1212

13-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
13+
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.
1414

15-
If bundler is not being used to manage dependencies, install the gem by executing:
15+
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).
1616

17-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
17+
Thank you to those at CWCB and DWR for providing an accessible and well documented REST API!
1818

19-
## Usage
2019

21-
TODO: Write usage instructions here
20+
> See [**`cdssr`**](https://github.com/anguswg-ucsb/cdssr), for the **R** version of this package
2221
23-
## Development
22+
> See [**`cdsspy`**](https://github.com/anguswg-ucsb/cdsspy), for the **Python** version of this package
23+
24+
---
25+
26+
- [**cdssr (R)**](https://github.com/anguswg-ucsb/cdssr)
27+
28+
- [**cdssr documentation**](https://anguswg-ucsb.github.io/cdssr/)
29+
30+
- [**cdsspy (Python)**](https://github.com/anguswg-ucsb/cdsspy)
31+
32+
- [**cdsspy documentation**](https://pypi.org/project/cdsspy/)
33+
34+
- [**cdss-ruby (Ruby)**](https://github.com/mgm702/cdss-ruby)
35+
36+
- [**cdss-ruby documentation**](https://mgm702.com/cdss-ruby/)
37+
38+
---
39+
40+
41+
42+
## **Installation**
43+
44+
Add this line to your application's Gemfile:
45+
46+
```ruby
47+
gem 'cdss-ruby'
48+
```
49+
and then execute
50+
```ruby
51+
bundle install
52+
```
53+
54+
or install it yourself as:
55+
```bash
56+
gem install cdss-ruby
57+
```
58+
59+
## **Getting Started**
60+
61+
Using the gem is simple. Create a client and start making requests:
62+
63+
```ruby
64+
irb(main):001:0> @client = Cdss.client
65+
=> #<Cdss::Client:0x0000000103f757c0 @api_key=nil, @options={}>
66+
irb(main):002:0> @client.get_sw_stations
67+
```
68+
69+
## **Available Endpoints**
70+
71+
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).
72+
Here are some key modules:
73+
74+
* [Cdss::AdminCalls](https://mgm702.com/cdss-ruby/Cdss/AdminCalls.html) - Access administrative calls and structure data
75+
* [Cdss::Climate](https://mgm702.com/cdss-ruby/Cdss/Climate.html) - Get climate station data and time series
76+
* [Cdss::Groundwater](https://mgm702.com/cdss-ruby/Cdss/GroundWater.html) - Access groundwater well data and measurements
77+
* [Cdss::ReferenceTables](https://mgm702.com/cdss-ruby/Cdss/ReferenceTables.html) - Get reference tables
78+
* [Cdss::SurfaceWater](https://mgm702.com/cdss-ruby/Cdss/SurfaceWater.html) - Access surface water stations and time series
79+
* [Cdss::Telemetry](https://mgm702.com/cdss-ruby/Cdss/Telemetry.html) - Get telemetry station data and time series
80+
* [Cdss::WaterRights](https://mgm702.com/cdss-ruby/Cdss/WaterRights.html) - Access water rights net amounts and transactions
81+
* [Cdss::Analysis](https://mgm702.com/cdss-ruby/Cdss/Analysis.html) - Perform call analysis and get source route frameworks
82+
83+
## **Development**
2484

2585
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.
2686

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

2989
## Contributing
3090

31-
Bug reports and pull requests are welcome on GitHub at https://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](https://github.com/mgm702/cdss-ruby/blob/main/CODE_OF_CONDUCT.md).
91+
If you would like to contribute to this plugin, submit a Pull Request with an excellent commit message.
92+
Contributions are more then welcome, however please make sure that your commit message is clear and understandable.
93+
94+
## License
95+
96+
The cdss-ruby gem is licensed under the MIT license.
97+
98+
## Like The Gem?
3299

33-
## Code of Conduct
100+
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).
34101

35-
Everyone interacting in the Cdss::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mgm702/cdss-ruby/blob/main/CODE_OF_CONDUCT.md).

‎cdss-ruby.gemspec‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ Gem::Specification.new do |spec|
1414
spec.license = "MIT"
1515
spec.required_ruby_version = ">= 2.7.0"
1616

17-
spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
18-
19-
spec.metadata["homepage_uri"] = spec.homepage
20-
spec.metadata["source_code_uri"] = "https://github.com/mgm702/cdss-ruby"
21-
spec.metadata["changelog_uri"] = "https://github.com/mgm702/cdss-ruby/CHANGELOG.md"
17+
spec.metadata = {
18+
"allowed_push_host" => "https://rubygems.org",
19+
"homepage_uri" => spec.homepage,
20+
"source_code_uri" => "https://github.com/mgm702/cdss-ruby",
21+
"changelog_uri" => "https://github.com/mgm702/cdss-ruby/blob/main/CHANGELOG.md",
22+
"rubygems_mfa_required" => "true"
23+
}
2224

2325
# Specify which files should be added to the gem when it is released.
2426
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.

0 commit comments

Comments
 (0)