plants 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8e9b712b2177d93408282db2d2b6efc283fb9fbfb84d17d6fc80efcc58a710b
+  data.tar.gz: e51872144774793b602adac46640d515ae2a353a07e89fa3beb70d33b50a4ffc
+SHA512:
+  metadata.gz: 3df27aab14d6ed43639c9837cbaa53b4ccf18790929af2f5966d25608735535057f43969c5185d7e4c4b0d7e578acf815ce2b7e30c144f1193760bed8a15ca9f
+  data.tar.gz: c3094796cde53a394b4b819047e1d1d38c492efb2e20d0b5c736f7ee891a46ce5eca065f43b2a063237fb215fdbf0a8921de19421b68b5cd2ad349c06ea7d31a

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--profile

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-gemset

@@ -0,0 +1 @@
+plants

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-28
+
+- 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 vhector.1337@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,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in plants.gemspec
+gemspec
+
+group :development do
+  gem "rake", "~> 13.0"
+
+  gem "rspec", "~> 3.0"
+
+  gem "rubocop", "~> 1.21"
+
+  gem 'simplecov', '~> 0'
+
+  gem 'sord', '~> 6'
+
+  gem 'webmock', '~> 3'
+end

data/README.md

@@ -0,0 +1,124 @@
+# Plants
+Gem to interact with the [trefle](https://docs.trefle.io/reference) API.
+
+## Install
+`spec.add_dependency 'plants', ~> 0`
+
+## Usage
+You need an authorization token, [see this](https://docs.trefle.io/docs/guides/getting-started).
+```ruby
+Plants.token = 'your token here'
+Plants.list_plants # ... 
+```
+
+### Endpoints
+#### Corrections
+```ruby
+# List
+Plants.list_corrections
+
+# Find 
+Plants.find_correction('correction')
+```
+
+#### Distributions
+```ruby
+# List
+Plants.list_distributions
+
+# Find 
+Plants.find_distribution('correction')
+```
+
+#### Division Classes
+```ruby
+# List
+Plants.list_division_classes
+
+# Find 
+Plants.find_division_class('class')
+```
+
+#### Division Orders
+```ruby
+# List
+Plants.list_division_orders
+
+# Find 
+Plants.find_division_order('order')
+```
+
+#### Divisions
+```ruby
+# List
+Plants.list_divisions
+
+# Find 
+Plants.find_division('division')
+```
+
+#### Families
+```ruby
+# List
+Plants.list_families
+
+# Find 
+Plants.find_family('family')
+```
+
+#### Genus
+```ruby
+# List
+Plants.list_genera
+
+# Find 
+Plants.find_genus('genus')
+```
+
+#### Kingdoms
+```ruby
+# List
+Plants.list_kingdoms
+
+# Find 
+Plants.find_kingdom('kingodm')
+```
+
+#### Plants
+```ruby
+# List
+Plants.list_plants
+
+# Find 
+Plants.find_plant('plant')
+
+# Search
+Plants.search_for_plant('plant')
+
+# List for Genus
+Plants.list_plants_for_genus('genus')
+
+# List for Distribution Zone
+Plants.list_plants_for_distribution_zone('zone')
+```
+
+#### Species
+```ruby
+# List
+Plants.list_species
+
+# Find 
+Plants.find_species('species')
+
+# Search
+Plants.search_for_species('species')
+```
+
+#### Subkingdoms
+```ruby
+# List
+Plants.list_subkingdoms
+
+# Find 
+Plants.find_subkingdom('subkingdom')
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/plants/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'http'
+
+require 'plants/log'
+require 'plants/config'
+require 'plants/version'
+
+module Plants
+  # HTTP Client
+  #
+  # @!attribute [r] config
+  #   @return [Plants::Config]
+  #
+  class Client
+    # @return [String] Trefle API URL
+    URL = 'https://trefle.io/api/v1'
+
+    # @param config [Plants::Config]
+    def initialize(config = Config.new)
+      @config = config
+    end
+    attr_reader :config
+
+
+    # @param resource [String]
+    # @param params [Hash]
+    # @return [::HTTP::Response]
+    def get(resource, params: {})
+      params.merge!({ token: config.token }) if config.token
+      http.get("#{URL}/#{resource}", params: params)
+    end
+
+    private
+
+    # @return [::HTTP::Client]
+    def http
+      HTTP
+        .timeout(10)
+        .use(logging: { logger: Log.instance })
+        .headers({ 'User-Agent' => "Plants #{Plants::VERSION} ruby-#{RUBY_VERSION}" })
+    end
+  end
+end

data/lib/plants/config.rb

@@ -0,0 +1,13 @@
+module Plants
+  # Configuration class
+  #
+  # @!attribute token
+  #   @return [String]
+  #
+  class Config
+    def initialize
+      @token = nil
+    end
+    attr_accessor :token
+  end
+end

data/lib/plants/log.rb

@@ -0,0 +1,53 @@
+require 'logger'
+
+module Plants
+  # Simple split logger
+  class Log
+    def initialize
+      @stdout = Logger.new(STDOUT)
+      @stderr = Logger.new(STDERR)
+    end
+
+    # @param progname [String]
+    # @param block [Proc]
+    # @return [void]
+    def debug(progname = nil, &block)
+      @stdout.debug(progname, &block)
+    end
+
+    # @param progname [String]
+    # @param block [Proc]
+    # @return [void]
+    def info(progname = nil, &block)
+      @stdout.info(progname, &block)
+    end
+
+    # @param progname [String]
+    # @param block [Proc]
+    # @return [void]
+    def warn(progname = nil, &block)
+      @stderr.warn(progname, &block)
+    end
+
+    # @param progname [String]
+    # @param block [Proc]
+    # @return [void]
+    def error(progname = nil, &block)
+      @stderr.error(progname, &block)
+    end
+
+    # @param progname [String]
+    # @param block [Proc]
+    # @return [void]
+    def fatal(progname = nil, &block)
+      @stderr.fatal(progname, &block)
+    end
+
+    class << self
+      # @return [Plants::Log]
+      def instance
+        @_instance ||= new
+      end
+    end
+  end
+end

data/lib/plants/resources/corrections.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Corrections module
+    # @see https://docs.trefle.io/reference#tag/Corrections
+    module Corrections
+      # GET /corrections
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_corrections(params: {})
+        client.get('corrections', params: params)
+      end
+
+      # @param correction [String]
+      # @return [::HTTP::Response]
+      def find_correction(correction)
+        client.get("corrections/#{correction}")
+      end
+    end
+  end
+end

data/lib/plants/resources/distributions.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Distributions module
+    # @see https://docs.trefle.io/reference#tag/Distributions
+    module Distributions
+      # GET /distributions
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_distributions(params: {})
+        client.get('distributions', params: params)
+      end
+
+      # @param distribution [String]
+      # @return [::HTTP::Response]
+      def find_distribution(distribution)
+        client.get("distributions/#{distribution}")
+      end
+    end
+  end
+end

data/lib/plants/resources/division_classes.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Division classes module
+    # @see https://docs.trefle.io/reference#tag/DivisionClasses
+    module DivisionClasses
+      # GET /division_classes
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_division_classes(params: {})
+        client.get('division_classes', params: params)
+      end
+
+      # @param division_class [String]
+      # @return [::HTTP::Response]
+      def find_division_class(division_class)
+        client.get("division_classes/#{division_class}")
+      end
+    end
+  end
+end

data/lib/plants/resources/division_orders.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Division orders module
+    # @see https://docs.trefle.io/reference#tag/DivisionOrders
+    module DivisionOrders
+      # GET /division_orders
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_division_orders(params: {})
+        client.get('division_orders', params: params)
+      end
+
+      # @param division_order [String]
+      # @return [::HTTP::Response]
+      def find_division_order(division_order)
+        client.get("division_orders/#{division_order}")
+      end
+    end
+  end
+end

data/lib/plants/resources/divisions.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Divisions module
+    # @see https://docs.trefle.io/reference#tag/Divisions
+    module Divisions
+      # GET /divisions
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_divisions(params: {})
+        client.get('divisions', params: params)
+      end
+
+      # @param division [String]
+      # @return [::HTTP::Response]
+      def find_division(division)
+        client.get("divisions/#{division}")
+      end
+    end
+  end
+end

data/lib/plants/resources/families.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Families module
+    # @see https://docs.trefle.io/reference#tag/Families
+    module Families
+      # GET /families
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_families(params: {})
+        client.get('families', params: params)
+      end
+
+      # @param family [String]
+      # @return [::HTTP::Response]
+      def find_family(family)
+        client.get("families/#{family}")
+      end
+    end
+  end
+end

data/lib/plants/resources/genus.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Genera module
+    # @see https://docs.trefle.io/reference#tag/Genus
+    module Genus
+      # GET /genus
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_genera(params: {})
+        client.get('genus', params: params)
+      end
+
+      # @param genus [String]
+      # @return [::HTTP::Response]
+      def find_genus(genus)
+        client.get("genus/#{genus}")
+      end
+    end
+  end
+end

data/lib/plants/resources/kingdoms.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Kingdoms module
+    # @see https://docs.trefle.io/reference#tag/Kingdoms
+    module Kingdoms
+      # GET /kingdoms
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_kingdoms(params: {})
+        client.get('kingdoms', params: params)
+      end
+
+      # @param kingdom [String]
+      # @return [::HTTP::Response]
+      def find_kingdom(kingdom)
+        client.get("kingdoms/#{kingdom}")
+      end
+    end
+  end
+end

data/lib/plants/resources/plants.rb

@@ -0,0 +1,42 @@
+module Plants
+  module Resources
+    # Plants resource
+    # @see https://docs.trefle.io/reference#tag/Plants
+    module Plants
+      # GET /plants
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_plants(params: {})
+        client.get('plants', params: params)
+      end
+
+      # GET /plants/{plant}
+      # @param plant [String]
+      # @return [::HTTP::Response]
+      def find_plant(plant)
+        client.get("plants/#{plant}")
+      end
+
+      # @param plant [String]
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def search_for_plant(plant, params: {})
+        client.get('plants/search', params: params.merge({ q: plant }))
+      end
+
+      # @param genus [String]
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_plants_for_genus(genus, params: {})
+        client.get("genus/#{genus}/plants", params: params)
+      end
+
+      # @param zone [String]
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_plants_for_distribution_zone(zone, params: {})
+        client.get("distributions/#{zone}/plants", params: params)
+      end
+    end
+  end
+end

data/lib/plants/resources/species.rb

@@ -0,0 +1,26 @@
+module Plants
+  module Resources
+    # Species module
+    # @see https://docs.trefle.io/reference#tag/Species
+    module Species
+      # GET /species
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_species(params: {})
+        client.get('species', params: params)
+      end
+
+      # @param species [String]
+      # @return [::HTTP::Response]
+      def find_species(species)
+        client.get("species/#{species}")
+      end
+
+      # @param species [String]
+      # @return [::HTTP::Response]s
+      def search_for_species(species)
+        client.get("species/search", params: { q: species })
+      end
+    end
+  end
+end

data/lib/plants/resources/subkingdoms.rb

@@ -0,0 +1,20 @@
+module Plants
+  module Resources
+    # Subkingdoms module
+    # @see https://docs.trefle.io/reference#tag/Subkingdoms
+    module Subkingdoms
+      # GET /subkingdoms
+      # @param params [Hash]
+      # @return [::HTTP::Response]
+      def list_subkingdoms(params: {})
+        client.get('subkingdoms', params: params)
+      end
+
+      # @param kingdom [String]
+      # @return [::HTTP::Response]
+      def find_subkingdom(kingdom)
+        client.get("subkingdoms/#{kingdom}")
+      end
+    end
+  end
+end

data/lib/plants/resources.rb

@@ -0,0 +1,28 @@
+require 'plants/resources/corrections'
+require 'plants/resources/distributions'
+require 'plants/resources/division_classes'
+require 'plants/resources/division_orders'
+require 'plants/resources/divisions'
+require 'plants/resources/families'
+require 'plants/resources/genus'
+require 'plants/resources/kingdoms'
+require 'plants/resources/plants'
+require 'plants/resources/species'
+require 'plants/resources/subkingdoms'
+
+module Plants
+  # Resources 'container' module
+  module Resources
+    include Corrections
+    include Distributions
+    include DivisionClasses
+    include DivisionOrders
+    include Divisions
+    include Families
+    include Genus
+    include Kingdoms
+    include Plants
+    include Species
+    include Subkingdoms
+  end
+end

data/lib/plants/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Plants
+  # @return [String]
+  VERSION = "0.1.0"
+end

data/lib/plants.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "plants/client"
+require "plants/config"
+require "plants/resources"
+require "plants/version"
+
+# Plants :)
+module Plants
+  extend Plants::Resources
+
+  class << self
+
+    # @param new_value [String]
+    # @return [void]
+    def token=(new_value)
+      client.config.token = new_value
+    end
+
+    # @return [Plants::Config]
+    def config
+      client.config
+    end
+
+    private
+
+    # @return [Plants::Client]
+    def client
+      @_client ||= Client.new
+    end
+  end
+end

data/plants.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/plants/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "plants"
+  spec.version = Plants::VERSION
+  spec.authors = ["Xero"]
+  spec.email = ["vhector.1337@gmail.com"]
+
+  spec.summary = "Plants API gem."
+  spec.description = "Gem to interact with Trefle API."
+  spec.homepage = "https://github.com/one-m1nd/plants"
+  spec.required_ruby_version = ">= 3"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "http", "~> 5"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/plants.rbs

@@ -0,0 +1,381 @@
+# Plants :)
+module Plants
+  extend Plants::Resources
+  VERSION: String
+
+  # _@param_ `new_value`
+  def self.token=: (String new_value) -> void
+
+  def self.config: () -> Plants::Config
+
+  def self.client: () -> Plants::Client
+
+  # GET /subkingdoms
+  # 
+  # _@param_ `params`
+  def self.list_subkingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `kingdom`
+  def self.find_subkingdom: (String kingdom) -> ::HTTP::Response
+
+  # GET /species
+  # 
+  # _@param_ `params`
+  def self.list_species: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `species`
+  def self.find_species: (String species) -> ::HTTP::Response
+
+  # _@param_ `species`
+  # 
+  # _@return_ — s
+  def self.search_for_species: (String species) -> ::HTTP::Response
+
+  # GET /kingdoms
+  # 
+  # _@param_ `params`
+  def self.list_kingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `kingdom`
+  def self.find_kingdom: (String kingdom) -> ::HTTP::Response
+
+  # GET /genus
+  # 
+  # _@param_ `params`
+  def self.list_genera: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `genus`
+  def self.find_genus: (String genus) -> ::HTTP::Response
+
+  # GET /families
+  # 
+  # _@param_ `params`
+  def self.list_families: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `family`
+  def self.find_family: (String family) -> ::HTTP::Response
+
+  # GET /divisions
+  # 
+  # _@param_ `params`
+  def self.list_divisions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `division`
+  def self.find_division: (String division) -> ::HTTP::Response
+
+  # GET /division_orders
+  # 
+  # _@param_ `params`
+  def self.list_division_orders: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `division_order`
+  def self.find_division_order: (String division_order) -> ::HTTP::Response
+
+  # GET /division_classes
+  # 
+  # _@param_ `params`
+  def self.list_division_classes: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+  # _@param_ `division_class`
+  def self.find_division_class: (String division_class) -> ::HTTP::Response
+
+  # GET /distributions
+  # 
+  # _@param_ `params`
+  def self.list_distributions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+  # _@param_ `distribution`
+  def self.find_distribution: (String distribution) -> ::HTTP::Response
+
+  # GET /corrections
+  # 
+  # _@param_ `params`
+  def self.list_corrections: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+  # _@param_ `correction`
+  def self.find_correction: (String correction) -> ::HTTP::Response
+
+  # HTTP Client
+  # 
+  # @!attribute [r] config
+  #   @return [Plants::Config]
+  class Client
+    URL: String
+
+    # _@param_ `config`
+    def initialize: (?Plants::Config config) -> void
+
+    # _@param_ `resource`
+    # 
+    # _@param_ `params`
+    def get: (String resource, ?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    def http: () -> ::HTTP::Client
+
+    attr_reader config: Plants::Config
+  end
+
+  # Configuration class
+  # 
+  # @!attribute token
+  #   @return [String]
+  class Config
+    def initialize: () -> void
+
+    attr_accessor token: String
+  end
+
+  # Resources 'container' module
+  module Resources
+    include Plants::Resources::Corrections
+    include Plants::Resources::Distributions
+    include Plants::Resources::DivisionClasses
+    include Plants::Resources::DivisionOrders
+    include Plants::Resources::Divisions
+    include Plants::Resources::Families
+    include Plants::Resources::Genus
+    include Plants::Resources::Kingdoms
+    include Plants
+    include Plants::Resources::Species
+    include Plants::Resources::Subkingdoms
+
+    # GET /subkingdoms
+    # 
+    # _@param_ `params`
+    def list_subkingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `kingdom`
+    def find_subkingdom: (String kingdom) -> ::HTTP::Response
+
+    # GET /species
+    # 
+    # _@param_ `params`
+    def list_species: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `species`
+    def find_species: (String species) -> ::HTTP::Response
+
+    # _@param_ `species`
+    # 
+    # _@return_ — s
+    def search_for_species: (String species) -> ::HTTP::Response
+
+    # GET /kingdoms
+    # 
+    # _@param_ `params`
+    def list_kingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `kingdom`
+    def find_kingdom: (String kingdom) -> ::HTTP::Response
+
+    # GET /genus
+    # 
+    # _@param_ `params`
+    def list_genera: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `genus`
+    def find_genus: (String genus) -> ::HTTP::Response
+
+    # GET /families
+    # 
+    # _@param_ `params`
+    def list_families: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `family`
+    def find_family: (String family) -> ::HTTP::Response
+
+    # GET /divisions
+    # 
+    # _@param_ `params`
+    def list_divisions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `division`
+    def find_division: (String division) -> ::HTTP::Response
+
+    # GET /division_orders
+    # 
+    # _@param_ `params`
+    def list_division_orders: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `division_order`
+    def find_division_order: (String division_order) -> ::HTTP::Response
+
+    # GET /division_classes
+    # 
+    # _@param_ `params`
+    def list_division_classes: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+    # _@param_ `division_class`
+    def find_division_class: (String division_class) -> ::HTTP::Response
+
+    # GET /distributions
+    # 
+    # _@param_ `params`
+    def list_distributions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+    # _@param_ `distribution`
+    def find_distribution: (String distribution) -> ::HTTP::Response
+
+    # GET /corrections
+    # 
+    # _@param_ `params`
+    def list_corrections: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+    # _@param_ `correction`
+    def find_correction: (String correction) -> ::HTTP::Response
+
+    # Genera module
+    # @see https://docs.trefle.io/reference#tag/Genus
+    module Genus
+      # GET /genus
+      # 
+      # _@param_ `params`
+      def list_genera: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `genus`
+      def find_genus: (String genus) -> ::HTTP::Response
+    end
+
+    # Plants resource
+    # @see https://docs.trefle.io/reference#tag/Plants
+    module Plants
+      # GET /plants
+      # 
+      # _@param_ `params`
+      def list_plants: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # GET /plants/{plant}
+      # 
+      # _@param_ `plant`
+      def find_plant: (String plant) -> ::HTTP::Response
+
+      # _@param_ `plant`
+      # 
+      # _@param_ `params`
+      def search_for_plant: (String plant, ?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `genus`
+      # 
+      # _@param_ `params`
+      def list_plants_for_genus: (String genus, ?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `zone`
+      # 
+      # _@param_ `params`
+      def list_plants_for_distribution_zone: (String zone, ?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+    end
+
+    # Species module
+    # @see https://docs.trefle.io/reference#tag/Species
+    module Species
+      # GET /species
+      # 
+      # _@param_ `params`
+      def list_species: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `species`
+      def find_species: (String species) -> ::HTTP::Response
+
+      # _@param_ `species`
+      # 
+      # _@return_ — s
+      def search_for_species: (String species) -> ::HTTP::Response
+    end
+
+    # Families module
+    # @see https://docs.trefle.io/reference#tag/Families
+    module Families
+      # GET /families
+      # 
+      # _@param_ `params`
+      def list_families: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `family`
+      def find_family: (String family) -> ::HTTP::Response
+    end
+
+    # Kingdoms module
+    # @see https://docs.trefle.io/reference#tag/Kingdoms
+    module Kingdoms
+      # GET /kingdoms
+      # 
+      # _@param_ `params`
+      def list_kingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `kingdom`
+      def find_kingdom: (String kingdom) -> ::HTTP::Response
+    end
+
+    # Divisions module
+    # @see https://docs.trefle.io/reference#tag/Divisions
+    module Divisions
+      # GET /divisions
+      # 
+      # _@param_ `params`
+      def list_divisions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `division`
+      def find_division: (String division) -> ::HTTP::Response
+    end
+
+    # Corrections module
+    # @see https://docs.trefle.io/reference#tag/Corrections
+    module Corrections
+      # GET /corrections
+      # 
+      # _@param_ `params`
+      def list_corrections: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+      # _@param_ `correction`
+      def find_correction: (String correction) -> ::HTTP::Response
+    end
+
+    # Subkingdoms module
+    # @see https://docs.trefle.io/reference#tag/Subkingdoms
+    module Subkingdoms
+      # GET /subkingdoms
+      # 
+      # _@param_ `params`
+      def list_subkingdoms: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `kingdom`
+      def find_subkingdom: (String kingdom) -> ::HTTP::Response
+    end
+
+    # Distributions module
+    # @see https://docs.trefle.io/reference#tag/Distributions
+    module Distributions
+      # GET /distributions
+      # 
+      # _@param_ `params`
+      def list_distributions: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `distribution`
+      def find_distribution: (String distribution) -> ::HTTP::Response
+    end
+
+    # Division orders module
+    # @see https://docs.trefle.io/reference#tag/DivisionOrders
+    module DivisionOrders
+      # GET /division_orders
+      # 
+      # _@param_ `params`
+      def list_division_orders: (?params: ::Hash[untyped, untyped]) -> ::HTTP::Response
+
+      # _@param_ `division_order`
+      def find_division_order: (String division_order) -> ::HTTP::Response
+    end
+
+    # Division classes module
+    # @see https://docs.trefle.io/reference#tag/DivisionClasses
+    module DivisionClasses
+      # GET /division_classes
+      # 
+      # _@param_ `params`
+      def list_division_classes: (::Hash[untyped, untyped] params) -> ::HTTP::Response
+
+      # _@param_ `division_class`
+      def find_division_class: (String division_class) -> ::HTTP::Response
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: plants
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Gem to interact with Trefle API.
+email:
+- vhector.1337@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/plants.rb
+- lib/plants/client.rb
+- lib/plants/config.rb
+- lib/plants/log.rb
+- lib/plants/resources.rb
+- lib/plants/resources/corrections.rb
+- lib/plants/resources/distributions.rb
+- lib/plants/resources/division_classes.rb
+- lib/plants/resources/division_orders.rb
+- lib/plants/resources/divisions.rb
+- lib/plants/resources/families.rb
+- lib/plants/resources/genus.rb
+- lib/plants/resources/kingdoms.rb
+- lib/plants/resources/plants.rb
+- lib/plants/resources/species.rb
+- lib/plants/resources/subkingdoms.rb
+- lib/plants/version.rb
+- plants.gemspec
+- sig/plants.rbs
+homepage: https://github.com/one-m1nd/plants
+licenses: []
+metadata:
+  homepage_uri: https://github.com/one-m1nd/plants
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Plants API gem.
+test_files: []