seowebchecker-seoaudit-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 216cda4028ed53965356f9985598f5a308bb840a6b9aa954bfc99681aee75de0
+  data.tar.gz: 1f88f524ef991768aebb6e758b280ac61ef2dc103b600fcf75d05e962ce43cda
+SHA512:
+  metadata.gz: 28a065f81d2c36e89859f691ede8471c230eb71ef4e6e8a4c072acd121a8d166b1e3806533fd66bd9a57f4c6b7734dc67c5f5327f9a0bac0173d3bcc69c04c2f
+  data.tar.gz: 7e9bc40bcc26028967f11b473d9bfa2e1b6510125501ab70230eb131d6c763e394813f618e6febc16163c33d93aaddfbbb4ca7566a99c2eb87c1b20df058f37d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SEOWebChecker (https://seowebchecker.com)
+
+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,46 @@
+# seowebchecker-seoaudit-sdk (Ruby)
+
+[![Gem Version](https://badge.fury.io/rb/seowebchecker-seoaudit-sdk.svg)](https://rubygems.org/gems/seowebchecker-seoaudit-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Official Site](https://img.shields.io/badge/Official%20Site-seowebchecker.com-indigo)](https://seowebchecker.com)
+
+Lightweight open-source Ruby client SDK and CLI tool for full website SEO audits, on-page analysis, and technical diagnostics.
+
+Official website: **[https://seowebchecker.com](https://seowebchecker.com)**
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'seowebchecker-seoaudit-sdk'
+```
+
+Or install via `gem`:
+
+```bash
+gem install seowebchecker-seoaudit-sdk
+```
+
+## Quick Start
+
+```ruby
+require 'seowebchecker_seoaudit'
+
+auditor = SeoWebChecker::SeoAudit::Auditor.new
+result = auditor.audit('https://example.com')
+
+puts "Score: #{result[:score][:overall]}/100 (Grade: #{result[:score][:grade]})"
+puts "Passed: #{result[:stats][:passed]}, Warnings: #{result[:stats][:warnings]}, Errors: #{result[:stats][:errors]}"
+```
+
+## CLI Usage
+
+```bash
+seowebchecker-audit https://example.com --format json
+seowebchecker-audit https://example.com --min-score 85
+```
+
+## License
+
+MIT License © 2026 [SEOWebChecker](https://seowebchecker.com).

data/bin/seowebchecker-audit

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+require_relative "../lib/seowebchecker_seoaudit"
+
+target_url = ARGV[0]
+
+if target_url.nil? || ARGV.include?("--help") || ARGV.include?("-h")
+  puts <<~HELP
+    SEOWebChecker CLI — Website SEO Audit Tool (Ruby)
+    Official Website: https://seowebchecker.com
+
+    Usage:
+      seowebchecker-audit <url> [options]
+
+    Options:
+      --format <pretty|json>   Output format (default: pretty)
+      --min-score <number>     Minimum acceptable score (exit 1 if lower)
+      --help, -h               Show this help message
+      --version, -v            Show version
+  HELP
+  exit(0)
+end
+
+if ARGV.include?("--version") || ARGV.include?("-v")
+  puts "seowebchecker-seoaudit-sdk v#{SeoWebChecker::SeoAudit::VERSION}"
+  exit(0)
+end
+
+auditor = SeoWebChecker::SeoAudit::Auditor.new
+result = auditor.audit(target_url)
+
+if ARGV.include?("--format") && ARGV[ARGV.index("--format") + 1] == "json"
+  puts JSON.pretty_generate(result)
+else
+  score = result[:score][:overall]
+  grade = result[:score][:grade]
+
+  puts "=" * 65
+  puts " SEOWebChecker SEO Audit Report: #{result[:url]}"
+  puts " Official: https://seowebchecker.com | Generated: #{result[:timestamp]}"
+  puts "=" * 65
+  puts "\n Overall Score: #{score}/100 | Grade: #{grade}"
+  puts " Checks: #{result[:stats][:passed]} Passed, #{result[:stats][:warnings]} Warnings, #{result[:stats][:errors]} Errors\n\n"
+
+  errors = result[:issues].select { |i| i[:severity] == "error" }
+  if errors.any?
+    puts "[!] High Priority Issues (Errors):"
+    errors.each do |e|
+      puts "  ✖ #{e[:title]}: #{e[:recommendation]}"
+    end
+  end
+end
+
+min_score_idx = ARGV.index("--min-score")
+if min_score_idx
+  min_score = ARGV[min_score_idx + 1].to_i
+  if result[:score][:overall] < min_score
+    warn "\n[CI/CD ERROR] Score #{result[:score][:overall]} is below minimum requirement of #{min_score}."
+    exit(1)
+  end
+end

data/lib/seowebchecker_seoaudit/auditor.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "time"
+
+module SeoWebChecker
+  module SeoAudit
+    class Auditor
+      attr_accessor :user_agent, :timeout
+
+      DEFAULT_UA = "SEOWebChecker-RubyBot/1.0 (+https://seowebchecker.com)"
+
+      def initialize(user_agent: DEFAULT_UA, timeout: 15)
+        @user_agent = user_agent
+        @timeout = timeout
+      end
+
+      def audit(url)
+        url = "https://#{url}" unless url.start_with?("http://", "https://")
+        uri = URI.parse(url)
+
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = (uri.scheme == "https")
+        http.open_timeout = @timeout
+        http.read_timeout = @timeout
+
+        req = Net::HTTP::Get.new(uri.request_uri, {
+          "User-Agent" => @user_agent,
+          "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
+        })
+
+        res = http.request(req)
+        elapsed_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time) * 1000.0).round(2)
+
+        audit_html(res.body || "", url: url, response_time_ms: elapsed_ms, status_code: res.code.to_i)
+      end
+
+      def audit_html(html, url: "https://seowebchecker.com", response_time_ms: 120.0, status_code: 200)
+        issues = []
+
+        # 1. Title
+        title_match = html.match(/<title[^>]*>(.*?)<\/title>/im)
+        title = title_match ? title_match[1].gsub(/\s+/, " ").strip : nil
+        title_len = title ? title.length : 0
+
+        if title.nil? || title.empty?
+          issues << { id: "meta-title-missing", category: "meta", severity: "error", title: "Missing Title Tag", message: "No <title> tag found.", recommendation: "Add a title tag between 30 and 60 characters." }
+        elsif title_len < 30
+          issues << { id: "meta-title-short", category: "meta", severity: "warning", title: "Title Too Short", message: "Title has #{title_len} characters.", recommendation: "Expand title to 30-60 characters." }
+        elsif title_len > 65
+          issues << { id: "meta-title-long", category: "meta", severity: "warning", title: "Title Too Long", message: "Title has #{title_len} characters.", recommendation: "Shorten title to under 60 characters." }
+        else
+          issues << { id: "meta-title-pass", category: "meta", severity: "pass", title: "Optimal Title Length", message: "Title length is #{title_len} characters.", recommendation: "Keep clear title." }
+        end
+
+        # 2. Description
+        desc_match = html.match(/<meta[^>]*name=["']description["'][^>]*content=["']([^"']*)["']/im) ||
+                     html.match(/<meta[^>]*content=["']([^"']*)["'][^>]*name=["']description["']/im)
+        desc = desc_match ? desc_match[1].strip : nil
+        desc_len = desc ? desc.length : 0
+
+        if desc.nil? || desc.empty?
+          issues << { id: "meta-desc-missing", category: "meta", severity: "error", title: "Missing Meta Description", message: "No description tag found.", recommendation: "Add meta description between 120 and 160 characters." }
+        elsif desc_len < 70
+          issues << { id: "meta-desc-short", category: "meta", severity: "warning", title: "Description Too Short", message: "Description has #{desc_len} characters.", recommendation: "Expand description to 120-160 characters." }
+        else
+          issues << { id: "meta-desc-pass", category: "meta", severity: "pass", title: "Optimal Description", message: "Description has #{desc_len} characters.", recommendation: "Maintain quality description." }
+        end
+
+        # 3. Viewport & Canonical
+        has_viewport = html =~ /<meta[^>]*name=["']viewport["']/i
+        if has_viewport
+          issues << { id: "meta-viewport-pass", category: "meta", severity: "pass", title: "Viewport Configured", message: "Mobile viewport meta tag detected.", recommendation: "Mobile responsive." }
+        else
+          issues << { id: "meta-viewport-missing", category: "meta", severity: "error", title: "Missing Viewport", message: "No mobile viewport tag.", recommendation: "Add viewport meta tag for mobile SEO." }
+        end
+
+        has_canonical = html =~ /<link[^>]*rel=["']canonical["']/i
+        if has_canonical
+          issues << { id: "meta-canonical-pass", category: "meta", severity: "pass", title: "Canonical Present", message: "Canonical tag detected.", recommendation: "Canonical URL active." }
+        else
+          issues << { id: "meta-canonical-missing", category: "meta", severity: "warning", title: "Missing Canonical Tag", message: "No canonical link.", recommendation: "Add canonical URL to avoid duplicates." }
+        end
+
+        # 4. Headings & Content
+        h1_tags = html.scan(/<h1[^>]*>(.*?)<\/h1>/im).flatten.map { |h| h.gsub(/<[^>]+>/, "").strip }
+        clean_text = html.gsub(/<(script|style)[^>]*>.*?<\/\1>/im, " ").gsub(/<[^>]+>/, " ")
+        words = clean_text.scan(/\b[a-zA-Z0-9_\'-]{2,}\b/)
+        word_count = words.length
+
+        if h1_tags.empty?
+          issues << { id: "content-h1-missing", category: "content", severity: "error", title: "Missing <h1> Tag", message: "No <h1> heading found.", recommendation: "Add a single <h1> heading." }
+        elsif h1_tags.length == 1
+          issues << { id: "content-h1-pass", category: "content", severity: "pass", title: "Single <h1> Tag Configured", message: "H1 heading: '#{h1_tags.first}'.", recommendation: "Good hierarchy." }
+        else
+          issues << { id: "content-h1-multiple", category: "content", severity: "warning", title: "Multiple <h1> Tags (#{h1_tags.length})", message: "Found #{h1_tags.length} <h1> tags.", recommendation: "Consolidate to a single <h1>." }
+        end
+
+        if word_count < 100
+          issues << { id: "content-thin", category: "content", severity: "error", title: "Thin Content", message: "Page contains only #{word_count} words.", recommendation: "Expand content to 300+ words." }
+        else
+          issues << { id: "content-words-pass", category: "content", severity: "pass", title: "Adequate Word Count", message: "Page contains #{word_count} words.", recommendation: "Good text volume." }
+        end
+
+        # 5. Images
+        images = html.scan(/<img\s+([^>]*?)>/im).flatten
+        missing_alt = images.count { |attrs| attrs !~ /alt=["']/i }
+        if !images.empty? && missing_alt > 0
+          issues << { id: "images-missing-alt", category: "images", severity: "error", title: "#{missing_alt} Images Missing Alt Text", message: "#{missing_alt} of #{images.length} images lack alt attributes.", recommendation: "Add descriptive alt attributes." }
+        elsif !images.empty?
+          issues << { id: "images-alt-pass", category: "images", severity: "pass", title: "All Images Have Alt Text", message: "All #{images.length} images have alt tags.", recommendation: "Great image SEO." }
+        end
+
+        # 6. Technical HTTPS
+        is_https = url.downcase.start_with?("https://")
+        if is_https
+          issues << { id: "tech-https-pass", category: "technical", severity: "pass", title: "Secure HTTPS", message: "Connection secured with SSL/TLS.", recommendation: "Keep certificate updated." }
+        else
+          issues << { id: "tech-not-https", category: "technical", severity: "error", title: "Insecure HTTP", message: "Site does not enforce HTTPS.", recommendation: "Install SSL certificate." }
+        end
+
+        # Compute Score
+        passed_count = issues.count { |i| i[:severity] == "pass" }
+        warning_count = issues.count { |i| i[:severity] == "warning" }
+        error_count = issues.count { |i| i[:severity] == "error" }
+
+        total = issues.length
+        raw_score = total > 0 ? ((passed_count.to_f / total) * 100.0).round : 80
+        raw_score -= (error_count * 10) + (warning_count * 3)
+        final_score = [[raw_score, 0].max, 100].min
+
+        grade = case final_score
+                when 95..100 then "A+"
+                when 90...95 then "A"
+                when 80...90 then "B"
+                when 70...80 then "C"
+                when 60...70 then "D"
+                else "F"
+                end
+
+        {
+          url: url,
+          timestamp: Time.now.utc.iso8601,
+          score: {
+            overall: final_score,
+            grade: grade
+          },
+          stats: {
+            total: total,
+            passed: passed_count,
+            warnings: warning_count,
+            errors: error_count
+          },
+          meta: {
+            title: title,
+            title_length: title_len,
+            description: desc,
+            description_length: desc_len
+          },
+          content: {
+            word_count: word_count,
+            h1_tags: h1_tags
+          },
+          images: {
+            total_images: images.length,
+            missing_alt: missing_alt
+          },
+          technical: {
+            is_https: is_https
+          },
+          performance: {
+            response_time_ms: response_time_ms,
+            status_code: status_code
+          },
+          issues: issues
+        }
+      end
+    end
+  end
+end

data/lib/seowebchecker_seoaudit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SeoWebChecker
+  module SeoAudit
+    VERSION = "1.0.0"
+  end
+end

data/lib/seowebchecker_seoaudit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "seowebchecker_seoaudit/version"
+require_relative "seowebchecker_seoaudit/auditor"
+
+module SeoWebChecker
+  module SeoAudit
+    def self.audit(url, options = {})
+      Auditor.new(**options).audit(url)
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: seowebchecker-seoaudit-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- SEOWebChecker Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-25 00:00:00.000000000 Z
+dependencies: []
+description: Instant website SEO auditing, on-page optimization diagnostics, meta
+  tag validation, and Core Web Vitals checks.
+email:
+- support@seowebchecker.com
+executables:
+- seowebchecker-audit
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/seowebchecker-audit
+- lib/seowebchecker_seoaudit.rb
+- lib/seowebchecker_seoaudit/auditor.rb
+- lib/seowebchecker_seoaudit/version.rb
+homepage: https://seowebchecker.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://seowebchecker.com
+  source_code_uri: https://github.com/jaiganesh6999/seowebchecker-seoaudit-sdk
+  changelog_uri: https://github.com/jaiganesh6999/seowebchecker-seoaudit-sdk/releases
+  bug_tracker_uri: https://github.com/jaiganesh6999/seowebchecker-seoaudit-sdk/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Lightweight open-source client SDK and CLI tool for full website SEO audits
+  by SEOWebChecker.
+test_files: []