How to save a base64 string as an image using ruby

Question

I'm integrating my Ruby on Rails app with a usps shipping system. Once you make a postage request, you pay for that postage and it's nonrefundable.

Postage requests will return you an xml response including a base64 string, which is the shipping label.

I'm able to render the shipping label in a view, however to make it foolproof, I would like to be able to save that base64 string as an image on my server in the event that something happens to the shipping label between generation (paying for it) and mailing so it may be reprinted without buying a new one.

My first thoughts were as follows

# Attempt 1
File.open('shipping_label.gif', 'w+') {|f|
    f.puts Base64.decode64(base_64_encoded_data)
}

# Attempt 2
File.open('shipping_label.gif', 'w+') {|f|
    f.puts Base64.decode64(Base64.decode64(base_64_encoded_data))
}

Neither work.

tadman · Accepted Answer · 2021-05-24T19:58:16.193

106

When writing binary data to a file, such as is the case with an image, you cannot use text printing tools like IO#puts.

There's two things you need to ensure:

You need to be writing in binary mode to avoid any possible LF to CRLF expansion.
You must use write instead of puts as write can work on arbitrary data, but puts (literally "put string") is exclusively for text.

Combining these you get:

File.open('shipping_label.gif', 'wb') do |f|
  f.write(Base64.decode64(base_64_encoded_data))
end

edited May 24 '21 at 19:58

answered Jul 21 '09 at 19:00

tadman

208,517
23
234
262

1

This work's perfectly. Thank's for the explanations and links. – Ricky Jul 21 '09 at 19:55
@AhmedSalah Not sure what you mean. This should still work for base64-encoded data. – tadman Apr 11 '20 at 19:41
@tadman I'm trying to save PNG image but the image file is corruputed, Image Viewer for ex saying 'Fatal error reading PNG image file: not a PNG file' also I have similar Q here https://stackoverflow.com/questions/61157933/how-to-attach-base64-image-to-active-storage-object – Ahmed Salah Apr 11 '20 at 20:07

score 26 · Answer 2 · answered Feb 20 '16 at 00:55

26

Other answers are pretty close, but usually assume that base64 stream will contain PNG data. This is not always the case so I suggest to use mime types library to establish correct file extension:

REGEXP = /\Adata:([-\w]+\/[-\w\+\.]+)?;base64,(.*)/m

data_uri_parts = data_url.match(REGEXP) || []
extension = MIME::Types[data_uri_parts[1]].first.preferred_extension
file_name = "myfilename.#{extension}"

File.open(file_name, 'wb') do |file|
    file.write(Base64.decode64(data_uri_parts[2]))
end

answered Feb 20 '16 at 00:55

Piotr Kuczynski

699
7
9

REGEXP = /\Adata:([-\w]+\/[-\w\+\.]+)?;base64,(.*)/m SyntaxError Exception: (byebug):1: unterminated regexp meets end of file ...= /\Adata:([-\w]+\/[-\w\+\.]+)? – Muhammad Umair Jul 24 '19 at 09:20
Just change `REGEXP` to lowercase - `regexp`. That gets rid of the error. – Qasim Aug 10 '22 at 10:01

score 8 · Answer 3 · edited Feb 11 '22 at 15:02

8

data = params[:image_text]# code like this  data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABPUAAAI9CAYAAABSTE0XAAAgAElEQVR4Xuy9SXPjytKm6ZwnUbNyHs7Jc7/VV9bW1WXWi9q
image_data = Base64.decode64(data['data:image/png;base64,'.length .. -1])
new_file=File.new("somefilename.png", 'wb')
new_file.write(image_data)

After you can use image as a file Photo.new(image: image)#save using paperclip in Photo model

edited Feb 11 '22 at 15:02

DivinesLight

2,398
2
24
30

answered Dec 11 '14 at 15:40

stopanko

306
3
7

1

why did you require 'RMagick'? the rest of the solution doesn't use it – Mark Ellul Mar 17 '20 at 12:30
This is what I needed. – DivinesLight Feb 11 '22 at 15:00

score 1 · Answer 4 · answered Jul 21 '09 at 19:41

1

If you need to write it to an image then use imagemagick through the rmagick gem.

http://rmagick.rubyforge.org/

answered Jul 21 '09 at 19:41

Corban Brook

21,270
4
28
34

How to save a base64 string as an image using ruby

4 Answers4

Linked