Checkerberry

Checkerberry is a Ruby wrapper on the GNverifier API. Code follows the spirit/approach of the Gem serrano, and indeed much of the wrapping utility is copied 1:1 from that repo, thanks @sckott.

Add this line to your application's Gemfile:

gem 'checkerberry'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install checkerberry

Verify a single scientific name:

Checkerberry.verify('Homo sapiens')

Verify multiple scientific names:

Checkerberry.verify(['Homo sapiens', 'Mus musculus'])

Verify with additional options:

Checkerberry.verify('Homo sapiens', data_sources: [1, 11], with_stats: true)

Search for a species:

Checkerberry.search(name_string: "Homo sapiens", genus: 'Homo', species: 'sapiens')

Search for a species within a parent taxon:

Checkerberry.search(parent_taxon: "Plantae", genus: 'Agathis', species: 'montana')
Checkerberry.search(parent_taxon: "Animalia", genus: 'Agathis', species: 'montana')

Search for a species verified by specific data sources:

Checkerberry.search(name_string: "Homo sapiens", genus: 'Homo', species: 'sapiens', data_sources: 1)
Checkerberry.search(name_string: "Homo sapiens", genus: 'Homo', species: 'sapiens', data_sources: [1, 3])

Get list of all data sources:

Checkerberry.data_sources

Get a specific data source by ID:

Checkerberry.data_source(1)

Check if the GNverifier service is up

Checkerberry.ping
pong

Get the GNVerifier API version information:

Checkerberry.version

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, update the CHANGELOG.md, 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.

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

The gem is available as open source under the terms of the MIT license. You can learn more about the MIT license on Wikipedia and compare it with other open source licenses at the Open Source Initiative.

Everyone interacting in the Checkerberry project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.