too_rendermonkey 0.3.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"   
+gem "rest-client", "~> 1.6.1"  
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "rails", "~> 3.0.3"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.4)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (1.0.1)
+      rake (>= 0.8.7)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.10)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
+    thor (0.14.4)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rails (~> 3.0.3)
+  rcov
+  rest-client (~> 1.6.1)
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# TooRendermonkey
+
+## PDF template generation plugin for Ruby on Rails 
+
+### Master tracks Rails 3. Branch Rails 2 tracks >= Rails 2.3.5
+
+This plugin allows the generation of pdf files from controllers using the pdf mime type. This plugin will not generate a pdf but will render the pages specified for the pdf format with the extension .pdf.erb as html and forward the request on to the RendermonkeyToo API which will generate this page as a PDF. This is useful for having a separate server generate PDF files from your Ruby on Rails application. This allows for custom PDF files to be generated for the specified page.
+
+### Installation as gem
+	gem install too_rendermonkey
+	rails generate too_rendermonkey  
+	
+### Installation as plugin
+    rails plugin install git://github.com/amkirwan/too_rendermonkey.git
+    rails generate too_rendermonkey
+    
+    #In your Rails project Gemfile add
+    gem 'too_rendermonkey', :path=>'vendor/plugins/too_rendermonkey'
+    
+
+Generate will install a file in config/initializers/too_rendermonkey.rb. The following params must be specified in this file to generate PDFs using the RendermonkeyToo API.
+
+* URI of the RendermonkeyToo instance which is running
+* api_key given from the RendermonkeyToo API
+* hash_key (secret key) given from the RendermonkeyToo API. This key is used to hash all the params sent to the RendermonkeyToo API when generating a PDF. Keep this key secure. 
+
+
+### Example
+                                            
+Setup the Rails initializer config/initializers/too_rendermonkey.rb after running script/generate too_rendermonkey. Use your API info from RendermonkeyToo to configure. Make sure to keep the hash_key secure. Anytime you edit this file you will need to restart the server.
+
+	TooRendermonkey.config = {
+  		:uri => "http://localhost:4567/generate",
+  		:api_key => "abcdefg",
+  		:hash_key => "abcdefg123456789"
+	}
+
+In your controller within the action that you want to generate a PDF you would need to specify the following
+*render :pdf, :pdf_template and :pdf_layout need to be specified*
+
+    class ExampleController < ApplicationController
+        def show
+            respond_to do |format|
+                format.html #index.html.erb
+                format.pdf  do
+				   render :pdf  => "Phone List",
+						  :pdf_layout => "reports.pdf.erb",
+						  :pdf_template => "reports/phone_list.pdf.erb",
+						  :render_options => {
+							:header_right => 'Page [page] of [toPage]',
+							:grayscale => true
+						  }
+                end
+            end
+        end
+    end
+
+In your view code you can specify the PDF path like in the example below. This will generate a PDF request.
+	<div>
+		<ul>
+			<li class="reports">Department Phone List</li>
+			<li class="reports-type"><%= link_to "Web", phone_list_reports_path %></li>
+			<li class="reports-type"><%= link_to "PDF", phone_list_reports_path(:pdf) %></li>
+		</ul>
+	</div>
+	
+For the PDF templates you will need to include the css within the document so that it can be formatted correctly since the document is being sent to a server to be generated. 
+
+Use the RendermonkeyToo helper *stylesheet_tag_pdf* within your pdf_layout to accomplish this. Specify the name of the pdf file and it will automatically read in your css into the document.
+
+	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+		<head>
+			<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+			<%= stylesheet_tag_pdf "reports_pdf" %>
+		</head>
+		
+The pdf_template can have links to partial .html.erb files so you do not need to duplicate all your pages. You must however add in a .html extension to any partials you are includeing.
+
+	<div class="list-wrap">
+		<%= render(:partial => "col_one_subheading.html", :object => "Faculty") %>
+		<div class="section-wrap">
+			<%= render(:partial => "report_column_one.html", :object => @all_faculty_column_one)  %>
+			<%= render(:partial => "report_column_two.html", :object => @all_faculty_column_two)  %>
+			<%= render(:partial => "report_column_three.html", :object => @all_faculty_column_three)  %>
+		</div>
+	</div>
+	
+### Plugin Params - Troubleshooting
+
+When generating a request the plugin sends the following params to the TooRendermonkey API
+
+* api_key (your api_key)
+* timestamp (Time request generated, iso8601)
+* page - (HTML to render to PDF)
+* name - (Name of PDF file) Only Param that is optional
+* signature - (SHA256 HMAC generated using your hash_key plus all the params of the current request )
+
+If the request generated takes longer than 5 minutes to arrive at the Rendermonkey API server it will be rejected. This is to prevent someone from attempting to replay your request.
+
+All of this will be handled for you by the plugin. If there are any errors with your params the Rendermonkey API will respond with a message stating the reason for failure.
+
+
+
+Copyright (c) 2010 [Anthony Kirwan], released under the MIT license

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "too_rendermonkey"
+  gem.homepage = "http://github.com/amkirwan/too_rendermonkey"
+  gem.license = "MIT"
+  gem.summary = %Q{Forward HTML renderer to RendemonkeyToo server}
+  gem.email = "amkirwan@gmail.com"
+  gem.authors = ["Anthony Kirwan"] 
+  gem.description = %Q{This plugin allows the generation of pdf files from controllers using the pdf mime type. 
+  This plugin will not generate a pdf but will render the pages specified for the pdf format 
+  with the extension .pdf.erb as html and forward the request on to the RendermonkeyToo API 
+  which will generate this page as a PDF. This is useful for having a separate server generate 
+  PDF files from your Ruby on Rails application. This allows for custom PDF files to be generated 
+  for the specified page.}
+  gem.add_runtime_dependency 'rest-client', '~> 1.6.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "too_rendermonkey #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/generators/too_rendermonkey/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a initializer to specify the api_key and hash_key(secret key) to generate PDF requests on the rendermonkey_too server.
+
+Example:
+    rails generate too_rendermonkey 
+
+    This will create:
+        config/initializers/too_rendermonkey.rb

data/lib/generators/too_rendermonkey/templates/too_rendermonkey.rb

@@ -0,0 +1,8 @@
+# You probably do not want to keep this in your repo when using the secret_key
+
+## Generator Path
+TooRendermonkey.configure = {
+  #:uri => "https://rendermonkey-too.heroku.com/generate",
+  #:api_key => "example1234example",
+  #:hash_key => "example1234example"
+}

data/lib/generators/too_rendermonkey/too_rendermonkey_generator.rb

@@ -0,0 +1,11 @@
+class TooRendermonkeyGenerator < Rails::Generators::Base  
+  
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end   
+  
+  def copy_config_files
+    copy_file("too_rendermonkey.rb", "config/initializers/too_rendermonkey.rb")
+  end
+
+end

data/lib/too_rendermonkey.rb

@@ -0,0 +1,7 @@
+module TooRendermonkey
+  require 'too_rendermonkey/railtie' if defined?(Rails)  
+  
+  class << self
+    attr_accessor :configure
+  end
+end

data/lib/too_rendermonkey/exceptions.rb

@@ -0,0 +1,6 @@
+module TooRendermonkey
+  
+  class ConfigureError < StandardError 
+  end  
+
+end

data/lib/too_rendermonkey/pdf_generator.rb

@@ -0,0 +1,76 @@
+require 'openssl'
+require 'digest/sha2'
+require 'base64'
+require 'time'  
+require 'rest-client'
+require 'exceptions'
+
+module PDFGenerator    
+  
+  attr_reader :pdf_params
+  
+  def make_pdf_erb(pdf_name, options = {})  
+    check_configure   
+    options[:pdf_layout] ||= false
+    options[:pdf_template] ||= File.join(controller_path, action_name)
+    page = render_to_string(:template => options[:pdf_template], :layout => options[:pdf_layout])
+    params = generate_params(pdf_name, options, page)     
+    begin
+      response = RestClient.post TooRendermonkey.configure[:uri], params
+      send_data response, :type => 'application/pdf', :disposition => "#{response.headers[:content_disposition]}"
+    rescue => e     
+      logger.info '*'*15 + "ERROR GENERATING PDF: #{e.http_body}" + '*'*15 
+      render :file => "public/500.html", :status => 500
+    end
+  end 
+  
+  def check_configure 
+    keys = %w(uri api_key hash_key)     
+    keys.each do |key|
+       raise TooRendermonkey::ConfigureError, "Configure Error: #{key.to_s}" unless TooRendermonkey.configure.has_key?(key.to_sym)
+    end   
+  end
+
+  def generate_params(pdf_name, options, page)
+    @pdf_params = { "name" => pdf_name,
+                    "page" => page,
+                    "api_key" => TooRendermonkey.configure[:api_key],
+                    "timestamp" => Time.now.utc.iso8601 }
+    process_render_options(options)
+    @pdf_params["signature"] = generate_signature(@pdf_params)
+    @pdf_params
+  end    
+
+  def process_render_options(options) 
+    if !options[:render_options].nil? && !options[:render_options].empty?
+      options[:render_options].each do |key, value|
+        @pdf_params[key.to_s] = value.to_s
+      end
+    end
+  end
+
+  def generate_signature(params)
+    c_q = canonical_querystring(params)
+
+    if TooRendermonkey.configure[:hash_key].size == 44
+  		#logger.info '*'*10 + "Using SHA256"
+  		hashtype = 'SHA256'
+  	elsif TooRendermonkey.configure[:hash_key].size == 89
+  		#logger.info '*'*10 + "Using SHA512"
+  		hashtype = 'SHA512'		
+  	elsif  TooRendermonkey.configure[:hash_key].size == 28
+  		#logger.info '*'*10 + "Using SHA1"
+  		hashtype = 'SHA1'		
+  	else 
+  		raise TooRendermonkey::ConfigureError, "Could not match has_key type"
+  	end
+
+    digest = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new(hashtype), TooRendermonkey.configure[:hash_key], c_q)
+    Base64.encode64(digest).chomp 
+  end
+
+  def canonical_querystring(params)
+    params.sort.collect do |key, value| [key.to_s, value.to_s].join('=') end.join('&')
+  end  
+  
+end

data/lib/too_rendermonkey/railtie.rb

@@ -0,0 +1,31 @@
+require 'too_rendermonkey'
+require 'logger'
+ 
+$:.unshift File.join(File.dirname(__FILE__)) 
+require "pdf_generator"
+require "too_rendermonkey_css"
+
+
+module Rails  
+  module TooRendermonkey 
+    class Railtie < ::Rails::Railtie             
+      initializer "add pdf renderer" do         
+        ActionController::Renderers.add :pdf do |pdf_name, options| 
+          begin     
+            make_pdf_erb(pdf_name, options)
+          rescue => e
+            logger.info e.message
+            render :file => "public/500.html", :status => 500
+          end
+        end  
+        Mime::Type.register 'application/pdf', :pdf 
+      end  
+
+      config.to_prepare do    
+        ActionController::Base.send :include, PDFGenerator
+        ActionView::Base.send :include, TooRendermonkeyCss
+      end 
+      
+    end  
+  end
+end