friday_gemini_ai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaac0eba90ceab2439b7f713c1a78cd649fb7419e80fb079baa25ac9e788e79f
+  data.tar.gz: 5045e0fcca735aae909c2e52c316ffab8023f72e0aa982f53e255b31d38dcf4a
+SHA512:
+  metadata.gz: 6371fe6b7dcb90b6a83d0865f3dfd9ce2467ac465f8946f356a4cbfc82e851b44d5a4954959e495d94336a9c8751c5778ca8ed567e826943ec39c5d0afdec038
+  data.tar.gz: d6283f58a22cac64c5e0c2bb4f8101c15d7f102ee84262b735f3eb4ae797afd051013c0ac9c5dd91630ec13e6bb7698d4591b49f13a9c1e1a087dc93d46231ff

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Niladri Das
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,215 @@
+# 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
+
+## 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:
+```ruby
+gem 'friday_gemini_ai', '~> 0.1.0'
+```
+
+## Quick Start
+
+1. Get your API key from [Google AI Studio](https://aistudio.google.com/app/apikey)
+
+2. Set your API key:
+```bash
+export GEMINI_API_KEY='your_api_key_here'
+```
+
+3. Start using the gem:
+```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
+```
+
+### Quick Verification
+First, ensure your API key is set:
+```bash
+export GEMINI_API_KEY='your_api_key_here'
+```
+
+Then run the verification script:
+```bash
+ruby verify_api.rb
+```
+
+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
+
+### Basic Text Generation
+```ruby
+require 'gemini_ai'
+
+# Initialize client with default model
+client = GeminiAI::Client.new(ENV['GEMINI_API_KEY'])
+
+# Generate text
+response = client.generate_text('Tell me a joke about programming')
+puts response
+```
+
+### 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')
+```
+
+### 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)
+```
+
+## 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
+```
+
+## 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.

data/gemini_ai.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'friday_gemini_ai'
+  spec.version     = '0.1.0'
+  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/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/gemini_ai',
+    'documentation_uri' => 'https://github.com/bniladridas/gemini_ai/blob/main/README.md',
+    'bug_tracker_uri' => 'https://github.com/bniladridas/gemini_ai/issues'
+  }
+end

data/lib/gemini_ai.rb

@@ -0,0 +1,185 @@
+require 'httparty'
+require 'json'
+require 'base64'
+require 'logger'
+
+module GeminiAI
+  class Error < StandardError; end
+
+  class Client
+    BASE_URL = 'https://generativelanguage.googleapis.com/v1/models'
+    MODELS = {
+      pro: 'gemini-2.0-flash',
+      flash: 'gemini-2.0-flash',
+      flash_lite: 'gemini-2.0-flash-lite'
+    }
+
+    # Configure logging
+    def self.logger
+      @logger ||= Logger.new(STDOUT).tap do |log|
+        log.level = Logger::DEBUG  # Changed to DEBUG for more information
+        log.formatter = proc do |severity, datetime, progname, msg|
+          # Mask any potential API key in logs
+          masked_msg = msg.to_s.gsub(/AIza[a-zA-Z0-9_-]{35,}/, '[REDACTED]')
+          "#{datetime}: #{severity} -- #{masked_msg}\n"
+        end
+      end
+    end
+
+    def initialize(api_key = nil, model: :pro)
+      # Prioritize passed API key, then environment variable
+      @api_key = api_key || ENV['GEMINI_API_KEY']
+      
+      # Extensive logging for debugging
+      self.class.logger.debug("Initializing Client")
+      self.class.logger.debug("API Key present: #{!@api_key.nil?}")
+      self.class.logger.debug("API Key length: #{@api_key&.length}")
+      
+      # Validate API key
+      validate_api_key!
+      
+      @model = MODELS.fetch(model) { 
+        self.class.logger.warn("Invalid model: #{model}, defaulting to pro")
+        MODELS[:pro] 
+      }
+      
+      self.class.logger.debug("Selected model: #{@model}")
+    end
+
+    def generate_text(prompt, options = {})
+      validate_prompt!(prompt)
+
+      request_body = {
+        contents: [{ parts: [{ text: prompt }] }],
+        generationConfig: build_generation_config(options)
+      }
+
+      send_request(request_body)
+    end
+
+    def generate_image_text(image_base64, prompt, options = {})
+      raise Error, "Image is required" if image_base64.nil? || image_base64.empty?
+      
+      request_body = {
+        contents: [
+          { parts: [
+            { inline_data: { mime_type: 'image/jpeg', data: image_base64 } },
+            { text: prompt }
+          ]}
+        ],
+        generationConfig: build_generation_config(options)
+      }
+
+      send_request(request_body, model: :pro_vision)
+    end
+
+    def chat(messages, options = {})
+      request_body = {
+        contents: messages.map { |msg| { role: msg[:role], parts: [{ text: msg[:content] }] } },
+        generationConfig: build_generation_config(options)
+      }
+
+      send_request(request_body)
+    end
+
+    private
+
+    def validate_api_key!
+      if @api_key.nil? || @api_key.strip.empty?
+        self.class.logger.error("API key is missing")
+        raise Error, "API key is required. Set GEMINI_API_KEY environment variable or pass key directly."
+      end
+
+      # Optional: Add basic API key format validation
+      unless valid_api_key_format?(@api_key)
+        self.class.logger.error("Invalid API key format")
+        raise Error, "Invalid API key format. Please check your key."
+      end
+
+      # Optional: Check key length and complexity
+      if @api_key.length < 40
+        self.class.logger.warn("Potentially weak API key detected")
+      end
+    end
+
+    def valid_api_key_format?(key)
+      # Strict format check: starts with 'AIza', reasonable length
+      key =~ /^AIza[a-zA-Z0-9_-]{35,}$/
+    end
+
+    def validate_prompt!(prompt)
+      if prompt.nil? || prompt.strip.empty?
+        self.class.logger.error("Empty prompt provided")
+        raise Error, "Prompt cannot be empty"
+      end
+
+      if prompt.length > 8192
+        self.class.logger.error("Prompt exceeds maximum length")
+        raise Error, "Prompt too long (max 8192 tokens)"
+      end
+    end
+
+    def build_generation_config(options)
+      {
+        temperature: options[:temperature] || 0.7,
+        maxOutputTokens: options[:max_tokens] || 1024,
+        topP: options[:top_p] || 0.9,
+        topK: options[:top_k] || 40
+      }
+    end
+
+    def send_request(body, model: nil)
+      current_model = model ? MODELS.fetch(model) { MODELS[:pro] } : @model
+      url = "#{BASE_URL}/#{current_model}:generateContent?key=#{@api_key}"
+
+      # Log URL with masked API key for security
+      masked_url = "#{BASE_URL}/#{current_model}:generateContent?key=#{mask_api_key(@api_key)}"
+      self.class.logger.debug("Request URL: #{masked_url}")
+      self.class.logger.debug("Request Body: #{body.to_json}")
+
+      begin
+        response = HTTParty.post(
+          url, 
+          body: body.to_json,
+          headers: { 
+            'Content-Type' => 'application/json',
+            'x-goog-api-client' => 'gemini_ai_ruby_gem/0.1.0'
+          },
+          # Add timeout to prevent hanging
+          timeout: 30
+        )
+
+        self.class.logger.debug("Response Code: #{response.code}")
+        self.class.logger.debug("Response Body: #{response.body}")
+
+        parse_response(response)
+      rescue HTTParty::Error, Net::OpenTimeout => e
+        self.class.logger.error("API request failed: #{e.message}")
+        raise Error, "API request failed: #{e.message}"
+      end
+    end
+
+    def parse_response(response)
+      case response.code
+      when 200
+        text = response.parsed_response
+               .dig('candidates', 0, 'content', 'parts', 0, 'text')
+        text || 'No response generated'
+      else
+        error_message = response.parsed_response['error']&.dig('message') || response.body
+        self.class.logger.error("API Error: #{error_message}")
+        raise Error, "API Error: #{error_message}"
+      end
+    end
+
+    # Mask API key for logging and error reporting
+    def mask_api_key(key)
+      return '[REDACTED]' if key.nil?
+      
+      # Keep first 4 and last 4 characters, replace middle with asterisks
+      return key if key.length <= 8
+      
+      "#{key[0,4]}#{'*' * (key.length - 8)}#{key[-4,4]}"
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: friday_gemini_ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bniladridas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.4
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- bniladridas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- gemini_ai.gemspec
+- lib/gemini_ai.rb
+homepage: https://github.com/bniladridas/gemini_ai
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/bniladridas/gemini_ai
+  documentation_uri: https://github.com/bniladridas/gemini_ai/blob/main/README.md
+  bug_tracker_uri: https://github.com/bniladridas/gemini_ai/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Ruby interface for Google Gemini AI models
+test_files: []