svg_export 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29cd48d4c228f1bff9ef0b858af286576259509f
+  data.tar.gz: 76599ab388d1411d9ecbf746caefa2b2661f5c53
+SHA512:
+  metadata.gz: bd97c57721248ff795a323619c81eab75134ee60043d7245b61ab9f3c34170013c1bec233bda6de1a71e697efe9a9983738b2c56717d445faabfd7e7ccc20467
+  data.tar.gz: 0799b34368309f3d4a10dbb18b007fff9374bd17de0a49d1da1f50c52f4c62e3056a586266bd07e515ef0418192c894f4318415ca26ace26402df30de9243281

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Stefan Wienert
+
+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,67 @@
+# Svg-Export Engine for Ruby on Rails
+
+Highcharts compliant svg-rasterizer. To find more about Highcharts Exporting, look [here](http://www.highcharts.com/docs/export-module/export-module-overview)
+
+Features:
+
+* makes relative URLs absolute (with HTTP_REFERER)
+* relative URLs that begins with /assets are locally linked (Performance boost + works in single-threaded server envs)
+
+
+## Installation
+
+
+### 1. install Gem
+
+```ruby
+# Gemfile
+gem 'svg_export'
+```
+
+Run ``bundle``
+
+### 2. mount engine + configure
+
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  #...
+
+  mount SvgExport::Engine => '/exporting'
+end
+```
+
+### 3. Download or install Apache Batik
+
+This project needs Apache Batik installed on the system.
+
+Quick install:
+
+```
+cd bin
+wget http://ftp.halifax.rwth-aachen.de/apache/xmlgraphics/batik/binaries/batik-bin-1.8.tar.gz
+tar xf batik-bin-1.8.tar.gz
+```
+
+And configure the path, e.g. in ``config/initializers/svg_export.rb``
+
+```ruby
+SvgExport::Engine.batik_path = Rails.root.join('bin/batik-1.8/batik-rasterizer-1.8.jar')
+```
+
+
+### 4. Change Highchart configuration to use that server:
+
+e.g.:
+
+```javascript
+{
+  exporting: {
+    url: '/exporting'
+  }
+}
+```
+
+

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SvgExport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/svg_export/application_controller.rb

@@ -0,0 +1,4 @@
+module SvgExport
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/svg_export/svg_controller.rb

@@ -0,0 +1,18 @@
+module SvgExport
+  class SvgController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+
+    def create
+      if Engine.batik_path.blank?
+        raise ArgumentError.new("Set SvgExport::Engine.batik_path = '...' to the correct path of the batik-rasterizer")
+      end
+      wrapper = CommandWrapper.new(params, base_url: request.referer)
+      begin
+        file = wrapper.()
+      rescue SvgExport::Error => e
+        render :text => "Unable to export image;\n #{e}", status: 422
+      end
+      send_file file, type: wrapper.type, filename: wrapper.filename, disposition: 'attachment', stream: false
+    end
+  end
+end

data/app/services/svg_export/command_wrapper.rb

@@ -0,0 +1,70 @@
+module SvgExport
+  class CommandWrapper
+    attr_reader :params
+    def initialize(params, options)
+      @params = params
+      @allowed_types = Engine.default_options[:allowed_types]
+      @tmp_path = Engine.default_options[:tmp_path]
+      @svg_transformer = Engine.default_options[:svg_transformer]
+      @options = options
+    end
+
+    def call
+      transformer = @svg_transformer.new(@options)
+      svg = transformer.transform(params[:svg])
+      infile.write(svg)
+      infile.flush
+      result = run!
+      fs = File.size?( outfile.path)
+      if fs.nil? || fs < 10
+        raise SvgExport::Error.new( "Output file empty;  #{result}")
+      end
+      File.open(outfile)
+    end
+
+    def filename
+      base = params[:filename].blank? ? "chart" : params[:filename]
+      "#{base}.#{ext}"
+    end
+
+    def type
+      @type ||= begin
+                  @allowed_types.find{|t| t == params[:type] } or raise SvgExport::Error.new("Unknown type #{params[:type]}")
+                end
+    end
+
+    protected
+
+    def run!
+      cmd = "java -jar #{Engine.batik_path} -m #{type} -d #{outfile.path} #{width} #{infile.path} 2>&1"
+      result = `#{cmd}`
+      if result.index("success").nil?
+        raise SvgExport::Error.new(rsp)
+      end
+      result
+    end
+
+    def width
+      if params[:width].to_i > 0
+        "-w #{Shellwords.escape(params[:width])}"
+      end
+    end
+
+    def outfile
+      @outfile ||= Tempfile.new(['highcharts-out',".#{ext}"], @tmp_path)
+    end
+
+    def infile
+      @infile ||= Tempfile.open(['highcharts-in',".svg"], @tmp_path)
+    end
+
+    def ext
+      { 'image/png' => 'png',
+        'image/jpeg' => 'jpg',
+        'application/pdf' => 'pdf'
+      }[type]
+    end
+
+
+  end
+end

data/app/services/svg_export/error.rb

@@ -0,0 +1,4 @@
+module SvgExport
+  class Error < StandardError
+  end
+end

data/app/services/svg_export/svg_transformer.rb

@@ -0,0 +1,54 @@
+module SvgExport
+  class SvgTransformer
+    def initialize(base_url, options={})
+      @tempfiles = []
+      @base_url = options[:base_url]
+    end
+
+    def transform(svg)
+      doc = Nokogiri::XML.parse(svg)
+      doc.search('image').each do |image|
+        if image['xlink:href'] and image['xlink:href'][/^\//]
+          if image['xlink:href'][%r{/assets/([^\?]+)}, 1] and path = find_asset_path($1)
+            # local Asset path
+            body = File.read(path)
+            url = path
+          elsif @base_url
+            url = URI.join(@base_url, image['xlink:href']).to_s
+            body = download(url)
+          else
+            next
+          end
+
+          ext =  url[/\.(\w+)$/, 1] || 'png'
+          tf = Tempfile.new(["highchart-tmp-inline", ".#{ext}", Rails.root.join('tmp')])
+          tf.binmode
+          @tempfiles << tf
+          tf.write(body)
+          tf.flush
+          # relative url
+          image['xlink:href'] = "file://" + tf.path
+        end
+      end
+      doc.to_s
+    end
+
+    protected
+
+    def download(url)
+      require 'open-uri'
+      open(url)
+    end
+
+    def find_asset_path(partial_path)
+      Rails.application.config.assets.paths.each do |asset_dir|
+        Dir.glob("#{asset_dir}/*").each do |full_path|
+          if full_path.ends_with?(partial_path)
+            return full_path
+          end
+        end
+      end
+      nil
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+SvgExport::Engine.routes.draw do
+  root to: 'svg#create'
+  match '/' => 'svg#create', via: [:post]
+end

data/lib/svg_export/engine.rb

@@ -0,0 +1,18 @@
+module SvgExport
+  class Engine < ::Rails::Engine
+    isolate_namespace SvgExport
+    cattr_accessor :batik_path
+    cattr_accessor :default_options
+    self.default_options = {
+    }
+    initializer 'svg_export.init' do
+      Engine.default_options.reverse_merge!({
+        allowed_types: ['image/png', 'image/jpeg', 'application/pdf'],
+        tmp_path: Rails.root.join('tmp'),
+        svg_transformer: SvgTransformer
+      })
+    end
+  end
+end
+
+# SvgExport::Engine.batik_path = SvgExport::Engine.root.join('bin/batik-rasterizer-1.8.jar')

data/lib/svg_export/version.rb

@@ -0,0 +1,3 @@
+module SvgExport
+  VERSION = "0.0.1"
+end

data/lib/svg_export.rb

@@ -0,0 +1,4 @@
+require "svg_export/engine"
+
+module SvgExport
+end

data/lib/tasks/svg_export_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :svg_export do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: svg_export
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails engine for rasterizing Highcharts SVG files
+email:
+- stefan.wienert@pludoni.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/svg_export/application_controller.rb
+- app/controllers/svg_export/svg_controller.rb
+- app/services/svg_export/command_wrapper.rb
+- app/services/svg_export/error.rb
+- app/services/svg_export/svg_transformer.rb
+- config/routes.rb
+- lib/svg_export.rb
+- lib/svg_export/engine.rb
+- lib/svg_export/version.rb
+- lib/tasks/svg_export_tasks.rake
+homepage: https://github.com/pludoni/svg_export
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails engine for rasterizing Highcharts SVG files
+test_files: []