indexboost-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a12049408abec0e580ce7986070fb0eb9c2cd1f0afe9ef7b2f83ebf4401907c9
+  data.tar.gz: aa39809870273dc0d846872f186b417a9a43e5b763c2e5984acd3db1e0e8dbdf
+SHA512:
+  metadata.gz: 28603508bbd4942417a9a8c1aead80240f9dbf354c73bfdc57ba902d00779a6f49cbb6a403ec79c0b5b1fa45d7532a9a338ca7d9da5503538f0c483bd47a690c
+  data.tar.gz: 8cd4d44057088b3a4bf015b8753c1f0f910009e0e596ed3f77e54e730a5275b67d91bddf24217cebbb8b1490195e9cbe0ad9c48b1ca93343760275b1a74698f4

data/README.md

@@ -0,0 +1,54 @@
+# indexboost-rails
+
+IndexBoost Render Rack middleware for **Ruby on Rails** and any Rack-compatible framework.
+
+## Installation
+
+```ruby
+# Gemfile
+gem "indexboost-rails"
+```
+
+```bash
+bundle install
+```
+
+## Setup
+
+```ruby
+# config/application.rb
+require "indexboost-rails"
+
+module MyApp
+  class Application < Rails::Application
+    config.middleware.insert_before 0, IndexBoost::Middleware,
+      token: ENV.fetch("INDEXBOOST_TOKEN")
+  end
+end
+```
+
+```bash
+# .env
+INDEXBOOST_TOKEN=your_token_here
+```
+
+## Options
+
+| Option | Default | Description |
+|---|---|---|
+| `token` | **required** | Render token from app.getindexboost.com |
+| `service_url` | `https://render.getindexboost.com` | Override render URL |
+| `timeout` | `30` | HTTP timeout in seconds |
+| `ignored_paths` | `[/^\/api\//, /^\/rails\//]` | Array of Regexp to skip |
+
+## Sinatra / plain Rack
+
+```ruby
+require "indexboost-rails"
+
+use IndexBoost::Middleware, token: ENV.fetch("INDEXBOOST_TOKEN")
+```
+
+## License
+
+MIT

data/indexboost-rails.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name        = "indexboost-rails"
+  spec.version = "1.0.0"
+  spec.authors     = ["IndexBoost"]
+  spec.email       = ["support@getindexboost.com"]
+  spec.summary     = "IndexBoost Render middleware for Ruby on Rails"
+  spec.description = "Rack middleware that intercepts crawler requests and serves rendered HTML from render.getindexboost.com."
+  spec.homepage    = "https://getindexboost.com/docs/integrations/rails"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = ">= 3.1"
+  spec.files = Dir["lib/**/*", "README.md", "*.gemspec"]
+
+  spec.add_dependency "rack", ">= 2.0"
+
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "minitest"
+end

data/lib/indexboost/middleware.rb

@@ -0,0 +1,95 @@
+require "net/http"
+require "uri"
+
+module IndexBoost
+  # Rack middleware that intercepts crawler requests and serves rendered
+  # HTML from the IndexBoost render service.
+  #
+  # Usage in config/application.rb:
+  #
+  #   config.middleware.insert_before 0, IndexBoost::Middleware,
+  #     token: ENV.fetch("INDEXBOOST_TOKEN")
+  #
+  class Middleware
+    CRAWLERS = /googlebot|bingbot|gptbot|claudebot|perplexitybot|duckduckbot|
+                slurp|naverbot|yandexbot|baiduspider|facebookexternalhit|
+                twitterbot|linkedinbot|whatsapp|telegrambot|applebot|rogerbot|
+                semrushbot|ahrefsbot|bytespider|dotbot|mj12bot|pinterestbot/ix
+
+    STATIC_EXTENSIONS = /\.(js|css|png|jpg|jpeg|gif|webp|svg|ico|woff|woff2|
+                          ttf|eot|otf|pdf|zip|xml|map|txt|json|csv|gz|br)$/ix
+
+    DEFAULT_SERVICE_URL = "https://render.getindexboost.com"
+
+    # @param app   [#call]  The next Rack app
+    # @param token [String] IndexBoost render token (required)
+    # @option options [String]  :service_url  Override render URL
+    # @option options [Integer] :timeout      HTTP timeout in seconds (default 30)
+    # @option options [Array]   :ignored_paths Array of Regexp to skip
+    def initialize(app, token:, **options)
+      raise ArgumentError, "[IndexBoost] token is required" if token.nil? || token.empty?
+
+      @app            = app
+      @token          = token
+      @service_url    = options.fetch(:service_url, DEFAULT_SERVICE_URL).chomp("/")
+      @timeout        = options.fetch(:timeout, 30)
+      @ignored_paths  = options.fetch(:ignored_paths, [%r{^/api/}, %r{^/rails/}])
+    end
+
+    def call(env)
+      return @app.call(env) unless should_render?(env)
+
+      html = fetch_rendered(env)
+      return @app.call(env) if html.nil?
+
+      [
+        200,
+        {
+          "Content-Type"          => "text/html; charset=utf-8",
+          "X-IndexBoost-Rendered" => "true",
+          "Cache-Control"         => "public, max-age=3600",
+        },
+        [html],
+      ]
+    end
+
+    private
+
+    def should_render?(env)
+      return false unless env["REQUEST_METHOD"] == "GET"
+
+      path = env["PATH_INFO"].to_s
+      return false if STATIC_EXTENSIONS.match?(path)
+
+      @ignored_paths.each { |p| return false if p.match?(path) }
+
+      ua = env["HTTP_USER_AGENT"].to_s
+      CRAWLERS.match?(ua)
+    end
+
+    def fetch_rendered(env)
+      scheme   = env["rack.url_scheme"] || "https"
+      host     = env["HTTP_HOST"] || env["SERVER_NAME"]
+      path     = env["REQUEST_URI"] || env["PATH_INFO"]
+      full_url = "#{scheme}://#{host}#{path}"
+
+      render_uri = URI("#{@service_url}/?url=#{URI.encode_uri_component(full_url)}")
+
+      request = Net::HTTP::Get.new(render_uri)
+      request["X-INDEXBOOST-TOKEN"]        = @token
+      request["X-Original-User-Agent"]   = env["HTTP_USER_AGENT"].to_s
+
+      http = Net::HTTP.new(render_uri.host, render_uri.port)
+      http.use_ssl     = render_uri.scheme == "https"
+      http.read_timeout = @timeout
+      http.open_timeout = 10
+
+      response = http.request(request)
+      return nil unless response.is_a?(Net::HTTPSuccess)
+
+      response.body
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/indexboost-rails.rb

@@ -0,0 +1,5 @@
+require "indexboost/middleware"
+
+module IndexBoost
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: indexboost-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- IndexBoost
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware that intercepts crawler requests and serves rendered
+  HTML from render.getindexboost.com.
+email:
+- support@getindexboost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- indexboost-rails.gemspec
+- lib/indexboost-rails.rb
+- lib/indexboost/middleware.rb
+homepage: https://getindexboost.com/docs/integrations/rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: IndexBoost Render middleware for Ruby on Rails
+test_files: []