Skip to content

Ruby Image Validation

How it works

  1. The image gets uploaded to your server.
  2. Before storing the image on disk, it is being validated on server side.

Jump to Complete Example

Image Upload

In the Server Upload article we explain the steps to upload an image on your server. When you insert an image in the rich text editor, you can validate its format. However that check is done only on the filename and not on the mime type. We recommend to make additional checks on server side just to make sure that users don't upload images in bad formats.

Validate Extension

The WYSIWYG editor's Ruby SDK comes with the possibility to check the image extension when it is being stored on the disk. Additional to the file name extension, it is using the mime type of the file for better accuracy.

class UploadController < ActionController::Base

  ...

  def image_upload
    options: {
      fieldname: 'file',
      validation: {
        allowedExts: [".gif", ".jpeg", ".jpg", ".png", ".svg", ".blob"],
        allowedMimeTypes: [ "image/gif", "image/jpeg", "image/pjpeg", "image/x-png", "image/png", "image/svg+xml" ]
      }
    }

    # Store the image.
    FroalaEditorSDK::Image.upload(params, "public/uploads/images/", options)
  end

  ...

end

Custom Validation

You can also pass a custom method instead of validating the extension and mime type. This gives you full control on what types of images you want to store on disk. Below is an example of how to validate if an image is square.

class UploadController < ActionController::Base

  ...

  def image_upload
    options: {
      validation: Proc.new do |file, type|
        img = MiniMagick::Image.open(file)
        if img.width != img.height
          raise 'Image is not square'
        end
      end
    })
    render :json => FroalaEditorSDK::Image.upload(params, "public/uploads/images/", options)
  end

  ...

end

Complete Example

<script>
  new FroalaEditor('.selector', {
    // Set the image upload URL.
    imageUploadURL: '/image_upload'
  })
</script>
class UploadController < ActionController::Base

  ...

  def upload_file_validation
    options: {
      validation: Proc.new do |file, type|
        img = MiniMagick::Image.open(file)
        if img.width != img.height
          raise 'Image is not square'
        end
      end
    })
    render :json => FroalaEditorSDK::Image.upload(params, "public/uploads/images/", options)
  end

  ...

end

Do you think we can improve this article? Let us know.