ChiSexOffenders

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/chi_sex_offenders. To experiment with that code, run bin/console for an interactive prompt.

Searches Sex Offenders through the City of Chicago's Web Portal

Installation

Add this line to your application's Gemfile:

gem 'chi_sex_offenders'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chi_sex_offenders

Usage

To Return List of Chicago Sex Offenders

p ChiSexOffenders::SexOffender.all

To Search Chicago Sex Offenders By Attributes

p ChiSexOffenders::SexOffender.where({race: "WHITE", age: 50.0})

note all strings must be capitalized and age must be in decimal format

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chi_sex_offenders.