og_pilot_ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3a7a8cb4b3b8346a2fc20b5f2fff70122dfc7fefb95513a196c8408aeec566c
-  data.tar.gz: 7c2f0a25126d3c5c03c4471d3a6c7f1dc76012b9187074bbb0caa2381361bdc0
+  metadata.gz: 9624035f48941775c8b1e55637f9d20e6c65a10ffdcfe983ab47ef2ae53dae5d
+  data.tar.gz: 4889190ff785ff95df863f3e320fa17c04f08e1ae2f9772ffa405922440ec58f
 SHA512:
-  metadata.gz: 51438c44674e1cf92fc0e4d1ea75ea932a98f2ad9a68ec02d13b71edc89d02a53cf7eaf07a2d8a4e433a7fc3efaa43400943f989401f67d9a23e5f514b2148b9
-  data.tar.gz: cfed717cb42d3a00eecdbe1d745559d2ecbacd25296753ca7c82594e2c765ac299441a37705daf027dec9c920a41bed18ceaf60c3ab7ea53352a0d36d4794ed0
+  metadata.gz: 8e43e439eea7e9a8684c77cbc591a94dabc41b40b4096b8ea06eba2a8a73cb680868f362360ede49242285e94902b0258439bf40c47ae5ca91206098c74eb6b6
+  data.tar.gz: 5b966815886946cf1af21c2028a1e9a0721a8c820df34557e8bdd047fc457fe7650b8b4848a5438ecf56dbb8cb0653519bdcf6b8a2999800ab29e9f4f2071a99

data/README.md

@@ -28,6 +28,7 @@ Override as needed:
 OgPilotRuby.configure do |config|
   config.api_key = ENV.fetch("OG_PILOT_API_KEY")
   config.domain = ENV.fetch("OG_PILOT_DOMAIN")
+  # config.strip_extensions = true
 end
 ```
 
@@ -103,6 +104,17 @@ The gem handles `iss` (domain) and `sub` (API key prefix) automatically.
 | `iat`         | No       | —        | Issued-at timestamp for daily cache busting                   |
 | `path`        | No       | auto-set | Request path for image rendering context. When provided, it overrides auto-resolution (see [Path handling](#path-handling)) |
 
+### Configuration options
+
+| Option             | Default                 | Description                                                              |
+|--------------------|-------------------------|--------------------------------------------------------------------------|
+| `api_key`          | `ENV["OG_PILOT_API_KEY"]` | Your OG Pilot API key                                                   |
+| `domain`           | `ENV["OG_PILOT_DOMAIN"]`  | Your domain registered with OG Pilot                                    |
+| `base_url`         | `https://ogpilot.com`   | OG Pilot API base URL                                                    |
+| `open_timeout`     | `5`                     | Connection timeout in seconds                                            |
+| `read_timeout`     | `10`                    | Read timeout in seconds                                                  |
+| `strip_extensions` | `true`                  | When `true`, file extensions are stripped from resolved paths (see [Strip extensions](#strip-extensions)) |
+
 ### Ruby options
 
 | Option    | Default | Description                                                              |
@@ -161,12 +173,37 @@ Fetch JSON metadata instead:
 ```ruby
 payload = {
   template: "page",
-  title: "Hello OG Pilot"
+  title: "Hello OG Pilot"q
 }
 
 data = OgPilotRuby.create_image(**payload, json: true)
 ```
 
+### Strip extensions
+
+When `strip_extensions` is enabled, the client removes file extensions from the
+last segment of every resolved path. This ensures that `/docs`, `/docs.md`,
+`/docs.php`, and `/docs.html` all resolve to `"/docs"`, so analytics are
+consolidated under a single path regardless of the URL extension.
+
+Multiple extensions are also stripped (`/archive.tar.gz` becomes `/archive`).
+Dotfiles like `/.hidden` are left unchanged. Query strings are preserved.
+
+```ruby
+OgPilotRuby.configure do |config|›
+  config.strip_extensions = true
+end
+
+# All of these resolve to path "/docs":
+OgPilotRuby.create_image(title: "Docs", path: "/docs")
+OgPilotRuby.create_image(title: "Docs", path: "/docs.md")
+OgPilotRuby.create_image(title: "Docs", path: "/docs.php")
+
+# Nested paths work too: /blog/my-post.html → /blog/my-post
+# Query strings are preserved: /docs.md?ref=main → /docs?ref=main
+# Dotfiles are unchanged: /.hidden stays /.hidden
+```
+
 ## Development
 
 Run tests with:

data/lib/generators/og_pilot_ruby/install/templates/initializer.rb

@@ -8,4 +8,5 @@ OgPilotRuby.configure do |config|
   # Optional overrides:
   # config.open_timeout = 5
   # config.read_timeout = 10
+  # config.strip_extensions = true
 end

data/lib/og_pilot_ruby/client.rb

@@ -166,9 +166,32 @@ module OgPilotRuby
 
         cleaned = extract_request_uri(cleaned)
         cleaned = "/#{cleaned}" unless cleaned.start_with?("/")
+        cleaned = strip_extension(cleaned) if config.strip_extensions
         cleaned
       end
 
+      def strip_extension(path)
+        path_part, query = path.split("?", 2)
+
+        dir = File.dirname(path_part)
+        base = File.basename(path_part)
+
+        # Don't strip dotfiles like "/.hidden" or "/.env" — only strip when
+        # there's a non-dot character before the first meaningful dot.
+        unless base.match?(/\A\./)  # starts with dot = hidden file, skip
+          base = base.sub(/\..+\z/, "")
+        end
+
+        stripped = if dir == "/" || dir == "."
+                     "/#{base}"
+                   else
+                     "#{dir}/#{base}"
+                   end
+        stripped = "/" if stripped.empty?
+
+        query ? "#{stripped}?#{query}" : stripped
+      end
+
       def extract_request_uri(value)
         return value unless value.start_with?("http://", "https://")
 

data/lib/og_pilot_ruby/configuration.rb

@@ -5,7 +5,7 @@ module OgPilotRuby
     DEFAULT_BASE_URL = "https://ogpilot.com"
     private_constant :DEFAULT_BASE_URL
 
-    attr_accessor :api_key, :domain, :base_url, :open_timeout, :read_timeout
+    attr_accessor :api_key, :domain, :base_url, :open_timeout, :read_timeout, :strip_extensions
 
     def initialize
       @api_key = ENV.fetch("OG_PILOT_API_KEY", nil)
@@ -13,6 +13,7 @@ module OgPilotRuby
       @base_url = DEFAULT_BASE_URL
       @open_timeout = 5
       @read_timeout = 10
+      @strip_extensions = true
     end
   end
 end

data/lib/og_pilot_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OgPilotRuby
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: og_pilot_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sunergos IT LLC