Crawlyflower

crawlyflower (a play on cauliflower) is a low-level wrapper around the WoRMS (World Register of Marine Species) REST 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 'crawlyflower'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install crawlyflower

require 'crawlyflower'

Get a record by AphiaID:

Crawlyflower.record(127160)

Get classification:

Crawlyflower.classification(127160)

Search by name:

Crawlyflower.records_by_name("Solea solea")

Get children of a taxon:

Crawlyflower.children(126132)

Get synonyms:

Crawlyflower.synonyms(127160)

Get vernacular names:

Crawlyflower.vernaculars(127160)

Get distributions:

Crawlyflower.distributions(127160)

Get sources:

Crawlyflower.sources(127160)

Get external identifiers:

Crawlyflower.external_id(127160, type: "tsn")

Get attributes:

Crawlyflower.attributes(127160)

Suggest taxa by name prefix:

Crawlyflower.suggest("Solea")

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.

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 Crawlyflower project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.