Plazucchini is a Ruby wrapper on the Plazi's TreatmentBank 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 'plazucchini'And then execute:
$ bundle install
Or install it yourself as:
$ gem install plazucchini
All Plazi API endpoints are wrapped. Please see the tests for usage examples. Here are a few examples:
Get treatments for a taxon:
Plazucchini.treatments_search_by_doi(doi: '10.5281/zenodo.8117062', limit: 1)Get treatments for a taxon:
Plazucchini.treatments_for_taxon(genus: 'Arboridia', species: 'septempunctata', limit: 1)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/plazucchini. 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 Plazucchini project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.