RubyGems - shutterbug - Versions diffs - 0.0.4 → 0.0.6 - Mend

shutterbug 0.0.4 → 0.0.6

Files changed (12) hide show

data/README.md +7 -1
data/lib/shutterbug/bug_file.rb +22 -0
data/lib/shutterbug/configuration.rb +55 -0
data/lib/shutterbug/html_file.rb +3 -0
data/lib/shutterbug/js_file.rb +11 -0
data/lib/shutterbug/phantom_job.rb +70 -0
data/lib/shutterbug/png_file.rb +3 -0
data/lib/shutterbug/rackapp.rb +10 -26
data/lib/shutterbug/service.rb +9 -75
data/lib/shutterbug.rb +7 -1
data/spec/shutterbug/rackapp_spec.rb +12 -9
metadata +10 -4

data/README.md CHANGED Viewed

@@ -6,7 +6,13 @@
 A rack utility that will create and save images (pngs) from parts of your html's documents current dom. These images become available as public png resources in the rack application. Currently shutterbug supports HTML, SVG and Canvas elements.
-    use Shutterbug::Rackapp
+    use Shutterbug::Rackapp do |config|
+      conf.resource_dir  = "/Users/npaessel/tmp"
+      config.uri_prefix  = "http://localhost:9292"
+      config.path_prefix = "/shutterbug"
+    end
+Configuration options default to reasonable defaults.
 ## Installation

data/lib/shutterbug/bug_file.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module Shutterbug
+  class BugFile
+    def initialize(filename)
+      @filename = filename
+    end
+    def open
+      @stream_file = File.open(@filename, 'r')
+      @stream_file.rewind
+    end
+    def each(&blk)
+      @stream_file.each(&blk)
+    ensure
+      @stream_file.close
+    end
+    def size
+      @stream_file.size
+    end
+  end
+end

data/lib/shutterbug/configuration.rb ADDED Viewed

@@ -0,0 +1,55 @@
+module Shutterbug
+  class Configuration
+    attr_accessor :uri_prefix
+    attr_accessor :path_prefix
+    attr_accessor :resource_dir
+    def self.instance(opts={})
+      return @instance || @instance = self.new(opts)
+    end
+    def initialize(opts={})
+      self.uri_prefix   = opts[:uri_prefix]   || ""
+      self.path_prefix  = opts[:path_prefix]  || "/shutterbug"
+      self.resource_dir = opts[:resource_dir] || Dir.tmpdir
+    end
+    def js_path
+      "#{uri_prefix}#{path_prefix}/shutterbug.js"
+    end
+    def js_regex
+      /#{path_prefix}\/shutterbug.js/
+    end
+    def js_file
+      File.join(File.dirname(__FILE__),"shutterbug.js")
+    end
+    def convert_path
+      "#{uri_prefix}#{path_prefix}/make_snapshot"
+    end
+    def convert_regex
+      /#{path_prefix}\/make_snapshot/
+    end
+    def png_path(sha='')
+      "#{uri_prefix}#{path_prefix}/get_png/#{sha}"
+    end
+    def png_regex
+      /#{path_prefix}\/get_png\/([^\/]+)/
+    end
+    def html_path(sha='')
+      "#{uri_prefix}#{path_prefix}/get_html/#{sha}"
+    end
+    def html_regex
+      /#{path_prefix}\/get_html\/([^\/]+)/
+    end
+    def base_url(req)
+      req.POST()['base_url'] ||  req.referrer || "#{req.scheme}://#{req.host_with_port}"
+    end
+  end
+end

data/lib/shutterbug/html_file.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Shutterbug
+  class HtmlFile < BugFile; end
+end

data/lib/shutterbug/js_file.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module Shutterbug
+  class JsFile   < BugFile
+    def initialize(_config=Configuration.instance())
+      @config = _config
+      @javascript = File.read(@config.js_file).gsub(/CONVERT_PATH/,@config.convert_path)
+    end
+    def open
+      @stream_file = StringIO.new(@javascript)
+    end
+  end
+end

data/lib/shutterbug/phantom_job.rb ADDED Viewed

@@ -0,0 +1,70 @@
+module Shutterbug
+  class PhantomJob
+    attr_accessor :png_file
+    attr_accessor :html_file
+    def program
+      'phantomjs'
+    end
+    def rasterize_js
+      File.join(File.dirname(__FILE__),'rasterize.js')
+    end
+    def initialize(base_url, html, css="", width=1000, height=700)
+      @base_url = base_url
+      @html     = html
+      @css      = css
+      @width    = width
+      @height   = height
+    end
+    def cache_key
+      return @key || @key = Digest::SHA1.hexdigest("#{@html}#{@css}#{@base_url}")[0..10]
+    end
+    def document
+      date = Time.now.strftime("%Y-%m-%d (%I:%M%p)")
+      """
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <base href='#{@base_url}'>
+          <meta content='text/html;charset=utf-8' http-equiv='Content-Type'>
+          <title>content from #{@base_url} #{date}</title>
+          #{@css}
+        </head>
+        <body>
+          #{@html}
+        </body>
+      </html>
+      """
+    end
+    def base_path
+      Configuration.instance.resource_dir
+    end
+    def infilename
+      File.join(base_path,"phantom_#{cache_key}.html")
+    end
+    def outfilename
+      File.join(base_path,"phantom_#{cache_key}.png")
+    end
+    def rasterize_cl
+      %x[#{self.program} #{self.rasterize_js} #{self.infilename} #{self.outfilename} #{@width}*#{@height}]
+    end
+    def rasterize
+      infile  = File.open(infilename, 'w') do |f|
+        f.write(document)
+      end
+      rasterize_cl()
+      self.png_file  = PngFile.new(outfilename)
+      self.html_file = HtmlFile.new(infilename)
+    end
+  end
+end

data/lib/shutterbug/png_file.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Shutterbug
+  class PngFile  < BugFile; end
+end

data/lib/shutterbug/rackapp.rb CHANGED Viewed

@@ -2,52 +2,36 @@
 module Shutterbug
   class Rackapp
-    BASE_PATH      = "/shutterbug"
-    CONVERT_PATH   = "#{BASE_PATH}/make_snapshot"
-    CONVERT_REGEX  = /#{CONVERT_PATH}/
-    PNG_PATH       = "#{BASE_PATH}/get_png"
-    GET_PNG_REGEX  = /#{PNG_PATH}\/([^\/]+)/
-    HTML_PATH      = "#{BASE_PATH}/get_html"
-    GET_HTML_REGEX = /#{HTML_PATH}\/([^\/]+)/
-    JS_PATH        = "#{BASE_PATH}/shutterbug.js"
-    JS_REGEX       = /#{JS_PATH}$/
-    def initialize app
+    def initialize(app, &block)
+      @config = Configuration.instance
+      yield @config if block_given?
       @app = app
-      @shutterbug = Service.new()
+      @shutterbug = Service.new(@config)
       log "initialized"
     end
-    def base_url(req)
-      req.POST()['base_url'] ||  req.referrer || "#{req.scheme}://#{req.host_with_port}"
-    end
     def do_convert(req)
       html     = req.POST()['content']  ||  ""
       width    = req.POST()['width']    || 1000
       height   = req.POST()['height']   ||  700
       css      = req.POST()['css']      ||  ""
-      signature = @shutterbug.convert(base_url(req), html, css, width, height)
-      response_url = "#{PNG_PATH}/#{signature}"
-      response_text = "<img src='#{response_url}' alt='#{signature}'>"
+      signature = @shutterbug.convert(@config.base_url(req), html, css, width, height)
+      response_text = "<img src='#{@config.png_path(signature)}' alt='#{signature}'>"
       return good_response(response_text,'text/plain')
     end
     def call env
       req = Rack::Request.new(env)
       case req.path
-      when CONVERT_REGEX
+      when @config.convert_regex
         do_convert(req)
-      when GET_PNG_REGEX
+      when @config.png_regex
         good_response(@shutterbug.get_png_file($1),'image/png')
-      when GET_HTML_REGEX
+      when @config.html_regex
         good_response(@shutterbug.get_html_file($1),'text/html')
-      when JS_PATH
+      when @config.js_regex
         good_response(@shutterbug.get_shutterbug_file, 'application/javascript')
       else
         skip(env)

data/lib/shutterbug/service.rb CHANGED Viewed

@@ -1,87 +1,21 @@
 require 'stringio'
 module Shutterbug
   class Service
-    class RackFile
-      def initialize(file)
-        @stream_file = file
-      end
-      def open
-        @stream_file.open
-        @stream_file.rewind
-      end
-      def each(&blk)
-        @stream_file.each(&blk)
-      ensure
-        @stream_file.close
-      end
-      def size
-        @stream_file.size
-      end
-    end
-    class PngFile  < RackFile; end
-    class HtmlFile < RackFile; end
-    class JSFile   < RackFile
-      def initialize(_filename)
-        @javascript = File.read(_filename).gsub(/CONVERT_PATH/,Shutterbug::Rackapp::CONVERT_PATH)
-      end
-      def open
-        @stream_file = StringIO.new(@javascript)
-      end
-    end
-    PROGRAM = 'phantomjs'
-    RASTERIZE_JS  = File.join(File.dirname(__FILE__),'rasterize.js')
-    SHUTTERBUG_JS = File.join(File.dirname(__FILE__),'shutterbug.js')
-    def document(html, css, url_base)
-      date = Time.now.strftime("%Y-%m-%d (%I:%M%p)")
-      """
-      <!DOCTYPE html>
-      <html>
-        <head>
-          <base href='#{url_base}'>
-          <meta content='text/html;charset=utf-8' http-equiv='Content-Type'>
-          <title>png from #{url_base} #{date}</title>
-          #{css}
-        </head>
-        <body>
-          #{html}
-        </body>
-      </html>
-      """
-    end
-    def initialize
+    def initialize(_config = Configuration.instance)
       @file_cache = {}
-      @js_file = JSFile.new(SHUTTERBUG_JS)
+      @config = _config
+      @js_file = JsFile.new()
     end
     def convert(base_url, html, css="", width=1000, height=700)
-      html_content = document(html, css, base_url)
-      signature = Digest::SHA1.hexdigest(html_content)[0..10]
-      return signature if @file_cache[signature]
-      infile = Tempfile.new(['phantom_page','.html'])
-      infile_name = infile.path
-      outfile = Tempfile.new(['phantom_render','.png'])
-      outfile_name = outfile.path
-      begin
-        infile.write(html_content)
-        infile.rewind
-        %x[#{PROGRAM} #{RASTERIZE_JS} #{infile_name} #{outfile_name} #{width}*#{height}]
-        @file_cache[signature] = {'png' => PngFile.new(outfile), 'html' => HtmlFile.new(infile) }
-      ensure
-        infile.close
+      job = PhantomJob.new(base_url, html, css, width, height)
+      key = job.cache_key
+      unless (@file_cache[key])
+        job.rasterize
+        @file_cache[key] = {'html' => job.html_file, 'png' => job.png_file }
       end
-      return signature
+      return key
     end
     def get_png_file(sha)

data/lib/shutterbug.rb CHANGED Viewed

@@ -1,5 +1,11 @@
 module Shutterbug
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
   autoload :Service,        "shutterbug/service"
   autoload :Rackapp,        "shutterbug/rackapp"
+  autoload :Configuration,  "shutterbug/configuration"
+  autoload :BugFile,        "shutterbug/bug_file"
+  autoload :HtmlFile,       "shutterbug/html_file"
+  autoload :PngFile,        "shutterbug/png_file"
+  autoload :JsFile,         "shutterbug/js_file"
+  autoload :PhantomJob,     "shutterbug/phantom_job"
 end

data/spec/shutterbug/rackapp_spec.rb CHANGED Viewed

@@ -6,11 +6,13 @@ RSpec::Matchers.define :be_happy_response do |filetype|
 end
 describe Shutterbug::Rackapp do
-  let(:sha)     { "542112e"                     }
-  let(:size)    { 200                           }
-  let(:rackfile){ mock :fackfile, :size => size }
-  let(:service) { mock :service                 }
-  let(:app)     { mock :app     }
+  let(:sha)     { "542112e"                          }
+  let(:size)    { 200                                }
+  let(:rackfile){ mock :fackfile, :size => size      }
+  let(:service) { mock :service                      }
+  let(:app)     { mock :app                          }
+  let(:config)  { Shutterbug::Configuration.instance }
   let(:post_data) do
     {
       'content'  => "<div class='foo'>foo!</div>",
@@ -20,6 +22,7 @@ describe Shutterbug::Rackapp do
       'base_url' => "http://localhost:8080/"
     }
   end
   subject { Shutterbug::Rackapp.new(app) }
   before(:each) do
@@ -46,7 +49,7 @@ describe Shutterbug::Rackapp do
     end
     describe "convert route" do
-      let(:path)           { Shutterbug::Rackapp::CONVERT_PATH  }
+      let(:path)           { config.convert_path    }
       let(:image_response) { mock :image_response               }
       it "should route #do_convert" do
         subject.should_receive(:do_convert, :with => req).and_return image_response
@@ -55,7 +58,7 @@ describe Shutterbug::Rackapp do
     end
     describe "get png route" do
-      let(:path) { "#{Shutterbug::Rackapp::PNG_PATH}/#{sha}" }
+      let(:path) { config.png_path(sha) }
       it "should route #do_get_png" do
         service.should_receive(:get_png_file, :with => sha).and_return rackfile
         subject.call(mock).should be_happy_response('image/png')
@@ -63,7 +66,7 @@ describe Shutterbug::Rackapp do
     end
     describe "get html route" do
-      let(:path) { "#{Shutterbug::Rackapp::HTML_PATH}/#{sha}" }
+      let(:path) { config.html_path(sha) }
       it "should route #do_get_html" do
         service.should_receive(:get_html_file, :with => sha).and_return rackfile
         subject.call(mock).should be_happy_response('text/html')
@@ -71,7 +74,7 @@ describe Shutterbug::Rackapp do
     end
     describe "get shutterbug javascipt route" do
-      let(:path) { "#{Shutterbug::Rackapp::JS_PATH}" }
+      let(:path) { config.js_path }
       it "should route #do_get_shutterbug" do
         service.should_receive(:get_shutterbug_file).and_return rackfile
         subject.call(mock).should be_happy_response('application/javascript')

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shutterbug
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,12 @@ files:
 - README.md
 - Rakefile
 - lib/shutterbug.rb
+- lib/shutterbug/bug_file.rb
+- lib/shutterbug/configuration.rb
+- lib/shutterbug/html_file.rb
+- lib/shutterbug/js_file.rb
+- lib/shutterbug/phantom_job.rb
+- lib/shutterbug/png_file.rb
 - lib/shutterbug/rackapp.rb
 - lib/shutterbug/rasterize.js
 - lib/shutterbug/service.rb
@@ -134,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2066388252220893222
+      hash: -488192167171583670
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2066388252220893222
+      hash: -488192167171583670
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.23