sumologic-query 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5822fc268d1979e97d6993b7f233b720049f832c4d5d921a75c32ecccc16ce68
-  data.tar.gz: f9e1cde6a138f45d70ec4ed2e06b22f87faf9500a6cb4fb7274fe8df787bcba1
+  metadata.gz: f62e0cd6d7ee0fbfd44b2720b0075e4f1776e086ef1ccbe39ad9e520f539f951
+  data.tar.gz: da262a85a0fa2d556c310876d011705edd4fc1b46db47c43d6f892adf71649ff
 SHA512:
-  metadata.gz: 661862b1dfbc17a5729fbffc54c459e9b2e52a996346b0c028179002c606689096c0a191a26d7bb06d737c197f50324eb86e574289a093c4a392b9248a3e2647
-  data.tar.gz: fda3e751c1dc953fa10d878288193ffe060dcd9366e9d18e8cad9d8eeaf8a194e0dcaa1f50ca245fdc5ab20a95c7f1b67809add3dbed2aa28341f68130188ffd
+  metadata.gz: 458d97b1853c3626d85f84770faaf918ebbd2842718ffed416ead1736a8a075bc4061eb040e003a24227e8af6b7f6f125baf2b2aec5627f0398abd6b054fe880
+  data.tar.gz: '078544851f936431eea88d6b0783f39c58789072bbfa8fe17f5147c2a9aff9df8bc0b3f5e71c48e7d6793f8ad94a69a134bfabe5ab3d46689ff35613a13446f5'

data/CHANGELOG.md

@@ -6,6 +6,27 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 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.4.1](https://github.com/patrick204nqh/sumologic-query/compare/v1.4.0...v1.4.1) (2026-02-11)
+
+### 🎉 New Features
+
+- add "Open in Sumo Logic" URL to search output
+- add command recipe and CLI command specs
+
+### 🐛 Bug Fixes
+
+- update source_code_uri metadata to use homepage
+
+### 🔧 Refactoring
+
+- resolve ADR-006, fix README links, extract command helpers
+
+### 📚 Documentation
+
+- consolidate query examples and document v1/v2 API split
+
+
+
 ## [1.4.0](https://github.com/patrick204nqh/sumologic-query/compare/v1.3.5...v1.4.0) (2026-02-11)
 
 ### 🎉 New Features

data/README.md

@@ -152,9 +152,9 @@ client.list_all_sources
 ## Documentation
 
 - [Query Examples](examples/queries.md) - Query patterns and examples
-- [Quick Reference](docs/tldr.md) - Command cheat sheet
-- [Rate Limiting](docs/rate-limiting.md) - Performance tuning
-- [Architecture](docs/architecture/) - Design decisions
+- [Quick Reference](docs/sdlc/7-maintain/tldr.md) - Command cheat sheet
+- [Rate Limiting](docs/sdlc/4-develop/rate-limiting.md) - Performance tuning
+- [Architecture](docs/sdlc/3-design/overview.md) - Design decisions
 
 ## Contributing
 

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

@@ -17,6 +17,18 @@ module Sumologic
 
         private
 
+        def list_resource(label:, key:)
+          warn "Fetching #{label}..."
+          items = yield
+          output_json(total: items.size, key => items)
+        end
+
+        def get_resource(label:, id:)
+          warn "Fetching #{label} #{id}..."
+          result = yield
+          output_json(result)
+        end
+
         def output_json(data)
           json_output = JSON.pretty_generate(data)
 

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

@@ -8,11 +8,9 @@ module Sumologic
       # Handles the export-content command execution
       class ExportContentCommand < BaseCommand
         def execute
-          content_id = options[:content_id]
-          warn "Exporting content #{content_id}..."
-          result = client.export_content(content_id: content_id)
-
-          output_json(result)
+          get_resource(label: 'content', id: options[:content_id]) do
+            client.export_content(content_id: options[:content_id])
+          end
         end
       end
     end

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

@@ -8,11 +8,9 @@ module Sumologic
       # Handles the get-content command execution
       class GetContentCommand < BaseCommand
         def execute
-          path = options[:path]
-          warn "Looking up content at path: #{path}..."
-          content = client.get_content(path: path)
-
-          output_json(content)
+          get_resource(label: 'content at path:', id: options[:path]) do
+            client.get_content(path: options[:path])
+          end
         end
       end
     end

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

@@ -8,11 +8,9 @@ module Sumologic
       # Handles the get-dashboard command execution
       class GetDashboardCommand < BaseCommand
         def execute
-          dashboard_id = options[:dashboard_id]
-          warn "Fetching dashboard #{dashboard_id}..."
-          dashboard = client.get_dashboard(dashboard_id: dashboard_id)
-
-          output_json(dashboard)
+          get_resource(label: 'dashboard', id: options[:dashboard_id]) do
+            client.get_dashboard(dashboard_id: options[:dashboard_id])
+          end
         end
       end
     end

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

@@ -8,11 +8,9 @@ module Sumologic
       # Handles the get-lookup command execution
       class GetLookupCommand < BaseCommand
         def execute
-          lookup_id = options[:lookup_id]
-          warn "Fetching lookup table #{lookup_id}..."
-          lookup = client.get_lookup(lookup_id: lookup_id)
-
-          output_json(lookup)
+          get_resource(label: 'lookup table', id: options[:lookup_id]) do
+            client.get_lookup(lookup_id: options[:lookup_id])
+          end
         end
       end
     end

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

@@ -8,11 +8,9 @@ module Sumologic
       # Handles the get-monitor command execution
       class GetMonitorCommand < BaseCommand
         def execute
-          monitor_id = options[:monitor_id]
-          warn "Fetching monitor #{monitor_id}..."
-          monitor = client.get_monitor(monitor_id: monitor_id)
-
-          output_json(monitor)
+          get_resource(label: 'monitor', id: options[:monitor_id]) do
+            client.get_monitor(monitor_id: options[:monitor_id])
+          end
         end
       end
     end

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

@@ -8,13 +8,7 @@ module Sumologic
       # Handles the list-apps command execution
       class ListAppsCommand < BaseCommand
         def execute
-          warn 'Fetching app catalog...'
-          apps = client.list_apps
-
-          output_json(
-            total: apps.size,
-            apps: apps
-          )
+          list_resource(label: 'app catalog', key: :apps) { client.list_apps }
         end
       end
     end

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

@@ -8,13 +8,7 @@ module Sumologic
       # 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
-          )
+          list_resource(label: 'collectors', key: :collectors) { client.list_collectors }
         end
       end
     end

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

@@ -8,13 +8,9 @@ module Sumologic
       # Handles the list-dashboards command execution
       class ListDashboardsCommand < BaseCommand
         def execute
-          warn 'Fetching dashboards...'
-          dashboards = client.list_dashboards(limit: options[:limit] || 100)
-
-          output_json(
-            total: dashboards.size,
-            dashboards: dashboards
-          )
+          list_resource(label: 'dashboards', key: :dashboards) do
+            client.list_dashboards(limit: options[:limit] || 100)
+          end
         end
       end
     end

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

@@ -8,13 +8,9 @@ module Sumologic
       # Handles the list-health-events command execution
       class ListHealthEventsCommand < BaseCommand
         def execute
-          warn 'Fetching health events...'
-          events = client.list_health_events(limit: options[:limit] || 100)
-
-          output_json(
-            total: events.size,
-            healthEvents: events
-          )
+          list_resource(label: 'health events', key: :healthEvents) do
+            client.list_health_events(limit: options[:limit] || 100)
+          end
         end
       end
     end

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

@@ -9,17 +9,13 @@ module Sumologic
       # Uses the monitors search API for flat, filterable results
       class ListMonitorsCommand < BaseCommand
         def execute
-          warn 'Fetching monitors...'
-          monitors = client.list_monitors(
-            query: options[:query],
-            status: options[:status],
-            limit: options[:limit] || 100
-          )
-
-          output_json(
-            total: monitors.size,
-            monitors: monitors
-          )
+          list_resource(label: 'monitors', key: :monitors) do
+            client.list_monitors(
+              query: options[:query],
+              status: options[:status],
+              limit: options[:limit] || 100
+            )
+          end
         end
       end
     end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require_relative 'base_command'
 require_relative '../../utils/time_parser'
 
@@ -46,6 +47,7 @@ module Sumologic
           end
           warn "Query: #{options[:query]}"
           warn "Limit: #{options[:limit] || 'unlimited'}"
+          warn "Open in Sumo: #{build_search_url}"
           warn '-' * 60
           warn 'Creating search job...'
           $stderr.puts
@@ -96,6 +98,7 @@ module Sumologic
               from_original: @original_from,
               to_original: @original_to,
               time_zone: @parsed_timezone,
+              search_url: build_search_url,
               record_count: results.size,
               records: results
             )
@@ -107,6 +110,7 @@ module Sumologic
               from_original: @original_from,
               to_original: @original_to,
               time_zone: @parsed_timezone,
+              search_url: build_search_url,
               message_count: results.size,
               messages: results
             )
@@ -135,10 +139,20 @@ module Sumologic
             'from' => @parsed_from,
             'to' => @parsed_to,
             'time_zone' => @parsed_timezone,
+            'search_url' => build_search_url,
             'message_count' => results.size,
             'messages' => results
           }
         end
+
+        def build_search_url
+          from_ms = (Time.parse("#{@parsed_from}Z").to_f * 1000).to_i
+          to_ms = (Time.parse("#{@parsed_to}Z").to_f * 1000).to_i
+          encoded_query = ERB::Util.url_encode(options[:query])
+          base = client.config.web_ui_base_url
+
+          "#{base}/ui/#/search/create?query=#{encoded_query}&startTime=#{from_ms}&endTime=#{to_ms}"
+        end
       end
     end
   end

data/lib/sumologic/configuration.rb

@@ -45,6 +45,10 @@ module Sumologic
       @base_url_v2 ||= build_base_url('v2')
     end
 
+    def web_ui_base_url
+      @web_ui_base_url ||= build_web_ui_base_url
+    end
+
     def validate!
       raise AuthenticationError, 'SUMO_ACCESS_ID not set' unless @access_id
       raise AuthenticationError, 'SUMO_ACCESS_KEY not set' unless @access_key
@@ -52,6 +56,23 @@ module Sumologic
 
     private
 
+    def build_web_ui_base_url
+      case @deployment
+      when /^http/
+        @deployment.sub('api.', 'service.').sub(%r{/api/v\d+.*}, '')
+      when 'us1'
+        'https://service.sumologic.com'
+      when 'us2'
+        'https://service.us2.sumologic.com'
+      when 'eu'
+        'https://service.eu.sumologic.com'
+      when 'au'
+        'https://service.au.sumologic.com'
+      else
+        "https://service.#{@deployment}.sumologic.com"
+      end
+    end
+
     def build_base_url(version = API_VERSION)
       case @deployment
       when /^http/

data/lib/sumologic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sumologic
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sumologic-query
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - patrick204nqh
@@ -154,7 +154,6 @@ homepage: https://github.com/patrick204nqh/sumologic-query
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/patrick204nqh/sumologic-query
   source_code_uri: https://github.com/patrick204nqh/sumologic-query
   bug_tracker_uri: https://github.com/patrick204nqh/sumologic-query/issues
   changelog_uri: https://github.com/patrick204nqh/sumologic-query/blob/main/CHANGELOG.md