fishfyi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5120437ea2b7e29a81038697e0b79b178039fceaf1507fb0b02515a307a1fb98
+  data.tar.gz: 0206bfd9e9d87b6cd8d4f4dac0e784cf6524938ec9c0e0c97c4b7310f9caef1a
+SHA512:
+  metadata.gz: 4bba80b36aa5d67bab270b0a6ffe1bf9246dd80a63c9e1856514732a2354f52cfb26249a04778bd427769b143efda64d604e48558bc424648cafdce577b50451
+  data.tar.gz: 724c6c39d59d4519bfaf0764c8dc81a97351378edcc63477b7646e82571d4a960498b1edcf6fbea48e26a02ad769e7267017d6a5d54524c0dfaebb6bce73d97c

data/lib/fishfyi.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+# Ruby client for FishFYI REST API (fishfyi.com).
+#
+#   client = FishFYI::Client.new
+#   result = client.search("query")
+#
+module FishFYI
+  class Client
+    BASE_URL = "https://fishfyi.com"
+
+    def initialize(base_url: BASE_URL)
+      @base_url = base_url
+    end
+
+    def search(query)
+      get("/api/v1/search/", q: query)
+    end
+
+    # List all compatibility.
+    def list_compatibility
+      get("/api/v1/compatibility/")
+    end
+
+    # Get compatibility by slug.
+    def get_compatibility(slug)
+      get("/api/v1/compatibility/#{slug}/")
+    end
+    # List all countries.
+    def list_countries
+      get("/api/v1/countries/")
+    end
+
+    # Get country by slug.
+    def get_country(slug)
+      get("/api/v1/countries/#{slug}/")
+    end
+    # List all families.
+    def list_families
+      get("/api/v1/families/")
+    end
+
+    # Get family by slug.
+    def get_family(slug)
+      get("/api/v1/families/#{slug}/")
+    end
+    # List all faqs.
+    def list_faqs
+      get("/api/v1/faqs/")
+    end
+
+    # Get faq by slug.
+    def get_faq(slug)
+      get("/api/v1/faqs/#{slug}/")
+    end
+    # List all fish.
+    def list_fish
+      get("/api/v1/fish/")
+    end
+
+    # Get fish by slug.
+    def get_fish(slug)
+      get("/api/v1/fish/#{slug}/")
+    end
+    # List all glossary.
+    def list_glossary
+      get("/api/v1/glossary/")
+    end
+
+    # Get term by slug.
+    def get_term(slug)
+      get("/api/v1/glossary/#{slug}/")
+    end
+    # List all glossary categories.
+    def list_glossary_categories
+      get("/api/v1/glossary-categories/")
+    end
+
+    # Get glossary category by slug.
+    def get_glossary_category(slug)
+      get("/api/v1/glossary-categories/#{slug}/")
+    end
+    # List all guide series.
+    def list_guide_series
+      get("/api/v1/guide-series/")
+    end
+
+    # Get guide sery by slug.
+    def get_guide_sery(slug)
+      get("/api/v1/guide-series/#{slug}/")
+    end
+    # List all guides.
+    def list_guides
+      get("/api/v1/guides/")
+    end
+
+    # Get guide by slug.
+    def get_guide(slug)
+      get("/api/v1/guides/#{slug}/")
+    end
+    # List all methods.
+    def list_methods
+      get("/api/v1/methods/")
+    end
+
+    # Get method by slug.
+    def get_method(slug)
+      get("/api/v1/methods/#{slug}/")
+    end
+    # List all orders.
+    def list_orders
+      get("/api/v1/orders/")
+    end
+
+    # Get order by slug.
+    def get_order(slug)
+      get("/api/v1/orders/#{slug}/")
+    end
+    # List all regions.
+    def list_regions
+      get("/api/v1/regions/")
+    end
+
+    # Get region by slug.
+    def get_region(slug)
+      get("/api/v1/regions/#{slug}/")
+    end
+    # List all seasons.
+    def list_seasons
+      get("/api/v1/seasons/")
+    end
+
+    # Get season by slug.
+    def get_season(slug)
+      get("/api/v1/seasons/#{slug}/")
+    end
+    # List all water bodies.
+    def list_water_bodies
+      get("/api/v1/water-bodies/")
+    end
+
+    # Get water body by slug.
+    def get_water_body(slug)
+      get("/api/v1/water-bodies/#{slug}/")
+    end
+
+    private
+
+    def get(path, **params)
+      uri = URI.join(@base_url, path)
+      uri.query = URI.encode_www_form(params) unless params.empty?
+      response = Net::HTTP.get_response(uri)
+      raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+      JSON.parse(response.body)
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: fishfyi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- FYIPedia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-21 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client for the FishFYI REST API at fishfyi.com. Zero external dependencies.
+email: dev@fyipedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fishfyi.rb
+homepage: https://fishfyi.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/fyipedia/fishfyi-rb
+  documentation_uri: https://fishfyi.com/api/v1/schema/
+  homepage_uri: https://fishfyi.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for FishFYI API
+test_files: []