shutterbug 0.0.11 → 0.1.0

data/lib/shutterbug.rb

@@ -1,11 +1,9 @@
 module Shutterbug
-  VERSION = "0.0.11"
-  autoload :Service,        "shutterbug/service"
+  VERSION = "0.1.0"
   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 :Storage,        "shutterbug/storage"
+  autoload :Handlers,       "shutterbug/handlers"
   autoload :PhantomJob,     "shutterbug/phantom_job"
+  autoload :CacheManager,   "shutterbug/cache_manager"
 end

data/lib/shutterbug/cache_manager.rb

@@ -0,0 +1,6 @@
+module Shutterbug
+  module CacheManager
+    autoload :NoCache,      "shutterbug/cache_manager/no_cache"
+    autoload :CacheEntry,   "shutterbug/cache_manager/cache_entry"
+  end
+end

data/lib/shutterbug/cache_manager/cache_entry.rb

@@ -0,0 +1,19 @@
+module Shutterbug
+  module CacheManager
+    class CacheEntry
+      attr_accessor :key
+      attr_accessor :url
+      attr_accessor :preview_url
+
+      def initialize(storage)
+        @key = storage.filename
+        @url = storage.url
+        @preview_url = storage.url
+      end
+
+      def image_tag
+        "<img src='#{self.preview_url}' alt='#{self.preview_url}'>"
+      end
+    end
+  end
+end

data/lib/shutterbug/cache_manager/no_cache.rb

@@ -0,0 +1,19 @@
+module Shutterbug
+  module CacheManager
+    class NoCache
+      attr_accessor :entries
+      def initialize
+        @entries = {}
+      end
+
+      def find(key)
+        return @entries[key]
+      end
+
+      def add_entry(cache_entry)
+        @entries[cache_entry.key] = cache_entry
+      end
+
+    end
+  end
+end

data/lib/shutterbug/configuration.rb

@@ -1,3 +1,4 @@
+require 'tmpdir'
 module Shutterbug
   class Configuration
 
@@ -5,6 +6,10 @@ module Shutterbug
     attr_accessor :path_prefix
     attr_accessor :resource_dir
     attr_accessor :phantom_bin_path
+    attr_accessor :s3_bin
+    attr_accessor :s3_key
+    attr_accessor :s3_secret
+    attr_accessor :cache_manager
 
     def self.instance(opts={})
       return @instance || @instance = self.new(opts)
@@ -15,43 +20,34 @@ module Shutterbug
       self.path_prefix      = opts[:path_prefix]      || "/shutterbug"
       self.resource_dir     = opts[:resource_dir]     || Dir.tmpdir
       self.phantom_bin_path = opts[:phantom_bin_path] || "phantomjs"
+      self.s3_bin           = opts[:s3_bin]
+      self.s3_key           = opts[:s3_key]
+      self.s3_secret        = opts[:s3_secret]
+      self.cache_manager    = opts[:cache_manager]    || Shutterbug::CacheManager::NoCache.new
     end
 
-    def js_path
-      "#{uri_prefix}#{path_prefix}/shutterbug.js"
+    def fs_path_for(filename)
+      File.join(resource_dir,"phantom_#{filename}")
     end
 
-    def js_regex
-      /#{path_prefix}\/shutterbug.js/
-    end
-
-    def js_file
-      File.join(File.dirname(__FILE__),"shutterbug.js")
+    def url_prefix
+      "#{uri_prefix}#{path_prefix}"
     end
 
     def convert_path
-      "#{uri_prefix}#{path_prefix}/make_snapshot"
-    end
-    def convert_regex
-      /#{path_prefix}\/make_snapshot/
+      "#{url_prefix}/make_snapshot"
     end
 
-    def png_path(sha='')
-      "#{uri_prefix}#{path_prefix}/get_png/#{sha}"
-    end
-    def png_regex
-      /#{path_prefix}\/get_png\/([^\/]+)/
+    def base_url(req)
+      req.POST()['base_url'] ||  req.referrer || "#{req.scheme}://#{req.host_with_port}"
     end
 
-    def html_path(sha='')
-      "#{uri_prefix}#{path_prefix}/get_html/#{sha}"
-    end
-    def html_regex
-      /#{path_prefix}\/get_html\/([^\/]+)/
+    def storage
+      use_s3? ? Storage::S3Storage : Storage::FileStorage
     end
 
-    def base_url(req)
-      req.POST()['base_url'] ||  req.referrer || "#{req.scheme}://#{req.host_with_port}"
+    def use_s3?
+      return (self.s3_bin && self.s3_key && self.s3_secret)
     end
   end
 end

data/lib/shutterbug/handlers.rb

@@ -0,0 +1,7 @@
+require "shutterbug/handlers/file_handlers"
+module Shutterbug
+  module Handlers
+    autoload :ConvertHandler,  "shutterbug/handlers/convert_handler"
+    autoload :JsFileHandler,   "shutterbug/handlers/js_file_handler"
+  end
+end

data/lib/shutterbug/handlers/convert_handler.rb

@@ -0,0 +1,38 @@
+require 'stringio'
+module Shutterbug
+  module Handlers
+    class ConvertHandler
+
+      def initialize(_config = Configuration.instance)
+        @config = _config
+      end
+
+      def regex
+        /#{@config.path_prefix}\/make_snapshot/
+      end
+
+      def handle(helper, req, env)
+        response_text = convert(req).image_tag
+        helper.good_response(response_text,'text/plain')
+      end
+
+      def convert(req)
+        html     = req.POST()['content']  ||  ""
+        width    = req.POST()['width']    || 1000
+        height   = req.POST()['height']   ||  700
+        css      = req.POST()['css']      ||  ""
+        job = PhantomJob.new(@config.base_url(req), html, css, width, height)
+        unless (cache_entry = @config.cache_manager.find(job.cache_key))
+          job.rasterize
+          html_entry = Shutterbug::CacheManager::CacheEntry.new(job.html_file)
+          png_entry  = Shutterbug::CacheManager::CacheEntry.new(job.png_file)
+          html_entry.preview_url = png_entry.preview_url
+          @config.cache_manager.add_entry(html_entry)
+          cache_entry = @config.cache_manager.add_entry(png_entry)
+        end
+        # return the image tag
+        return cache_entry
+      end
+    end
+  end
+end

data/lib/shutterbug/handlers/file_handlers.rb

@@ -0,0 +1,9 @@
+module Shutterbug
+  module Handlers
+    module FileHandlers
+      require "shutterbug/handlers/file_handlers/base"
+      require "shutterbug/handlers/file_handlers/html_file"
+      require "shutterbug/handlers/file_handlers/png_file"
+    end
+  end
+end

data/lib/shutterbug/handlers/file_handlers/base.rb

@@ -0,0 +1,39 @@
+require 'tmpdir'
+module Shutterbug
+  module Handlers
+    module FileHandlers
+      class Base
+        attr_accessor :config
+
+        def self.instance
+          return @instance || self.new
+        end
+
+        def initialize(_config = Configuration.instance)
+          self.config = _config
+        end
+
+        def urlify(name)
+          "#{self.path_prefix}/#{name}"
+        end
+
+        def path_prefix
+          "#{self.config.path_prefix}/get_#{file_extension}"
+        end
+
+        def filename_matcher
+          "(([^\/|\.]+)\.?([^\/]+))?"
+        end
+
+        def regex
+          /#{path_prefix}\/#{filename_matcher}/
+        end
+
+        def filename(base)
+          "#{base}.#{file_extension}"
+        end
+
+      end
+    end
+  end
+end

data/lib/shutterbug/handlers/file_handlers/html_file.rb

@@ -0,0 +1,22 @@
+module Shutterbug
+  module Handlers
+    module FileHandlers
+      class HtmlFile < Base
+
+        def file_extension
+          "html"
+        end
+
+        def mime_type
+          "text/html"
+        end
+
+        def handle(helper, req, env)
+          sha  = regex.match(req.path)[1]
+          file = @config.storage.new(filename(sha),self)
+          helper.good_response(file.get_content, self.mime_type)
+        end
+      end
+    end
+  end
+end

data/lib/shutterbug/handlers/file_handlers/png_file.rb

@@ -0,0 +1,23 @@
+module Shutterbug
+  module Handlers
+    module FileHandlers
+      class PngFile < Base
+
+        def file_extension
+          "png"
+        end
+
+        def mime_type
+          "image/png"
+        end
+
+        def handle(helper, req, env)
+          local_filename  = regex.match(req.path)[1]
+          file = @config.storage.new(local_filename,self)
+          helper.good_response(file.get_content, self.mime_type)
+        end
+      end
+    end
+  end
+
+end

data/lib/shutterbug/handlers/js_file_handler.rb

@@ -0,0 +1,27 @@
+module Shutterbug
+  module Handlers
+    class JsFileHandler
+
+      def self.js_path
+        "#{Configuration.instance.url_prefix}/shutterbug.js"
+      end
+
+      def regex
+        /#{@config.path_prefix}\/shutterbug.js/
+      end
+
+      def js_file
+        File.join(File.dirname(__FILE__),"shutterbug.js")
+      end
+
+      def initialize(_config=Configuration.instance())
+        @config = _config
+        @javascript = File.read(js_file).gsub(/CONVERT_PATH/,@config.convert_path)
+      end
+
+      def handle(helper, req, env)
+        helper.good_response(@javascript, 'application/javascript')
+      end
+    end
+  end
+end

data/lib/shutterbug/{shutterbug.js → handlers/shutterbug.js}

@@ -1,5 +1,6 @@
 /*global $ */
 (function(){
+  var $ = window.$;
 
   var getBaseUrl = function() {
     var base = window.location.href;
@@ -72,17 +73,31 @@
       }
     }
     var self = this;
+    var time = 0;
+    var counter = $("<span>");
+    counter.html(time);
+
+    $(self.imgDst).html("creating snapshot: ").append(counter);
+    var timer = setInterval(function(t) {
+      time = time + 1;
+      counter.html(time);
+    }, 1000);
+
     $.ajax({
       url: "CONVERT_PATH",
       type: "POST",
       data: html
-    }).done(function(msg) {
+    }).success(function(msg) {
       if(self.imgDst) {
         $(self.imgDst).html(msg);
       }
       if (self.callback) {
         self.callback(msg);
       }
+      clearInterval(timer);
+    }).fail(function(e) {
+      $(self.imgDst).html("snapshot failed");
+      clearInterval(timer);
     });
   };
 
@@ -95,7 +110,16 @@
     destination.postMessage(JSON.stringify(message),"*");
   };
 
-  window.Shutterbug = function(selector,imgDst,callback,id) {
+  window.Shutterbug = function(selector,imgDst,callback,id,jQuery) {
+    if (typeof(jQuery) != "undefined" && jQuery != null) {
+      $ = jQuery;
+    }
+    // If we still don't have a valid jQuery, try setting it from the global jQuery default.
+    // This can happen if shutterbug.js is included before jquery.js
+    if ((typeof($) == "undefined" || $ == null) && typeof(window.$) != "undefined" && window.$ != null) {
+      $ = window.$;
+    }
+
     var shutterbugInstance = {
       element: selector,
       imgDst: imgDst,
@@ -150,5 +174,4 @@
     });
     return shutterbugInstance;
   };
-
 })();

data/lib/shutterbug/phantom_job.rb

@@ -5,7 +5,7 @@ module Shutterbug
     attr_accessor :html_file
 
     def program
-      Configuration.instance.phantom_bin_path
+      @config.phantom_bin_path
     end
 
     def rasterize_js
@@ -18,10 +18,11 @@ module Shutterbug
       @css      = css
       @width    = width
       @height   = height
+      @config   = Configuration.instance
     end
 
     def cache_key
-      return @key || @key = Digest::SHA1.hexdigest("#{@html}#{@css}#{@base_url}")[0..10]
+      @cache_key ||= Digest::SHA1.hexdigest("#{@html}#{@css}#{@base_url}")[0..10]
     end
 
     def document
@@ -42,29 +43,33 @@ module Shutterbug
       """
     end
 
-    def base_path
-      Configuration.instance.resource_dir
+    def html_file_name
+      "#{cache_key}.html"
     end
 
-    def infilename
-      File.join(base_path,"phantom_#{cache_key}.html")
+    def png_file_name
+      "#{cache_key}.png"
     end
 
-    def outfilename
-      File.join(base_path,"phantom_#{cache_key}.png")
+    def input_path
+      @config.fs_path_for(html_file_name)
+    end
+
+    def output_path
+      @config.fs_path_for(png_file_name)
     end
 
     def rasterize_cl
-      %x[#{self.program} #{self.rasterize_js} #{self.infilename} #{self.outfilename} #{@width}*#{@height}]
+      %x[#{self.program} #{self.rasterize_js} #{self.input_path} #{self.output_path} #{@width}*#{@height}]
     end
 
     def rasterize
-      File.open(infilename, 'w') do |f|
+      File.open(input_path, 'w') do |f|
         f.write(document)
       end
       rasterize_cl()
-      self.png_file  = PngFile.new(outfilename)
-      self.html_file = HtmlFile.new(infilename)
+      self.png_file  = @config.storage.new(png_file_name, Shutterbug::Handlers::FileHandlers::PngFile.new)
+      self.html_file = @config.storage.new(html_file_name,  Shutterbug::Handlers::FileHandlers::HtmlFile.new)
     end
   end
 end