marlens-jira-api 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d03091de06691a2493443796b27c4c7205067ba92eb3503cdf0ccb2771b86a6
-  data.tar.gz: 0f1c94a08e018b97a171a25a888baabebb301a9427f9f6eccc915e8b222fad7a
+  metadata.gz: 89d099771b89c4a51659eaca4c4242d7102762ec507e4d80265ce2e1612d756c
+  data.tar.gz: 93682e74950ac69b58316049b1251f61eb6f1a8eed75d7d14695585da4ad45d9
 SHA512:
-  metadata.gz: a47ff4083694ad1406d0248b4ac86afead42c425464c2cfeb0fb61f9d344aed3c8a78172fae723095d02f09ea0cdc9343cfac0d9394388cfa490a646449900bc
-  data.tar.gz: 51e132f5fa0b5f3e59fb6ebb35c37d8fd9ec468bab881dbca2fb7bc191cd210a9adc1055ac9173fc1200ab27b05ec49824c1468a9786414a7db6e64b2f8e8c2d
+  metadata.gz: 20e4b6ecd4f692d4c9b699f1ed4d0a3fe2f3ae5be5de2bb7970c540efacdbd08ec45a9dd9384184fb38300b23d5ac07dd0adec482eb93025ec9f8d8d6e28ecfb
+  data.tar.gz: ad230b1e8235738fecc90762794c5e8ca2fd07f62fa3d551c2f47eca630177676c3d04e5af53e7d5f699f6ce1ce9ff511971b037cef1e01c663b21a08f2ae98c

data/README.md

@@ -50,6 +50,8 @@ jira-comment delete --issue-key WRAPX-123 --comment-id 10001
 
 Remote Markdown image URLs are advanced opt-in behavior. Pass `allowed_image_hosts:` in Ruby or repeat `--image-host` in the CLI only when you intentionally want the gem to fetch images from trusted hosts, upload them to Jira, and convert them into Jira media attachments.
 
+Ruby callers that need to detect degraded images can pass an array via `image_upload_failures:`. Add `strict_images: true` in Ruby or `--strict-images` in the CLI to raise `Marlens::JiraApi::ImageUploadError` instead of falling back to `Alt text: URL` when an image cannot be fetched or uploaded.
+
 ## Feature and Issue Workflow
 
 Preferred flow for issue and feature work:
@@ -61,4 +63,6 @@ Preferred flow for issue and feature work:
 5. Open a draft PR, link the issue, include the checks run, and mark it ready only after verification.
 6. Merge the PR to `main` so GitHub records the review path.
 7. After merge, build and publish the gem version to RubyGems with `gem build marlens-jira-api.gemspec` and `gem push marlens-jira-api-<version>.gem`.
-8. Verify RubyGems lists the released version with `gem list --remote marlens-jira-api --exact --all`, then run an install or CLI smoke check.
+8. Verify RubyGems lists the released version with `gem list --remote marlens-jira-api --exact --all`; if that output is stale, verify the specific version API at `https://rubygems.org/api/v2/rubygems/marlens-jira-api/versions/<version>.json`.
+9. Run an install or CLI smoke check against the published gem.
+10. Keep one-off smoke cleanup helpers in `tmp/`, delete them before committing, and do not turn cleanup-only scripts into product API.

data/lib/marlens/jira_api/cli.rb

@@ -37,14 +37,14 @@ module Marlens
 
         @out.puts JSON.pretty_generate(send(config.fetch(:action), options))
         0
-      rescue OptionParser::ParseError, KeyError => error
+      rescue OptionParser::ParseError, KeyError, ImageUploadError => error
         fail_with(error.message)
       end
 
       private
 
       def parse_options
-        options = { allowed_image_hosts: [] }
+        options = { allowed_image_hosts: [], strict_images: false }
         parser = OptionParser.new do |parser|
           parser.banner = "Usage: jira-comment [#{COMMANDS.keys.join("|")}] [options]"
           parser.on("--issue-key ISSUE", "Jira issue key") { |value| options[:issue_key] = value }
@@ -53,6 +53,9 @@ module Marlens
           parser.on("--image-host HOST", "Allowed remote image host; repeatable") do |value|
             options[:allowed_image_hosts] << value
           end
+          parser.on("--strict-images", "Fail create/update when a remote image cannot be uploaded") do
+            options[:strict_images] = true
+          end
         end
         parser.parse!(@argv)
         options
@@ -67,20 +70,28 @@ module Marlens
       end
 
       def create_comment(options)
-        client.create_markdown_comment(
+        image_upload_failures = []
+        result = client.create_markdown_comment(
           issue_key: options.fetch(:issue_key),
           markdown: File.read(options.fetch(:markdown_file)),
-          allowed_image_hosts: options.fetch(:allowed_image_hosts)
+          allowed_image_hosts: options.fetch(:allowed_image_hosts),
+          strict_images: options.fetch(:strict_images),
+          image_upload_failures: image_upload_failures
         )
+        result_with_image_failures(result, image_upload_failures)
       end
 
       def update_comment(options)
-        client.update_markdown_comment(
+        image_upload_failures = []
+        result = client.update_markdown_comment(
           issue_key: options.fetch(:issue_key),
           comment_id: options.fetch(:comment_id),
           markdown: File.read(options.fetch(:markdown_file)),
-          allowed_image_hosts: options.fetch(:allowed_image_hosts)
+          allowed_image_hosts: options.fetch(:allowed_image_hosts),
+          strict_images: options.fetch(:strict_images),
+          image_upload_failures: image_upload_failures
         )
+        result_with_image_failures(result, image_upload_failures)
       end
 
       def delete_comment(options)
@@ -88,6 +99,12 @@ module Marlens
         { deleted: true }
       end
 
+      def result_with_image_failures(result, image_upload_failures)
+        return result if image_upload_failures.empty?
+
+        result.merge("image_upload_failures" => image_upload_failures)
+      end
+
       def client
         @client ||= @client_factory.call(env: @env)
       end

data/lib/marlens/jira_api/client.rb

@@ -54,20 +54,24 @@ module Marlens
         raise "Failed to delete Jira comment #{comment_id} for #{issue_key}: #{response.code} #{response.body}"
       end
 
-      def create_markdown_comment(issue_key:, markdown:, allowed_image_hosts: [])
+      def create_markdown_comment(issue_key:, markdown:, allowed_image_hosts: [], strict_images: false, image_upload_failures: nil)
         document = markdown_document(
           issue_key: issue_key,
           markdown: markdown,
-          allowed_image_hosts: allowed_image_hosts
+          allowed_image_hosts: allowed_image_hosts,
+          strict_images: strict_images,
+          image_upload_failures: image_upload_failures
         )
         create_comment(issue_key: issue_key, document: document)
       end
 
-      def update_markdown_comment(issue_key:, comment_id:, markdown:, allowed_image_hosts: [])
+      def update_markdown_comment(issue_key:, comment_id:, markdown:, allowed_image_hosts: [], strict_images: false, image_upload_failures: nil)
         document = markdown_document(
           issue_key: issue_key,
           markdown: markdown,
-          allowed_image_hosts: allowed_image_hosts
+          allowed_image_hosts: allowed_image_hosts,
+          strict_images: strict_images,
+          image_upload_failures: image_upload_failures
         )
         update_comment(issue_key: issue_key, comment_id: comment_id, document: document)
       end
@@ -94,11 +98,13 @@ module Marlens
 
       private
 
-      def markdown_document(issue_key:, markdown:, allowed_image_hosts:)
+      def markdown_document(issue_key:, markdown:, allowed_image_hosts:, strict_images:, image_upload_failures:)
         image_uploader = RemoteImageAttachmentUploader.new(
           client: self,
           issue_key: issue_key,
-          allowed_hosts: allowed_image_hosts
+          allowed_hosts: allowed_image_hosts,
+          strict: strict_images,
+          failures: image_upload_failures
         )
         MarkdownToAdf.call(markdown) do |image|
           image_uploader.media_node_for(image)

data/lib/marlens/jira_api/remote_image_attachment_uploader.rb

@@ -7,13 +7,24 @@ require "uri"
 
 module Marlens
   module JiraApi
+    class ImageUploadError < StandardError
+      attr_reader :failure
+
+      def initialize(failure)
+        @failure = failure
+        super("Failed to upload image #{failure.fetch(:url)}: #{failure.fetch(:error_class)}: #{failure.fetch(:error_message)}")
+      end
+    end
+
     class RemoteImageAttachmentUploader
       MAX_REDIRECTS = 5
 
-      def initialize(client:, issue_key:, allowed_hosts:)
+      def initialize(client:, issue_key:, allowed_hosts:, strict: false, failures: nil)
         @allowed_hosts = allowed_hosts
         @client = client
+        @failures = failures
         @issue_key = issue_key
+        @strict = strict
       end
 
       def media_node_for(image)
@@ -27,6 +38,10 @@ module Marlens
           height: image_dimension_value(image[:height], dimensions.fetch("height"))
         )
       rescue StandardError => error
+        failure = { url: image[:url], alt: image[:alt], error_class: error.class.name, error_message: error.message }
+        @failures << failure if @failures
+        raise ImageUploadError.new(failure) if @strict
+
         warn "Failed to upload image #{image[:url]}: #{error.class}: #{error.message}"
         MarkdownToAdf.paragraph("#{image[:alt] || "Image"}: #{image[:url]}")
       end

data/lib/marlens/jira_api/version.rb

@@ -2,6 +2,6 @@
 
 module Marlens
   module JiraApi
-    VERSION = "0.5.1"
+    VERSION = "0.5.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marlens-jira-api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Marlen Brunner