https://github.com/sckott/gbifrb
GBIF Ruby client; docs: http://www.rubydoc.info/gems/gbifrb/0.1.0
https://github.com/sckott/gbifrb
biodiversity data ecology gbif gbif-api
Last synced: 9 months ago
JSON representation
GBIF Ruby client; docs: http://www.rubydoc.info/gems/gbifrb/0.1.0
- Host: GitHub
- URL: https://github.com/sckott/gbifrb
- Owner: sckott
- License: mit
- Created: 2017-09-06T16:09:22.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T13:58:28.000Z (over 3 years ago)
- Last Synced: 2025-09-10T18:19:01.405Z (10 months ago)
- Topics: biodiversity, data, ecology, gbif, gbif-api
- Language: Ruby
- Homepage:
- Size: 487 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ecodata - Ruby client
README
gbifrb
======
[](https://rubygems.org/gems/gbifrb)
[](https://github.com/sckott/gbifrb/actions/workflows/ruby.yml)
[](http://codecov.io/github/sckott/gbifrb?branch=main)
`gbifrb` is a low level client for the GBIF API
Other GBIF API clients:
- Python: [pygbif](https://github.com/sckott/pygbif)
- R: [rgbif](https://github.com/ropensci/rgbif)
- PHP: [php-gbif](https://gitlab.res-telae.cat/restelae/php-gbif)
## Changes
For changes see the [Changelog][changelog]
## API
Methods in relation to [GBIF API][gbifapi] routes
registry
* `/node` - `Gbif::Registry.nodes`
* `/network` - `Gbif::Registry.networks`
* `/installations` - `Gbif::Registry.installations`
* `/organizations` - `Gbif::Registry.organizations`
* `/dataset_metrics` - `Gbif::Registry.dataset_metrics`
* `/datasets` - `Gbif::Registry.datasets`
* `/dataset_suggest` - `Gbif::Registry.dataset_suggest`
* `/dataset_search` - `Gbif::Registry.dataset_search`
species
* `/species/match` - `Gbif::Species.name_backbone`
* `/species/suggest` - `Gbif::Species.name_suggest`
* `/species/search` - `Gbif::Species.name_lookup`
* `/species` - `Gbif::Species.name_usage`
occurrences
* `/search` - `Gbif::Occurrences.search`
* `/get` - `Gbif::Occurrences.get`
* `/get_verbatim` - `Gbif::Occurrences.get_verbatim`
* `/get_fragment` - `Gbif::Occurrences.get_fragment`
## Install
### Release version
```
gem install gbifrb
```
### Development version
```
git clone git@github.com:sckott/gbifrb.git
cd gbifrb
rake install
```
## Examples, in Ruby repl
### Registry module
Nodes
```ruby
require 'gbifrb'
registry = Gbif::Registry
registry.nodes(limit: 5)
```
Networks
```ruby
registry.networks(uuid: '16ab5405-6c94-4189-ac71-16ca3b753df7')
```
### Species module
GBIF backbone
```ruby
species = Gbif::Species
species.name_backbone(name: "Helianthus")
```
Suggester
```ruby
species.name_suggest(q: "Helianthus")
```
Lookup
```ruby
species.name_lookup(q: "Helianthus")
```
Lookup example with more parameters: name usages of plants where accepted scientific name includes 'reptans':
```ruby
species.name_lookup(q: 'reptans', higherTaxonKey: 6, nameType: 'SCIENTIFIC', status: 'ACCEPTED')
```
Name usage (`/species`)
```ruby
species.name_usage(name: "Helianthus")
```
Name usage example with more parameters: name usages of 'Andropogon' in Database of Vascular Plants of Canada (VASCAN) checklist:
```ruby
species.name_usage(name: 'Andropogon', datasetKey: '3f8a1297-3259-4700-91fc-acc4170b27ce')
```
### Occurrences
```ruby
occ = Gbif::Occurrences
occ.search(taxonKey: 3329049)
occ.search(taxonKey: 3329049, limit: 2)
occ.search(scientificName: 'Ursus americanus')
```
### curl options
```ruby
species = Gbif::Species
species.name_backbone("Helianthus", verbose: true)
```
### Todo
* CLI interface
* occurrence metrics methods
* occurrence downloads methods
* OAI-PMH interface
## Meta
* Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.
* License: MIT
[gbifapi]: https://www.gbif.org/developer/summary
[changelog]: https://github.com/sckott/gbifrb/blob/main/CHANGELOG.md