og_pilot_ruby 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee4898069ea1b40ff62e9db35ca4d5c726aaa27cf7b658c233c9f5f9bcc70bb2
-  data.tar.gz: 4c38cee9d0e4753208e3b65c37c4b33a6b478fa1b34c9fd16cd98aca56836c56
+  metadata.gz: 7378c97e45ba7c02d8f8895b53614583443c0d393d56e0c8f4267941a65012d1
+  data.tar.gz: ec37c266916a73ce5610d7a9a74137bd1771dddf9f368db910c2d8f36880a1e9
 SHA512:
-  metadata.gz: 2c1772c79ca7847a027611e42869888017b53e2e829a1262c519fb708d7e30e9fd4bce3bb0eb1ccc997c022a250b314ceadc88d3db5bcdb6c415c6aa23d5a177
-  data.tar.gz: dced72f71149af6c1544bd11ff0803e10159d81e1f0039a58df025009e8527f7b4a1f4eca2bfe934d86e8d37f47a353bf9c6dfb1e32b4ba387d1ed8f4b01a66a
+  metadata.gz: b12fee2e4b63b2eb78942dfa301c7fdeaa44c205dacac2e505c05720370be0ca33da85ddcad5af19d64c9accca72098bc17942bb581ecc6492e14ca06d064fa1
+  data.tar.gz: ceb27ff2523496441e15247740db9dbb446fe59aebfe242f3f81b127e033bb66b57e0f774a9e7f3d549c000c8066d3ea1f509267ce3ed9bdf2d0d10a4eb96784

data/README.md

@@ -683,20 +683,25 @@ OgPilotRuby.create_image(title: "Docs", path: "/docs.php")
 ### Strip query parameters
 
 When `strip_query_parameters` is enabled, the client drops the query string from
-every resolved path before it signs the payload. This keeps analytics grouped
-under the canonical path even when links include tracking or pagination
-parameters. It works alongside `strip_extensions`, so
-`/archive.tar.gz?ref=campaign` resolves to `"/archive"` when both are enabled.
+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")
-OgPilotRuby.create_image(title: "Docs", path: "https://example.com/docs?ref=campaign")
+
+# 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

data/lib/og_pilot_ruby/client.rb

@@ -38,7 +38,8 @@ module OgPilotRuby
       result = if json
         JSON.parse(response.body)
       else
-        response["Location"] || final_uri.to_s
+        url = response["Location"] || final_uri.to_s
+        status_placeholder?(url) ? nil : url
       end
 
       write_cached(cache_key, result, iat:) if config.cache_store && cache_key && result
@@ -102,6 +103,11 @@ module OgPilotRuby
         if response.is_a?(Net::HTTPRedirection)
           location = response["Location"]
           if location && !location.empty?
+            # Status placeholders (processing/failed) mean the image isn't ready yet.
+            # Return the redirect response as-is so the caller can detect this and
+            # avoid caching a temporary placeholder URL.
+            return [response, URI.join(uri.to_s, location)] if status_placeholder?(location)
+
             raise OgPilotRuby::RequestError, "OG Pilot request failed with too many redirects" if redirects_left <= 0
 
             redirect_uri = URI.join(uri.to_s, location)
@@ -131,6 +137,10 @@ module OgPilotRuby
         raise OgPilotRuby::RequestError, "OG Pilot request failed with unauthorized: #{e.message}"
       end
 
+      def status_placeholder?(url)
+        url.to_s.match?(%r{/status/(?:processing|failed)\.(?:jpg|png)\z})
+      end
+
       def build_http_request(method, uri)
         case method
         when :post

data/lib/og_pilot_ruby/version.rb

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

metadata

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