kscript 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 063aeed0edf967058b4f711054a6faf7bd1d9b4648944e9d8087e53d4638a2a9
-  data.tar.gz: c1bd30a10d30507dd8be6390d44f65c9e55a68f7a0c8079f55812156143961db
+  metadata.gz: 9858f96cfbf2ee112ddc38885f50d0e2dec2247536c0611de542641b4865cbcf
+  data.tar.gz: e3fec35b64539ed8a87d24fc4d4b647d6ff3f202f9844d61e9801b95d846aec2
 SHA512:
-  metadata.gz: 066b7dd8b0d95de5e5391d1317ff9c86eb7c1c4b0aa4adcb52da652f9d4aebf055b6bc1ea9aa9f1e4b23397789232967bf4739264cdf71d92791f1dcb69c0b65
-  data.tar.gz: 61de9beedfa35069b788c6b6e52c520b01c83bf01d715dad3d0c0d4b91b18ec5e8a2fed65fed589ffbe66774e271e5d322bd039e908e563f81831472b88a47a2
+  metadata.gz: 46ed820b66174793117e203f24a50b65c274247992f29283753b13f6c5f25026651bdb8222898636e2962477e78ecd66cbad311d8dcf54deff21dc4555051f82
+  data.tar.gz: 36468f99eaccf8f268faf3de72201d435af545407bdab20e9601a898717bdd6f2b0dc7f1570d0c7700b0e98e3224724fbc8119485b8dbee8c6297029ad527f5a

data/README.md

@@ -16,6 +16,23 @@ _  ,<  _(__  )/ /__ _  /   _  / __  /_/ / /_
 
 ---
 
+## 🗺️ 架构图
+
+```mermaid
+graph TD
+  A[用户终端/脚本] -->|命令行| B(kscript CLI)
+  B --> C[插件注册与分发]
+  B --> D[日志系统]
+  B --> E[配置加载]
+  B --> F[Shell补全生成]
+  B --> G[结构化日志/美化输出]
+  B --> H[CI/CD自动发布]
+  F --> I1[zsh补全脚本]
+  F --> I2[bash补全脚本]
+  H --> J[GitHub Actions]
+  J --> K[RubyGems发布]
+```
+
 ## ✨ 特性亮点
 - 统一 CLI 框架，所有命令一键调用，美化输出
 - 插件化架构，业务命令即插件，易扩展、易维护
@@ -97,91 +114,32 @@ kscript port_scan 192.168.1.1 --log-level=debug
 | project   | `vcs_cleaner`          | `kscript vcs_cleaner ~/projects/src`                             | `[src_path]`                                           | Clean old source code versions, keep N latest.               |
 | project   | `file_rename`          | `kscript file_rename foo bar ./src`                              | `<pattern> <replacement> [path]`                       | Batch rename files by pattern.                               |
 | system    | `shell_helper`         | `kscript shell_helper 'ls'`                                      | `[subcommand] [args...]`                               | Query shell command usage and cheatsheets.                   |
-| system    | `lvm_manage`           | `kscript lvm_manage /dev/sda2 /mnt/data`                         | `<device> <mount_point>`                               | Mount and manage Linux LVM volumes.                          |
-| macos     | `mac_status`           | `kscript mac_status`                                             |                                                        | Show macOS system resource monitor report.                   |
-| macos     | `mac_optimize`         | `kscript mac_optimize`                                           |                                                        | Optimize macOS system performance.                           |
-| media     | `ffmpeg_install`       | `kscript ffmpeg_install 6.0`                                     | `[version]`                                            | Install and verify FFmpeg on Linux.                          |
-| elastic   | `elastic_cert_finger`  | `kscript elastic_cert_finger ./ca.crt`                           | `<cert_file>`                                          | Generate Elasticsearch certificate SHA256 fingerprint.       |
-| elastic   | `kibana_manage`        | `kscript kibana_manage export --host=localhost --index=log-*`    | `[subcommand] [options]`                               | Kibana automation: space, index, user, role management.      |
-| ci        | `jenkins_manage`       | `kscript jenkins_manage list --host=jenkins.local`               | `[subcommand] [options]`                               | Jenkins job export/import automation.                        |
-| cloud     | `aws_s3`               | `kscript aws_s3 --file local.txt --bucket my-bucket ...`         | `--file --bucket --key --region --access_key --secret_key` | Upload a file to AWS S3 for testing.                         |
-| finance   | `usd_rate`             | `kscript usd_rate CNY`                                           | `[currency_code]`                                      | Get latest USD exchange rates.                               |
-
----
-
-## ⚡ Shell 自动补全 & 配置示例
-
-- 首次安装/升级自动为 zsh/bash 部署补全脚本，并生成 `~/.kscript/.env` 配置示例
-- 补全脚本路径：
-  - zsh: `~/.zsh/completions/_kscript`
-  - bash: `~/.bash_completion.d/kscript`
-- 配置文件路径：
-  - `~/.kscript/.env`（自动生成，支持 ENV 变量注释说明）
-- 手动生成补全：
-  ```bash
-  kscript completion zsh > ~/.zsh/completions/_kscript
-  kscript completion bash > ~/.bash_completion.d/kscript
-  ```
-
----
-
-## ⚙️ 全局配置（.env 格式）
-
-所有全局参数均通过 `~/.kscript/.env` 文件（自动生成，标准 .env 格式）或环境变量注入。例如：
-
-```env
-# AWS S3 upload config
-AWS_BUCKET=my-bucket
-AWS_REGION=ap-northeast-1
-AWS_ACCESS_KEY_ID=xxx
-AWS_SECRET_ACCESS_KEY=yyy
-
-# Logging config
-KSCRIPT_LOG_LEVEL=info
-LOG=1
-```
----
-
-## 🧑‍💻 插件开发规范
-- 插件文件统一放在 `lib/kscript/plugins/kk_xxx_utils.rb`
-- 类名如 `KkApnicIpUtils`，自动注册为 `apnic_ip` 命令
-- 支持 `self.description`、`self.usage`、`self.arguments`、`self.group`、`self.author`
-- 输出统一用 `logger.kinfo`/`logger.kerror`，支持结构化日志
-- 兼容多余参数，避免 ArgumentError
-- 依赖统一在主入口 require，插件只需 require 'kscript'
-
----
-
-## 🚚 CI/CD 自动发布
-
-- `.github/workflows/gem-push.yml`：main 分支和 PR 自动构建、tag push 自动发布到 RubyGems
-- 需在 GitHub secrets 配置 `RUBYGEMS_API_KEY`
-- [CI 状态与历史](https://github.com/kevin197011/kscript/actions/workflows/gem-push.yml)
+| system    | `lvm_manage`           | `kscript lvm_manage /dev/sda2 /mnt/data`                        | `<device> <mount_point>`                                 | Mount and manage Linux LVM volumes.                          |
 
 ---
 
-## 📦 依赖与兼容性
-
-- Ruby >= 3.0
-- 依赖：bcrypt, http, nokogiri, thor, aws-sdk-s3, httpx 等
-- 支持 macOS、Linux，部分工具支持 Windows
-
----
+## 🤝 贡献指南
 
-## 📄 许可证
+欢迎提交 Issue 和 Pull Request！请遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范，确保所有代码通过 Linter 检查。详细贡献流程见 CONTRIBUTING.md（如有）。
 
-MIT License. 详见 [LICENSE](LICENSE)。
+## ❓ 常见问题
 
----
+- **如何启用 shell 补全？**
+  安装后自动生成补全脚本，重启 shell 或手动 `source ~/.zshrc`/`~/.bashrc`。
+- **如何切换日志模式？**
+  所有命令支持 `--log` 或 `--log-level=debug`，详见上文示例。
+- **如何自定义配置？**
+  编辑 `~/.kscript/.env`，可配置 AWS、日志等参数。
 
-## 🤝 贡献
+如有更多问题，欢迎提交 [Issue](https://github.com/kevin197011/kscript/issues)。
 
-1. Fork & PR
-2. 遵循输出与插件开发规范
-3. 保持文档与代码同步
+## 📬 联系方式 & 致谢
 
----
+- 作者: [kk (kevin197011)](https://github.com/kevin197011)
+- 邮箱: kevin197011@outlook.com
 
-如需更多示例、插件开发指导或遇到问题，欢迎提 issue 或 PR！
+感谢所有贡献者和开源依赖项目！
 
+## 📄 License
 
+This project is licensed under the [MIT License](LICENSE).

data/lib/kscript/completions/kscript.bash

@@ -8,7 +8,7 @@ _kscript_completions() {
 
     # Main command list as array
     local opts=(
-        apnic_ip aws_s3 cursor_rules elastic_cert_finger ffmpeg_install file_rename ip_lookup jenkins_manage kibana_manage lvm_manage mac_optimize mac_status port_scan project_scan shell_helper usd_rate vcs_cleaner wg_acl wg_pass
+        apnic_ip aws_s3 cursor_rules elastic_cert_finger ffmpeg_install file_rename hn_jobs ip_lookup jenkins_manage kibana_manage lvm_manage mac_optimize mac_status port_scan project_scan shell_helper usd_rate vcs_cleaner wg_acl wg_pass
     )
 
     if [[ ${COMP_CWORD} == 1 ]]; then

data/lib/kscript/completions/kscript.zsh

@@ -8,6 +8,7 @@ _kscript() {
     'elastic_cert_finger:kscript command'
     'ffmpeg_install:kscript command'
     'file_rename:kscript command'
+    'hn_jobs:kscript command'
     'ip_lookup:kscript command'
     'jenkins_manage:kscript command'
     'kibana_manage:kscript command'

data/lib/kscript/plugins/kk_apnic_ip_utils.rb

@@ -5,7 +5,7 @@
 # This software is released under the MIT License.
 # https://opensource.org/licenses/MIT
 
-# require 'kscript' # 移除此行
+require 'httpx'
 
 module Kscript
   class KkApnicIpUtils < Kscript::Base
@@ -30,8 +30,9 @@ module Kscript
         end
       end
       url = 'https://ftp.apnic.net/stats/apnic/delegated-apnic-latest'
-      response = HTTP.get(url)
-      raise "Failed to download the APNIC data. HTTP Status: #{response.status}" unless response.status.success?
+      response = HTTPX.get(url)
+      response = response.first if response.is_a?(Array)
+      raise "Failed to download the APNIC data. HTTP Status: #{response.status}" unless response.status == 200
 
       File.write(cache_file, response.body.to_s)
       logger.kinfo("Data downloaded and saved to #{cache_file}")

data/lib/kscript/plugins/kk_cursor_rules_utils.rb

@@ -68,7 +68,7 @@ module Kscript
       # Ensure .gitignore contains .cursor
       if File.exist?('.gitignore') && File.readlines('.gitignore').none? { |l| l.strip == '.cursor' }
         logger.kinfo('Adding .cursor to .gitignore...')
-        File.open('.gitignore', 'a') { |f| f.puts '\n.cursor' }
+        File.open('.gitignore', 'a') { |f| f.puts "\n.cursor" }
       end
 
       logger.kinfo("\n✅ Cursor rules deploy completed!")

data/lib/kscript/plugins/kk_hn_jobs_utils.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2025 Kk
+#
+# This software is released under the MIT License.
+# https://opensource.org/licenses/MIT
+
+module Kscript
+  class KkHnJobsUtils < Kscript::Base
+    HN_JOBS_API = 'https://hacker-news.firebaseio.com/v0/jobstories.json'
+    HN_ITEM_API = 'https://hacker-news.firebaseio.com/v0/item'
+
+    def initialize(*args, **opts)
+      super
+      @limit = (args[0] || 10).to_i
+    end
+
+    def run(*args, **_opts)
+      with_error_handling do
+        limit = (args[0] || @limit || 10).to_i
+        logger.kinfo("Fetching latest #{limit} Hacker News jobs...")
+        job_ids = fetch_job_ids.first(limit)
+        jobs = job_ids.map { |id| extract_job_info(fetch_job_item(id)) }
+        display_jobs(jobs)
+      end
+    end
+
+    def self.arguments
+      '[limit]'
+    end
+
+    def self.usage
+      'kscript hn_jobs [limit]'
+    end
+
+    def self.group
+      'network'
+    end
+
+    def self.author
+      'kk'
+    end
+
+    def self.description
+      'Fetch and display latest Hacker News jobs: description and url.'
+    end
+
+    private
+
+    def fetch_job_ids
+      require_httpx
+      response = HTTPX.get(HN_JOBS_API)
+      response = response.first if response.is_a?(Array)
+      raise "Failed to fetch job ids: #{response.status}" unless response.status == 200
+
+      JSON.parse(response.body.to_s)
+    end
+
+    def fetch_job_item(id)
+      require_httpx
+      url = "#{HN_ITEM_API}/#{id}.json"
+      response = HTTPX.get(url)
+      response = response.first if response.is_a?(Array)
+      raise "Failed to fetch job item #{id}: #{response.status}" unless response.status == 200
+
+      JSON.parse(response.body.to_s)
+    end
+
+    # 只提取描述和 url
+    def extract_job_info(item)
+      {
+        description: item['title'].to_s.strip,
+        url: item['url'] || "https://news.ycombinator.com/item?id=#{item['id']}"
+      }
+    end
+
+    def display_jobs(jobs)
+      logger.kinfo('| 描述 | 链接 |')
+      logger.kinfo('|------|------|')
+      jobs.each do |job|
+        logger.kinfo("| #{job[:description]} | [查看](#{job[:url]}) |")
+      end
+    end
+
+    def require_httpx
+      require 'httpx'
+    rescue LoadError
+      abort 'Missing dependency: httpx. Please run: gem install httpx'
+    end
+  end
+end

data/lib/kscript/plugins/kk_jenkins_manage_utils.rb

@@ -5,7 +5,7 @@
 # This software is released under the MIT License.
 # https://opensource.org/licenses/MIT
 
-# require 'kscript'
+require 'httpx'
 
 module Kscript
   class KkJenkinsManageUtils < Kscript::Base
@@ -61,8 +61,9 @@ module Kscript
 
     def get_all_job_names
       url = "#{@jenkins_url}/api/json?tree=jobs[name]"
-      response = HTTP.get(url, headers: { 'Authorization' => @auth_header })
-      if response.status.success?
+      response = HTTPX.get(url, headers: { 'Authorization' => @auth_header })
+      response = response.first if response.is_a?(Array)
+      if response.status == 200
         jobs = JSON.parse(response.body.to_s)['jobs']
         jobs.map { |job| job['name'] }
       else
@@ -76,8 +77,9 @@ module Kscript
 
     def export_job(job_name)
       url = "#{@jenkins_url}/job/#{job_name}/config.xml"
-      response = HTTP.get(url, headers: { 'Authorization' => @auth_header })
-      return response.body.to_s if response.status.success?
+      response = HTTPX.get(url, headers: { 'Authorization' => @auth_header })
+      response = response.first if response.is_a?(Array)
+      return response.body.to_s if response.status == 200
 
       logger.kerror("Error exporting job #{job_name}: #{response.status}")
       nil
@@ -94,10 +96,11 @@ module Kscript
         create_new_job(job_name, config_xml)
       rescue StandardError
         logger.kinfo("Updating existing job #{job_name}")
-        HTTP.put(url, body: config_xml, headers: {
-                   'Authorization' => @auth_header,
-                   'Content-Type' => 'application/xml'
-                 })
+        response = HTTPX.put(url, body: config_xml, headers: {
+                               'Authorization' => @auth_header,
+                               'Content-Type' => 'application/xml'
+                             })
+        response.first if response.is_a?(Array)
       end
     end
 
@@ -125,11 +128,12 @@ module Kscript
 
     def create_new_job(job_name, config_xml)
       url = "#{@jenkins_url}/createItem?name=#{job_name}"
-      response = HTTP.post(url, body: config_xml, headers: {
-                             'Authorization' => @auth_header,
-                             'Content-Type' => 'application/xml'
-                           })
-      if response.status.success?
+      response = HTTPX.post(url, body: config_xml, headers: {
+                              'Authorization' => @auth_header,
+                              'Content-Type' => 'application/xml'
+                            })
+      response = response.first if response.is_a?(Array)
+      if response.status == 200
         logger.kinfo("Successfully created new job #{job_name}")
       else
         logger.kerror("Failed to create job #{job_name}: #{response.status}")

data/lib/kscript/plugins/kk_kibana_manage_utils.rb

@@ -5,7 +5,7 @@
 # This software is released under the MIT License.
 # https://opensource.org/licenses/MIT
 
-# require 'kscript'
+require 'httpx'
 
 module Kscript
   class KkKibanaManageUtils < Kscript::Base
@@ -33,7 +33,8 @@ module Kscript
     def space_exists?
       url = "#{@base_url}/api/spaces/space/#{@space_name}"
       response = client.get(url, headers: kbn_headers)
-      response.status.success?
+      response = response.first if response.is_a?(Array)
+      response.status == 200
     rescue StandardError => e
       logger.kerror("Error checking space existence: #{e.message}")
       false
@@ -51,7 +52,8 @@ module Kscript
       }
 
       response = client.post(url, json: body, headers: kbn_headers)
-      if response.status.success?
+      response = response.first if response.is_a?(Array)
+      if response.status == 200
         logger.kinfo("Space '#{@space_name}' created successfully!")
       else
         logger.kerror("Failed to create space '#{@space_name}': #{response.body}")
@@ -62,12 +64,17 @@ module Kscript
 
     # Return the HTTP client with authentication
     def client
-      @client ||= HTTP.basic_auth(user: @username, pass: @password)
+      @client ||= HTTPX.with(headers: { 'Authorization' => basic_auth_header })
+    end
+
+    def basic_auth_header
+      'Basic ' + Base64.strict_encode64("#{@username}:#{@password}")
     end
 
     # Fetch all indices from Kibana
     def indices
       response = client.get("#{@base_url}/api/index_management/indices", headers: kbn_headers)
+      response = response.first if response.is_a?(Array)
       handle_response(response) { |body| JSON.parse(body).map { |item| item['name'] } }
     end
 
@@ -83,7 +90,8 @@ module Kscript
           },
           'version' => 1
         }
-        client.post(url, json: body, headers: kbn_headers)
+        response = client.post(url, json: body, headers: kbn_headers)
+        response.first if response.is_a?(Array)
       end
     end
 
@@ -94,7 +102,8 @@ module Kscript
       body = index_body(index_name, uuid)
 
       response = client.post(url, json: body, headers: kbn_headers)
-      if response.status.success?
+      response = response.first if response.is_a?(Array)
+      if response.status == 200
         logger.kinfo("#{index_name} Index creation successful!")
       else
         handle_error(response, index_name)
@@ -136,7 +145,8 @@ module Kscript
           }
         ]
       }.to_json
-      client.put(url, body: request_body, headers: kbn_headers)
+      response = client.put(url, body: request_body, headers: kbn_headers)
+      response.first if response.is_a?(Array)
       logger.kinfo("Create #{@project_name} user role sucessed!")
     end
 
@@ -149,7 +159,8 @@ module Kscript
         'email' => "#{@project_name}@devops.io",
         'roles' => [@project_name]
       }.to_json
-      client.post(url, body: request_body, headers: kbn_headers)
+      response = client.post(url, body: request_body, headers: kbn_headers)
+      response.first if response.is_a?(Array)
       logger.kinfo("Create #{@project_name} user sucessed!")
     end
 
@@ -185,7 +196,9 @@ module Kscript
         'options' => { 'fields' => %w[title type typeMeta name] },
         'version' => 1
       }
-      JSON.parse(client.post(url, json: body, headers: kbn_headers))['result']['result']['hits']
+      response = client.post(url, json: body, headers: kbn_headers)
+      response = response.first if response.is_a?(Array)
+      JSON.parse(response.body)['result']['result']['hits']
     end
 
     # Construct the body for creating an index
@@ -218,7 +231,8 @@ module Kscript
 
     # Handle the response from Kibana
     def handle_response(response)
-      if response.status.success?
+      response = response.first if response.is_a?(Array)
+      if response.status == 200
         yield response.body
       else
         handle_error(response)

data/lib/kscript/plugins/kk_usd_rate_utils.rb

@@ -5,7 +5,7 @@
 # This software is released under the MIT License.
 # https://opensource.org/licenses/MIT
 
-require 'net/http'
+require 'httpx'
 require 'json'
 
 module Kscript
@@ -25,9 +25,9 @@ module Kscript
     end
 
     def fetch_rates
-      uri = URI(API_URL)
-      response = Net::HTTP.get(uri)
-      data = JSON.parse(response)
+      response = HTTPX.get(API_URL)
+      response = response.first if response.is_a?(Array)
+      data = JSON.parse(response.body.to_s)
       if @currency_code && data['rates'][@currency_code.upcase]
         rate = data['rates'][@currency_code.upcase]
         logger.kinfo("1 USD = #{rate} #{@currency_code.upcase}")

data/lib/kscript/version.rb

@@ -6,5 +6,5 @@
 # https://opensource.org/licenses/MIT
 
 module Kscript
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/lib/kscript.rb

@@ -20,8 +20,6 @@ require 'open3'
 require 'openssl'
 
 # 第三方 gem
-require 'http'
-require 'bcrypt'
 require 'nokogiri'
 require 'thor'
 require 'aws-sdk-s3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kscript
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Kk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-11 00:00:00.000000000 Z
+date: 2025-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -162,6 +162,7 @@ files:
 - lib/kscript/plugins/kk_elastic_cert_finger_utils.rb
 - lib/kscript/plugins/kk_ffmpeg_install_utils.rb
 - lib/kscript/plugins/kk_file_rename_utils.rb
+- lib/kscript/plugins/kk_hn_jobs_utils.rb
 - lib/kscript/plugins/kk_ip_lookup_utils.rb
 - lib/kscript/plugins/kk_jenkins_manage_utils.rb
 - lib/kscript/plugins/kk_kibana_manage_utils.rb