spyglasses 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c17daf9d91be6e696d95a82d8d55189052aa68f7d7dc01531ebecbb9fd2e924
-  data.tar.gz: f8c66528f3fe86d414d6070544f37af1332f7a92a009eb4744c19edf84fbb309
+  metadata.gz: c0a3d6de667a48f878769b774eccd367018ed52f1c6628cd730e1ff8c9fdaabe
+  data.tar.gz: 737c8e8de705a5dc0eadf303afe1b1fa7a5d2292a700642aa5d82416565661ae
 SHA512:
-  metadata.gz: 45eb83cc190e3b3ff8fd6851218b5d69425d8bcc8673b8f323e5d2a16ab208abf0602608eac71e7e1ab3dbb40cac300067723edc3517ee3f3b362a90ec8f0293
-  data.tar.gz: 1cde873159cc7e46aeef4a7a15e7f72ee595886fc8eba4c501174af8b1a95431b88a064320b0efdc37a494e4b79c9286aa4cb2a5a15899568f8f7d48f072f32b
+  metadata.gz: 4493abc121849ba91d73c18ceaf060f0008b409bbe8c3402f74fa224c8906e6b4ea07e43e3c0f477bd028b37899db73c144ec49daabff0cce54f4878475d54a5
+  data.tar.gz: 22e71db5b421dcb9a78ef599261036d5b32dde80b92abb995933d57261a6b68b9a5505482fe9392c3420e363f8ff42b798c2659d2e012930e4df0d4cd97c5a41

data/CHANGELOG.md

@@ -5,41 +5,55 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.1] - 2025-06-23
+## [1.1.0] - 2024-12-29
+
+### Fixed
+- **BREAKING**: Fixed API payload format to match TypeScript collector endpoint
+  - Changed `platform_type` to `platformType` in JSON payload (camelCase)
+  - Ensured `ip_address` and `request_query` are never nil (required strings in API schema)
+  - Enhanced IP extraction from forwarded headers with comma-separated values
+- Fixed 400 Bad Request errors when logging to collector endpoint
+- Improved error handling and data validation for API compatibility
 
 ### Changed
-- Updated documentation links in README to point to correct docs location (https://www.spyglasses.io/docs/platforms/ruby)
-- Updated gem author attribution to Orchestra AI, Inc.
+- **BREAKING**: JSON payload field names now use camelCase to match API expectations
+- Enhanced middleware IP extraction with better fallback handling
+- Improved request query string handling to ensure non-nil values
+
+## [1.0.1] - 2024-12-28
+
+### Added
+- Comprehensive Ruby documentation in main docs site
+- Rails-specific configuration examples
+- Deployment platform guidance (Heroku, Railway, etc.)
+- Troubleshooting section for common issues
+
+### Fixed
+- Documentation formatting and code examples
+- Installation instructions for various Ruby frameworks
 
-## [1.0.0] - 2025-06-23
+## [1.0.0] - 2024-12-28
 
 ### Added
 - Initial release of Spyglasses Ruby gem
-- Core AI agent detection functionality
-- Bot pattern matching with regex support
-- AI referrer detection for platforms like ChatGPT, Claude, Perplexity
-- Flexible blocking system based on patterns and property settings
-- Rack middleware for easy integration with Ruby web frameworks
-- Rails, Sinatra, and generic Rack application support
-- Non-blocking request logging to Spyglasses collector API
-- Thread-safe pattern caching and background processing
-- Comprehensive test suite with >95% code coverage
-- Environment variable configuration support
+- AI bot detection with pattern matching
+- AI referrer detection for traffic from AI platforms
+- Flexible blocking rules via Spyglasses platform
+- Non-blocking request logging to collector API
+- Rack middleware for universal Ruby framework support
+- Thread-safe operations for concurrent applications
 - Default patterns for common AI agents and crawlers
-- Pattern synchronization from Spyglasses API
-- Debug logging capabilities
-- Comprehensive documentation and examples
-
-### Security
-- Thread-safe operations for concurrent Ruby applications
-- Secure API key handling with masked logging
-- Input validation and error handling
-
-### Performance
-- Compiled regex pattern caching
-- Background thread processing for API calls
-- Smart path exclusions for static assets
-- Minimal request overhead (<1ms typical)
+- Configuration via environment variables
+- Debug logging support
+- Pattern synchronization with API
+- Support for Rails, Sinatra, and other Rack-based frameworks
+
+### Features
+- **Bot Detection**: GPTBot, ClaudeBot, ChatGPT-User, Claude-User, and more
+- **AI Referrer Detection**: ChatGPT, Claude, Perplexity, Gemini, Copilot
+- **Blocking Rules**: Configurable via platform dashboard
+- **Performance**: Pattern caching, background logging, minimal overhead
+- **Framework Support**: Universal Rack middleware design
 
 [Unreleased]: https://github.com/spyglasses/spyglasses-ruby/compare/v1.0.1...HEAD
 [1.0.1]: https://github.com/spyglasses/spyglasses-ruby/compare/v1.0.0...v1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spyglasses (1.0.1)
+    spyglasses (1.1.0)
       json (>= 2.0)
       rack (>= 2.0)
 

data/lib/spyglasses/middleware.rb

@@ -137,13 +137,17 @@ module Spyglasses
     def log_request_async(detection_result, request, status, response_time)
       return unless @configuration.api_key_present?
 
+      # Ensure ip_address is never nil
+      client_ip = extract_client_ip(request) || '127.0.0.1'
+      
       request_info = {
         url: request.url,
         user_agent: request.user_agent || '',
-        ip_address: extract_client_ip(request),
+        ip_address: client_ip,
         request_method: request.request_method,
         request_path: request.path,
-        request_query: request.query_string.empty? ? nil : request.query_string,
+        # Ensure request_query is never nil - use empty string if no query
+        request_query: request.query_string || '',
         referrer: request.referrer,
         response_status: status,
         response_time_ms: (response_time * 1000).round,
@@ -157,13 +161,21 @@ module Spyglasses
 
     def extract_client_ip(request)
       # Try various headers to get the real client IP
-      [
+      ip = [
         request.env['HTTP_X_FORWARDED_FOR'],
         request.env['HTTP_X_REAL_IP'],
         request.env['HTTP_CF_CONNECTING_IP'], # Cloudflare
         request.env['HTTP_X_CLIENT_IP'],
         request.env['REMOTE_ADDR']
-      ].find { |ip| ip && !ip.empty? && ip != '127.0.0.1' } || request.ip
+      ].find { |ip| ip && !ip.empty? && ip != '127.0.0.1' }
+      
+      # If we found an IP in headers, handle comma-separated lists (X-Forwarded-For)
+      if ip && ip.include?(',')
+        ip = ip.split(',').first.strip
+      end
+      
+      # Return the found IP or fallback to request.ip
+      ip || request.ip
     end
 
     def extract_headers(request)

data/lib/spyglasses/types.rb

@@ -187,17 +187,17 @@ module Spyglasses
         {
           url: @url,
           user_agent: @user_agent,
-          ip_address: @ip_address,
+          ip_address: @ip_address || '',
           request_method: @request_method,
           request_path: @request_path,
-          request_query: @request_query,
+          request_query: @request_query || '',
           request_body: @request_body,
           referrer: @referrer,
           response_status: @response_status,
           response_time_ms: @response_time_ms,
           headers: @headers,
           timestamp: @timestamp,
-          platform_type: @platform_type,
+          platformType: @platform_type,
           metadata: @metadata
         }
       end

data/lib/spyglasses/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spyglasses
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyglasses
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Orchestra AI, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack