meme_captain 0.0.9 → 0.1.0

data/ChangeLog

@@ -1,3 +1,17 @@
+0.1.0	2012-02-07
+
+	Redesign web interface.
+
+	Avoid repeated failures fetching the same source image from the web
+	interface / API.
+
+	ruby interface now supports adding any number of text strings to
+	an image.
+
+	Add custom text positioning and sizing to web interface, API and
+	ruby interface. Web interface has text positioning widget using
+	fabric.js and canvas.
+
 0.0.9	2012-01-19
 
 	Design and markup improvements on the site.

data/README.md

@@ -1,21 +1,48 @@
-Ruby gem to create meme images (images with text added at the top and bottom).
+Ruby gem to create meme images (images with text added).
 
 Runs locally and has no web dependencies.
 
 Works with animated gifs.
 
+Create a simple top and bottom text meme:
+
 ```ruby
 require 'open-uri'
 
 require 'meme_captain'
 
 open('http://memecaptain.com/troll_face.jpg', 'rb') do |f|
-  i = MemeCaptain.meme(f, 'test', '1 2 3')
+  i = MemeCaptain.meme_top_bottom(f, 'test', '1 2 3')
+  i.display
+  i.write('out.jpg')
+end
+```
+
+Advanced usage with text sizing and positioning and RMagick attributes:
+
+```ruby
+require 'open-uri'
+
+require 'meme_captain'
+
+open('http://memecaptain.com/cool_story_bro.jpg', 'rb') do |f|
+  i = MemeCaptain.meme(f, [
+    MemeCaptain::TextPos.new('the quick brown fox', 0.70, 0.1, 0.25, 0.5,
+      :fill => 'green'),
+    MemeCaptain::TextPos.new('jumped over the lazy dog', 100, 400, 200, 100,
+      :font => 'Impact-Regular'),
+    MemeCaptain::TextPos.new('test', 10, 10, 50, 25)
+    ])
   i.display
   i.write('out.jpg')
 end
 ```
 
+Text box sizes and positions can be specified as pixels (the origin is the top
+left corner of the image) or as floats which are percentages of the image
+width and height. The x and y coordinates of a text box are the coordinates
+of its top left corner.
+
 Also includes a Sinatra app that exposes the API over HTTP which is currently
 running http://memecaptain.com/
 
@@ -24,36 +51,34 @@ You can use the memecaptain.com API if you prefer it to using the gem.
 Simplest API:
 
 ```
-http://memecaptain.com/i?u=<url encoded source image url>&tt=<url encoded top text>&tb=<url encoded bottom text>
+http://memecaptain.com/i?u=<url encoded source image url>&t1=<url encoded top text>&t2=<url encoded bottom text>
 ```
 
 Example:
 
 ```
-http://memecaptain.com/i?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&tt=sure+i%27ll+test&tb=the+api
+http://memecaptain.com/i?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&t1=sure+i%27ll+test&t2=the+api
 ```
 
-![Sure I'll test the API](http://memecaptain.com/i?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&tt=sure+i%27ll+test&tb=the+api)
+![Sure I'll test the API](http://memecaptain.com/i?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&t1=sure+i%27ll+test&t2=the+api)
 
 If you want better error messages, use this which will return JSON:
 
 ```
-http://memecaptain.com/g?u=<url encoded source image url>&tt=<url encoded top text>&tb=<url encoded bottom text>
+http://memecaptain.com/g?u=<url encoded source image url>&t1=<url encoded top text>&t2=<url encoded bottom text>
 ```
 
 Example:
 
 ```
-http://memecaptain.com/g?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&tt=sure+i%27ll+test&tb=the+api
+http://memecaptain.com/g?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&t1=sure+i%27ll+test&t2=the+api
 ```
 
-Note: tempUrl is deprecated and will now always be the same as permUrl. It is
-left for compability with older clients.
-
-
 ```json
 {
-  permUrl: "http://memecaptain.com/i?u=http%3A%2F%2Fmemecaptain.com%2Fyao_ming.jpg&tt=sure+i%27ll+test&tb=the+api"
-  tempUrl: "http://memecaptain.com/tmp/de55f7a78c6559d4a24ef3e72e2de89992b82695.jpeg"
+  imageUrl: "http://memecaptain.com/c7757f.jpg"
 }
 ```
+
+Optional parameters t1x, t1y, t1w, t1h, t2x, t2y, t2w, t2h can be added to
+position and size text (see example above).

data/bin/memecaptain

@@ -50,7 +50,9 @@ unless ARGV.empty?
     ].include? k
   end
 
-  output_image = MemeCaptain.meme(
+  meme_options = Hash[meme_options]  if meme_options.is_a?(Array)
+
+  output_image = MemeCaptain.meme_top_bottom(
     input_io, options[:top_text], options[:bottom_text], meme_options)
 
   input_io.close

data/config.ru

@@ -3,6 +3,7 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require 'mongo'
 require 'mongo_mapper'
 require 'rack'
+require 'rack/rewrite'
 
 require 'meme_captain'
 
@@ -18,8 +19,28 @@ MemeCaptain::MemeData.ensure_index :meme_id
 
 MemeCaptain::MemeData.ensure_index [
   [:source_url, 1],
-  [:top_text, 1],
-  [:bottom_text, 1],
+  [:texts, 1],
 ]
 
+MemeCaptain::SourceFetchFail.ensure_index :url
+
+use Rack::Rewrite do
+  rewrite %r{/([gi])\?(.+)}, lambda { |match, rack_env|
+    result = match[0]
+
+    if match[2].index('tt=') or match[2].index('tb=')
+      q = Rack::Utils.parse_query(match[2])
+      if q.key?('tt') or q.key?('tb')
+        q['t1'] = q.delete('tt')  if q.key?('tt')
+        q['t2'] = q.delete('tb')  if q.key?('tb')
+        new_q = q.map { |k,v|
+          "#{Rack::Utils.escape(k)}=#{Rack::Utils.escape(v)}" }.join('&')
+        result = "#{match[1]}?#{new_q}"
+      end
+    end
+
+    result
+  }
+end
+
 run MemeCaptain::Server

data/lib/meme_captain.rb

@@ -6,4 +6,6 @@ require 'meme_captain/image_list'
 require 'meme_captain/meme'
 require 'meme_captain/meme_data'
 require 'meme_captain/server'
+require 'meme_captain/source_fetch_fail'
+require 'meme_captain/text_pos'
 require 'meme_captain/version'

data/lib/meme_captain/image_list.rb

@@ -1,5 +1,6 @@
 require 'meme_captain/image_list/cache'
 require 'meme_captain/image_list/fetch'
+require 'meme_captain/image_list/fetch_error'
 require 'meme_captain/image_list/watermark'
 
 require 'meme_captain/image_list/source_image'

data/lib/meme_captain/image_list/fetch.rb

@@ -13,7 +13,7 @@ module MemeCaptain
           c.useragent = 'Meme Captain http://memecaptain.com/'
         end
         unless curl.response_code == 200
-          raise "Error loading source image url #{url}"
+          raise FetchError.new(curl.response_code)
         end
 
         from_blob curl.body_str

data/lib/meme_captain/image_list/fetch_error.rb

@@ -0,0 +1,17 @@
+module MemeCaptain
+
+  module ImageList
+
+    # Error for source image fetch failures.
+    class FetchError < StandardError
+
+      def initialize(response_code)
+        @response_code = response_code
+      end
+
+      attr_accessor :response_code    
+    end
+
+  end
+
+end

data/lib/meme_captain/meme.rb

@@ -6,19 +6,12 @@ module MemeCaptain
 
   # Create a meme image.
   #
-  # Input can be an IO object or a blob of data.
+  # Input can be an IO object or a blob of data. text_poss is an enumerable
+  # of TextPos objects containing text, position and style options.
   #
   # Options:
-  #   max_lines - maximum number of text lines per caption
-  #   min_pointsize - minimum point size
   #   super_sample - work this many times larger before shrinking
-  #   text_height_pct - float percentage of image height for each caption
-  #   text_width_pct - float percentage of image width for each caption
-  #
-  #  Any other options will be set on the Draw objects for the text and
-  #  can be used to control text fill, stroke, etc. See RMagick annotate
-  #  attributes.
-  def meme(input, top_text, bottom_text, options={})
+  def meme(input, text_poss, options={})
     img = Magick::ImageList.new
     if input.respond_to?(:read)
       img.from_blob(input.read)
@@ -26,27 +19,7 @@ module MemeCaptain
       img.from_blob(input)
     end
 
-    options = {
-      :max_lines       => 16,
-      :min_pointsize   => 12,
-      :super_sample    => 2.0,
-      :text_height_pct => 0.25,
-      :text_width_pct  => 0.9,
-
-      # Draw options
-      :fill            => 'white',
-      :font            => 'Impact',
-      :stroke          => 'black',
-      :stroke_width    => 8,
-    }.merge(options)
-
-    max_lines = options.delete(:max_lines)
-    super_sample = options.delete(:super_sample)
-    min_pointsize = options.delete(:min_pointsize) * super_sample
-
-    text_width = img.page.width * options.delete(:text_width_pct) * super_sample
-    text_height = img.page.height * options.delete(:text_height_pct) *
-      super_sample
+    super_sample = options[:super_sample] || 2.0
 
     text_layer = Magick::Image.new(
       img.page.width * super_sample, img.page.height * super_sample) {
@@ -54,38 +27,54 @@ module MemeCaptain
       self.density = 72.0 * super_sample
     }
 
-    draw = Magick::Draw.new {
-      options.each { |k,v| self.send("#{k}=", v) }
-    }
+    text_poss.each do |text_pos|
+      caption = Caption.new(text_pos.text)
 
-    draw.extend(Draw)
+      if caption.drawable?
+        wrap_tries = (1..text_pos.max_lines).map { |num_lines|
+          caption.wrap(num_lines).upcase.annotate_quote
+        }.uniq
 
-    [
-      [Caption.new(top_text), Magick::NorthGravity],
-      [Caption.new(bottom_text), Magick::SouthGravity],
-    ].select { |x| x[0].drawable? }.each do |caption, gravity|
-      wrap_tries = (1..max_lines).map { |num_lines|
-        caption.wrap(num_lines).upcase.annotate_quote
-      }.uniq
+        text_x = (text_pos.x.is_a?(Float) ?
+          img.page.width * text_pos.x : text_pos.x) * super_sample
 
-      choices = wrap_tries.map do |wrap_try|
-        pointsize, metrics = draw.calc_pointsize(
-          text_width, text_height, wrap_try, min_pointsize)
+        text_y = (text_pos.y.is_a?(Float) ?
+          img.page.height * text_pos.y : text_pos.y) * super_sample
 
-        CaptionChoice.new(pointsize, metrics, wrap_try, text_width,
-          text_height)
-      end
+        text_width = (text_pos.width.is_a?(Float) ?
+          img.page.width * text_pos.width : text_pos.width) * super_sample
+
+        text_height = (text_pos.height.is_a?(Float) ?
+          img.page.height * text_pos.height : text_pos.height) * super_sample
+
+        min_pointsize = text_pos.min_pointsize * super_sample
 
-      choice = choices.max
+        draw = Magick::Draw.new {
+          text_pos.draw_options.each { |k,v| self.send("#{k}=", v) }
+        }
 
-      draw.gravity = gravity
-      draw.pointsize = choice.pointsize
+        draw.extend Draw
 
-      draw.stroke = options[:stroke]
-      draw.annotate text_layer, 0, 0, 0, 0, choice.text
+        choices = wrap_tries.map do |wrap_try|
+          pointsize, metrics = draw.calc_pointsize(text_width, text_height,
+            wrap_try, min_pointsize)
 
-      draw.stroke = 'none'
-      draw.annotate text_layer, 0, 0, 0, 0, choice.text
+          CaptionChoice.new(pointsize, metrics, wrap_try, text_width,
+            text_height)
+        end
+
+        choice = choices.max
+
+        draw.pointsize = choice.pointsize
+
+        draw.annotate text_layer, text_width, text_height, text_x, text_y,
+          choice.text
+
+        draw.stroke = 'none'
+
+        draw.annotate text_layer, text_width, text_height, text_x, text_y,
+          choice.text
+      end
     end
 
     text_layer.resize!(1.0 / super_sample)
@@ -99,4 +88,12 @@ module MemeCaptain
 
   end
 
+  # Shortcut to generate a typical meme with text at the top and bottom.
+  def meme_top_bottom(input, top_text, bottom_text, options={})
+    meme(input, [
+      TextPos.new(top_text, 0.05, 0, 0.9, 0.25, options),
+      TextPos.new(bottom_text, 0.05, 0.75, 0.9, 0.25, options)
+      ])
+  end
+
 end

data/lib/meme_captain/meme_data.rb

@@ -14,8 +14,7 @@ module MemeCaptain
 
     key :source_url, String
     key :source_fs_path, String
-    key :top_text, String
-    key :bottom_text, String
+    key :texts, Array
 
     key :request_count, Integer
     key :last_request, Time

data/lib/meme_captain/server.rb

@@ -15,22 +15,51 @@ module MemeCaptain
 
     get '/' do
       @u = params[:u]
-      @tt= params[:tt]
-      @tb = params[:tb]
+
+      @t1 = params[:t1]
+      @t1x = params[:t1x]
+      @t1y = params[:t1y]
+      @t1w = params[:t1w]
+      @t1h = params[:t1h]
+
+      @t2 = params[:t2]
+      @t2x = params[:t2x]
+      @t2y = params[:t2y]
+      @t2w = params[:t2w]
+      @t2h = params[:t2h]
 
       @root_url = url('/')
 
       erb :index
     end
 
+    def convert_metric(metric, default)
+      case
+        when metric.to_s.empty?; default
+        when metric.index('.'); metric.to_f
+        else; metric.to_i
+      end
+    end
+
     def normalize_params(p)
       result = {
         'u' => p[:u],
+
          # convert to empty string if null
-        'tt' => p[:tt].to_s,
-        'tb' => p[:tb].to_s,
+        't1' => p[:t1].to_s,
+        't2' => p[:t2].to_s,
       }
 
+      result['t1x'] = convert_metric(p[:t1x], 0.05)
+      result['t1y'] = convert_metric(p[:t1y], 0)
+      result['t1w'] = convert_metric(p[:t1w], 0.9)
+      result['t1h'] = convert_metric(p[:t1h], 0.25)
+
+      result['t2x'] = convert_metric(p[:t2x], 0.05)
+      result['t2y'] = convert_metric(p[:t2y], 0.75)
+      result['t2w'] = convert_metric(p[:t2w], 0.9)
+      result['t2h'] = convert_metric(p[:t2h], 0.25)
+
       # if the id of an existing meme is passed in as the source url, use the
       # source image of that meme for the source image
       if result['u'][%r{^[a-f0-9]+\.(?:gif|jpg|png)$}]
@@ -48,23 +77,54 @@ module MemeCaptain
 
       if existing = MemeData.first(
         :source_url => norm_params[:u],
-        :top_text => norm_params[:tt],
-        :bottom_text => norm_params[:tb]
+
+        'texts.0.text' => norm_params[:t1],
+        'texts.0.x' => norm_params[:t1x],
+        'texts.0.y' => norm_params[:t1y],
+        'texts.0.w' => norm_params[:t1w],
+        'texts.0.h' => norm_params[:t1h],
+
+        'texts.1.text' => norm_params[:t2],
+        'texts.1.x' => norm_params[:t2x],
+        'texts.1.y' => norm_params[:t2y],
+        'texts.1.w' => norm_params[:t2w],
+        'texts.1.h' => norm_params[:t2h]
         )
         existing
       else
         if same_source = MemeData.find_by_source_url(norm_params[:u])
           source_fs_path = same_source.source_fs_path
         else
-          source_img = ImageList::SourceImage.new
-          source_img.fetch! norm_params[:u]
-          source_img.prepare! settings.source_img_max_side, settings.watermark
-          source_fs_path = source_img.cache(norm_params[:u], 'source_cache')
+          if source_fetch_fail = SourceFetchFail.find_by_url(norm_params[:u])
+            source_fetch_fail.requested!
+            halt 500, 'Error loading source image url'
+          else
+            source_img = ImageList::SourceImage.new
+            begin
+              source_img.fetch! norm_params[:u]
+            rescue => error
+              SourceFetchFail.new(
+                :attempt_count => 1,
+                :orig_ip => request.ip,
+                :response_code => error.respond_to?(:response_code) ?
+                  error.response_code : nil,
+                :url => norm_params[:u]
+              ).save!
+              halt 500, 'Error loading source image url'
+            end
+            source_img.prepare! settings.source_img_max_side, settings.watermark
+            source_fs_path = source_img.cache(norm_params[:u], 'source_cache')
+          end
         end
 
         open(source_fs_path, 'rb') do |source_io|
-          meme_img = MemeCaptain.meme(source_io, norm_params[:tt],
-            norm_params[:tb])
+          t1 = TextPos.new(norm_params[:t1], norm_params[:t1x],
+            norm_params[:t1y], norm_params[:t1w], norm_params[:t1h])
+
+          t2 = TextPos.new(norm_params[:t2], norm_params[:t2x],
+            norm_params[:t2y], norm_params[:t2w], norm_params[:t2h])
+
+          meme_img = MemeCaptain.meme(source_io, [t1, t2])
           meme_img.extend ImageList::Cache
 
           # convert non-animated gifs to png
@@ -95,8 +155,20 @@ module MemeCaptain
 
             :source_url => norm_params[:u],
             :source_fs_path => source_fs_path,
-            :top_text => norm_params[:tt],
-            :bottom_text => norm_params[:tb],
+
+            :texts => [{
+              :text => norm_params[:t1],
+              :x => norm_params[:t1x],
+              :y => norm_params[:t1y],
+              :w => norm_params[:t1w],
+              :h => norm_params[:t1h],
+              }, {
+              :text => norm_params[:t2],
+              :x => norm_params[:t2x],
+              :y => norm_params[:t2y],
+              :w => norm_params[:t2w],
+              :h => norm_params[:t2h],
+            }],
 
             :request_count => 0,
 
@@ -117,22 +189,11 @@ module MemeCaptain
       begin
         meme_data = gen(params)
 
-        meme_url = url("/#{meme_data.meme_id}")
-
-        template_query = [
-          [:u, meme_data.meme_id],
-          [:tt, meme_data.top_text],
-          [:tb, meme_data.bottom_text],
-          ].map { |k,v|
-            "#{Rack::Utils.escape(k)}=#{Rack::Utils.escape(v)}" }.join('&')
-
         [200, { 'Content-Type' => 'application/json' }, {
-          'tempUrl' => meme_url,
-          'permUrl' => meme_url,
-          'templateUrl' => url("/?#{template_query}"),
+          'imageUrl' => url("/#{meme_data.meme_id}")
         }.to_json]
       rescue => error
-        [500, { 'Content-Type' => 'text/plain' }, error.to_s]
+        [500, { 'Content-Type' => 'text/plain' }, 'Error generating image']
       end
     end