项目作者: sckott

项目描述 :
GBIF Ruby client; docs: http://www.rubydoc.info/gems/gbifrb/0.1.0
高级语言: Ruby
项目地址: git://github.com/sckott/gbifrb.git
创建时间: 2017-09-06T16:09:22Z
项目社区:https://github.com/sckott/gbifrb

开源协议:MIT License

下载


gbifrb

gem version
Ruby
codecov.io

gbifrb is a low level client for the GBIF API

Other GBIF API clients:

Changes

For changes see the Changelog

API

Methods in relation to GBIF API 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

  1. gem install gbifrb

Development version

  1. git clone git@github.com:sckott/gbifrb.git
  2. cd gbifrb
  3. rake install

Examples, in Ruby repl

Registry module

Nodes

  1. require 'gbifrb'
  2. registry = Gbif::Registry
  3. registry.nodes(limit: 5)

Networks

  1. registry.networks(uuid: '16ab5405-6c94-4189-ac71-16ca3b753df7')

Species module

GBIF backbone

  1. species = Gbif::Species
  2. species.name_backbone(name: "Helianthus")

Suggester

  1. species.name_suggest(q: "Helianthus")

Lookup

  1. species.name_lookup(q: "Helianthus")

Lookup example with more parameters: name usages of plants where accepted scientific name includes ‘reptans’:

  1. species.name_lookup(q: 'reptans', higherTaxonKey: 6, nameType: 'SCIENTIFIC', status: 'ACCEPTED')

Name usage (/species)

  1. species.name_usage(name: "Helianthus")

Name usage example with more parameters: name usages of ‘Andropogon’ in Database of Vascular Plants of Canada (VASCAN) checklist:

  1. species.name_usage(name: 'Andropogon', datasetKey: '3f8a1297-3259-4700-91fc-acc4170b27ce')

Occurrences

  1. occ = Gbif::Occurrences
  2. occ.search(taxonKey: 3329049)
  3. occ.search(taxonKey: 3329049, limit: 2)
  4. occ.search(scientificName: 'Ursus americanus')

curl options

  1. species = Gbif::Species
  2. 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. By participating in this project you agree to abide by its terms.
  • License: MIT