crawlyflower 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d09d7c7cbc67c9f0b951b65721429f50954afbda4498fb7164ef1e4baef662e8
+  data.tar.gz: e819ff083cc3ad3fc3cf9adf21e778d84de499617060178c9ede90e0e2618a2b
+SHA512:
+  metadata.gz: 52b5955cb246e580e919bb2f083236de3b1e8d56ebbe110e8004d5b104f7f2ee0ce22078692f30f063b8d48d86aad49da78e7c2aa916425363d88cf8c05b6c2d
+  data.tar.gz: abb488db453c0a9eccfbb6fb16803b1873277720451a612c0cae1ac4b4eb351bd08d480ec57a1eeae5d461970517c1534cbc611c027026694ea05372224deb2f

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3.4
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake
+      env:
+        USER: ${{ vars.USER }}
+        PASSWORD: ${{ secrets.PASSWORD }}
+

data/.gitignore

@@ -0,0 +1,13 @@
+.byebug_history
+.vscode
+.idea
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.0.1] - 2026-03-03
+
+- Initial release
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at diapriid@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in crawlyflower.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2026 Species File Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Crawlyflower
+
+<img src="https://github.com/SpeciesFileGroup/crawlyflower/blob/main/crawlyflower.png" width="350" alt="Crawlyflower"/>
+
+`crawlyflower` (a play on cauliflower) is a low-level wrapper around the [WoRMS (World Register of Marine Species) REST API](https://www.marinespecies.org/rest/). Code follows the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crawlyflower'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install crawlyflower
+
+## Usage
+
+```ruby
+require 'crawlyflower'
+```
+
+Get a record by AphiaID:
+```ruby
+Crawlyflower.record(127160)
+```
+
+Get classification:
+```ruby
+Crawlyflower.classification(127160)
+```
+
+Search by name:
+```ruby
+Crawlyflower.records_by_name("Solea solea")
+```
+
+Get children of a taxon:
+```ruby
+Crawlyflower.children(126132)
+```
+
+Get synonyms:
+```ruby
+Crawlyflower.synonyms(127160)
+```
+
+Get vernacular names:
+```ruby
+Crawlyflower.vernaculars(127160)
+```
+
+Get distributions:
+```ruby
+Crawlyflower.distributions(127160)
+```
+
+Get sources:
+```ruby
+Crawlyflower.sources(127160)
+```
+
+Get external identifiers:
+```ruby
+Crawlyflower.external_id(127160, type: "tsn")
+```
+
+Get attributes:
+```ruby
+Crawlyflower.attributes(127160)
+```
+
+Suggest taxa by name prefix:
+```ruby
+Crawlyflower.suggest("Solea")
+```
+
+## Development
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT license](https://github.com/SpeciesFileGroup/crawlyflower/blob/main/LICENSE.txt). You can learn more about the MIT license on [Wikipedia](https://en.wikipedia.org/wiki/MIT_License) and compare it with other open source licenses at the [Open Source Initiative](https://opensource.org/license/mit/).
+
+## Code of Conduct
+
+Everyone interacting in the Crawlyflower project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SpeciesFileGroup/crawlyflower/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "crawlyflower"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crawlyflower.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/crawlyflower/version"
+
+Gem::Specification.new do |s|
+  s.name          = "crawlyflower"
+  s.version       = Crawlyflower::VERSION
+  s.authors       = ["Geoff Ower"]
+  s.email         = ["gdower@illinois.edu"]
+
+  s.summary       = "WoRMS REST API Client"
+  s.description   = "crawlyflower is a low-level wrapper around the WoRMS (World Register of Marine Species) REST API."
+  s.homepage      = "https://github.com/SpeciesFileGroup/crawlyflower"
+  s.license       = "MIT"
+  s.required_ruby_version = ">= 2.5.0"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/SpeciesFileGroup/crawlyflower"
+  s.metadata["changelog_uri"] = "https://github.com/SpeciesFileGroup/crawlyflower/releases/tag/v#{s.version}"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|s|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 2.1", ">= 2.1.4"
+  s.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  s.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.6"
+  s.add_development_dependency "vcr", "~> 6.0"
+  s.add_development_dependency "webmock", "~> 3.18"
+
+  s.add_runtime_dependency "faraday", "~> 2.2"
+  s.add_runtime_dependency "faraday-follow_redirects", ">= 0.1", "< 0.4"
+  s.add_runtime_dependency "multi_json", "~> 1.15"
+end

data/lib/crawlyflower/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Crawlyflower
+  # Custom error class for rescuing from all Crawlyflower errors
+  class Error < StandardError; end
+
+  # Raised when WoRMS returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when WoRMS returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when WoRMS returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when WoRMS returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when WoRMS returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when WoRMS returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/crawlyflower/faraday.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "multi_json"
+
+# @private
+module Faraday
+  module CrawlyflowerErrors
+    # @private
+    class Middleware < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+          when 400
+            raise Crawlyflower::BadRequest, error_message_400(response)
+          when 404
+            raise Crawlyflower::NotFound, error_message_400(response)
+          when 500
+            raise Crawlyflower::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 502
+            raise Crawlyflower::BadGateway, error_message_500(response, "The server returned an invalid or incomplete response.")
+          when 503
+            raise Crawlyflower::ServiceUnavailable, error_message_500(response, "The service is unavailable.")
+          when 504
+            raise Crawlyflower::GatewayTimeout, error_message_500(response, "504 Gateway Time-out")
+          end
+        end
+      end
+
+      def initialize(app)
+        super app
+        @parser = nil
+      end
+
+      private
+
+      def error_message_400(response)
+        "\n   #{response[:method].to_s.upcase} #{response[:url]}\n   Status #{response[:status]}#{error_body(response[:body])}"
+      end
+
+      def error_body(body)
+        if !body.nil? && !body.empty? && body.is_a?(String)
+          if json?(body)
+            body = ::MultiJson.load(body)
+            if body["message"].nil?
+              body = nil
+            else
+              body = body["message"]
+            end
+          end
+        end
+
+        if body.nil?
+          nil
+        else
+          ": #{body}"
+        end
+      end
+
+      def error_message_500(response, body = nil)
+        "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ":", body].compact.join(" ")}"
+      end
+
+      def json?(string)
+        MultiJson.load(string)
+        true
+      rescue MultiJson::ParseError
+        false
+      end
+    end
+  end
+end

data/lib/crawlyflower/helpers/configuration.rb

@@ -0,0 +1,25 @@
+# taken from https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/helpers/configuration.rb
+# taken from: https://viget.com/extend/easy-gem-configuration-variables-with-defaults
+module Configuration
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/crawlyflower/request.rb

@@ -0,0 +1,41 @@
+require_relative "faraday"
+require "faraday/follow_redirects"
+require_relative "utils"
+require "crawlyflower/error"
+
+module Crawlyflower
+  class Request
+    attr_accessor :endpoint, :verbose, :options
+
+    def initialize(**args)
+      @endpoint = args[:endpoint]
+      @verbose = args[:verbose]
+      @options = args[:options] || {}
+      @accept = args[:accept] || 'application/json,*/*'
+    end
+
+    def perform
+      conn = Faraday.new(url: Crawlyflower.base_url, request: { params_encoder: Faraday::FlatParamsEncoder }) do |f|
+        f.response :logger if @verbose
+        f.use Faraday::CrawlyflowerErrors::Middleware
+        f.response :follow_redirects
+        f.adapter Faraday.default_adapter
+      end
+
+      conn.headers['Accept'] = @accept
+      conn.headers[:user_agent] = make_user_agent
+      conn.headers["X-USER-AGENT"] = make_user_agent
+
+      res = conn.get endpoint, @options
+
+      # WoRMS returns 204 for "nothing found"
+      return nil if res.status == 204
+
+      begin
+        MultiJson.load(res.body)
+      rescue MultiJson::ParseError
+        res.body
+      end
+    end
+  end
+end

data/lib/crawlyflower/utils.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# From https://raw.githubusercontent.com/sckott/serrano/main/lib/serrano/utils.rb
+
+def make_user_agent
+  requa = "Faraday/v" + Faraday::VERSION
+  habua = "Crawlyflower/v" + Crawlyflower::VERSION
+  ua = requa + " " + habua
+  ua
+end

data/lib/crawlyflower/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Crawlyflower
+  VERSION = "0.0.1"
+end

data/lib/crawlyflower.rb

@@ -0,0 +1,346 @@
+# frozen_string_literal: true
+
+require "erb"
+require_relative "crawlyflower/error"
+require_relative "crawlyflower/version"
+require_relative "crawlyflower/request"
+require "crawlyflower/helpers/configuration"
+
+module Crawlyflower
+  extend Configuration
+
+  define_setting :base_url, "https://www.marinespecies.org/rest/"
+
+  # Get the direct children (max. 50) for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  # @param marine_only [Boolean] Limit to marine taxa. Default: true
+  # @param extant_only [Boolean] Limit to extant taxa. Default: true
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.children(id, marine_only: nil, extant_only: nil, offset: nil, verbose: false)
+    endpoint = "AphiaChildrenByAphiaID/#{id}"
+    opts = { marine_only: marine_only, extant_only: extant_only, offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get the complete classification for one taxon
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [Hash, nil] A classification hash or nil if nothing found
+  def self.classification(id, verbose: false)
+    endpoint = "AphiaClassificationByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get all distributions for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [Array, nil] An array of distributions or nil if nothing found
+  def self.distributions(id, verbose: false)
+    endpoint = "AphiaDistributionsByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get any external identifier(s) for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  # @param type [String] Type of external identifier (algaebase, bold, dyntaxa, fishbase, iucn, lsid, ncbi, tsn, gisd)
+  #
+  # @return [Array, nil] An array of external identifiers or nil if nothing found
+  def self.external_id(id, type: nil, verbose: false)
+    endpoint = "AphiaExternalIDByAphiaID/#{id}"
+    opts = { type: type }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get the AphiaID for a given name
+  #
+  # @param name [String] Name to search for
+  # @param marine_only [Boolean] Limit to marine taxa. Default: true
+  # @param extant_only [Boolean] Limit to extant taxa. Default: true
+  #
+  # @return [Integer, nil] An AphiaID, -999 for multiple matches, or nil if nothing found
+  def self.aphia_id_by_name(name, marine_only: nil, extant_only: nil, verbose: false)
+    endpoint = "AphiaIDByName/#{ERB::Util.url_encode(name)}"
+    opts = { marine_only: marine_only, extant_only: extant_only }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get the name for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [String, nil] The scientific name or nil if nothing found
+  def self.name(id, verbose: false)
+    endpoint = "AphiaNameByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get the complete AphiaRecord for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [Hash, nil] An AphiaRecord hash or nil if nothing found
+  def self.record(id, verbose: false)
+    endpoint = "AphiaRecordByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get AphiaRecords for multiple AphiaIDs in one go (max: 50)
+  #
+  # @param ids [Array<Integer>] The AphiaIDs to search for
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.records_by_aphia_ids(ids, verbose: false)
+    endpoint = "AphiaRecordsByAphiaIDs"
+    opts = { "aphiaids[]": Array(ids) }
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get the Aphia Record for a given external identifier
+  #
+  # @param id [String] The external identifier to search for
+  # @param type [String] Type of external identifier (algaebase, bold, dyntaxa, fishbase, iucn, lsid, ncbi, tsn, gisd)
+  #
+  # @return [Hash, nil] An AphiaRecord hash or nil if nothing found
+  def self.record_by_external_id(id, type: nil, verbose: false)
+    endpoint = "AphiaRecordByExternalID/#{ERB::Util.url_encode(id.to_s)}"
+    opts = { type: type }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Lists all AphiaRecords that have their last edit action during the specified period
+  #
+  # @param startdate [String] ISO 8601 formatted start date(time)
+  # @param enddate [String] ISO 8601 formatted end date(time)
+  # @param marine_only [Boolean] Limit to marine taxa
+  # @param extant_only [Boolean] Limit to extant taxa
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.records_by_date(startdate:, enddate: nil, marine_only: nil, extant_only: nil, offset: nil, verbose: false)
+    endpoint = "AphiaRecordsByDate"
+    opts = { startdate: startdate, enddate: enddate, marine_only: marine_only, extant_only: extant_only, offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Try to find AphiaRecords using the TAXAMATCH fuzzy matching algorithm
+  #
+  # @param scientificnames [Array<String>] Names to search for
+  # @param authorships [Array<String>] The authorities of the given names
+  # @param marine_only [Boolean] Limit to marine taxa
+  # @param extant_only [Boolean] Limit to extant taxa
+  # @param match_authority [Boolean] Use the authority in the matching process
+  #
+  # @return [Array, nil] An array of arrays of AphiaRecords or nil if nothing found
+  def self.records_by_match_names(scientificnames:, authorships: nil, marine_only: nil, extant_only: nil, match_authority: nil, verbose: false)
+    endpoint = "AphiaRecordsByMatchNames"
+    opts = { "scientificnames[]": Array(scientificnames), marine_only: marine_only, extant_only: extant_only, match_authority: match_authority }
+    opts[:"authorships[]"] = Array(authorships) if authorships
+    opts = opts.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get one or more matching (max. 50) AphiaRecords for a given name
+  #
+  # @param name [String] Name to search for
+  # @param like [Boolean] Add a '%'-sign after the ScientificName. Default: true
+  # @param marine_only [Boolean] Limit to marine taxa
+  # @param extant_only [Boolean] Limit to extant taxa
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.records_by_name(name, like: nil, marine_only: nil, extant_only: nil, offset: nil, verbose: false)
+    endpoint = "AphiaRecordsByName/#{ERB::Util.url_encode(name)}"
+    opts = { like: like, marine_only: marine_only, extant_only: extant_only, offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # For each given scientific name, try to find one or more AphiaRecords (max 500 names)
+  #
+  # @param scientificnames [Array<String>] Names to search for
+  # @param like [Boolean] Add a '%'-sign after the ScientificName. Default: false
+  # @param marine_only [Boolean] Limit to marine taxa
+  # @param extant_only [Boolean] Limit to extant taxa
+  #
+  # @return [Array, nil] An array of arrays of AphiaRecords or nil if nothing found
+  def self.records_by_names(scientificnames:, like: nil, marine_only: nil, extant_only: nil, verbose: false)
+    endpoint = "AphiaRecordsByNames"
+    opts = { "scientificnames[]": Array(scientificnames), like: like, marine_only: marine_only, extant_only: extant_only }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get one or more Aphia Records (max. 50) for a given vernacular
+  #
+  # @param name [String] The vernacular to find records for
+  # @param like [Boolean] Add a '%'-sign before and after the input. Default: false
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.records_by_vernacular(name, like: nil, offset: nil, verbose: false)
+    endpoint = "AphiaRecordsByVernacular/#{ERB::Util.url_encode(name)}"
+    opts = { like: like, offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get all synonyms for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.synonyms(id, offset: nil, verbose: false)
+    endpoint = "AphiaSynonymsByAphiaID/#{id}"
+    opts = { offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get all vernaculars for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [Array, nil] An array of vernaculars or nil if nothing found
+  def self.vernaculars(id, verbose: false)
+    endpoint = "AphiaVernacularsByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get one or more sources/references including links, for one AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  #
+  # @return [Array, nil] An array of sources or nil if nothing found
+  def self.sources(id, verbose: false)
+    endpoint = "AphiaSourcesByAphiaID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get taxonomic ranks by their identifier
+  #
+  # @param id [Integer] A taxonomic rank identifier. Default: -1
+  # @param aphia_id [Integer] The AphiaID of the kingdom
+  #
+  # @return [Array, nil] An array of taxonomic ranks or nil if nothing found
+  def self.taxon_ranks_by_id(id, aphia_id: nil, verbose: false)
+    endpoint = "AphiaTaxonRanksByID/#{id}"
+    opts = { AphiaID: aphia_id }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get taxonomic ranks by their name
+  #
+  # @param name [String] A taxonomic rank name
+  # @param aphia_id [Integer] The AphiaID of the kingdom
+  #
+  # @return [Array, nil] An array of taxonomic ranks or nil if nothing found
+  def self.taxon_ranks_by_name(name, aphia_id: nil, verbose: false)
+    endpoint = "AphiaTaxonRanksByName/#{ERB::Util.url_encode(name)}"
+    opts = { AphiaID: aphia_id }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get the AphiaRecords for a given taxonRankID (max 50)
+  #
+  # @param id [Integer] A taxonomic rank identifier
+  # @param belongs_to [Integer] Limit the results to descendants of the given AphiaID
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaRecords or nil if nothing found
+  def self.records_by_taxon_rank_id(id, belongs_to: nil, offset: nil, verbose: false)
+    endpoint = "AphiaRecordsByTaxonRankID/#{id}"
+    opts = { belongsTo: belongs_to, offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  FULL_RECORD_FORMATS = {
+    jsonld: 'application/ld+json',
+    rdf: 'application/rdf+xml',
+    turtle: 'text/turtle',
+    ntriples: 'application/n-triples'
+  }.freeze
+
+  # Get the complete AphiaFullRecord (linked open data) for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  # @param format [Symbol] Response format: :jsonld (default), :rdf, :turtle, :ntriples
+  #
+  # @return [Hash, String, nil] The full record or nil if nothing found
+  def self.full_record(id, format: :jsonld, verbose: false)
+    endpoint = "AphiaRecordFullByAphiaID/#{id}"
+    accept = FULL_RECORD_FORMATS[format] || FULL_RECORD_FORMATS[:jsonld]
+    Request.new(endpoint: endpoint, verbose: verbose, accept: accept).perform
+  end
+
+  # Get attribute definitions
+  #
+  # @param id [Integer] The attribute definition id to search for. Use 0 for root items
+  # @param include_children [Boolean] Include the tree of children. Default: true
+  #
+  # @return [Array, nil] An array of attribute keys or nil if nothing found
+  def self.attribute_keys(id, include_children: nil, verbose: false)
+    endpoint = "AphiaAttributeKeysByID/#{id}"
+    opts = { include_children: include_children }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get list values that are grouped by a CategoryID
+  #
+  # @param id [Integer] The CategoryID to search for
+  #
+  # @return [Array, nil] An array of attribute values or nil if nothing found
+  def self.attribute_values_by_category(id, verbose: false)
+    endpoint = "AphiaAttributeValuesByCategoryID/#{id}"
+    Request.new(endpoint: endpoint, verbose: verbose).perform
+  end
+
+  # Get a list of AphiaIDs (max 50) with attribute tree for a given attribute definition ID
+  #
+  # @param id [Integer] The attribute definition id to search for
+  # @param offset [Integer] Starting record number. Default: 1
+  #
+  # @return [Array, nil] An array of AphiaAttributeSets or nil if nothing found
+  def self.aphia_ids_by_attribute_key(id, offset: nil, verbose: false)
+    endpoint = "AphiaIDsByAttributeKeyID/#{id}"
+    opts = { offset: offset }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get a list of attributes for a given AphiaID
+  #
+  # @param id [Integer] The AphiaID to search for
+  # @param include_inherited [Boolean] Include attributes inherited from parent(s). Default: false
+  #
+  # @return [Array, nil] An array of attributes or nil if nothing found
+  def self.attributes(id, include_inherited: nil, verbose: false)
+    endpoint = "AphiaAttributesByAphiaID/#{id}"
+    opts = { include_inherited: include_inherited }.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+
+  # Get taxa suggestions for a given prefix of a taxon name
+  #
+  # @param name_part [String] The prefix to use to search for taxa
+  # @param rank_min [Integer] The minimum rank of the returned suggestion. Default: 10
+  # @param rank_max [Integer] The maximum rank of the returned suggestion. Default: 280
+  # @param max_matches [Integer] The maximum number of suggestions to return. Default: 20, Max: 50
+  # @param excluded_ids [Array<Integer>] AphiaIDs to exclude from the result set
+  # @param combine_vernaculars [Boolean] When true the name can also match vernaculars. Default: false
+  # @param marine_only [Boolean] Limit to marine taxa. Default: true
+  # @param fossil_id [Integer] Determines the search behavior for fossil taxa. Default: 0
+  # @param languages [Array<String>] List of ISO 639-3 language codes to filter search results
+  #
+  # @return [Array, nil] An array of suggestion records or nil if nothing found
+  def self.suggest(name_part, rank_min: nil, rank_max: nil, max_matches: nil, excluded_ids: nil, combine_vernaculars: nil, marine_only: nil, fossil_id: nil, languages: nil, verbose: false)
+    endpoint = "AjaxAphiaRecordsByNamePart/#{ERB::Util.url_encode(name_part)}"
+    opts = { rank_min: rank_min, rank_max: rank_max, max_matches: max_matches,
+             combine_vernaculars: combine_vernaculars, marine_only: marine_only, fossil_id: fossil_id }
+    opts[:"excluded_ids[]"] = Array(excluded_ids) if excluded_ids
+    opts[:"languages[]"] = Array(languages) if languages
+    opts = opts.compact
+    Request.new(endpoint: endpoint, verbose: verbose, options: opts).perform
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: crawlyflower
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geoff Ower
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: crawlyflower is a low-level wrapper around the WoRMS (World Register
+  of Marine Species) REST API.
+email:
+- gdower@illinois.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crawlyflower.gemspec
+- crawlyflower.png
+- lib/crawlyflower.rb
+- lib/crawlyflower/error.rb
+- lib/crawlyflower/faraday.rb
+- lib/crawlyflower/helpers/configuration.rb
+- lib/crawlyflower/request.rb
+- lib/crawlyflower/utils.rb
+- lib/crawlyflower/version.rb
+homepage: https://github.com/SpeciesFileGroup/crawlyflower
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SpeciesFileGroup/crawlyflower
+  source_code_uri: https://github.com/SpeciesFileGroup/crawlyflower
+  changelog_uri: https://github.com/SpeciesFileGroup/crawlyflower/releases/tag/v0.0.1
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: WoRMS REST API Client
+test_files: []