https://github.com/y9v/carrierwave-base64

Upload files encoded as base64 strings directly to carrierwave
https://github.com/y9v/carrierwave-base64

api carrierwave file-uploads ruby

Last synced: 6 days ago
JSON representation

Upload files encoded as base64 strings directly to carrierwave

• Host: GitHub
• URL: https://github.com/y9v/carrierwave-base64
• Owner: y9v
• License: mit
• Created: 2015-01-26T20:35:03.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-08-20T19:00:24.000Z (4 months ago)
• Last Synced: 2024-10-18T03:09:55.169Z (2 months ago)
• Topics: api, carrierwave, file-uploads, ruby
• Language: Ruby
• Homepage:
• Size: 257 KB
• Stars: 267
• Watchers: 4
• Forks: 81
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Carrierwave::Base64

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/y9v/carrierwave-base64/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/y9v/carrierwave-base64/tree/master)

[![Gem Version](https://badge.fury.io/rb/carrierwave-base64.svg)](http://badge.fury.io/rb/carrierwave-base64)

[![Code Climate](https://codeclimate.com/github/y9v/carrierwave-base64/badges/gpa.svg)](https://codeclimate.com/github/y9v/carrierwave-base64)

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.

## Installation

Add the gem to your Gemfile:

```ruby

gem 'carrierwave-base64'

```

Also add this if you need mongoid support:

```ruby

gem "carrierwave-mongoid"

```

## Usage

Mount the uploader to your model:

```ruby

mount_base64_uploader :image, ImageUploader

```

Now you can also upload files by passing an encoded base64 string to the attribute. This also works for normal file uploads from file fields inside an HTML form, so you can safely replace `mount_uploader` with `mount_base64_uploader` to support both file input and base64 encoded input

## Upload file extension

The file extension for the uploaded base64 string is identified automatically using the [mime-types](https://github.com/mime-types/ruby-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](http://www.rubydoc.info/gems/mime-types/MIME/Types#add-class_method):

```ruby

MIME::Types.add(

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

    type.add_extensions 'icml'

  end

)

```

## 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:

```ruby

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):

```ruby

# Deprecated way:

mount_base64_uploader :image, ImageUploader, file_name: 'userpic'

# New way

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

```

## Data format

File extention for the uploaded file is identified automatically based on the file contents. If it can't be identified automaticaly, it falls back to the content-type, specified in the data string.

```

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

```

## Contributing

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