too_rendermonkey 0.3.0

data/test/rails_test/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/test/rails_test/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/rails_test/public/stylesheets/reports_pdf.css

@@ -0,0 +1,3 @@
+.bold {
+  font-weight: bold;
+}

data/test/rails_test/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/rails_test/test/functional/pdf_render_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'   
+require 'rest-client'  
+
+class PdfRenderTest < ActionController::TestCase
+
+  def setup
+    @controller = PDFRenderController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new     
+    @filename = "abc" 
+    
+    TooRendermonkey.configure = {
+      :uri => "http://localhost:4567/generate",
+      :api_key => "835a3161dc4e71b",
+      :hash_key => "sQQTe93eWcpV4Gr5HDjKUh8vu2aNDOvn3+suH1Tc4P4="
+    } 
+  end                                           
+  
+  def teardown
+    @controller = nil
+    @request = nil
+    @response = nil
+  end  
+  
+  def request_success
+    stub_request(:post, "http://localhost:4567/generate").to_return(
+                                                          :body => File.open('./test/functional/abc.pdf'),
+                                                          :status => 200, 
+                                                          :headers => { 'Content-Length' => File.open('./test/functional/abc.pdf').size.to_s, 
+                                                                        'Content-Disposition' => "attachment; filename=#{@filename}"})
+  end
+  
+  def request_fail
+    stub_request(:post, "http://localhost:4567/generate").to_return(
+                                                          :status => 412,
+                                                          :body => "Incorrect or missing parameters")
+  end                                                                    
+                                                                        
+  test "should render with pdf format" do 
+    request_success
+    get :render_pdf, :format => :pdf      
+    assert_response :success 
+  end 
+  
+  test "should render with css" do   
+    css_style = '<style type="text/css"> 
+                    .bold { font-weight: bold; } 
+                 </style>'
+    request_success
+    get :render_pdf, :format => :pdf             
+    assert @controller.pdf_params["page"].gsub(/\s+/, "").include?(css_style.gsub(/\s+/, ""))
+  end
+  
+  # Failures 
+  test "should should error message from server on failed request" do  
+    request_fail    
+    begin
+      RestClient.post "http://localhost:4567/generate", {}
+      raise
+    rescue RestClient::PreconditionFailed => e
+      assert_equal e.http_body, "Incorrect or missing parameters"
+    end
+  end
+  
+  test "should render 500 on error" do 
+    request_fail 
+    get :render_pdf, :format => :pdf      
+    assert_response :error 
+  end     
+  
+  test "should render 500 on missing configure key" do  
+    TooRendermonkey.configure.delete(:api_key)  
+    get :render_pdf, :format => :pdf
+    assert_response :error
+  end  
+  
+  test "should render 500 on incorrect hash_key" do  
+    TooRendermonkey.configure[:hash_key] = "abcdefg"  
+    get :render_pdf, :format => :pdf
+    assert_response :error
+  end
+  
+end

data/test/rails_test/test/test_helper.rb

@@ -0,0 +1,15 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help' 
+require 'webmock/test_unit'   
+require 'logger'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...  
+end

data/test/rails_test/test/unit/initializer_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'   
+require 'active_support'      
+
+class InitializerTest < ActiveSupport::TestCase  
+     
+  test "too rendermonkey initialize" do
+    assert_equal 'application/pdf', Mime.const_get(:PDF)
+  end 
+  
+  test "PDFGenerator included in ActionController::Base" do
+    assert ActionController::Base.included_modules.include?(PDFGenerator)
+  end
+  
+  test "TooRendermonkeyCss included in ActionView::Base" do
+    assert ActionView::Base.included_modules.include?(TooRendermonkeyCss)
+  end       
+  
+  test "too_rendermonkey.rb initializer file is loaded" do   
+    assert "Hash", TooRendermonkey.configure.class.to_s
+    assert_equal TooRendermonkey.configure.length, 3
+  end
+  
+end  

data/test/rails_test/test/unit/pdf_generator_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper' 
+
+class PDFGeneratorTest < ActiveSupport::TestCase
+  include PDFGenerator   
+  
+  ## add required tests
+  ## add configure tests
+  
+  def setup     
+    @pdf_name = "pdf name"
+    @options = { :pdf_layout => "reports_layout.pdf.erb", :pdf_template => "reports/report.pdf.erb", 
+                 :render_options =>  {
+                    :header_right => 'Page [page] of [toPage]',
+                    :grayscale => true,
+                    :page_size => 'Letter'} 
+                }  
+    @page = "<html><head><head><body><b>Hello</b> World</body></html>" 
+    
+    TooRendermonkey.configure = {
+      :uri => "http://localhost:4567/generate",
+      :api_key => "835a3161dc4e71b",
+      :hash_key => "sQQTe93eWcpV4Gr5HDjKUh8vu2aNDOvn3+suH1Tc4P4="
+    }    
+  end       
+  
+  test "check configuration has values" do 
+    generate_params(@pdf_name, @options, @page)
+    
+    assert TooRendermonkey.configure[:uri], "Configure has uri"
+    assert TooRendermonkey.configure[:api_key], "Configure has api_key"
+    assert TooRendermonkey.configure[:hash_key], "Configure has hash_key"    
+  end    
+  
+  test "should raise configure error on missing key" do
+    TooRendermonkey.configure.delete(:hash_key)
+    exception = assert_raise(TooRendermonkey::ConfigureError) { check_configure }  
+    assert_match "Configure Error: hash_key", exception.message
+  end
+  
+  test "should generate default params" do
+    pdf_params = generate_params(@pdf_name, @options, @page)   
+    assert_equal @pdf_name, pdf_params["name"]
+    assert_equal @page, pdf_params["page"]  
+    assert_equal TooRendermonkey.configure[:api_key], pdf_params["api_key"]
+    assert_in_delta Time.now.utc, Time.parse(pdf_params["timestamp"]), 300
+    assert_equal 44, pdf_params["signature"].length, 
+  end   
+  
+  test "should process render options" do  
+    pdf_params = generate_params(@pdf_name, @options, @page) 
+    assert_equal 'Page [page] of [toPage]', pdf_params["header_right"]
+    assert_equal "true", pdf_params["grayscale"] 
+    assert_equal "Letter", pdf_params["page_size"]
+  end  
+  
+  test "pdf_params all keys should be strings" do
+    pdf_params = generate_params(@pdf_name, @options, @page)
+    pdf_params.each_key { |key| assert_equal String, key.class, "Key is not a String" }
+  end                                                             
+  
+  test "pdf_params all values should be strings" do
+    pdf_params = generate_params(@pdf_name, @options, @page)
+    pdf_params.each_value { |value| assert_equal String, value.class, "Value is not a String" }
+  end   
+  
+  test "canonical_querystring" do  
+    pdf_params = generate_params(@pdf_name, @options, @page)
+    pdf_params["timestamp"] = "2010-12-07T04:37:59Z"
+    pdf_params.delete("signature")
+    match_string = "api_key=835a3161dc4e71b&grayscale=true&header_right=Page [page] of [toPage]&name=pdf name&page=<html><head><head><body><b>Hello</b> World</body></html>&page_size=Letter&timestamp=2010-12-07T04:37:59Z"
+    assert_equal match_string, canonical_querystring(pdf_params) 
+  end   
+  
+  test "generate signature SHA256" do
+    # returned in base64 
+    assert_equal 44, generate_signature(@options).length
+  end       
+  
+  test "generate signature SHA512" do 
+    # returned in base64    
+    TooRendermonkey.configure[:hash_key] = "sQQTe93eWcpV4Gr5HDjKUh8vu2aNDOvn3+suH1Tc4P4sQQTe93eWcpV4Gr5HDjKUh8vu2aNDOvn3+suH1Tc4P4aa="
+    assert_equal 89, generate_signature(@options).length
+  end
+  
+  test "generate signature SHA1" do
+    # returned in base64
+    TooRendermonkey.configure[:hash_key] = "sQQTe93eWcpV4Gr5HDjKUh8vu2a="
+    assert_equal 28, generate_signature(@options).length
+  end 
+  
+  test "should raise TooRendermonkey::ConfigureError on incorrect hash_key length" do  
+    TooRendermonkey.configure[:hash_key] = "sQQTe93eWcpV4Gr5HDjKUh8vu2aN="
+    exception = assert_raise(TooRendermonkey::ConfigureError) { generate_signature(@options) }  
+    assert_match "Could not match has_key type", exception.message
+  end   
+     
+end

data/test/rails_test/test/unit/too_rendermonkey_css_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class TooRendermonkeyCssTest < ActiveSupport::TestCase 
+  include TooRendermonkeyCss  
+  
+  def setup
+    Rails.logger =Logger.new(STDOUT)
+  end 
+  
+  test "should return css style that is html safe" do
+    css_file = ActionView::Base.new.stylesheet_tag_pdf("reports_pdf")
+    assert lambda {css_file.html_safe?}
+  end   
+  
+  test "should return empty css if it cannot find the file" do
+    css_file = ActionView::Base.new.stylesheet_tag_pdf("does_not_exist.pdf")
+    assert_equal "<style type=\"text/css\"></style>", css_file.to_s 
+    assert lambda {css_file.html_safe?}
+  end
+ 
+end

data/test/rails_test/test/unit/too_rendermonkey_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'  
+
+class TooRendermonkeyTest < ActiveSupport::TestCase   
+  
+  test "should be able to write to configure" do
+    TooRendermonkey.configure = "Foobar"
+    assert TooRendermonkey.configure, "Foobar"
+  end  
+  
+  
+  
+end
+
+
+