og_pilot_ruby 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c13264ba768430bb4aba5a662b4957fe73c01a87ac5ba953897b35335686ab3
-  data.tar.gz: 699f6f44f60db4eb9afb36a1eb17e6be4d3c80d8acabe0868140be522866d700
+  metadata.gz: 7dfbdfc6efc8c0fc36a6b92c6b99af56c0e0ef3b3831d7b91b8e56056b09dd16
+  data.tar.gz: 4fe12f91a949bd6117a915b48b88df8d25fda2d9665a5bba1d78533557cad202
 SHA512:
-  metadata.gz: dd5ab6d159c8a38f0e1d89742e0112bdc258f3b16f1a770ac5427d0524a1082db68b92658b8be5666f43642092dbfb2a19b5e655b913c1ab29900c41bd229288
-  data.tar.gz: fdf1e6bb75fef728a3422f6ce47326744c8b8052ec53723df1cfe19a32ba6b140b433096f3f55858ed13a1b28bd69471e81db0da6b725410084f8dc09766f363
+  metadata.gz: 6cb305db104f09b0fb0cfc430f8fd1fdc276d02d048e4f4936bde4ba5273569568e351e5fdafe9287bb33fc9f9ba5d94279c38f161ebb4f1a36a87aa56a331c0
+  data.tar.gz: e144441605b592d95c672242cb90813c1056dc498fd045a10ee0882dfa157a30600585f11effa2fb976983189e14a53170888a3323c8f4cc3198f458c96a6ca8

data/README.md

@@ -61,6 +61,15 @@ image_url = OgPilotRuby.create_image(
 If you omit `iat`, OG Pilot will cache the image indefinitely. Provide an `iat` to
 refresh the cache daily.
 
+### Fail-safe behavior
+
+`create_image` is non-blocking. If any error occurs (request, configuration,
+validation, parsing, etc.), the gem does not raise to your app and logs an
+error-level message instead.
+
+- URL mode (`json: false`, default): returns `nil`
+- JSON mode (`json: true`): returns `{ "image_url" => nil }`
+
 ### Template helpers
 
 `create_image` defaults to the `page` template when `template` is omitted.
@@ -119,7 +128,7 @@ The gem handles `iss` (domain) and `sub` (API key prefix) automatically.
 
 | Option    | Default | Description                                                              |
 |-----------|---------|--------------------------------------------------------------------------|
-| `json`    | `false` | When `true`, sends `Accept: application/json` and parses the JSON response |
+| `json`    | `false` | When `true`, sends `Accept: application/json` and parses the JSON response. On failure, returns `{ "image_url" => nil }` |
 | `headers` | —       | Additional HTTP headers to include with the request                      |
 | `default` | `false` | Forces `path` to `/` when `true`, unless a manual `path` is provided (see [Path handling](#path-handling)) |
 
@@ -173,7 +182,7 @@ Fetch JSON metadata instead:
 ```ruby
 payload = {
   template: "page",
-  title: "Hello OG Pilot"q
+  title: "Hello OG Pilot"
 }
 
 data = OgPilotRuby.create_image(**payload, json: true)
@@ -190,7 +199,7 @@ 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|›
+OgPilotRuby.configure do |config|
   config.strip_extensions = true
 end
 

data/lib/og_pilot_ruby/client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "logger"
 require "net/http"
 require "uri"
 
@@ -10,6 +11,7 @@ require_relative "jwt_encoder"
 module OgPilotRuby
   class Client
     ENDPOINT_PATH = "/api/v1/images"
+    MAX_REDIRECTS = 5
 
     def initialize(config)
       @config = config
@@ -24,31 +26,67 @@ module OgPilotRuby
       params[:path] = manual_path.to_s.strip.empty? ? resolved_path(default:) : normalize_path(manual_path)
 
       uri = build_uri(params, iat:)
-      response = request(uri, json:, headers:)
+      response, final_uri = request(uri, json:, headers:)
 
       if json
         JSON.parse(response.body)
       else
-        response["Location"] || uri.to_s
+        response["Location"] || final_uri.to_s
       end
+    rescue StandardError => e
+      log_create_image_failure(e, json:)
+      json ? { "image_url" => nil } : nil
     end
 
     private
 
       attr_reader :config
 
-      def request(uri, json:, headers:)
+      def log_create_image_failure(error, json:)
+        mode = json ? "json" : "url"
+        message = "OgPilotRuby create_image failed (mode=#{mode}): #{error.class}: #{error.message}"
+        create_image_logger&.error(message)
+      rescue StandardError
+        nil
+      end
+
+      def create_image_logger
+        if defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+          ::Rails.logger
+        else
+          @create_image_logger ||= Logger.new($stderr)
+        end
+      end
+
+      def request(uri, json:, headers:, method: :post, redirects_left: MAX_REDIRECTS)
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = uri.scheme == "https"
         http.open_timeout = config.open_timeout if config.open_timeout
         http.read_timeout = config.read_timeout if config.read_timeout
 
-        request = Net::HTTP::Post.new(uri)
+        request = build_http_request(method, uri)
         request["Accept"] = "application/json" if json
         headers.each { |key, value| request[key] = value }
 
         response = http.request(request)
-        return response unless response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
+        if response.is_a?(Net::HTTPRedirection)
+          location = response["Location"]
+          if location && !location.empty?
+            raise OgPilotRuby::RequestError, "OG Pilot request failed with too many redirects" if redirects_left <= 0
+
+            redirect_uri = URI.join(uri.to_s, location)
+            redirect_method = redirect_method_for(response, method)
+            return request(
+              redirect_uri,
+              json:,
+              headers:,
+              method: redirect_method,
+              redirects_left: redirects_left - 1
+            )
+          end
+        end
+
+        return [response, uri] unless response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
 
         raise OgPilotRuby::RequestError, "OG Pilot request failed with status #{response.code}: #{response.body}"
       rescue OpenSSL::SSL::SSLError => e
@@ -63,6 +101,24 @@ module OgPilotRuby
         raise OgPilotRuby::RequestError, "OG Pilot request failed with unauthorized: #{e.message}"
       end
 
+      def build_http_request(method, uri)
+        case method
+        when :post
+          Net::HTTP::Post.new(uri)
+        when :get
+          Net::HTTP::Get.new(uri)
+        else
+          raise ArgumentError, "Unsupported HTTP method: #{method.inspect}"
+        end
+      end
+
+      def redirect_method_for(response, current_method)
+        return current_method unless current_method == :post
+
+        status_code = response.code.to_i
+        [307, 308].include?(status_code) ? :post : :get
+      end
+
       def build_uri(params, iat:)
         payload = build_payload(params, iat:)
         token = OgPilotRuby::JwtEncoder.encode(payload, api_key!)

data/lib/og_pilot_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: og_pilot_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 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: 3.6.7
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby client for the OG Pilot Open Graph image generator.
 test_files: []