Project

legistar

0.0
No commit activity in last 3 years
No release in over 3 years
A .gem to interact with the Legistar WebApi
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.16
>= 0
~> 10.0
~> 3.0

Runtime

 Project Readme

Legistar

This .gem is for interacting with the Legistar API.

Installation

To install the legistar .gem, add this line to your application's Gemfile:

gem 'legistar'

And then execute:

$ bundle

Or install it yourself as:

$ gem install legistar

Usage

See /specs for examples, like:

client = Legistar::Bodies.new(host: "mesa")
client.get("362") # => returns a specific Governing Body from Mesa

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 tags, and push the .gem file to rubygems.org.

Publishing the gem

Assumptions:

  • VERSION.rb has been updated
  • User has access to Rubygems, if publishing.
  1. Run gem build legistar.gemspec to build legistar-0.x.x.gem
  2. Run gem push legistar-0.x.x.gem to publish the .gem to Rubygems

Contributing

Bug reports and pull requests (with tests/specs) are welcome on GitHub at https://github.com/afomi/legistar.

License

The gem is available as open source under the terms of the MIT License.