sumologic-query 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3064549af4cc950fcd9ff873bd9f1bb9940b4e6078bc45d9086973fbab1162
-  data.tar.gz: c16964c3af7afd22e6ebdb878bc00d22cb4b6ab55f6b4a6946c0db435856e128
+  metadata.gz: f674ac09efecc2c167df4d3853be9d9bd5c1c043bf6e0d574f068770e9979a8b
+  data.tar.gz: 4e43daf71638156ad4ac9f72b862daf501f4714037b3cee603aac1a6e8de1efb
 SHA512:
-  metadata.gz: 2a8c9c6b61000afc3d3ba204215b054332c7efc001bb1fc0a3a349e161b2ac9f9f36b7794ca561b0564b6b3b56245bf8ed9f630a7fe57fdba086ddba4f94f7ce
-  data.tar.gz: 6466d1a6180686719d614022fc908db2a2a8949594192c41bdf87e1a8c4c3d6d93bf754e4ef00e4479467f15c2eee5b4f240086afc200ef78bfad1786444b427
+  metadata.gz: cc1c1a801d4c0dcf282ae281cc4da00eb125095b036f45489cda7c74638e4116fde5ad5c317896fb8e05988fd143887d7b470f31d02fba10426cc3c3c7bd78a0
+  data.tar.gz: 3b360acf874598ea9ca2513d1ddd507c617e970b94f79efb5029fc3a2e37e807b1f8aac2e3e9cbe95793ef0d74f210fd2ab13e9d7d3f0d25fad446014f6f46cb

data/CHANGELOG.md

@@ -1,20 +1,170 @@
-## [1.2.2](https://github.com/patrick204nqh/sumologic-query/compare/v1.2.1...v1.2.2) (2025-11-15)
+# Changelog
 
+All notable changes to this project will be documented in this file.
 
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and release notes are automatically generated from commit messages.
+## [1.3.3](https://github.com/patrick204nqh/sumologic-query/compare/v1.3.2...v1.3.3) (2025-11-17)
+
+### 🎉 New Features
+
+- implement modular HTTP client components for improved organization and functionality
+- refactor CLI structure to modular commands and remove deprecated modules
+- update CHANGELOG entry creation to include changelog content directly
+- bump version to 1.3.3
+- add ADR for SSL certificate verification to address connection issues with Sumo Logic API
+- refactor CLI structure into modular components for improved organization and maintainability
+- implement debug logging for HTTP requests and responses
+- enhance release notes generation and update CHANGELOG format for better clarity
+
+
+
+
+## [1.3.2](https://github.com/patrick204nqh/sumologic-query/compare/v1.3.1...v1.3.2) (2025-11-16)
+
+### 🎉 New Features
+
+- Refactor FzfViewer with modular configuration, formatting, and header building for better maintainability
+- Add modular file structure with separate concerns (Config, Formatter, SearchableBuilder, FzfConfig, HeaderBuilder)
+- Implement module_function for better encapsulation in all FzfViewer modules
+- Add RubyGems download badge to README
+
+### 🐛 Bug Fixes
+
+- Update source field reference in FzfViewer for consistency (use lowercase `_source` field)
+- Fix RuboCop offenses across all FzfViewer modules
+
+### 🔧 Refactoring
+
+- Extract searchable builder methods to reduce complexity
+- Separate FzfViewer into 6 focused modules (~50-100 lines each)
+- Use constants for display configuration (widths, colors, padding)
+- Improve code organization with clear section headers
+
+### 🧹 Maintenance
+
+- Update release notes generation and changelog management in CI pipeline
+
+## [1.3.1](https://github.com/patrick204nqh/sumologic-query/compare/v1.3.0...v1.3.1) (2025-11-15)
+
+### 🧹 Maintenance
+
+- Automated version bump and release preparation
+
+## [1.3.0](https://github.com/patrick204nqh/sumologic-query/compare/v1.2.1...v1.3.0) (2025-11-15)
+
+### 📚 Documentation
+
+- Establish commit message convention using Conventional Commits
+- Update CONTRIBUTING.md for clarity and best practices
+
+### 🧹 Maintenance
+
+- Remove path restriction for version file in release workflow
+- Improve CI/CD pipeline configuration
 
 ## [1.2.1](https://github.com/patrick204nqh/sumologic-query/compare/v1.2.0...v1.2.1) (2025-11-14)
 
+### 🎉 New Features
+
+- Add interactive mode with FZF for enhanced log exploration
+- Support real-time log browsing and filtering
+- Add keyboard shortcuts for common operations
 
+### 📚 Documentation
 
-# [1.2.0](https://github.com/patrick204nqh/sumologic-query/compare/v1.1.2...v1.2.0) (2025-11-14)
+- Update CLI and documentation to support new interactive feature
+- Add usage examples for interactive mode
 
+## [1.2.0](https://github.com/patrick204nqh/sumologic-query/compare/v1.1.2...v1.2.0) (2025-11-14)
 
+### 🎉 New Features
+
+- Add ADR 004 for enhanced progress tracking and user experience
+- Implement real-time visibility with callbacks in CLI and fetcher classes
+- Add comprehensive progress indicators for long-running operations
+
+### 🔧 Refactoring
+
+- Implement reusable Worker utility for parallel execution
+- Refactor metadata and search fetching classes to utilize Worker
+- Remove deprecated ParallelFetcher and Paginator
+- Simplify pagination logic
+- Remove streaming APIs for better maintainability
+- Update configuration defaults for optimal performance
+
+### 📚 Documentation
+
+- Reorganize architecture documentation files
+- Add architectural overview and decision records
 
 ## [1.1.2](https://github.com/patrick204nqh/sumologic-query/compare/v1.1.1...v1.1.2) (2025-11-14)
 
+### 🐛 Bug Fixes
+
+- Fix command syntax in tldr.md for listing collectors and sources
 
+### 🎉 New Features
+
+- Add version command to CLI
+
+### 📚 Documentation
+
+- Add quick reference documentation (tldr.md)
+- Refactor documentation structure
+- Remove examples.md and consolidate content
+- Streamline troubleshooting.md
+- Consolidate queries.md with improved examples
 
 ## [1.1.1](https://github.com/patrick204nqh/sumologic-query/compare/v1.1.0...v1.1.1) (2025-11-14)
 
+### 🔧 Refactoring
+
+- Refactor search logging in CLI and Poller classes for improved readability
+- Consolidate attribute accessors in Configuration class
+- Improve CLI options structure
+
+## [1.1.0](https://github.com/patrick204nqh/sumologic-query/compare/v1.0.1...v1.1.0) (2025-11-13)
+
+### 🎉 New Features
+
+- Add CLI support with Thor framework
+- Refactor Sumo Logic client for better usability
+
+### 🔧 Refactoring
+
+- Refine polling logic in Sumo Logic client
+- Improve overall code structure and organization
+
+### 🧹 Maintenance
+
+- Refactor CI and release workflows
+- Streamline version checking and build process
+- Improve release tagging automation
+
+## [1.0.1](https://github.com/patrick204nqh/sumologic-query/compare/v1.0.0...v1.0.1) (2025-11-13)
+
+### 🎉 New Features
+
+- Add CODEOWNERS file for repository management
+
+### 🧹 Maintenance
+
+- Refactor release workflow to generate release notes using GitHub API
+- Update CHANGELOG.md format for better clarity
+- Add changelog extraction for automated versioning
+
+## [1.0.0](https://github.com/patrick204nqh/sumologic-query/releases/tag/v1.0.0) (2025-11-13)
 
+### 🎉 Initial Release
 
+- Initial release of Sumo Logic Query Tool
+- Core search functionality
+- Metadata querying (collectors, sources)
+- Basic CLI interface
+- HTTP client with authentication
+- Automated pagination
+- Search job polling
+- JSON output support

data/README.md

@@ -3,6 +3,7 @@
 > A lightweight Ruby CLI for querying Sumo Logic logs and metadata. Simple, fast, read-only access to your logs.
 
 [![Gem Version](https://badge.fury.io/rb/sumologic-query.svg)](https://badge.fury.io/rb/sumologic-query)
+[![Downloads](https://img.shields.io/gem/dt/sumologic-query.svg)](https://rubygems.org/gems/sumologic-query)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Why This Tool?

data/lib/sumologic/cli/commands/base_command.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sumologic
+  class CLI < Thor
+    module Commands
+      # Base class for all CLI commands
+      # Provides common functionality like client creation, output handling, and formatting
+      class BaseCommand
+        attr_reader :options, :client
+
+        def initialize(options, client)
+          @options = options
+          @client = client
+        end
+
+        private
+
+        def output_json(data)
+          json_output = JSON.pretty_generate(data)
+
+          if options[:output]
+            File.write(options[:output], json_output)
+            warn "\nResults saved to: #{options[:output]}"
+          else
+            puts json_output
+          end
+        end
+
+        def format_collector(collector)
+          {
+            id: collector['id'],
+            name: collector['name'],
+            collectorType: collector['collectorType'],
+            alive: collector['alive'],
+            category: collector['category']
+          }
+        end
+
+        def format_source(source)
+          {
+            id: source['id'],
+            name: source['name'],
+            category: source['category'],
+            sourceType: source['sourceType'],
+            alive: source['alive']
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sumologic/cli/commands/list_collectors_command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+
+module Sumologic
+  class CLI < Thor
+    module Commands
+      # Handles the list-collectors command execution
+      class ListCollectorsCommand < BaseCommand
+        def execute
+          warn 'Fetching collectors...'
+          collectors = client.list_collectors
+
+          output_json(
+            total: collectors.size,
+            collectors: collectors.map { |c| format_collector(c) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/sumologic/cli/commands/list_sources_command.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+
+module Sumologic
+  class CLI < Thor
+    module Commands
+      # Handles the list-sources command execution
+      class ListSourcesCommand < BaseCommand
+        def execute
+          if options[:collector_id]
+            list_sources_for_collector
+          else
+            list_all_sources
+          end
+        end
+
+        private
+
+        def list_sources_for_collector
+          warn "Fetching sources for collector: #{options[:collector_id]}"
+          sources = client.list_sources(collector_id: options[:collector_id])
+
+          output_json(
+            collector_id: options[:collector_id],
+            total: sources.size,
+            sources: sources.map { |s| format_source(s) }
+          )
+        end
+
+        def list_all_sources
+          warn 'Fetching all sources from all collectors...'
+          warn 'This may take a minute...'
+
+          all_sources = client.list_all_sources
+
+          output_json(
+            total_collectors: all_sources.size,
+            total_sources: all_sources.sum { |c| c['sources'].size },
+            data: all_sources.map { |item| format_collector_with_sources(item) }
+          )
+        end
+
+        def format_collector_with_sources(item)
+          {
+            collector: item['collector'],
+            sources: item['sources'].map { |s| format_source(s) }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sumologic/cli/commands/search_command.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+
+module Sumologic
+  class CLI < Thor
+    module Commands
+      # Handles the search command execution
+      class SearchCommand < BaseCommand
+        def execute
+          log_search_info
+          results = perform_search
+
+          display_results_summary(results)
+
+          if options[:interactive]
+            launch_interactive_mode(results)
+          else
+            output_search_results(results)
+          end
+        end
+
+        private
+
+        def log_search_info
+          warn '=' * 60
+          warn 'Sumo Logic Search Query'
+          warn '=' * 60
+          warn "Time Range: #{options[:from]} to #{options[:to]}"
+          warn "Query: #{options[:query]}"
+          warn "Limit: #{options[:limit] || 'unlimited'}"
+          warn '-' * 60
+          warn 'Creating search job...'
+          $stderr.puts
+        end
+
+        def perform_search
+          client.search(
+            query: options[:query],
+            from_time: options[:from],
+            to_time: options[:to],
+            time_zone: options[:time_zone],
+            limit: options[:limit]
+          )
+        end
+
+        def display_results_summary(results)
+          warn '=' * 60
+          warn "Results: #{results.size} messages"
+          warn '=' * 60
+          $stderr.puts
+        end
+
+        def output_search_results(results)
+          output_json(
+            query: options[:query],
+            from: options[:from],
+            to: options[:to],
+            time_zone: options[:time_zone],
+            message_count: results.size,
+            messages: results
+          )
+        end
+
+        def launch_interactive_mode(results)
+          require_relative '../../interactive'
+
+          formatted_results = build_formatted_results(results)
+          Sumologic::Interactive.launch(formatted_results)
+        rescue Sumologic::Interactive::Error => e
+          warn e.message
+          exit 1
+        end
+
+        def build_formatted_results(results)
+          {
+            'query' => options[:query],
+            'from' => options[:from],
+            'to' => options[:to],
+            'time_zone' => options[:time_zone],
+            'message_count' => results.size,
+            'messages' => results
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sumologic/cli.rb

@@ -2,9 +2,13 @@
 
 require 'thor'
 require 'json'
+require_relative 'cli/commands/search_command'
+require_relative 'cli/commands/list_collectors_command'
+require_relative 'cli/commands/list_sources_command'
 
 module Sumologic
   # Thor-based CLI for Sumo Logic query tool
+  # Delegates commands to specialized command classes
   class CLI < Thor
     class_option :debug, type: :boolean, aliases: '-d', desc: 'Enable debug output'
     class_option :output, type: :string, aliases: '-o', desc: 'Output file (default: stdout)'
@@ -13,6 +17,11 @@ module Sumologic
       true
     end
 
+    def initialize(*args)
+      super
+      $DEBUG = true if options[:debug]
+    end
+
     desc 'search', 'Search Sumo Logic logs'
     long_desc <<~DESC
       Search Sumo Logic logs using a query string.
@@ -39,23 +48,7 @@ module Sumologic
     option :limit, type: :numeric, aliases: '-l', desc: 'Maximum messages to return'
     option :interactive, type: :boolean, aliases: '-i', desc: 'Launch interactive browser (requires fzf)'
     def search
-      $DEBUG = true if options[:debug]
-
-      client = create_client
-
-      log_search_info
-      results = execute_search(client)
-
-      warn '=' * 60
-      warn "Results: #{results.size} messages"
-      warn '=' * 60
-      $stderr.puts
-
-      if options[:interactive]
-        launch_interactive_mode(results)
-      else
-        output_search_results(results)
-      end
+      Commands::SearchCommand.new(options, create_client).execute
     end
 
     desc 'list-collectors', 'List all Sumo Logic collectors'
@@ -66,17 +59,7 @@ module Sumologic
         sumo-query list-collectors --output collectors.json
     DESC
     def list_collectors
-      $DEBUG = true if options[:debug]
-
-      client = create_client
-
-      warn 'Fetching collectors...'
-      collectors = client.list_collectors
-
-      output_json(
-        total: collectors.size,
-        collectors: collectors.map { |c| format_collector(c) }
-      )
+      Commands::ListCollectorsCommand.new(options, create_client).execute
     end
 
     desc 'list-sources', 'List sources from collectors'
@@ -92,15 +75,7 @@ module Sumologic
     DESC
     option :collector_id, type: :string, desc: 'Collector ID to list sources for'
     def list_sources
-      $DEBUG = true if options[:debug]
-
-      client = create_client
-
-      if options[:collector_id]
-        list_sources_for_collector(client, options[:collector_id])
-      else
-        list_all_sources(client)
-      end
+      Commands::ListSourcesCommand.new(options, create_client).execute
     end
 
     desc 'version', 'Show version information'
@@ -127,120 +102,8 @@ module Sumologic
       exit 1
     end
 
-    def list_sources_for_collector(client, collector_id)
-      warn "Fetching sources for collector: #{collector_id}"
-      sources = client.list_sources(collector_id: collector_id)
-
-      output_json(
-        collector_id: collector_id,
-        total: sources.size,
-        sources: sources.map { |s| format_source(s) }
-      )
-    end
-
-    def list_all_sources(client)
-      warn 'Fetching all sources from all collectors...'
-      warn 'This may take a minute...'
-
-      all_sources = client.list_all_sources
-
-      output_json(
-        total_collectors: all_sources.size,
-        total_sources: all_sources.sum { |c| c['sources'].size },
-        data: all_sources.map do |item|
-          {
-            collector: item['collector'],
-            sources: item['sources'].map { |s| format_source(s) }
-          }
-        end
-      )
-    end
-
-    def format_collector(collector)
-      {
-        id: collector['id'],
-        name: collector['name'],
-        collectorType: collector['collectorType'],
-        alive: collector['alive'],
-        category: collector['category']
-      }
-    end
-
-    def format_source(source)
-      {
-        id: source['id'],
-        name: source['name'],
-        category: source['category'],
-        sourceType: source['sourceType'],
-        alive: source['alive']
-      }
-    end
-
-    def output_json(data)
-      json_output = JSON.pretty_generate(data)
-
-      if options[:output]
-        File.write(options[:output], json_output)
-        warn "\nResults saved to: #{options[:output]}"
-      else
-        puts json_output
-      end
-    end
-
     def error(message)
       warn message
     end
-
-    def log_search_info
-      warn '=' * 60
-      warn 'Sumo Logic Search Query'
-      warn '=' * 60
-      warn "Time Range: #{options[:from]} to #{options[:to]}"
-      warn "Query: #{options[:query]}"
-      warn "Limit: #{options[:limit] || 'unlimited'}"
-      warn '-' * 60
-      warn 'Creating search job...'
-      $stderr.puts
-    end
-
-    def execute_search(client)
-      client.search(
-        query: options[:query],
-        from_time: options[:from],
-        to_time: options[:to],
-        time_zone: options[:time_zone],
-        limit: options[:limit]
-      )
-    end
-
-    def output_search_results(results)
-      output_json(
-        query: options[:query],
-        from: options[:from],
-        to: options[:to],
-        time_zone: options[:time_zone],
-        message_count: results.size,
-        messages: results
-      )
-    end
-
-    def launch_interactive_mode(results)
-      require_relative 'interactive'
-
-      # Format results for interactive mode
-      formatted_results = {
-        'query' => options[:query],
-        'from' => options[:from],
-        'to' => options[:to],
-        'time_zone' => options[:time_zone],
-        'message_count' => results.size,
-        'messages' => results
-      }
-
-      Sumologic::Interactive.launch(formatted_results)
-    rescue Sumologic::Interactive::Error => e
-      error e.message
-      exit 1
-    end
   end
 end