{"id":1126,"date":"2016-02-05T05:47:31","date_gmt":"2016-02-05T05:47:31","guid":{"rendered":"http:\/\/siriinnovations.com\/blog\/?p=1126"},"modified":"2016-02-05T10:30:43","modified_gmt":"2016-02-05T10:30:43","slug":"watermarking-an-image-using-paperclip-gem","status":"publish","type":"post","link":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/","title":{"rendered":"Watermarking an image using paperclip gem"},"content":{"rendered":"

You can brand all the images present in your application by placing your official logo as watermark on images. This can be done in a programmatic manner using a paperclip gem.<\/span><\/p>\n

Requirements:<\/strong><\/span>
\n \u2022 Add paperclip gem to your ruby on rails application and install all the dependencies like image magick.<\/span><\/p>\n

Implementation:<\/strong><\/span>
\n \u2022 Choose a model and add image attribute columns by following paperclip documentation.<\/span>
\n \u2022 Using paperclip options you can easily define different size of images within the model.<\/span>
\n \u2022 Paperclip allows you to add your custom processor to deal with the images and its sizes.<\/span>
\n \u2022 If you have multiple sizes of images then you can workout the changes on the original image by adding a custom processor. So that the other images will do have a watermark image correspondingly.<\/span>
\n \u2022 Create a processor and place in your library folder of your application. If you have multiple processors then it is suggested to have a folder for processors.<\/span><\/p>\n

Path:<\/strong><\/span>RAILS_APP\/lib\/paperclip_processors\/watermark.rb<\/span><\/h5>\n
module Paperclip\r\nclass Watermark < Processor\r\n    # Handles watermarking of images that are uploaded.\r\nattr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options, :watermark_path, :overlay, :position\r\ndef initialize file, options = {}, attachment = nil\r\nsuper\r\ngeometry          = options[:geometry]\r\n      @file             = file\r\nifgeometry.present?\r\n        @crop             = geometry[-1,1] == '#'\r\nend\r\n      @target_geometry  =Geometry.parse geometry\r\n      @current_geometry = Geometry.from_file @file\r\n      @convert_options  = options[:convert_options]\r\n      @whiny            = options[:whiny].nil? ? true : options[:whiny]\r\n      @format           = options[:format]\r\n      @watermark_path   = options[:watermark_path]\r\n      @dissolve         = options.fetch(:watermark_dissolve, 70)\r\n      @position         = options[:position].nil? ? \"SouthEast\" : options[:position]\r\n      @overlay          = options[:overlay].nil? ? true : false\r\n      @current_format   = File.extname(@file.path)\r\n      @basename         = File.basename(@file.path, @current_format)\r\nend\r\n    # TODO: extend watermark\r\n    # Returns true if the +target_geometry+ is meant to crop.\r\ndef crop?\r\n      @crop\r\nend\r\n    # Returns true if the image is meant to make use of additional convert options.\r\ndefconvert_options?\r\nnot @convert_options.blank?\r\nend\r\n    # Performs the conversion of the +file+ into a watermark. Returns the Tempfile\r\n    # that contains the new image.\r\ndef make\r\ndst = Tempfile.new([@basename, @format].compact.join(\".\"))\r\ndst.binmode\r\ncommand = \"convert\"\r\nparams = [fromfile]\r\nparams += transformation_command\r\nparams<<tofile(dst)\r\nbegin\r\nsuccess = Paperclip.run(command, params.flatten.compact.collect{|e| \"'#{e}'\"}.join(\" \"))\r\nrescue Paperclip::Errors::CommandNotFoundError\r\nraise Paperclip::Errors::CommandNotFoundError, \"There was an error resizing and cropping #{@basename}\" if @whiny\r\nend\r\nifwatermark_path\r\ncommand = \"composite\"\r\ncommand += \" -dissolve #{@dissolve}\"\r\nparams = %W[-gravity #{@position} #{watermark_path} #{tofile(dst)}]\r\nparams<<tofile(dst)\r\nbegin\r\nsuccess = Paperclip.run(command, params.flatten.compact.collect{|e| \"'#{e}'\"}.join(\" \"))\r\nrescue Paperclip::Errors::CommandNotFoundError\r\nraise Paperclip::Errors::CommandNotFoundError, \"There was an error processing the watermark for #{@basename}\" if @whiny\r\nend\r\nend\r\ndst\r\nend\r\ndeffromfile\r\nFile.expand_path(@file.path)\r\nend\r\ndeftofile(destination)\r\nFile.expand_path(destination.path)\r\nend\r\ndeftransformation_command\r\nif @target_geometry.present?\r\nscale, crop = @current_geometry.transformation_to(@target_geometry, crop?)\r\ntrans = %W[-resize #{scale}]\r\ntrans += %W[-crop #{crop} +repage] if crop\r\ntrans<<convert_options if convert_options?\r\ntrans\r\nend\r\nend\r\nend\r\nend\r\n<\/pre>\n
\u2022 By using this module, you can manipulate the image to handle<\/span> wat<\/span>ermarking.<\/span><\/span>
\n \u2022 Your model cant call any of the method in the module since its out of model scope. You can require the module by specifying require \u00a0 \u00a0paperclip_processors\/watermark’ on top of your model inside the class.<\/span>
\n \u2022 Once after requiring the module, you can able to call the processor on to your image with various options.<\/span>
\n \u2022 You can place your desired image\/logo in public folder.<\/span>
\n \u2022 Specify the following options in your model inorder to get the watermark on the uploaded image.<\/span><\/p>\n
:original => {\t\t\r\n\t\t\t:processors => [:watermark],\r\n\t\t\t:watermark_path => \"#{Rails.root}\/public\/images\/logo-home-new.png\",\r\n\t\t\t:position => 'NorthWest',\r\n\t\t\t:watermark_dissolve => 90,\r\n\t\t\t:auto_orient    => false\r\n\t\t}\r\n<\/pre>\n
\u2022 Here the processors option in the original hash uses the customized watermark class.<\/span>
\n \u2022 Watermark_path should have the watermark image complete url. This image will come on uploads.<\/span>
\n \u2022 The position option is where the watermark image will get pasted. For now, the watermark image comes on left-top \u00a0 \u00a0of the uploaded \u00a0 \u00a0 \u00a0image, refer the documentation of image magick for various values to pass.<\/span>
\n \u2022 Auto orient adjusts an image so that its orientation is suitable for viewing. Currently it is set to false.<\/span>
\n \u2022 After all configurations are done, the image uploads will get a watermark present on them.<\/span>
\n \u2022 For adding watermarks to existing images in your model, you can try as below,<\/span><\/p>\n
ModelName.find_eachdo|rec|<\/span>
\n rec.image_or_avatar.reprocess!<\/span>
\n end<\/span><\/p>\n
Note:<\/strong> Running above command on your model will convert all the images to be watermarked.<\/em><\/span><\/p>\n","protected":false},"excerpt":{"rendered":"
You can brand all the images present in your application by placing your official logo as watermark on images. This can be done in a programmatic manner using a paperclip gem. Requirements: \u2022 Add paperclip gem to your ruby on rails application and install all the dependencies like image magick. Implementation: \u2022 Choose a model […]<\/p>\n","protected":false},"author":1,"featured_media":1145,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[99,3,6],"tags":[102,104,101,103,100],"class_list":["post-1126","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-ruby-on-rails","category-technical","category-tutorials","tag-gem","tag-image","tag-paperclip","tag-rails","tag-ruby-on-rails"],"yoast_head":"\nWatermarking an image using paperclip gem - Siri Innovations<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Watermarking an image using paperclip gem - Siri Innovations\" \/>\n<meta property=\"og:description\" content=\"You can brand all the images present in your application by placing your official logo as watermark on images. This can be done in a programmatic manner using a paperclip gem. Requirements: \u2022 Add paperclip gem to your ruby on rails application and install all the dependencies like image magick. Implementation: \u2022 Choose a model […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\" \/>\n<meta property=\"og:site_name\" content=\"Siri Innovations\" \/>\n<meta property=\"article:published_time\" content=\"2016-02-05T05:47:31+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2016-02-05T10:30:43+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"624\" \/>\n\t<meta property=\"og:image:height\" content=\"264\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"admin\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\"},\"author\":{\"name\":\"admin\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be\"},\"headline\":\"Watermarking an image using paperclip gem\",\"datePublished\":\"2016-02-05T05:47:31+00:00\",\"dateModified\":\"2016-02-05T10:30:43+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\"},\"wordCount\":396,\"commentCount\":0,\"image\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg\",\"keywords\":[\"Gem\",\"Image\",\"Paperclip\",\"Rails\",\"Ruby on Rails\"],\"articleSection\":[\"Ruby On Rails\",\"Technical\",\"Tutorials\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\",\"url\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\",\"name\":\"Watermarking an image using paperclip gem - Siri Innovations\",\"isPartOf\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg\",\"datePublished\":\"2016-02-05T05:47:31+00:00\",\"dateModified\":\"2016-02-05T10:30:43+00:00\",\"author\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be\"},\"breadcrumb\":{\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage\",\"url\":\"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg\",\"contentUrl\":\"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg\",\"width\":624,\"height\":264,\"caption\":\"Ruby\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/siriinnovations.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Watermarking an image using paperclip gem\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/#website\",\"url\":\"https:\/\/siriinnovations.com\/blog\/\",\"name\":\"Technical blog from Siri Innovations\",\"description\":\"Innovative like no other\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/siriinnovations.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be\",\"name\":\"admin\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/0502de904af36be1590ebd238e45c079e504330e5ef528f9a607c84a218015b6?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/0502de904af36be1590ebd238e45c079e504330e5ef528f9a607c84a218015b6?s=96&d=mm&r=g\",\"caption\":\"admin\"},\"url\":\"https:\/\/siriinnovations.com\/blog\/author\/admin\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Watermarking an image using paperclip gem - Siri Innovations","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/","og_locale":"en_US","og_type":"article","og_title":"Watermarking an image using paperclip gem - Siri Innovations","og_description":"You can brand all the images present in your application by placing your official logo as watermark on images. This can be done in a programmatic manner using a paperclip gem. Requirements: \u2022 Add paperclip gem to your ruby on rails application and install all the dependencies like image magick. Implementation: \u2022 Choose a model […]","og_url":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/","og_site_name":"Siri Innovations","article_published_time":"2016-02-05T05:47:31+00:00","article_modified_time":"2016-02-05T10:30:43+00:00","og_image":[{"width":624,"height":264,"url":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","type":"image\/jpeg"}],"author":"admin","twitter_misc":{"Written by":"admin","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#article","isPartOf":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/"},"author":{"name":"admin","@id":"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be"},"headline":"Watermarking an image using paperclip gem","datePublished":"2016-02-05T05:47:31+00:00","dateModified":"2016-02-05T10:30:43+00:00","mainEntityOfPage":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/"},"wordCount":396,"commentCount":0,"image":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage"},"thumbnailUrl":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","keywords":["Gem","Image","Paperclip","Rails","Ruby on Rails"],"articleSection":["Ruby On Rails","Technical","Tutorials"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/","url":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/","name":"Watermarking an image using paperclip gem - Siri Innovations","isPartOf":{"@id":"https:\/\/siriinnovations.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage"},"image":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage"},"thumbnailUrl":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","datePublished":"2016-02-05T05:47:31+00:00","dateModified":"2016-02-05T10:30:43+00:00","author":{"@id":"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be"},"breadcrumb":{"@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#primaryimage","url":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","contentUrl":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","width":624,"height":264,"caption":"Ruby"},{"@type":"BreadcrumbList","@id":"https:\/\/siriinnovations.com\/blog\/watermarking-an-image-using-paperclip-gem\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/siriinnovations.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Watermarking an image using paperclip gem"}]},{"@type":"WebSite","@id":"https:\/\/siriinnovations.com\/blog\/#website","url":"https:\/\/siriinnovations.com\/blog\/","name":"Technical blog from Siri Innovations","description":"Innovative like no other","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/siriinnovations.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/d73ce03810dedf6ffc67ed4068c107be","name":"admin","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/siriinnovations.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/0502de904af36be1590ebd238e45c079e504330e5ef528f9a607c84a218015b6?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/0502de904af36be1590ebd238e45c079e504330e5ef528f9a607c84a218015b6?s=96&d=mm&r=g","caption":"admin"},"url":"https:\/\/siriinnovations.com\/blog\/author\/admin\/"}]}},"jetpack_featured_media_url":"https:\/\/siriinnovations.com\/blog\/wp-content\/uploads\/2016\/02\/1.jpg","_links":{"self":[{"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/posts\/1126","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/comments?post=1126"}],"version-history":[{"count":17,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/posts\/1126\/revisions"}],"predecessor-version":[{"id":1144,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/posts\/1126\/revisions\/1144"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/media\/1145"}],"wp:attachment":[{"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/media?parent=1126"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/categories?post=1126"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/siriinnovations.com\/blog\/wp-json\/wp\/v2\/tags?post=1126"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}