highcharts-rails 3.0.1 → 3.0.1.5.pre1

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 3.0.1.5 / unreleased
+
+* Add a Rack endpoint for exporting charts to image files
+
 # 3.0.1 / 2013-04-09
 
 * Updated Highcharts to 3.0.1

data/README.markdown

@@ -45,6 +45,54 @@ Or one of the themes
 
 Other than that, refer to the [Highcharts documentation](http://highcharts.com/documentation/how-to-use)
 
+## Export endpoint
+
+This gem contains a Rack endpoint for converting the chart to a downloadable file.
+It is not required by default, so to use it, `require
+'highcharts/export_endpoint'`
+
+The endpoint is basically a port of the [PHP version made available](https://github.com/highslide-software/highcharts.com/blob/master/exporting-server/php/php-batik/index.php).
+It currently needs a lot of cleanup, but it is working fine for me. Your milage
+may vary.
+
+It uses [Apache Batik](http://xmlgraphics.apache.org/batik/) for the conversion, which must be
+installed separately, as well as a Java Runtime Environment.
+
+It expects to find a JRE in `/usr/bin/java`, and Batik in
+`/usr/share/java/batik-rasterizer.jar`, but both paths are configurable.
+
+Example usage in Rails:
+
+    # config/routes.rb
+    require 'highcharts/export_endpoint'
+
+    MyRailsApp::Application.routes.draw do
+      ...
+      mount Highcharts::ExportEndpoint.new({
+        java_path: "/usr/bin/java",
+        batik: "/usr/share/java/batik-rasterizer.jar"
+      }), at: "highcharts-export"
+      ...
+    end
+
+    # When rendering the chart
+    new Highcharts.Chart({
+      ...
+      exporting: {
+        url: "/highcharts-export",
+        ...
+      }
+    })
+
+### Cocaine
+
+The exporting endpoint uses [Cocaine](https://github.com/thoughtbot/cocaine) for
+handling the command lines and arguments and so on.
+
+I don't know a way to get optional dependencies in the gemspec, so for now
+that gets added whether you want it or not. I'd like to get this fixed,
+but would also like to avoid `begin; require 'cocaine'; rescue LoadError; ...; end` and similar hacks.
+
 ## Licensing
 
 Highcharts, which makes up the majority of this gem, has [its own, separate licensing](http://highcharts.com/license).

data/highcharts-rails.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "railties", ">= 3.1"
+  s.add_dependency "cocaine",  "~> 0.4.0"
   s.add_development_dependency "bundler", "~> 1.0"
   s.add_development_dependency "rails",   ">= 3.1"
 end

data/lib/highcharts-rails.rb

@@ -1,2 +1,2 @@
 require 'highcharts/version'
-require 'highcharts/rails'
+require 'highcharts/rails'

data/lib/highcharts/export_endpoint.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+require 'cocaine'
+
+module Highcharts
+  class ExportEndpoint
+    class InsecureSVGError      < ArgumentError; end
+    class MissingLibrary        < RuntimeError; end
+    class FailedToGenerateChart < RuntimeError; end
+    class InvalidType           < ArgumentError; end
+
+    attr_reader :output, :options
+
+    def initialize(options = {})
+      @options = default_options.merge(options)
+    end
+
+    def default_options
+      {
+        java_path: "/usr/bin/java",
+        batik: "/usr/share/java/batik-rasterizer.jar",
+      }
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      with_rescues do
+        raise MissingLibrary.new("Could not find batik-rasterizer.jar in #{options[:batik].inspect}") unless File.exists?(options[:batik].to_s)
+
+        request = Rack::Request.new(env)
+
+        filename = request.params["filename"].to_s
+        filename  = "chart" if filename.blank? || filename !~ /\A[A-Za-z0-9\-_ ]+\Z/
+
+        type     = request.params["type"].to_s
+        width    = request.params["width"].to_i
+        svg      = request.params["svg"].to_s
+
+        raise InsecureSVGError.new if svg.index("<!ENTITY") || svg.index("<!DOCTYPE")
+
+        if type == "image/svg+xml"
+          # We were sent SVG from the client, so can just render that back
+          return [200, {
+            'Content-Disposition' => "attachment; filename=\"#{filename}.svg\"",
+            'Content-Type'        => 'image/svg+xml'
+          }, [svg]]
+        end
+
+        width     = width > 0 ? width.to_s : "600"
+        extension = case type
+                    when "image/png"       then "png"
+                    when "image/jpeg"      then "jpg"
+                    when "application/pdf" then "pdf"
+                    when "image/svg+xml"   then "svg"
+                    else raise InvalidType.new("#{type} is not a valid type.")
+                    end
+
+        input     = write_svg_to_file(svg)
+        @output   = create_output_file(extension)
+
+        command.run(batik: options[:batik], outfile: output.path, type: type, width: width, infile: input.path)
+        input.close
+        content_length = output.size
+        output.rewind
+
+        raise FailedToGenerateChart.new("Nothing written to file") if !File.exists?(output.path) || content_length < 10
+
+        Rack::Response.new(self, 200, {
+          'Content-Disposition' => "attachment; filename=\"#{filename}.#{extension}\"",
+          'Content-Type'        => type
+        }).finish
+      end
+    end
+
+    # Pass the block along to the output file, and
+    # make sure to close the file afterwards
+    def each(&block)
+      output.each(&block)
+    ensure
+      output.close
+    end
+
+    def command
+      Cocaine::CommandLine.new(options[:java_path], "-jar :batik -m :type -d :outfile -w :width :infile")
+    end
+
+    def write_svg_to_file(contents)
+      file = ::Tempfile.new(["highcharts-input", ".svg"], Dir.tmpdir, encoding: 'utf-8')
+      file.puts contents
+      file.flush
+      file
+    end
+
+    def create_output_file(extension)
+      file = ::Tempfile.new(["highcharts-chart", ".#{extension}"])
+      file.binmode
+      file
+    end
+
+    def with_rescues
+      yield
+    rescue Highcharts::ExportEndpoint::InsecureSVGError => e
+      [400, {'Content-Type' => 'text/plain'}, ["The posted SVG could contain code for a malicious attack"]]
+    rescue Highcharts::ExportEndpoint::InvalidType => e
+      [400, {'Content-Type' => 'text/plain'}, [e]]
+    rescue Cocaine::CommandNotFoundError => e
+      [503, {'Content-Type' => 'text/plain'}, ["Unable to find required binary. #{e}"]]
+    rescue Highcharts::ExportEndpoint::MissingLibrary => e
+      [503, {'Content-Type' => 'text/plain'}, ["Unable to find required library. #{e}"]]
+    rescue Highcharts::ExportEndpoint::FailedToGenerateChart => e
+      [500, {'Content-Type' => 'text/plain'}, ["Failed to generate chart. More details may be available in the server logs."]]
+    rescue => e
+      [500, {'Content-Type' => 'text/plain'}, ["Something went wrong. More details may be available in the server logs."]]
+    end
+
+    def error(code, message)
+      [code, {}, [message].flatten]
+    end
+  end
+end

data/lib/highcharts/version.rb

@@ -1,3 +1,3 @@
 module Highcharts
-  VERSION = "3.0.1"
+  VERSION = "3.0.1.5.pre1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: highcharts-rails
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 3.0.1
+  prerelease: 8
+  version: 3.0.1.5.pre1
 platform: ruby
 authors:
 - Per Christian B. Viken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   type: :development
@@ -91,6 +107,7 @@ files:
 - app/assets/javascripts/highcharts/themes/skies.js
 - highcharts-rails.gemspec
 - lib/highcharts-rails.rb
+- lib/highcharts/export_endpoint.rb
 - lib/highcharts/rails.rb
 - lib/highcharts/version.rb
 homepage: http://northblue.org/
@@ -108,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -118,3 +135,4 @@ signing_key:
 specification_version: 3
 summary: Gem for easily adding Highcharts to the Rails Asset Pipeline
 test_files: []
+has_rdoc: 

data.tar.gz.asc

@@ -1,18 +0,0 @@
------BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
-Comment: GPGTools - http://gpgtools.org
-
-iQIcBAABAgAGBQJRZCX4AAoJEH1ncb0Txu7XWUgQAKSwMYAj6ECNovM5FQnW9Xrs
-84xcCzwhur/YD5/jOVxl85tTVmboBRdVPp53CmsuquGYUMRrrXRobt6C6/hMp4DP
-imZ72AL1ZjYjFPCjHXuJzVXsiwGKLE7SdhGo01l3+69rhGwurpA3fZ9d1DaO+YZ6
-BlwHypnXlQGOPapB7Eh2V/U5UbZi3V1kLTlUaJyUu914p99Jo6MutHobM7aShMOx
-hdqn+ZqN0ha2ourKFk+wJKWTMKe4jvlp9SDrOLe9JY+AJ9zfCns+QFwFJQaC6+VE
-DlxQVt33q2nl+W7DdQr23kBM9/Vr9tQzNPE4E17NvGGZBwTZGxPSwPVzoO1ajRVH
-MwzbcKrqo1AkRDY5th1Hf2WAyruQ62DlbHF/5luJo1ezsuakus74/JWIo36BXKdp
-R20yR4hnQflxGj9BwOUZ5oroG4+PvIBHEfy9no7R600u5Q/RzCj+C3MCekYTMyKV
-KurzDyFfanNU1RNVkV2rJAAB2373cCZRiORqi7HNfdjkzzJiuFCTIWNkEo2eLPx4
-KlCZL5czNj1fgiEZclMGqv7Le5RXR3SuQXzxTw/cpEbvy5Zwm1zUGWankUQb+TEg
-7hP/wQD5E8zJ/ZYbYjXCnS2K8e59+EOc5DcGpaPT9ELSmaCDlG3AvNnKuFS3g+nj
-pm1NAKtYl8Y62Yf35hba
-=qJvF
------END PGP SIGNATURE-----

metadata.gz.asc

@@ -1,18 +0,0 @@
------BEGIN PGP SIGNATURE-----
-Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
-Comment: GPGTools - http://gpgtools.org
-
-iQIbBAABAgAGBQJRZCX4AAoJEH1ncb0Txu7X/t4P9R5ENkevewpnG4BmYF2THRJd
-bws9bcN4bPeSYpceQBphAnFEVQfL+QAXzTweHHw5nk/mGg1iPl18ySyWWeWdSq+G
-bbjIAqcG9IdeX/ItzzWXn47WvXhjsu7s6LZ3vP57Y7q0+AcHW45Tl90p1XYSFI3D
-1Cx1lh6ljZ7JtsNe8j3lnxHq/gL29RA+f4u+k8u+jdas69I+dpcc5EiuI+9C2AnB
-usTAafb8Q7lVwsiv9Mkgufai5c3J9LkSZOjLF8GhoXSVE/xybAFpFs4SzyoGKm6K
-C/xXtZV+78/sv5WUm1UK//T/9LXO0jebYiE5/WZgJZDnt/zDVJDYU5Nmsr9IF1ty
-QYRHUO3iMZODpDyeRxKDEL1DMYoKrZJbvZqbJx+0FmYSfvxqcyX0cKoIFYOLhZUo
-rxWKoEw3otoWiJhKJPC6A+CkYS3NxOjHjixhRs6T59Dxo5Hb5dYO9cF823feCIGU
-ge/FlB4wBTJeFrSSMTjl/ABU5Vrdfx2/Ng5e/nyAwFaki8p4n8CRNnfYvsJ8SvQC
-8jAspjcyeiXzQx27ujgny45NTYNMkfrl01OLHsRjVaXnTw97z8+96QQaCV/5M0tA
-ZZtWxDI2BTWXIkzBp0BzyAq1utDiS++CE/p3nEhlDGRMwj49iAg3JD3mfS0/OfmB
-cHbhD6RW3WPUEGUKW4M=
-=LkjG
------END PGP SIGNATURE-----