Upload files encoded as base64 strings directly to carrierwave

License: MIT

Language: Ruby

Keywords: api, carrierwave, file-uploads, ruby


Gem Version Build Status Code Climate Inch CI

Upload files encoded as base64 to carrierwave.

This small gem can be useful for API's that interact with mobile devices.

This gem requires Ruby 2.0 or higher.


Add the gem to your Gemfile:

gem 'carrierwave-base64'

Also add this if you need mongoid support:

gem "carrierwave-mongoid"


Mount the uploader to your model:

mount_base64_uploader :image, ImageUploader

Now you can also upload files by passing an encoded base64 string to the attribute.

Upload file extension

The file extension for the uploaded base64 string is identified automatically using the mime-types gem and content_type from the uploaded string.

If the required MIME type is not registered, you can add it, using MIME::Types#add:

  MIME::Type.new('application/icml').tap do |type|
    type.add_extensions 'icml'

Setting the file name

You can set the file_name option to a lambda, that will return a filename without an extension, using the model instance:

mount_base64_uploader :image, ImageUploader, file_name: -> (u) { u.username }

[DEPRECATED: Settings this option to a string is deprecated, if you still want to set the filename to a fixed string, wrap it in a Proc] To set the file name for the uploaded files, use the :file_name option (without extention):

# Deprecated way:
mount_base64_uploader :image, ImageUploader, file_name: 'userpic'

# New way
mount_base64_uploader :image, ImageUploader, file_name: -> { 'userpic' }

Data format

The string with the encoded data, should be prefixed with Data URI scheme format.

Keep in mind, that the content type specified in this string, would be used to identified the file extension. So if you have some custom content type uploaded, don't forget to register a Mime Type for it.

data:image/jpeg;base64,(base64 encoded data)


  1. Fork it ( https://github.com/[my-github-username]/carrierwave-base64/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Project Statistics

Sourcerank 8
Repository Size 223 KB
Stars 222
Forks 73
Watchers 5
Open issues 2
Dependencies 14
Contributors 15
Tags 30
Last updated
Last pushed

Top Contributors See all

Yury Lebedev Jordan Sitkin Hendrik Kleinwaechter Rostyslav Diachok Justis Blasco Alexander Lang Vadim Poplavskiy Gregg Horton Sajid Rabbani Piotr Kochowicz Francesco Rodríguez Ali Fakheri Graham Melcher Stuart Chinery Victor Viruete

Packages Referencing this Repo

This gem can be useful, if you need to upload files to your API from mobile devises.
Latest release 2.8.0 - Updated - 222 stars

Recent Tags See all

v2.8.0 November 29, 2018
v2.7.0 April 12, 2018
v2.6.1 October 16, 2017
v2.6.0 October 12, 2017
v2.5.3 May 30, 2017
v2.5.2 May 26, 2017
v2.5.2 May 26, 2017
v2.5.2 May 26, 2017
v2.5.1.1 May 22, 2017
v2.5.1 May 22, 2017
v2.5.0 March 17, 2017
v2.4.0 February 03, 2017
v2.3.5 February 03, 2017
v2.3.4 November 28, 2016
v2.3.3 November 22, 2016

Something wrong with this page? Make a suggestion

Last synced: 2018-11-29 08:32:35 UTC

Login to resync this repository