RubyGems - friday_gemini_ai - Versions diffs - 0.1.1 → 0.1.3 - Mend

friday_gemini_ai 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52341ffcd17c5b6273266d99825214442f6d59eb497a7eb3a47999d18a18e89f
-  data.tar.gz: 79731db3a54d4840d0222fa6dada373ef9e7da855a28fb8dbe8338f009567b41
+  metadata.gz: 66b53a7e6a9cdf4e1321c477ab5b151159f7b176907b620264bfcb81b4dc0955
+  data.tar.gz: 42dea151c596e24f2c96f40710bc4a61bc1448516182791af4bd6ce855a2f4b2
 SHA512:
-  metadata.gz: fd1316c73e47d2bf52ba576faf3802d2f836b0d8c0d3c09a75f1f01122349afeb396aeca23703fa75718051a69fe6ef6fc539f9fbe42e43e6ffbad8ee28cdf58
-  data.tar.gz: f1f921e622d15a751f9af0d1dbfe5d657af88eb9e8e7986527995b43866b3b2e5f31e846c62589858b183c9c07d50e159ebc2aac7dc6013ce82ddad92b47e5d0
+  metadata.gz: dad93b02ef3f339ded728ce61d2ffd98af06f332347e5d57c707c94052f8799cb1776fd8ba4119ee1e52f46adca495303024c17b0ac134eedfd9a00373425415
+  data.tar.gz: dc31beb2d7af9c8aae31d81df9416ed67b1c7b243c8f258fedd36f523a6860160432e4ba6424f50098889eb29da4d4bf72891437d4de12c868fcf4969155c479

data/README.md CHANGED Viewed

@@ -1,215 +1,104 @@
 # Friday Gemini AI Ruby Gem
-## Overview
-A powerful Ruby gem for interacting with Google's Gemini AI models, providing easy text generation capabilities.
-## Features
-- Support for multiple Gemini AI models
-- Flexible text generation
-- Comprehensive error handling
-- Configurable generation parameters
-- Advanced security and logging
-## Security
-### 🔒 API Key Protection
-#### Key Management
-1. **Never Hardcode API Keys**
-   - Do NOT include your API key directly in your code
-   - Use environment variables or secure key management systems
-2. **Environment Variable Setup**
-   ```bash
-   # Set in your shell profile (.bashrc, .zshrc, etc.)
-   export GEMINI_API_KEY='your_actual_api_key'
-   ```
-3. **Secure Key Passing**
-   ```ruby
-   # Recommended: Use environment variable
-   client = GeminiAI::Client.new
-   # Alternative: Pass key securely
-   client = GeminiAI::Client.new(ENV['GEMINI_API_KEY'])
-   ```
-#### Advanced Security Features
-- API key format validation
-- Automatic key masking in logs
-- Strict input validation
-- Request timeout protection
-### 🕵️ Logging and Monitoring
-#### Logging Configuration
-```ruby
-# Configure logging level
-GeminiAI::Client.logger.level = Logger::WARN  # Default
-GeminiAI::Client.logger.level = Logger::DEBUG  # More verbose
-```
-#### Log Masking
-- API keys are automatically masked in logs
-- Sensitive information is redacted
-- Prevents accidental key exposure
-### 🛡️ Best Practices
-- Restrict API key permissions
-- Use the principle of least privilege
-- Keep your API key confidential
-- Monitor API usage and set up alerts
-- Implement rate limiting
-- Regularly rotate API keys
+## Table of Contents
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Usage](#usage)
+   - [Text Generation](#text-generation)
+   - [Chat](#chat)
+   - [Error Handling](#error-handling)
+4. [Logging](#logging)
+5. [Security](#security)
+6. [Testing](#testing)
+7. [Contributing](#contributing)
 ## Installation
-### Local Installation
-1. Clone the repository
-```bash
-git clone https://github.com/bniladridas/gemini_ai.git
-cd gemini_ai
-```
-2. Build the gem
-```bash
-gem build gemini_ai.gemspec
-```
-3. Install the gem locally
-```bash
-gem install gemini_ai-0.1.0.gem
-```
-### Using Bundler
-Add to your Gemfile:
-```ruby
-gem 'gemini_ai', path: '/path/to/gemini_ai'
-```
 ### From RubyGems
 ```bash
 gem install friday_gemini_ai
 ```
-Or add to your Gemfile:
+### Using Bundler
+Add to your Gemfile:
 ```ruby
-gem 'friday_gemini_ai', '~> 0.1.0'
+gem 'friday_gemini_ai'
 ```
-## Quick Start
-1. Get your API key from [Google AI Studio](https://aistudio.google.com/app/apikey)
+## Configuration
-2. Set your API key:
+Set your API key:
 ```bash
 export GEMINI_API_KEY='your_api_key_here'
 ```
-3. Start using the gem:
+## Usage
+### Text Generation
 ```ruby
 require 'gemini_ai'
-# Initialize client
 client = GeminiAI::Client.new
-# Generate text
 response = client.generate_text('Tell me a joke')
 puts response
-# Use different model
-client_lite = GeminiAI::Client.new(model: :flash_lite)
-response = client_lite.generate_text('What is AI?')
-puts response
-# Use custom parameters
-response = client.generate_text('Write a haiku',
-  temperature: 0.3,
-  max_tokens: 30,
-  top_p: 0.8,
-  top_k: 20
-)
-puts response
 ```
-## Configuration
-## Testing and Verification
-### Running the Test Suite
-To run the comprehensive test suite:
-```bash
-ruby comprehensive_test.rb
-```
+### Chat
+```ruby
+messages = [
+  { role: 'user', content: 'Hello' },
+  { role: 'model', content: 'Hi there!' },
+  { role: 'user', content: 'How are you?' }
+]
-### Quick Verification
-First, ensure your API key is set:
-```bash
-export GEMINI_API_KEY='your_api_key_here'
+response = client.chat(messages)
+puts response
 ```
-Then run the verification script:
-```bash
-ruby verify_api.rb
+### Error Handling
+```ruby
+begin
+  client.generate_text('')
+rescue GeminiAI::Error => e
+  puts "Error: #{e.message}"
+end
 ```
-This will run a series of quick tests:
-- Basic text generation with the default model
-- Text generation with the flash_lite model
-- Text generation with custom parameters
-## Usage
+## Logging
-### Basic Text Generation
+### Configuration
 ```ruby
-require 'gemini_ai'
-# Initialize client with default model
-client = GeminiAI::Client.new(ENV['GEMINI_API_KEY'])
+# Set logging level
+GeminiAI::Client.logger.level = Logger::INFO
-# Generate text
-response = client.generate_text('Tell me a joke about programming')
-puts response
+# Log to file
+GeminiAI::Client.logger = Logger.new('logfile.log')
 ```
-### Specifying a Model
-```ruby
-# Use Flash Lite model
-client_lite = GeminiAI::Client.new(ENV['GEMINI_API_KEY'], model: :flash_lite)
-response = client_lite.generate_text('Explain AI in simple terms')
-```
+### Log Levels
+- DEBUG: Detailed debug information
+- INFO: General operational messages
+- WARN: Warning conditions
+- ERROR: Error conditions
-### Custom Generation Options
-```ruby
-options = {
-  temperature: 0.7,
-  max_tokens: 100,
-  top_p: 0.9,
-  top_k: 40
-}
-response = client.generate_text('Write a short story', options)
-```
+## Security
-## Error Handling
-The gem provides robust error handling:
-```ruby
-begin
-  client.generate_text('')  # Raises an error
-rescue GeminiAI::Error => e
-  puts "An error occurred: #{e.message}"
-end
+### API Key Protection
+- Never hardcode API keys
+- Use environment variables
+- Automatic key masking in logs
+## Testing
+Run the test suite:
+```bash
+bundle exec ruby test/gemini_ai_test.rb
 ```
 ## Contributing
 1. Fork the repository
 2. Create your feature branch
 3. Commit your changes
 4. Push to the branch
 5. Create a new Pull Request
-## License
-MIT License
-## Support
-For issues, please file a GitHub issue in the repository.

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friday_gemini_ai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - bniladridas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-01 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.21.0
 - !ruby/object:Gem::Dependency
-  name: json
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.3
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.25.4
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.25.4
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -66,22 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-description: A flexible Ruby gem for generating text using Google Gemini AI models
-  with comprehensive error handling and multiple model support.
+description: Provides easy text generation capabilities using Google's Gemini AI models
 email:
 - bniladridas@gmail.com
 executables: []
@@ -90,15 +75,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- gemini_ai.gemspec
 - lib/gemini_ai.rb
 homepage: https://github.com/bniladridas/friday_gemini_ai
 licenses:
 - MIT
-metadata:
-  source_code_uri: https://github.com/bniladridas/friday_gemini_ai
-  documentation_uri: https://github.com/bniladridas/friday_gemini_ai/blob/main/README.md
-  bug_tracker_uri: https://github.com/bniladridas/friday_gemini_ai/issues
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -107,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,5 +98,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Ruby interface for Google Gemini AI models
+summary: A Ruby gem for interacting with Google's Gemini AI models
 test_files: []

data/gemini_ai.gemspec DELETED Viewed

@@ -1,37 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name        = 'friday_gemini_ai'
-  spec.version     = '0.1.1'
-  spec.date        = '2025-03-01'
-  spec.summary     = 'Ruby interface for Google Gemini AI models'
-  spec.description = 'A flexible Ruby gem for generating text using Google Gemini AI models with comprehensive error handling and multiple model support.'
-  spec.authors     = ['bniladridas']
-  spec.email       = ['bniladridas@gmail.com']
-  spec.homepage    = 'https://github.com/bniladridas/friday_gemini_ai'
-  spec.license     = 'MIT'
-  spec.files = [
-    'lib/gemini_ai.rb',
-    'README.md',
-    'LICENSE',
-    'gemini_ai.gemspec'
-  ]
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 3.0.0'
-  # Runtime dependencies
-  spec.add_runtime_dependency 'httparty', '~> 0.21.0'
-  spec.add_runtime_dependency 'json', '~> 2.6.3'
-  # Development dependencies
-  spec.add_development_dependency 'minitest', '~> 5.25.4'
-  spec.add_development_dependency 'dotenv', '~> 2.8'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.metadata = {
-    'source_code_uri' => 'https://github.com/bniladridas/friday_gemini_ai',
-    'documentation_uri' => 'https://github.com/bniladridas/friday_gemini_ai/blob/main/README.md',
-    'bug_tracker_uri' => 'https://github.com/bniladridas/friday_gemini_ai/issues'
-  }
-end