pageflow-chart 0.1.0

data/app/assets/stylesheets/pageflow/chart/editor.css.scss

@@ -0,0 +1,17 @@
+.scraped_site_status {
+  .state {
+    display: none;
+  }
+
+  &.failed {
+    .failed.state {
+      display: block;
+    }
+  }
+
+  &.processing {
+    .processing.state {
+      display: block;
+    }
+  }
+}

data/app/assets/stylesheets/pageflow/chart/themes/default.css.scss

@@ -0,0 +1,10 @@
+$chart-background: $basic-background-color;
+
+.chart_page {
+  .iframeWrapper {
+    &:before {
+      opacity: 0.95;
+      background-color: $chart-background;
+    }
+  }
+}

data/app/controllers/pageflow/chart/application_controller.rb

@@ -0,0 +1,6 @@
+module Pageflow
+  module Chart
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/pageflow/chart/scraped_sites_controller.rb

@@ -0,0 +1,25 @@
+module Pageflow
+  module Chart
+    class ScrapedSitesController < Chart::ApplicationController
+      respond_to :json
+
+      def create
+        scraped_site = ScrapedSite.create!(scraped_site_params)
+        scraped_site.process!
+
+        respond_with(scraped_site)
+      end
+
+      def show
+        scraped_site = ScrapedSite.find(params[:id])
+        respond_with(scraped_site)
+      end
+
+      protected
+
+      def scraped_site_params
+        params.require(:scraped_site).permit(:url)
+      end
+    end
+  end
+end

data/app/helpers/pageflow/chart/scraped_sites_helper.rb

@@ -0,0 +1,13 @@
+module Pageflow
+  module Chart
+    module ScrapedSitesHelper
+      def scraped_site_url(scraped_site_id)
+        scraped_site = ScrapedSite.find_by_id(scraped_site_id)
+
+        if scraped_site
+          scraped_site.html_file_url
+        end
+      end
+    end
+  end
+end

data/app/jobs/pageflow/chart/scrape_site_job.rb

@@ -0,0 +1,59 @@
+module Pageflow
+  module Chart
+    class ScrapeSiteJob
+      extend StateMachineJob
+      @queue = :scraping
+
+      attr_reader :downloader
+
+      def initialize(downloader)
+        @downloader = downloader
+      end
+
+      def perform(scraped_site)
+        downloader.load(scraped_site.url) do |file|
+          scraper = Scraper.new(file.read, Chart.config.scraper_options)
+          scraped_site.html_file = StringIOWithContentType.new(
+            scraper.html,
+            file_name: 'file.html',
+            content_type: 'text/html'
+          )
+
+          downloader.load_all(scraper.javascript_urls, extension: '.js', separator: "\n;") do |file|
+            scraped_site.javascript_file = file
+          end
+
+          downloader.load_all(scraper.stylesheet_urls, extension: '.css', separator: "\n;") do |file|
+            scraped_site.stylesheet_file = file
+          end
+        end
+
+        downloader.load(scraped_site.csv_url) do |file|
+          scraped_site.csv_file = file
+        end
+
+        :ok
+      end
+
+      def self.perform_with_result(scraped_site, options = {})
+        # This is were the downloader passed to `initialize` is created.
+        new(Downloader.new(base_url: scraped_site.url)).perform(scraped_site)
+      end
+    end
+
+    class StringIOWithContentType < StringIO
+      def initialize(string, options)
+        super(string)
+        @options = options
+      end
+
+      def content_type
+        @options.fetch(:content_type)
+      end
+
+      def original_filename
+        @options.fetch(:file_name)
+      end
+    end
+  end
+end

data/app/models/pageflow/chart/scraped_site.rb

@@ -0,0 +1,51 @@
+module Pageflow
+  module Chart
+    class ScrapedSite < ActiveRecord::Base
+      has_attached_file :javascript_file, Chart.config.paperclip_options(extension: 'js')
+      has_attached_file :stylesheet_file, Chart.config.paperclip_options(extension: 'css')
+      has_attached_file :html_file, Chart.config.paperclip_options(extension: 'html')
+      has_attached_file :csv_file, Chart.config.paperclip_options(basename: 'data', extension: 'csv')
+
+      state_machine initial: 'unprocessed' do
+        extend StateMachineJob::Macro
+
+        state 'unprocessed'
+        state 'processing'
+        state 'processing_failed'
+        state 'processed'
+
+        event :process do
+          transition 'unprocessed' => 'processing'
+        end
+
+        event :reprocess do
+          transition 'processed' => 'processing'
+          transition 'processing_failed' => 'processing'
+        end
+
+        job ScrapeSiteJob do
+          on_enter 'processing'
+          result ok: 'processed'
+          result error: 'processing_failed'
+        end
+      end
+
+      def csv_url
+        URI.join(url, 'data.csv').to_s
+      end
+
+      def as_json(*)
+        super.merge(html_file_url: html_file_url)
+      end
+
+      def html_file_url
+        return unless html_file.try(:path)
+        if Chart.config.scraped_sites_root_url.present?
+          File.join(Chart.config.scraped_sites_root_url, html_file.path)
+        else
+          html_file.url
+        end
+      end
+    end
+  end
+end

data/app/views/pageflow/chart/page.html

@@ -0,0 +1,41 @@
+<div class="blackLayer"></div>
+<div class="content_and_background chart_page">
+  <div class="backgroundArea">
+    <%= background_image_div(configuration, 'background_image') %>
+    <%= shadow_div :opacity => configuration['gradient_opacity'] %>
+  </div>
+
+  <div class="content">
+    <div class="iframeWrapper">
+      <iframe data-src="<%= scraped_site_url(configuration['scraped_site_id']) %>"
+              style="width: 100%; height: 100%"
+              name="°"
+              scrolling="auto"
+              frameborder="0"
+              align="aus"
+              marginheight="15"
+              marginwidth="15"
+              allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true">
+      </iframe>
+      <div class="iframe_overlay"></div>
+      <div class="bigscreen_toggler" tabindex="4" title="<%= t('.toggle_title') %>"><%= t('.toggle') %></div>
+    </div>
+    <div class="scroller">
+      <div>
+        <div class="contentWrapper">
+          <div class="page_header">
+            <h2>
+              <span class="tagline"><%= configuration['tagline'] %></span>
+              <span class="title"><%= configuration['title'] %></span>
+              <span class="subtitle"><%= configuration['subtitle'] %></span>
+            </h2>
+            <%= background_image_tag(configuration['background_image_id'], {"class" => "print_image"}) %>
+          </div>
+          <div class="contentText">
+            <p><%= raw configuration['text'] %></p>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/pageflow/chart/page_type.json.jbuilder

@@ -0,0 +1,2 @@
+json.key_format! camelize: :lower
+json.supported_hosts Pageflow::Chart.config.supported_hosts

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/pageflow/chart/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/chart.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "pageflow-chart"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Tim Fischbach"]
+  spec.email         = ["tfischbach@codevise.de"]
+  spec.summary       = "Pagetype for Embedded Datawrapper Charts"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pageflow", "~> 0.7"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "paperclip"
+  spec.add_runtime_dependency "state_machine"
+  spec.add_runtime_dependency "state_machine_job"
+  spec.add_runtime_dependency 'i18n-js'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails", "~> 2.0"
+  spec.add_development_dependency 'factory_girl_rails'
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "webmock"
+end

data/config/locales/de.yml

@@ -0,0 +1,40 @@
+de:
+  activerecord:
+    attributes:
+      pageflow/page:
+        scraped_site_id: Diagramm URL
+  pageflow:
+    chart:
+      editor:
+        templates:
+          scraped_site_status:
+            failed: Beim Herunterladen des Diagramms ist ein Fehler aufgetreten.
+            pending: Diagramm wird heruntergeladen...
+      help_entries:
+        page_type:
+          menu_item: Diagramm
+          text: ! '# Diagramm
+
+
+            Einbindung von DataWrapper-Diagrammen
+
+
+            Hier kannst Du Deinen Pageflow um animierte Infografiken ergänzen. Eingebettet ist das
+
+            Diagramm in ein Hintergrund-Bild und Text. Die Infografik lässt sich durch Klicken
+
+            vergrössern.
+
+
+            Dein Diagramm musst Du allerdings zuvor extern erstellen und einen entsprechenden Link generieren. Unter www.datawrapper.de findest Du Beispiele und die Konditionen, um
+
+            diesen Dienst in Anspruch zu nehmen.
+
+
+            Typische Anwendungsbeispiele: Statistiken, Diagramme, Zahlen&Fakten'
+      page:
+        toggle: Ansicht vergrößern bzw. verkleinern
+        toggle_title: Ansicht vergrößern bzw. verkleinern
+      page_type_category_name: Daten und Diagramme
+      page_type_description: Einbindung von Diagrammen, die mit DataWrapper erstellt wurden
+      page_type_name: Diagramm

data/config/locales/en.yml

@@ -0,0 +1,22 @@
+en:
+  activerecord:
+    attributes:
+      pageflow/page:
+        scraped_site_id: Chart URL
+  pageflow:
+    chart:
+      editor:
+        templates:
+          scraped_site_status:
+            failed: Chart download failed.
+            pending: Downloading chart...
+      help_entries:
+        page_type:
+          menu_item: Chart
+          text: ! "# Chart\n\nIntegration of a DataWrapper-Diagram\n\nHere you can add animated infographics to your Pageflow. The diagram is embedded into a background-picture and text. To enlarge the graphic you simply have to click on it. \n\nBut first of all you have to create your graphic externally and generate a link. You can find examples and requirements for this under www.datawrapper.de.\n\nExamples of application: statistics, diagrams, numbers & facts"
+      page:
+        toggle: Toggle
+        toggle_title: Toggle
+      page_type_category_name: Data and Charts
+      page_type_description: Embedded DataWrapper chart
+      page_type_name: Chart

data/config/routes.rb

@@ -0,0 +1,3 @@
+Pageflow::Chart::Engine.routes.draw do
+  resources :scraped_sites, only: [:create, :show]
+end

data/db/migrate/20140417112724_create_pageflow_chart_scraped_sites.rb

@@ -0,0 +1,14 @@
+class CreatePageflowChartScrapedSites < ActiveRecord::Migration
+  def change
+    create_table :pageflow_chart_scraped_sites do |t|
+      t.string :url
+      t.string :state
+      t.attachment :html_file
+      t.attachment :javascript_file
+      t.attachment :stylesheet_file
+      t.attachment :csv_file
+
+      t.timestamps
+    end
+  end
+end

data/lib/pageflow/chart.rb

@@ -0,0 +1,21 @@
+require 'paperclip'
+require 'state_machine'
+require 'state_machine_job'
+
+require 'pageflow/chart/engine'
+
+module Pageflow
+  module Chart
+    def self.config
+      @config ||= Chart::Configuration.new
+    end
+
+    def self.configure(&block)
+      block.call(config)
+    end
+
+    def self.page_type
+      Chart::PageType.new
+    end
+  end
+end

data/lib/pageflow/chart/configuration.rb

@@ -0,0 +1,63 @@
+module Pageflow
+  module Chart
+    class Configuration
+      # Options to pass to Scraper when it is created in ScrapedSiteJob
+      attr_reader :scraper_options
+
+      # paperclip_base_path is a prefix for the paperclip options path
+      attr_accessor :paperclip_base_path
+
+      # If present scraped_sites_root_url replaces the host/domain-name of the
+      # URL paperclip returns for the scraped HTML file.
+      #
+      # This can be used to circumvent the same-domain policy by setting it
+      # to ie "/datawrapper" and redirecting from there to the S3 host alias that holds
+      # the files.
+      attr_accessor :scraped_sites_root_url
+
+      # Default options for paperclip attachments which are supposed to
+      # use s3 storage. All options allowed in paperclip has_attached_file
+      # calls are allowed.
+      # This defaults to the configuration in `config/initializers/pageflow.rb` by the same name.
+      #
+      # @param [Hash] opts
+      # @option opts [Array<Regexp>] :head_script_blacklist Script tags in page head are ignored if they match any of this list of regexes.
+      # @option opts [Array<Regexp>] :inline_script_blacklist Inline script tags are ignored if they match any of this list of regexes.
+      # @option opts [Array<String>] :selector_blacklist HTML-elements matched by selectors in this list will not be scraped.
+      # @return [Hash]
+      attr_accessor :paperclip_s3_default_options
+
+      # White list of URL prefixes (including protocol) of scraped
+      # sites.
+      # @return [Array<String>]
+      attr_reader :supported_hosts
+
+      def initialize
+        @scraper_options = {
+          head_script_blacklist: [/piwik/],
+          inline_script_blacklist: [/piwik/],
+          selector_blacklist: ['body .noscript']
+        }
+        @paperclip_s3_default_options = {}
+        @paperclip_base_path = ':host'
+        @scraped_sites_root_url = nil
+        @supported_hosts = ['http://cf.datawrapper.de']
+      end
+
+      # @api private
+      def paperclip_options(options = {})
+        Pageflow.config.paperclip_s3_default_options
+          .deep_merge(default_paperclip_path_options(options))
+          .deep_merge(paperclip_s3_default_options)
+      end
+
+      private
+
+      def default_paperclip_path_options(options)
+        {
+          path: File.join(paperclip_base_path, ":class/:id_partition/#{options.fetch(:basename, 'all')}.#{options.fetch(:extension)}")
+        }
+      end
+    end
+  end
+end