rack_grid_thumb 0.0.3

data/README.txt

@@ -0,0 +1,49 @@
+Rack::GridThumb
+
+  Rack::GridThumb is used to dynamically create thumbnails when in front of rack_grid.
+  You should run Rack::GridThumb behind a cache such as Varnish or Rack::Cache
+
+Installation
+
+  # gem install rack_grid_thumb
+
+Usage Example with Sinatra.
+
+  # app.rb
+  require 'rack_grid'
+  require 'rack_grid_thumb'
+
+  configure do
+    use Rack::GridThumb, :prefix => 'grid'
+    use Rack::Grid, :prefix => 'grid'
+  end
+
+  # view.erb
+  <img src="/grid/4ba69fde8c8f369a6e000003_50x50.jpg" alt="My Image" />
+
+Usage
+
+  /#{prefix}/#{uid}_50x50.jpg     # => Crop and resize to 50x50
+  /#{prefix}/#{uid}_50x50-nw.jpg  # => Crop and resize with northwest gravity
+  /#{prefix}/#{uid}_50x.jpg       # => Resize to a width of 50, preserving AR
+  /#{prefix}/#{uid}_x50.jpg       # => Resize to a height of 50, preserving AR
+
+
+  To prevent pesky end-users and bots from flooding your application with
+  render requests you can set up Rack::Thumb to check for an SHA-1 signature
+  that is unique to every url. Using this option, only thumbnails requested
+  by your templates will be valid. Example:
+
+  use Rack::Thumb, {
+  :secret => "My secret",
+  :keylength => "16"        # => Only use 16 digits of the SHA-1 key
+  }
+
+  You can then use your +secret+ to generate secure links in your templates:
+
+  /#{prefix}/#{uid}_50x100-sw-a267c193a7eff046.jpg  # => Successful
+  /#{prefix}/#{uid}_120x250-a267c193a7eff046.jpg    # => Returns a bad request error
+
+
+Inspired by:
+  https://github.com/akdubya/rack-thumb

data/lib/rack_grid_thumb.rb

@@ -0,0 +1,189 @@
+require 'rack'
+require 'mapel'
+require 'digest/sha1'
+require 'tempfile'
+
+module Rack
+
+  class GridThumb
+    RE_TH_BASE = /_([0-9]+x|x[0-9]+|[0-9]+x[0-9]+)(-(?:nw|n|ne|w|c|e|sw|s|se))?/
+    RE_TH_EXT = /(\.(?:jpg|jpeg|png|gif))/i
+    TH_GRAV = {
+      '-nw' => :northwest,
+      '-n' => :north,
+      '-ne' => :northeast,
+      '-w' => :west,
+      '-c' => :center,
+      '-e' => :east,
+      '-sw' => :southwest,
+      '-s' => :south,
+      '-se' => :southeast
+    }
+
+    def initialize(app, options={})
+      @app = app
+      @keylen = options[:keylength]
+      @secret = options[:secret]
+      @route  = generate_route(options[:prefix])
+    end
+
+    # Generates route given a prefixes.
+    def generate_route(prefix = nil)
+      if @keylen
+        /^(\/#{prefix}\/\w+).*#{RE_TH_BASE}-([0-9a-f]{#{@keylen}})#{RE_TH_EXT}$/
+      else
+        /^(\/#{prefix}\/\w+).*#{RE_TH_BASE}#{RE_TH_EXT}$/
+      end
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      response = catch(:halt) do
+        throw :halt unless %w{GET HEAD}.include? env["REQUEST_METHOD"]
+        @env = env
+        @path = env["PATH_INFO"]
+        if match = @path.match(@route)
+          @source, dim, grav = extract_meta(match)
+          @image = get_source_image
+          @thumb = render_thumbnail(dim, grav) unless head?
+          serve
+        end
+        nil
+      end
+
+      response || @app.call(env)
+    end
+
+    # Extracts filename and options from the path.
+    def extract_meta(match)
+      result = if @keylen
+        extract_signed_meta(match)
+      else
+        extract_unsigned_meta(match)
+      end
+
+      throw :halt unless result
+      result
+    end
+
+    # Extracts filename and options from a signed path.
+    def extract_signed_meta(match)
+      base, dim, grav, sig, ext = match.captures
+      digest = Digest::SHA1.hexdigest("#{base}_#{dim}#{grav}#{ext}#{@secret}")[0..@keylen-1]
+      throw(:halt, bad_request) unless sig && (sig == digest)
+      [base + ext, dim, grav]
+    end
+
+    # Extracts filename and options from an unsigned path.
+    def extract_unsigned_meta(match)
+      base, dim, grav, ext = match.captures
+      [base + ext, dim, grav]
+    end
+
+    # Fetch the source image from the downstream app, returning the downstream
+    # app's response if it is not a success.
+    def get_source_image
+      status, headers, body = @app.call(@env.merge(
+        "PATH_INFO" => @source
+      ))
+      unless (status >= 200 && status < 300) &&
+          (headers["Content-Type"].split("/").first == "image")
+        throw :halt, [status, headers, body]
+      end
+
+      @source_headers = headers
+
+      if !head?
+        if body.respond_to?(:path)
+          ::File.open(body.path, 'rb')
+        elsif body.respond_to?(:each)
+          data = ''
+          body.each { |part| data << part.to_s }
+          Tempfile.new(::File.basename(@path)).tap do |f|
+            f.binmode
+            f.write(data)
+            f.close
+          end
+        end
+      else
+        nil
+      end
+    end
+
+    # Renders a thumbnail from the source image. Returns a Tempfile.
+    def render_thumbnail(dim, grav)
+      gravity = grav ? TH_GRAV[grav] : :center
+      width, height = parse_dimensions(dim)
+      origin_width, origin_height = Mapel.info(@image.path)[:dimensions]
+      width = [width, origin_width].min if width
+      height = [height, origin_height].min if height
+      output = create_tempfile
+      cmd = Mapel(@image.path).gravity(gravity)
+      if width && height
+        cmd.resize!(width, height)
+      else
+        cmd.resize(width, height, 0, 0, '>')
+      end
+      cmd.to(output.path).run
+      output
+    end
+
+    # Serves the thumbnail. If this is a HEAD request we strip the body as well
+    # as the content length because the render was never run.
+    def serve
+      response = if head?
+        @source_headers.delete("Content-Length")
+        [200, @source_headers, []]
+      else
+        [200, @source_headers.merge("Content-Length" => ::File.size(@thumb.path).to_s), self]
+      end
+
+      throw :halt, response
+    end
+
+    # Parses the rendering options; returns false if rendering options are invalid
+    def parse_dimensions(meta)
+      dimensions = meta.split('x').map do |dim|
+        if dim.empty?
+          nil
+        elsif dim[0].to_i == 0
+          throw :halt, bad_request
+        else
+          dim.to_i
+        end
+      end
+      dimensions.any? ? dimensions : throw(:halt, bad_request)
+    end
+
+    # Creates a new tempfile
+    def create_tempfile
+      Tempfile.new(::File.basename(@path)).tap { |f| f.close }
+    end
+
+    def bad_request
+      body = "Bad thumbnail parameters in #{@path}\n"
+      [400, {"Content-Type" => "text/plain",
+         "Content-Length" => body.size.to_s},
+       [body]]
+    end
+
+    def head?
+      @env["REQUEST_METHOD"] == "HEAD"
+    end
+
+    def each
+      ::File.open(@thumb.path, "rb") { |file|
+        while part = file.read(8192)
+          yield part
+        end
+      }
+    end
+
+    def to_path
+      @thumb.path
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rack_grid_thumb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Dusty Doris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mapel
+  requirement: &2157443320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157443320
+description: Auto-create thumbnails when used with rack_grid
+email: github@dusty.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.txt
+files:
+- README.txt
+- lib/rack_grid_thumb.rb
+- test/test_rack_grid_thumb.rb
+homepage: http://github.com/dusty/rack_grid_thumb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: none
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Auto-create thumbnails when used with rack_grid
+test_files: []