shutterbug 0.2.1 → 0.2.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjVmZDdiYjY0NmUzYzc1YzNlN2QwMGI5MmEwOTk1MzNjNWZkNjM2NA==
+  data.tar.gz: !binary |-
+    N2I1N2ZlYzM5ZjAzOGNkMTA2ZGY4ZTE0N2VlYTQ3NmUyNjUzMzk5MQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmNjZWJlMmI1ZTI1OWJkMzc5MWVhZjhiZWQxYTk0MjNlMTIzNWMzYjk5YzI2
+    ZDdkOTExNmQ0NzBkYzFkN2UxOWY4MTAxNTJmMjY3YTc0OWZkNGUzOWYwMDY5
+    NTY5Zjc4YmUzNTEzZjllZmE2NDE1YTFmZjllNTllMTc0YmYzY2I=
+  data.tar.gz: !binary |-
+    M2E0OTFkZTlkN2ZmNmU1NjdiZjlmYzY5ZjE4YmI0NjRmYzQ2ZDU4MjgyMWQ4
+    ZDhjY2QzNmMxNjM0YjVjMzc1M2MzMWYzNDA1NjUwODdhZGQyNGE2NzM4YTg5
+    YmZkZmI3MWQwYTQyODgxOTYyNmRiMGU5Yzc0YTVjNTQwYTMzMTQ=

data/README.md

@@ -6,6 +6,22 @@
 
 ## Overview ##
 
+Shutterbug has two parts: a browser javascript library for taking html snapshots, and a server side utility for turning those html snapshots into images.
+
+### Browser Javascript library
+
+By itself `shutterbug.js` is useful for authors of iframe'able content. With `shutterbug.js` on the iframe'd page, the parent window can request an html snapshot even if the iframe'd page is on a different domain. To enable this functionality you need to add the following lines to your iframe'able page:
+
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.1/jquery.min.js"></script>
+    <script src="shutterbug.js"></script>
+    <script>new Shutterbug('body');</script>
+
+The `shutterbug.js` file is located in this repository: `lib/shutterbug/handlers/shutterbug.js`
+
+`shutterbug.js` also includes the API to talk to the server side utility to generate a image of the html snapshot. See the [Usage section](#usage) below for information.
+
+### Server Side Utility
+
 A rack utility using phantomjs 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. Here is a sample config.ru file:
 
 
@@ -69,6 +85,12 @@ This will replace the contents of `$("#outselector")` with an `<img src="http://
 
 ## Advanced usage
 
+You can specify a failure callback on your shutterbug object. This callback will be invoked when the server response was not 200:
+
+      var shutterbug = new Shutterbug('#sourceselector', '#outselector',optCallbackFn, optIdentifier);
+      shutterbug.setFailureCallback(function(jqXHR, textStatus, errorThrown) {
+        alert("Something went wrong: " + textStatus);
+      });
 
 ### IFrame support
 
@@ -129,7 +151,7 @@ Your app should have a config.ru that looks something like this:
     use Rack::Cors do
       allow do
         origins '*'
-        resource '/shutterbug/*', :headers => :any, :methods => :any
+        resource '/shutterbug/*'', :headers => :any, :methods => [:get, :post, :options]
       end
     end
 
@@ -155,6 +177,11 @@ And a Procfile which looks like this:
 
     web: bundle exec rackup config.ru -p $PORT
 
+## Changes ##
+
+*  November 12, 2014 – v 0.2.5
+    *  Added setFailureCallback to shutterbug.js for gracefully handling ajax failures in some custom way.
+    *  Updated CORS configuration in config.ru to allow [:options] requests.
 
 
 ## TODO: ##

data/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "shutterbug",
-  "version": "0.1.3",
+  "version": "0.2.5",
   "homepage": "https://github.com/concord-consortium/shutterbug",
   "authors": [
     "Noah Paessel <npaessel@concord.org>"

data/config.ru

@@ -4,7 +4,7 @@ require 'rack/cors'
 use Rack::Cors do
   allow do
     origins '*'
-    resource '/shutterbug/*', :headers => :any, :methods => :any
+     resource '*', :headers => :any, :methods => [:get, :post, :options]
   end
 end
 

data/lib/shutterbug.rb

@@ -1,5 +1,5 @@
 module Shutterbug
-  VERSION = "0.2.1"
+  VERSION = "0.2.5"
   autoload :Rackapp,        "shutterbug/rackapp"
   autoload :Configuration,  "shutterbug/configuration"
   autoload :Storage,        "shutterbug/storage"

data/lib/shutterbug/handlers/shutterbug.js

@@ -9,6 +9,11 @@
     return base;
   };
 
+  var _useIframeSizeHack = false;
+  var useIframeSizeHack = function(b) {
+    _useIframeSizeHack = b;
+  };
+
   var cloneDomItem = function(elem, elemTag) {
     var width   = elem.width();
     var height  = elem.height();
@@ -22,18 +27,17 @@
     return returnElm;
   };
 
-  var generateIFrameSrcData = function (iframeDesc) {
-    return "data:text/html," +
-      "<!DOCTYPE html>" +
+  var generateFullHtmlFromFragment = function (fragment) {
+    return "<!DOCTYPE html>" +
       "<html>" +
         "<head>" +
-          "<base href='" + iframeDesc.base_url + "'>" +
+          "<base href='" + fragment.base_url + "'>" +
           "<meta content='text/html;charset=utf-8' http-equiv='Content-Type'>" +
-          "<title>content from " + iframeDesc.base_url + "</title>" +
-          iframeDesc.css +
+          "<title>content from " + fragment.base_url + "</title>" +
+          fragment.css +
         "</head>" +
         "<body>" +
-          iframeDesc.content +
+          fragment.content +
         "</body>" +
       "</html>";
   };
@@ -80,6 +84,10 @@
       var height  = $element.height();
       var element = $element.clone();
 
+      // remove all script elements from the clone we don't want the html fragement
+      // changing itself
+      element.find("script").remove();
+
       if (arguments.length > 0) {
         var nestedIFrames = arguments;
         // This supports two cases:
@@ -89,7 +97,7 @@
           // When iframe doesn't support Shutterbug, request will timeout and null will be received.
           // In such case just ignore this iframe, we won't be able to render it.
           if (nestedIFrames[i] == null) return;
-          $(iframeElem).attr("src", generateIFrameSrcData(nestedIFrames[i]));
+          $(iframeElem).attr("src", "data:text/html," + generateFullHtmlFromFragment(nestedIFrames[i]));
         });
       }
 
@@ -106,7 +114,7 @@
         $(elm).replaceWith(replacementImgs[i]);
         backgroundDiv.insertBefore($(elm));
       });
-   
+
       element.css({
         'top':0,
         'left':0,
@@ -115,6 +123,12 @@
         'height':height
       });
 
+      // Due to a weird layout bug in PhantomJS, inner iframes sometimes don't render
+      // unless we set the width small. This doesn't affect the actual output at all.
+      if (_useIframeSizeHack) {
+        width = 10;
+      }
+
       var html_content = {
         content: $('<div>').append(element).html(),
         css: css,
@@ -154,8 +168,11 @@
           self.callback(msg);
         }
         clearInterval(timer);
-      }).fail(function(e) {
+      }).fail(function(jqXHR, textStatus, errorThrown) {
         $(self.imgDst).html("snapshot failed");
+        if (self.failCallback) {
+          self.failCallback(jqXHR, textStatus, errorThrown);
+        }
         clearInterval(timer);
       });
     });
@@ -170,6 +187,38 @@
     destination.postMessage(JSON.stringify(message), "*");
   };
 
+  var htmlSnap = function() {
+    this.getHtmlFragment(function callback(fragment){
+      // FIXME btoa is not intended to encode text it is for for 8bit per char strings
+      // so if you send it a UTF8 string with a special char in it, it will fail
+      // this SO has a note about handling this:
+      // http://stackoverflow.com/questions/246801/how-can-you-encode-a-string-to-base64-in-javascript
+      // also note that btoa is only available in IE10+
+      var encodedContent = btoa(generateFullHtmlFromFragment(fragment));
+      window.open("data:text/html;base64," + encodedContent);
+    });
+  };
+
+  var imageSnap = function() {
+    var oldImgDst = this.imgDst,
+        oldCallback = this.callback,
+        self = this;
+    this.imgDst = null;
+    this.callback = function (msg){
+      // extract the url out of the returned html fragment
+      var imgUrl = msg.match(/src='([^']*)'/)[1]
+      window.open(imgUrl);
+      self.imgDst = oldImgDst;
+      self.callback = oldCallback;
+    }
+    this.getDomSnapshot();
+  };
+
+  var setFailureCallback = function(failCallback) {
+    this.failCallback = failCallback;
+  };
+
+  // TODO: Construct using opts instead of positional arguments.
   window.Shutterbug = function(selector, imgDst, callback, id, jQuery) {
     if (typeof(jQuery) != "undefined" && jQuery != null) {
       $ = jQuery;
@@ -188,7 +237,11 @@
       getDomSnapshot: getDomSnapshot,
       getHtmlFragment: getHtmlFragment,
       requestHtmlFrag: requestHtmlFrag,
-      iframeReqTimeout: MAX_TIMEOUT
+      htmlSnap: htmlSnap,
+      imageSnap: imageSnap,
+      useIframeSizeHack: useIframeSizeHack,
+      iframeReqTimeout: MAX_TIMEOUT,
+      setFailureCallback: setFailureCallback
     };
 
     var handleMessage = function(message, signature, func) {

data/lib/shutterbug/phantom_job.rb

@@ -60,7 +60,7 @@ module Shutterbug
     end
 
     def rasterize_cl
-      %x[#{self.program} #{self.rasterize_js} #{self.input_path} #{self.output_path} #{@width}*#{@height}]
+      %x[#{self.program} --ignore-ssl-errors=true --ssl-protocol=any #{self.rasterize_js} #{self.input_path} #{self.output_path} #{@width}*#{@height}]
     end
 
     def rasterize
@@ -72,4 +72,4 @@ module Shutterbug
       self.html_file = @config.storage.new(html_file_name,  Shutterbug::Handlers::FileHandlers::HtmlFile.new)
     end
   end
-end
+end

data/shutterbug.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec",  "~> 2.14"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "rack-cors"
   spec.add_development_dependency "guard-rack"

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: shutterbug
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.5
 platform: ruby
 authors:
 - Noah Paessel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,23 +41,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-cors
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -227,33 +208,26 @@ files:
 homepage: http://github.com/concord-consortium/shutterbug
 licenses:
 - MIT, Simplified BSD, Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4021893285741860284
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4021893285741860284
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: use Shutterbug::Rackapp
 test_files:
 - spec/shared_examples_for_file_handlers.rb