og_pilot_ruby 0.4.6 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfefae49c597192416e12b3ce37cbeb6c9a96978cd0117544cab4ed3d334d754
-  data.tar.gz: 1ad8da7a1af0b52c0a039fce941d5e35c0718317586fbe694b537886c6e7e14d
+  metadata.gz: 7337416e1651ceadf68ca9eba08b8a4a4945d62f30154391006b2dd11cd7e892
+  data.tar.gz: ebd7c609da7e75151f6f06741b82a19d244ca3953e7f563f496f7f268c3ec5cb
 SHA512:
-  metadata.gz: 3c43d41211ef1bbe5685565ce341adea1c9e56b8007e322c37a7561ee5b068ba944176826a7455546ec6580b53b3a8b3f640064ad30dada66a25df1035230f1a
-  data.tar.gz: 8967f05bb0129386f0b8397f401918ccecc54127a6f939066615a960fa98433e3863579bfc59b926373631b0d0513624c8fff68a3715c8fff0192d464a8b5f90
+  metadata.gz: 06fcd6974ee8842cff3cb77747cb0c8a011207aecc5d0fced3f92ea049fd6109343d0bb9395fbe8798267a681b79a1d72dded42935c75e05c8e99b1d443c747f
+  data.tar.gz: 198f785e8486ebad307f5ca1f4c70d4743362e526bb9ff5978d65ad30a8878677f498f2c120317491319cf67183ffbffee0092432cfee65b359731e316e947dc

data/README.md

@@ -29,6 +29,9 @@ OgPilotRuby.configure do |config|
   config.api_key = ENV.fetch("OG_PILOT_API_KEY")
   config.domain = ENV.fetch("OG_PILOT_DOMAIN")
   # config.strip_extensions = true
+  # config.image_type = "webp"
+  # config.quality = 82
+  # config.max_bytes = 220_000
   # config.cache_store = Rails.cache
   # config.cache_ttl = 86_400
 end
@@ -63,6 +66,19 @@ image_url = OgPilotRuby.create_image(
 If you omit `iat`, OG Pilot will cache the image indefinitely. Provide an `iat` to
 refresh the cache daily.
 
+For the same delivery settings on every request, configure them once:
+
+```ruby
+OgPilotRuby.configure do |config|
+  config.image_type = "webp"
+  config.quality = 82
+  config.max_bytes = 220_000
+end
+```
+
+Per-call `image_type`, `quality`, and `max_bytes` values still override those
+defaults when you need a one-off delivery profile.
+
 When `config.cache_store` is set, the client can also cache generated responses
 locally:
 
@@ -553,6 +569,9 @@ The gem handles `iss` (domain) and `sub` (API key prefix) automatically.
 | `image_url`   | No       | —        | Hero image URL                                                |
 | `bg_color`    | No       | —        | Background color (hex format)                                 |
 | `text_color`  | No       | —        | Text color (hex format)                                       |
+| `image_type`  | No       | —        | Delivered image format: `jpeg`, `png`, `webp`, or `gif`       |
+| `quality`     | No       | —        | Delivered image quality from `1` to `100`                     |
+| `max_bytes`   | No       | —        | Maximum delivered image size in bytes                         |
 | `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)) |
 
@@ -567,6 +586,9 @@ The gem handles `iss` (domain) and `sub` (API key prefix) automatically.
 | `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)) |
+| `image_type`       | `nil`                   | Default delivered image format: `jpeg`, `png`, `webp`, or `gif`          |
+| `quality`          | `nil`                   | Default delivered image quality from `1` to `100`                        |
+| `max_bytes`        | `nil`                   | Default maximum delivered image size in bytes                            |
 | `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                       |
 

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

@@ -10,4 +10,7 @@ OgPilotRuby.configure do |config|
   # config.read_timeout = 10
   # config.strip_extensions = true
   # config.strip_query_parameters = true
+  # config.image_type = "webp"
+  # config.quality = 82
+  # config.max_bytes = 220_000
 end

data/lib/og_pilot_ruby/client.rb

@@ -20,7 +20,7 @@ module OgPilotRuby
 
     def create_image(params = {}, json: false, iat: nil, headers: {}, default: false)
       params ||= {}
-      params = params.dup
+      params = apply_configured_image_defaults(params.dup)
       # Always include a path; manual overrides win, otherwise resolve from the current request.
       manual_path = params.key?(:path) ? params[:path] : params["path"]
       params.delete("path") if params.key?("path")
@@ -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
@@ -168,6 +178,21 @@ module OgPilotRuby
         symbolized
       end
 
+      def apply_configured_image_defaults(params)
+        {
+          image_type: config.image_type,
+          quality: config.quality,
+          max_bytes: config.max_bytes
+        }.each do |key, value|
+          next if value.nil?
+          next if params.key?(key) || params.key?(key.to_s)
+
+          params[key] = value
+        end
+
+        params
+      end
+
       def validate_payload!(payload)
         raise OgPilotRuby::ConfigurationError, "OG Pilot domain is missing" if payload[:iss].nil? || payload[:iss].empty?
         raise OgPilotRuby::ConfigurationError, "OG Pilot API key prefix is missing" if payload[:sub].nil? || payload[:sub].empty?

data/lib/og_pilot_ruby/configuration.rb

@@ -5,7 +5,9 @@ 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, :strip_query_parameters, :cache_store, :cache_ttl
+    attr_accessor :api_key, :domain, :base_url, :open_timeout, :read_timeout,
+                  :strip_extensions, :strip_query_parameters, :image_type,
+                  :quality, :max_bytes, :cache_store, :cache_ttl
 
     def initialize
       @api_key = ENV.fetch("OG_PILOT_API_KEY", nil)
@@ -15,6 +17,9 @@ module OgPilotRuby
       @read_timeout = 10
       @strip_extensions = true
       @strip_query_parameters = false
+      @image_type = nil
+      @quality = nil
+      @max_bytes = nil
       @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.6"
+  VERSION = "0.4.8"
 end

data/lib/og_pilot_ruby.rb

@@ -59,6 +59,9 @@ module OgPilotRuby
     #   image_url   - String hero image URL.
     #   bg_color    - String background color (hex format).
     #   text_color  - String text color (hex format).
+    #   image_type  - String delivered image format (jpeg/png/webp/gif).
+    #   quality     - Integer delivered image quality (1-100).
+    #   max_bytes   - Integer maximum delivered image size in bytes.
     #   path        - String request path for analytics context.
     #
     # == Request options

metadata

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