GeminiCache Module Usage Documentation

The GeminiCache module is a library designed for managing API caches, with features to process web pages, local and remote files, as well as interact with an API to create, update, list, and delete caches. This document describes its functionalities and usage.

To use the module, ensure the following Ruby libraries are installed:

• faraday
• open-uri
• nokogiri
• json
• base64

The module includes the following components:

1. Classes and Modules:

   • GeminiCache::Error: Class for handling custom errors.
   • GeminiCache: Contains the main methods for cache management and file processing.

2. Dependencies:

   • gemini_cache/configuration
   • gemini_cache/api_client
   • gemini_cache/item_extender

Allows processing and cleaning the content of a web page.

GeminiCache.parse_html(url:, default_remover: true)

• Parameters:
  • url: The URL of the page to process.
  • default_remover: Automatically removes <script> and <style> elements (default: true).
• Returns: A Nokogiri::HTML object containing the processed HTML.

Reads a local file and returns its Base64 encoded data.

GeminiCache.read_local_file(path:, mime_type:)

• Parameters:
  • path: Path to the file.
  • mime_type: MIME type of the file.
• Returns: Hash containing the encoded data.

Reads a remote file and returns its Base64 encoded data.

GeminiCache.read_remote_file(url:, mime_type:)

• Parameters:
  • url: URL of the file.
  • mime_type: MIME type of the file.
• Returns: Hash containing the encoded data.

Extracts text content from a web page, removing unnecessary elements.

GeminiCache.read_webpage_text(url:, default_remover: true)

• Parameters:
  • url: URL of the page.
  • default_remover: Automatically removes <script> and <style> elements (default: true).
• Returns: Hash containing the page text.

Creates a new cache from different data sources.

GeminiCache.create(parts:, display_name:, on_conflict: :raise_error, model: nil, ttl: nil)

• Parameters:
  • parts: Cache data.
  • display_name: Display name of the cache.
  • on_conflict: Action on conflict (:raise_error or :get_existing).
  • model: Model used (default: system configuration).
  • ttl: Time-to-live for the cache (default: system configuration).
• Returns: The created cache object.

• Text:

  GeminiCache.create_from_text(text:, **options)

• Web Page:

  GeminiCache.create_from_webpage(url:, **options)

• Local File:

  GeminiCache.create_from_local_file(path:, mime_type:, **options)

• Remote File:

  GeminiCache.create_from_remote_file(url:, mime_type:, **options)

Lists all available caches.

GeminiCache.list

• Returns: Array of cache objects.

• By Name:

  GeminiCache.find_by_name(name:)

• By Display Name:

  GeminiCache.find_by_display_name(display_name:)

Updates an existing cache.

GeminiCache.update(name:, content:)

• Parameters:
  • name: Name of the cache.
  • content: Updated content.

• By Name:

  GeminiCache.delete(name:)

• All Caches:

  GeminiCache.delete_all

The methods use configurations defined in the gemini_cache/configuration module, and communication is handled via gemini_cache/api_client.

In case of conflicts or API errors, the module raises a custom exception GeminiCache::Error.

require 'gemini_cache'

parts = [
  { text: 'Some text' },
  GeminiCache.read_remote_file(url: '<remote_file_url>', mime_type: 'application/pdf'),
  GeminiCache.read_webpage_text(url: '<webpage url>')
]

cache = GeminiCache.create parts: parts, display_name: 'mycache'

This documentation covers the main functionalities of the GeminiCache module. For more details on specific configurations, refer to the source code or official documentation.