citedhealth 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1412f03c7f37f1c6e05d1cf651bd2185e9fe0a3697793bb352387199f907acf
-  data.tar.gz: 3237403eebbb4a5710df421e9462e43353a9c9eb8f772f1b99617e08695aee36
+  metadata.gz: e4d8d98d5d0436b85f88bf33f0533b1f321dfb353fb447b04dc7ddf6257c942b
+  data.tar.gz: 4397209a7ce632b899cd4b22e1474bddb2ce329bf33e135c21cdb6ed2584d517
 SHA512:
-  metadata.gz: 7fa44b8d9936beb53096330f88563dfcde9a17b4d45e8383da02ba4bd0e6ee937fbcade18f5eeae66d2989f7d9f7baec811c2850d7b88062265593648045ea1c
-  data.tar.gz: ded37c88e38fe195e3efe64a7e6383dbd10105621b1d6c68e8e915a41cfed52288caf78bd9441863e1e6526c001287a74aeaa4dc50284b69b1b215757ba8fc3c
+  metadata.gz: 1e85ad6f1ed398cfc39fbb2c8221f9f64ed1f4cd2825e93e489cff2eabeba8ed29b894c1505f312f63dce45404efa02669951c458405130c17099533d0c65f39
+  data.tar.gz: 8475541e7d88b3134e0fc897c3fcd2523057078187d3a60977043dccceca983b511129731e098c9755d66cbf2a66fc3b3514bf961fdec5bb7227c76e9428fd17

data/exe/citedhealth

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "citedhealth"
+require "citedhealth/cli"
+
+CitedHealth::CLI.run(ARGV)

data/lib/citedhealth/cli.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "json"
+
+module CitedHealth
+  # Command-line interface for the Cited Health API.
+  #
+  # Provides 5 subcommands to search ingredients, evidence, and papers
+  # from the terminal. Zero runtime dependencies beyond Ruby stdlib.
+  #
+  #   citedhealth ingredients biotin
+  #   citedhealth ingredient vitamin-d
+  #   citedhealth evidence biotin hair-loss
+  #   citedhealth papers --year 2024
+  #   citedhealth paper 12345678
+  #
+  module CLI
+    USAGE = <<~HELP
+      Usage: citedhealth <command> [options]
+
+      Commands:
+        ingredients [QUERY] [-c CATEGORY]   Search ingredients
+        ingredient SLUG                     Get ingredient details
+        evidence INGREDIENT CONDITION       Get evidence for a pair
+        papers [QUERY] [-y YEAR]            Search research papers
+        paper PMID                          Get paper by PubMed ID
+        conditions [--featured]             List health conditions
+        condition SLUG                      Get condition details
+        glossary [-c CATEGORY]              List glossary terms
+        glossary-term SLUG                  Get glossary term details
+        guides [-c CATEGORY]               List guides
+        guide SLUG                          Get guide details
+
+      Options:
+        --json       Compact JSON output
+        --version    Show version
+        --help       Show this help
+    HELP
+
+    class << self
+      def run(argv)
+        args = argv.dup
+        compact = extract_flag!(args, "--json")
+
+        if extract_flag!(args, "--version")
+          puts "citedhealth #{CitedHealth::VERSION}"
+          return
+        end
+
+        if args.empty? || extract_flag!(args, "--help")
+          puts USAGE
+          return
+        end
+
+        command = args.shift
+        client = CitedHealth::Client.new
+
+        result = case command
+                 when "ingredients"   then cmd_ingredients(client, args)
+                 when "ingredient"    then cmd_ingredient(client, args)
+                 when "evidence"      then cmd_evidence(client, args)
+                 when "papers"        then cmd_papers(client, args)
+                 when "paper"         then cmd_paper(client, args)
+                 when "conditions"    then cmd_conditions(client, args)
+                 when "condition"     then cmd_condition(client, args)
+                 when "glossary"      then cmd_glossary(client, args)
+                 when "glossary-term" then cmd_glossary_term(client, args)
+                 when "guides"        then cmd_guides(client, args)
+                 when "guide"         then cmd_guide(client, args)
+                 else
+                   warn "Unknown command: #{command}"
+                   warn USAGE
+                   exit 1
+                 end
+
+        output(result, compact: compact)
+      rescue CitedHealth::NotFoundError => e
+        warn "Error: #{e.message}"
+        exit 1
+      rescue CitedHealth::RateLimitError => e
+        msg = "Error: Rate limit exceeded"
+        msg += " (retry after #{e.retry_after}s)" if e.retry_after
+        warn msg
+        exit 1
+      rescue CitedHealth::Error => e
+        warn "Error: #{e.message}"
+        exit 1
+      end
+
+      private
+
+      def extract_flag!(args, flag)
+        if args.include?(flag)
+          args.delete(flag)
+          true
+        else
+          false
+        end
+      end
+
+      def cmd_ingredients(client, args)
+        category = extract_option!(args, "-c")
+        query = args.join(" ")
+        results = client.search_ingredients(query: query, category: category || "")
+        results.map { |i| to_hash(i) }
+      end
+
+      def cmd_ingredient(client, args)
+        slug = args.shift
+        if slug.nil? || slug.empty?
+          warn "Usage: citedhealth ingredient SLUG"
+          exit 1
+        end
+        to_hash(client.get_ingredient(slug))
+      end
+
+      def cmd_evidence(client, args)
+        ingredient_slug = args.shift
+        condition_slug = args.shift
+        if ingredient_slug.nil? || condition_slug.nil?
+          warn "Usage: citedhealth evidence INGREDIENT CONDITION"
+          exit 1
+        end
+        to_hash(client.get_evidence(
+          ingredient_slug: ingredient_slug,
+          condition_slug: condition_slug
+        ))
+      end
+
+      def cmd_papers(client, args)
+        year_str = extract_option!(args, "-y")
+        year = year_str&.to_i
+        query = args.join(" ")
+        results = client.search_papers(query: query, year: year)
+        results.map { |p| to_hash(p) }
+      end
+
+      def cmd_paper(client, args)
+        pmid = args.shift
+        if pmid.nil? || pmid.empty?
+          warn "Usage: citedhealth paper PMID"
+          exit 1
+        end
+        to_hash(client.get_paper(pmid))
+      end
+
+      def cmd_conditions(client, args)
+        featured = extract_flag!(args, "--featured")
+        is_featured = featured ? true : nil
+        results = client.list_conditions(is_featured: is_featured)
+        results.map { |c| to_hash(c) }
+      end
+
+      def cmd_condition(client, args)
+        slug = args.shift
+        if slug.nil? || slug.empty?
+          warn "Usage: citedhealth condition SLUG"
+          exit 1
+        end
+        to_hash(client.get_condition(slug))
+      end
+
+      def cmd_glossary(client, args)
+        category = extract_option!(args, "-c")
+        results = client.list_glossary(category: category)
+        results.map { |t| to_hash(t) }
+      end
+
+      def cmd_glossary_term(client, args)
+        slug = args.shift
+        if slug.nil? || slug.empty?
+          warn "Usage: citedhealth glossary-term SLUG"
+          exit 1
+        end
+        to_hash(client.get_glossary_term(slug))
+      end
+
+      def cmd_guides(client, args)
+        category = extract_option!(args, "-c")
+        results = client.list_guides(category: category)
+        results.map { |g| to_hash(g) }
+      end
+
+      def cmd_guide(client, args)
+        slug = args.shift
+        if slug.nil? || slug.empty?
+          warn "Usage: citedhealth guide SLUG"
+          exit 1
+        end
+        to_hash(client.get_guide(slug))
+      end
+
+      def extract_option!(args, flag)
+        idx = args.index(flag)
+        return nil unless idx
+
+        args.delete_at(idx) # remove flag
+        args.delete_at(idx) # remove value
+      end
+
+      def to_hash(obj)
+        hash = {}
+        obj.instance_variables.each do |var|
+          key = var.to_s.delete_prefix("@")
+          value = obj.instance_variable_get(var)
+          hash[key] = case value
+                      when CitedHealth::NestedIngredient, CitedHealth::Condition,
+                           CitedHealth::GlossaryTerm, CitedHealth::Guide
+                        to_hash(value)
+                      else
+                        value
+                      end
+        end
+        hash
+      end
+
+      def output(data, compact:)
+        if compact
+          puts JSON.generate(data)
+        else
+          puts JSON.pretty_generate(data)
+        end
+      end
+    end
+  end
+end

data/lib/citedhealth/client.rb

@@ -15,7 +15,7 @@ module CitedHealth
   #   puts ingredient.name  # => "Vitamin D"
   #
   class Client
-    DEFAULT_BASE_URL = "https://citedhealth.com"
+    DEFAULT_BASE_URL = "https://haircited.com"
     DEFAULT_TIMEOUT  = 30
 
     def initialize(base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT)
@@ -97,6 +97,75 @@ module CitedHealth
       Paper.from_hash(data)
     end
 
+    # List health conditions, optionally filtered by featured status.
+    #
+    # @param is_featured [Boolean, nil] filter by featured status
+    # @return [Array<Condition>] list of conditions
+    def list_conditions(is_featured: nil)
+      params = {}
+      params[:is_featured] = is_featured.to_s unless is_featured.nil?
+
+      data = get("/api/conditions/", params)
+      results = data["results"] || []
+      results.map { |h| Condition.from_hash(h) }
+    end
+
+    # Get a single condition by slug.
+    #
+    # @param slug [String] condition slug (e.g. "hair-loss")
+    # @return [Condition]
+    # @raise [NotFoundError] if the condition does not exist
+    def get_condition(slug)
+      data = get("/api/conditions/#{slug}/")
+      Condition.from_hash(data)
+    end
+
+    # List glossary terms, optionally filtered by category.
+    #
+    # @param category [String, nil] filter by category
+    # @return [Array<GlossaryTerm>] list of glossary terms
+    def list_glossary(category: nil)
+      params = {}
+      params[:category] = category unless category.nil?
+
+      data = get("/api/glossary/", params)
+      results = data["results"] || []
+      results.map { |h| GlossaryTerm.from_hash(h) }
+    end
+
+    # Get a single glossary term by slug.
+    #
+    # @param slug [String] glossary term slug
+    # @return [GlossaryTerm]
+    # @raise [NotFoundError] if the glossary term does not exist
+    def get_glossary_term(slug)
+      data = get("/api/glossary/#{slug}/")
+      GlossaryTerm.from_hash(data)
+    end
+
+    # List guides, optionally filtered by category.
+    #
+    # @param category [String, nil] filter by category
+    # @return [Array<Guide>] list of guides
+    def list_guides(category: nil)
+      params = {}
+      params[:category] = category unless category.nil?
+
+      data = get("/api/guides/", params)
+      results = data["results"] || []
+      results.map { |h| Guide.from_hash(h) }
+    end
+
+    # Get a single guide by slug.
+    #
+    # @param slug [String] guide slug
+    # @return [Guide]
+    # @raise [NotFoundError] if the guide does not exist
+    def get_guide(slug)
+      data = get("/api/guides/#{slug}/")
+      Guide.from_hash(data)
+    end
+
     private
 
     def get(path, params = {})

data/lib/citedhealth/types.rb

@@ -32,19 +32,83 @@ module CitedHealth
     end
   end
 
-  # A health condition referenced in evidence links.
+  # A health condition referenced in evidence links and the conditions API.
   class Condition
-    attr_reader :slug, :name
+    attr_reader :slug, :name, :description, :meta_description,
+                :prevalence, :symptoms, :risk_factors, :is_featured
 
-    def initialize(slug:, name:)
+    def initialize(slug:, name:, description: "", meta_description: "",
+                   prevalence: "", symptoms: [], risk_factors: [], is_featured: false)
       @slug = slug
       @name = name
+      @description = description
+      @meta_description = meta_description
+      @prevalence = prevalence
+      @symptoms = symptoms
+      @risk_factors = risk_factors
+      @is_featured = is_featured
     end
 
     def self.from_hash(hash)
       new(
         slug: hash["slug"],
-        name: hash["name"]
+        name: hash["name"],
+        description: hash["description"] || "",
+        meta_description: hash["meta_description"] || "",
+        prevalence: hash["prevalence"] || "",
+        symptoms: hash["symptoms"] || [],
+        risk_factors: hash["risk_factors"] || [],
+        is_featured: hash["is_featured"] || false
+      )
+    end
+  end
+
+  # A glossary term explaining health and supplement terminology.
+  class GlossaryTerm
+    attr_reader :slug, :term, :short_definition, :definition,
+                :abbreviation, :category
+
+    def initialize(slug:, term:, short_definition: "", definition: "",
+                   abbreviation: "", category: "")
+      @slug = slug
+      @term = term
+      @short_definition = short_definition
+      @definition = definition
+      @abbreviation = abbreviation
+      @category = category
+    end
+
+    def self.from_hash(hash)
+      new(
+        slug: hash["slug"],
+        term: hash["term"],
+        short_definition: hash["short_definition"] || "",
+        definition: hash["definition"] || "",
+        abbreviation: hash["abbreviation"] || "",
+        category: hash["category"] || ""
+      )
+    end
+  end
+
+  # A curated guide on health topics and supplement usage.
+  class Guide
+    attr_reader :slug, :title, :content, :category, :meta_description
+
+    def initialize(slug:, title:, content: "", category: "", meta_description: "")
+      @slug = slug
+      @title = title
+      @content = content
+      @category = category
+      @meta_description = meta_description
+    end
+
+    def self.from_hash(hash)
+      new(
+        slug: hash["slug"],
+        title: hash["title"],
+        content: hash["content"] || "",
+        category: hash["category"] || "",
+        meta_description: hash["meta_description"] || ""
       )
     end
   end

data/lib/citedhealth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CitedHealth
-  VERSION = "0.2.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citedhealth
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Cited Health
-bindir: bin
+autorequire: 
+bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -55,11 +56,14 @@ description: API client for citedhealth.com. Search ingredients, evidence links,
   research papers for evidence-based health supplement information. Zero dependencies.
 email:
 - hello@citedhealth.com
-executables: []
+executables:
+- citedhealth
 extensions: []
 extra_rdoc_files: []
 files:
+- exe/citedhealth
 - lib/citedhealth.rb
+- lib/citedhealth/cli.rb
 - lib/citedhealth/client.rb
 - lib/citedhealth/errors.rb
 - lib/citedhealth/types.rb
@@ -73,6 +77,7 @@ metadata:
   changelog_uri: https://github.com/citedhealth/citedhealth-rb/blob/main/CHANGELOG.md
   documentation_uri: https://citedhealth.com/developers/
   bug_tracker_uri: https://github.com/citedhealth/citedhealth-rb/issues
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,7 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby client for the Cited Health evidence-based supplement API
 test_files: []