How to download JIRA attachments with jira-ruby gem in Rails?

Other Questions Jira
1

Hey everyone,

I’m working on a Rails project and using the jira-ruby gem to interact with JIRA. I’m wondering if there’s a way to save attachment files from JIRA issues using this gem.

Specifically, I’m looking at the /rest/api/2/attachment/content/<ATTACHMENT_ID> endpoint. Is there a method in the gem, maybe something like .get, that I can use to download these attachments?

I’ve been digging through the documentation, but I’m not sure if I’m missing something obvious. Has anyone done this before or know if it’s even possible with jira-ruby?

Any tips or code examples would be super helpful. Thanks in advance!

2

I’ve encountered a similar challenge in my work with JIRA and Rails. While the jira-ruby gem doesn’t offer a direct method for attachment downloads, you can leverage the underlying Faraday client to achieve this.

Here’s a snippet that should work:

client = JIRA::Client.new(options)
issue = client.Issue.find('ISSUE-123')
attachment = issue.attachments.first

conn = Faraday.new(url: client.options[:site]) do |faraday|
  faraday.request :authorization, :basic, client.options[:username], client.options[:password]
end

response = conn.get(attachment.content)

if response.success?
  File.open(attachment.filename, 'wb') { |file| file.write(response.body) }
end

This approach utilizes Faraday to make authenticated requests to JIRA’s API, allowing you to download attachments efficiently. Remember to handle potential errors and ensure proper permissions are in place.

3

I’ve actually tackled this issue in a recent project. While jira-ruby doesn’t have a built-in method for downloading attachments, you can still accomplish this using the gem’s HTTP client.

Here’s what worked for me:

  1. Get the attachment’s URL from the issue
  2. Use the jira_client’s HTTP client to make a GET request to that URL
  3. Save the response body to a file

The code might look something like this:

attachment = issue.attachments.first
attachment_url = attachment.content

response = client.http_client.get_raw(attachment_url)
File.open(attachment.filename, 'wb') { |file| file.write(response.body) }

This approach bypasses the need for a specific attachment download method in the gem. Just make sure you have the necessary permissions to access the attachments. Hope this helps!

4

yo, i’ve done this before. u can use the http_client from jira-ruby to grab attachments. something like:

url = issue.attachments.first.content
response = client.http_client.get_raw(url)
File.write(‘file.pdf’, response.body)

just make sure u got the right permissions set up in JIRA. good luck!