mineralfyi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: deff232691cb4b29c6fddd4570f77d12d18a826417880e02bb6480e3f8a6db2d
+  data.tar.gz: 6c2c6b5003ffc34c2f023b3b990fb5757afee9d08f6dc72e20931b68670f751e
+SHA512:
+  metadata.gz: 833564712815e52a5da7cbb88801977423b01a7b6b236f9c75ff959f812188fe0471aa7e50b0193ffbbf21e198756ffb079a2658cef31ea59a0bc1958cc84a06
+  data.tar.gz: fb47cb9eed25ba552844d7e70aa5c62f314815f43e210e4ef2aefa0ec5a210a105a082c6d8b19484050fc5d732201b84afae0e3022725cd0d03e1a0ee5fb9303

data/lib/mineralfyi.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+# Ruby client for MineralFYI REST API (mineralfyi.com).
+#
+#   client = MineralFYI::Client.new
+#   result = client.search("query")
+#
+module MineralFYI
+  class Client
+    BASE_URL = "https://mineralfyi.com"
+
+    def initialize(base_url: BASE_URL)
+      @base_url = base_url
+    end
+
+    def search(query)
+      get("/api/v1/search/", q: query)
+    end
+
+    # List all classes.
+    def list_classes
+      get("/api/v1/classes/")
+    end
+
+    # Get classe by slug.
+    def get_classe(slug)
+      get("/api/v1/classes/#{slug}/")
+    end
+    # List all comparisons.
+    def list_comparisons
+      get("/api/v1/comparisons/")
+    end
+
+    # Get comparison by slug.
+    def get_comparison(slug)
+      get("/api/v1/comparisons/#{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 crystal systems.
+    def list_crystal_systems
+      get("/api/v1/crystal-systems/")
+    end
+
+    # Get crystal system by slug.
+    def get_crystal_system(slug)
+      get("/api/v1/crystal-systems/#{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 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 localities.
+    def list_localities
+      get("/api/v1/localities/")
+    end
+
+    # Get locality by slug.
+    def get_locality(slug)
+      get("/api/v1/localities/#{slug}/")
+    end
+    # List all minerals.
+    def list_minerals
+      get("/api/v1/minerals/")
+    end
+
+    # Get mineral by slug.
+    def get_mineral(slug)
+      get("/api/v1/minerals/#{slug}/")
+    end
+    # List all rock types.
+    def list_rock_types
+      get("/api/v1/rock-types/")
+    end
+
+    # Get rock type by slug.
+    def get_rock_type(slug)
+      get("/api/v1/rock-types/#{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,47 @@
+--- !ruby/object:Gem::Specification
+name: mineralfyi
+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 MineralFYI REST API at mineralfyi.com. Zero external
+  dependencies.
+email: dev@fyipedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mineralfyi.rb
+homepage: https://mineralfyi.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/fyipedia/mineralfyi-rb
+  documentation_uri: https://mineralfyi.com/api/v1/schema/
+  homepage_uri: https://mineralfyi.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 MineralFYI API
+test_files: []