og_pilot_ruby 0.4.4 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367bb4f8ea0c4a82c261f4403a42ae5bbf2afa25069bad87250c884ca343526b
-  data.tar.gz: 753f95ace14cc5d6b1895a286174810457837ba9e7b0fdb2dcb646bfa9f8ea78
+  metadata.gz: cfefae49c597192416e12b3ce37cbeb6c9a96978cd0117544cab4ed3d334d754
+  data.tar.gz: 1ad8da7a1af0b52c0a039fce941d5e35c0718317586fbe694b537886c6e7e14d
 SHA512:
-  metadata.gz: ec298c3d0d781c259aece2d385f1f53a0e26633295b0bc8b1624ab85123a6cb5840a0b4f81a4e303940c425b618d270b8f504e19cb7654466046c11dbbda666b
-  data.tar.gz: 29008c57e899486428e21c2395e0f3cdfc2010d1bc533cd93102e0ba17a41cabc96c94295bf4b3a46247ebe8a6ff5e183a7981e6c8d540406cbea3e22e29eb9f
+  metadata.gz: 3c43d41211ef1bbe5685565ce341adea1c9e56b8007e322c37a7561ee5b068ba944176826a7455546ec6580b53b3a8b3f640064ad30dada66a25df1035230f1a
+  data.tar.gz: 8967f05bb0129386f0b8397f401918ccecc54127a6f939066615a960fa98433e3863579bfc59b926373631b0d0513624c8fff68a3715c8fff0192d464a8b5f90

data/README.md

@@ -566,6 +566,7 @@ The gem handles `iss` (domain) and `sub` (API key prefix) automatically.
 | `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)) |
+| `strip_query_parameters` | `false`           | When `true`, query strings are removed from resolved paths before signing (see [Strip query parameters](#strip-query-parameters)) |
 | `cache_store`      | `nil`                   | Optional cache backend with `read`/`write` (for example `Rails.cache`)  |
 | `cache_ttl`        | `86400`                 | Cache TTL in seconds when `cache_store` is enabled                       |
 
@@ -679,6 +680,30 @@ OgPilotRuby.create_image(title: "Docs", path: "/docs.php")
 # Dotfiles are unchanged: /.hidden stays /.hidden
 ```
 
+### Strip query parameters
+
+When `strip_query_parameters` is enabled, the client drops the query string from
+every resolved path before it signs the payload, so `/docs?ref=main` and
+`/docs?ref=next` are normalized to `"/docs"`. When both `strip_extensions` and
+`strip_query_parameters` are enabled, the extension is removed first and the
+query string is removed afterward, which means `/archive.tar.gz?ref=campaign`
+becomes `"/archive"`.
+
+```ruby
+OgPilotRuby.configure do |config|
+  config.strip_query_parameters = true
+  config.strip_extensions = true
+end
+
+# These resolve to "/docs":
+OgPilotRuby.create_image(title: "Docs", path: "/docs")
+OgPilotRuby.create_image(title: "Docs", path: "/docs?ref=main")
+
+# Both of these resolve to "/archive":
+OgPilotRuby.create_image(title: "Archive", path: "/archive.tar.gz")
+OgPilotRuby.create_image(title: "Archive", path: "/archive.tar.gz?ref=campaign")
+```
+
 ## Development
 
 Run tests with:

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

@@ -9,4 +9,5 @@ OgPilotRuby.configure do |config|
   # config.open_timeout = 5
   # config.read_timeout = 10
   # config.strip_extensions = true
+  # config.strip_query_parameters = true
 end

data/lib/og_pilot_ruby/client.rb

@@ -253,6 +253,7 @@ module OgPilotRuby
         cleaned = extract_request_uri(cleaned)
         cleaned = "/#{cleaned}" unless cleaned.start_with?("/")
         cleaned = strip_extension(cleaned) if config.strip_extensions
+        cleaned = remove_query_parameters(cleaned) if config.strip_query_parameters
         cleaned
       end
 
@@ -278,6 +279,11 @@ module OgPilotRuby
         query ? "#{stripped}?#{query}" : stripped
       end
 
+      def remove_query_parameters(path)
+        stripped = path.split("?", 2).first
+        stripped.empty? ? "/" : 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, :strip_extensions, :cache_store, :cache_ttl
+    attr_accessor :api_key, :domain, :base_url, :open_timeout, :read_timeout, :strip_extensions, :strip_query_parameters, :cache_store, :cache_ttl
 
     def initialize
       @api_key = ENV.fetch("OG_PILOT_API_KEY", nil)
@@ -14,6 +14,7 @@ module OgPilotRuby
       @open_timeout = 5
       @read_timeout = 10
       @strip_extensions = true
+      @strip_query_parameters = false
       @cache_store = nil
       @cache_ttl = 86400
     end

data/lib/og_pilot_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: og_pilot_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.6
 platform: ruby
 authors:
 - Sunergos IT LLC
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby client for the OG Pilot Open Graph image generator.
 test_files: []