pageflow-panorama 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWUwNzdiMWE2ZDkyNTRiYTU0MThhNTAzODU3Y2ZlOWM2MDFlYTIyOA==
+  data.tar.gz: !binary |-
+    OGNlMjA3YzRhYWQzNzA4OGYyMWIwZDhlMmU2ZmQ3MzMzMGYzOTEwOA==
+SHA512:
+  metadata.gz: !binary |-
+    YzVhNzMxZWM1MGEyY2YxZDM3YWI5YTg0Y2IxOGM0YTI1MGY1NTJhYzNmZGM4
+    NTMyMjgxNDY2NGU2OTMxZGVkMTI5OGQxM2Y3MTUxNzBiNDg1ZWM5NTZkZWZk
+    ODczYzc3NmFjMTcxYjY1MTJjZWMzZmMyNmNlMDQzMzcyOTA4MjA=
+  data.tar.gz: !binary |-
+    YTM2ZDFhMTYyZWZlOGU4NDVjZmM0MWI3NzRkNDJkMTAzYTMzODkzZWRmNjcz
+    ZmQ3NjFiNTIxMWZjNWQ1ZGMzODkyMWExZDk4NzNhYjU0NWRhYzkyYmQxNWIx
+    NzliZjUyYjJhOWVlOThlYmQyYWIwMzY0OTk2ZDdhYzg1Y2JjYzA=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.sqlite3
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+log
+
+.localeapp

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+### Changes on `master`
+
+[Compare changes](https://github.com/codevise/pageflow-panorama/compare/v0.1.0...master)
+
+### Version 0.1.0
+
+2015-06-05
+
+Initial release.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panorama.gemspec
+gemspec
+
+gem 'state_machine', git: 'https://github.com/tf/state_machine.git', branch: 'master'
+gem 'activeadmin', git: 'https://github.com/codevise/active_admin.git', branch: 'rails4'
+gem 'ransack'
+gem 'inherited_resources', '1.4.1'
+gem 'formtastic', '2.3.0'

data/README.md

@@ -0,0 +1,76 @@
+# Pageflow Panorama
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-panorama.svg)](http://badge.fury.io/rb/pageflow-panorama)
+
+Page type showing 360° panoramas in embedded iframes. Currently
+supported are panoramas by palmsfilm.com, panogate.com and KRPano via
+upload in the editor.
+
+## Installation
+
+Add pageflow-panorama to your application's Gemfile:
+
+    # Gemfile
+    gem 'pageflow-panorama'
+
+and run `bundle install`.
+
+Register the page type:
+
+    # config/initializers/pageflow.rb
+    Pageflow.configure do |config|
+      config.register_page_type(Pageflow::Panorama.page_type)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/panorama
+
+    # app/assets/javascripts/pageflow/editor.js
+    //= require pageflow/panorama/editor
+
+    # app/assets/stylesheets/pageflow/application.css.scss
+    @import "pageflow/panorama";
+
+Install and run migrations:
+
+    $ rake pageflow_panorama:install:migrations
+    $ rake db:migrate
+
+### Create Proxies for the Panorama Providers:
+
+To circumvent the same-origin policy, a proxy from the domain that
+serves pageflow to the domain of the panorma-providers has to be
+configured.
+
+Example for Nginx:
+Copy `config/pageflow-panorama-proxies.conf.example` to your Nginx config
+directory, for example `/etc/nginx/pageflow-panorama-proxies.conf`
+and include it in you pageflow config file:
+
+     include /etc/nginx/pageflow-panorama-proxies.conf
+
+### Configure the Supported Panorama Providers
+
+If you support both palmfilms and panogate just copy
+`config/pageflow_panorama.rb.example` to `config/initializers/pageflow_panorama.rb`
+in your app. This sets the `base_path` to correspond with the proxy configuration above.
+
+Restart the application server.
+
+## Troubleshooting
+
+If you run into problems while installing the page type, please also
+refer to the
+[Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting)
+wiki page in the
+[Pageflow repository](https://github.com/codevise/pageflow). If that
+doesn't help, consider
+[filing an issue](https://github.com/codevise/pageflow-panorama/issues).
+
+## Contributing Locales
+
+Edit the translations directly on the
+[pageflow-panorama](http://www.localeapp.com/projects/public?search=tf/pageflow-panorama)
+locale project.

data/Rakefile

@@ -0,0 +1,17 @@
+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    = 'Pageflow Panorama'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/pageflow/panorama.js

@@ -0,0 +1,5 @@
+//= require_self
+
+//= require ./panorama/page_type
+
+pageflow.panorama = pageflow.panorama || {};

data/app/assets/javascripts/pageflow/panorama/editor.js

@@ -0,0 +1,8 @@
+//= require_self
+
+//= require_tree ./editor/models
+//= require_tree ./editor/views
+
+//= require ./editor/config
+
+pageflow.panorama = pageflow.panorama || {};

data/app/assets/javascripts/pageflow/panorama/editor/config.js

@@ -0,0 +1,9 @@
+pageflow.editor.fileTypes.register('pageflow_panorama_packages', {
+  model: pageflow.panorama.Package,
+  matchUpload: function(upload) {
+    return upload.type.match(/^application\/zip/) ||
+      upload.name.match(/\.zip$/);
+  }
+});
+
+pageflow.editor.registerPageConfigurationMixin(pageflow.panorama.configurationMixin);

data/app/assets/javascripts/pageflow/panorama/editor/models/configuration_mixin.js

@@ -0,0 +1,16 @@
+pageflow.panorama.configurationMixin = {
+  getPanoramaUrl: function() {
+    if (this.get('panorama_source') === 'url') {
+      return this.get('panorama_url');
+    }
+    else {
+      var panoramaPackage = this.getReference('panorama_package_id', 'pageflow_panorama_packages');
+
+      if (panoramaPackage && panoramaPackage.isReady()) {
+        return panoramaPackage.get('index_document_path');
+      }
+
+      return '';
+    }
+  }
+};

data/app/assets/javascripts/pageflow/panorama/editor/models/package.js

@@ -0,0 +1,11 @@
+pageflow.panorama.Package = pageflow.HostedFile.extend({
+  processingStages: [
+    {
+      name: 'unpacking',
+      activeStates: ['unpacking'],
+      failedStates: ['unpacking_failed']
+    }
+  ],
+
+  readyState: 'unpacked'
+});

data/app/assets/javascripts/pageflow/panorama/editor/views/configuration_editor.js

@@ -0,0 +1,49 @@
+pageflow.ConfigurationEditorView.register('panorama', {
+  configure: function() {
+    var providers = this.options.pageType.providers;
+
+    this.tab('general', function() {
+      this.group('general');
+
+      this.input('additional_title', pageflow.TextInputView);
+      this.input('additional_description', pageflow.TextAreaInputView, {size: 'short'});
+    });
+
+    this.tab('files', function() {
+      if (providers.length) {
+        this.input('panorama_source', pageflow.SelectInputView, {
+          values: ['package', 'url'],
+          ensureValueDefined: true
+        });
+        this.input('panorama_url', pageflow.ProxyUrlInputView, {
+          required: true,
+          proxies: providers,
+          displayPropertyName: 'display_panorama_url',
+          visibleBinding: 'panorama_source',
+          visibleBindingValue: 'url'
+        });
+        this.input('panorama_package_id', pageflow.FileInputView, {
+          collection: 'pageflow_panorama_packages',
+          imagePositioning: false,
+          visibleBinding: 'panorama_source',
+          visibleBindingValue: 'package'
+        });
+      }
+      else {
+        this.input('panorama_package_id', pageflow.FileInputView, {
+          collection: 'pageflow_panorama_packages',
+          imagePositioning: false
+        });
+      }
+
+      this.input('thumbnail_image_id', pageflow.FileInputView, {
+        collection: pageflow.imageFiles,
+        imagePositioning: false
+      });
+    });
+
+    this.tab('options', function() {
+      this.group('options');
+    });
+  }
+});

data/app/assets/javascripts/pageflow/panorama/page_type.js

@@ -0,0 +1,88 @@
+pageflow.pageType.register('panorama', _.extend({
+  enhance: function(pageElement, configuration) {
+    pageElement.addClass('hide_content_with_text');
+
+    pageElement.find('.play_button').on('mousedown touchstart', function() {
+      pageflow.hideText.activate();
+    });
+
+    pageElement.find('.close_button').on('click', function(e) {
+      pageflow.hideText.deactivate();
+      e.stopPropagation();
+    });
+  },
+
+  prepare: function(pageElement, configuration) {
+    this._ensureIframe(pageElement, configuration);
+  },
+
+  preload: function(pageElement, configuration) {
+    return pageflow.preload.backgroundImage(pageElement.find('.background_image'));
+  },
+
+  activating: function(pageElement, configuration) {
+    this._ensureIframe(pageElement, configuration);
+  },
+
+  activated: function(pageElement, configuration) {},
+
+  deactivating: function(pageElement, configuration) {},
+
+  deactivated: function(pageElement, configuration) {},
+
+  update: function(pageElement, configuration) {
+    pageElement.find('h2 .tagline').text(configuration.get('tagline') || '');
+    pageElement.find('h2 .title').text(configuration.get('title') || '');
+    pageElement.find('h2 .subtitle').text(configuration.get('subtitle') || '');
+    pageElement.find('p').html(configuration.get('text') || '');
+
+    this.updateInfoBox(pageElement, configuration);
+    this.updateCommonPageCssClasses(pageElement, configuration);
+
+    pageElement.find('.shadow').css({
+      opacity: configuration.get('gradient_opacity') / 100
+    });
+
+    if (this.panoramaUrl !== configuration.getPanoramaUrl()) {
+      this.panoramaUrl = configuration.getPanoramaUrl();
+
+      this._ensureIframeCreated(pageElement);
+      this.iframe.attr('src', this.panoramaUrl);
+    }
+  },
+
+  _ensureIframe: function(pageElement, configuration) {
+    if (!this.iframe) {
+      var panoramaUrl = pageElement.find('.iframeWrapper').data('panoramaUrl');
+
+      if (panoramaUrl) {
+        this._ensureIframeCreated(pageElement);
+        this.iframe.attr('src', panoramaUrl);
+
+        $(this.iframe).load(function() {
+          $(this).contents().find('body').keydown(function(event) {
+            if(event.keyCode == 27) {
+              pageflow.hideText.deactivate();
+            }
+          });
+        });
+      }
+    }
+  },
+
+  _ensureIframeCreated: function(pageElement) {
+    if (!this.iframe) {
+      this.iframe = $('<iframe style="width: 100%; height: 100%; position: absolute; top: 0; left: 0;" name="°" scrolling="no" frameborder="0" align="aus" marginheight="0" marginwidth="0" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>');
+      pageElement.find('.iframeWrapper').prepend(this.iframe);
+    }
+  },
+
+  embeddedEditorViews: function() {
+    return {
+      '.background_image': {
+        view: pageflow.BackgroundImageEmbeddedView,
+        options: {propertyName: 'fallback_image_id'}
+      }
+    };
+  }
+}, pageflow.commonPageCssClasses, pageflow.infoBox));

data/app/assets/stylesheets/pageflow/panorama.css.scss

@@ -0,0 +1,13 @@
+@include pageflow-page-type(panorama);
+
+.js .panorama_page {
+  overflow: hidden;
+
+  .contentText {
+    margin-bottom: 200px;
+
+    @include phone {
+      margin-bottom: 100px;
+    }
+  }
+}

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

@@ -0,0 +1,3 @@
+@include pageflow-hosted-file-stage('unpacking') {
+  @include archive-icon;
+}

data/app/helpers/pageflow/panorama/packages_helper.rb

@@ -0,0 +1,14 @@
+module Pageflow
+  module Panorama
+    module PackagesHelper
+      def panorama_url(configuration)
+        if configuration['panorama_source'] == 'url'
+          configuration['panorama_url']
+        else
+          package = Package.find_by_id(configuration['panorama_package_id'])
+          package ? package.index_document_path : nil
+        end
+      end
+    end
+  end
+end

data/app/jobs/pageflow/panorama/unpack_package_job.rb

@@ -0,0 +1,29 @@
+module Pageflow
+  module Panorama
+    class UnpackPackageJob
+      @queue = :slow
+
+      extend StateMachineJob
+
+      def self.perform_with_result(package, options)
+        JobStatusAttributes.handle(package, stage: :unpacking) do |&progress|
+          parse(package)
+
+          package.unpacker.upload(&progress)
+          package.attachment_on_filesystem.destroy
+        end
+
+        :ok
+      end
+
+      private
+
+      def self.parse(package)
+        result = Validation.parse(package.archive)
+
+        package.index_document = result.index_document
+        package.thumbnail = package.archive.find_entry(result.thumbnail)
+      end
+    end
+  end
+end

data/app/models/pageflow/panorama/package.rb

@@ -0,0 +1,63 @@
+require 'zip'
+
+module Pageflow
+  module Panorama
+    class Package < ActiveRecord::Base
+      include HostedFile
+
+      processing_state_machine do
+        state 'unpacking'
+        state 'unpacked'
+        state 'unpacking_failed'
+
+        event :process do
+          transition any => 'unpacking'
+        end
+
+        event :retry do
+          transition 'unpacking_failed' => 'unpacking'
+        end
+
+        job UnpackPackageJob do
+          on_enter 'unpacking'
+          result :ok, state: 'unpacked'
+          result :error, state: 'unpacking_failed'
+        end
+      end
+
+      has_attached_file(:thumbnail, Pageflow.config.paperclip_s3_default_options
+                          .merge(default_url: ':pageflow_placeholder',
+                                 default_style: :thumbnail,
+                                 styles: Pageflow.config.thumbnail_styles))
+
+      # @override
+      def keep_on_filesystem_after_upload_to_s3?
+        true
+      end
+
+      def thumbnail_url(*args)
+        thumbnail.url(*args)
+      end
+
+      def unpack_base_path
+        attachment_on_s3.present? ? File.dirname(attachment_on_s3.path(:unpacked)) : nil
+      end
+
+      def index_document_path
+        if attachment_on_s3.present? && index_document
+          File.join(Panorama.config.packages_base_path, unpack_base_path, index_document)
+        end
+      end
+
+      def archive
+        @archive ||= Zip::File.open(attachment_on_filesystem.path)
+      end
+
+      def unpacker
+        UnpackToS3.new(archive: archive,
+                       destination_bucket: attachment_on_s3.s3_bucket,
+                       destination_base_path: unpack_base_path)
+      end
+    end
+  end
+end

data/app/views/pageflow/panorama/editor/packages/_package.json.jbuilder

@@ -0,0 +1 @@
+json.(package, :unpacking_progress, :unpacking_error_message, :index_document_path)

data/app/views/pageflow/panorama/page.html.erb

@@ -0,0 +1,48 @@
+<div class="blackLayer"></div>
+<div class="content_and_background panorama_page">
+  <div class="close_button text_hidden_only" tabindex="4" title="<%= t('.close_title') %>">
+    <div class="label">
+      <%= t('.close') %>
+    </div>
+  </div>
+
+  <div class="backgroundArea">
+    <%= background_image_div(configuration, 'fallback_image') %>
+    <%= content_tag(:div, class: 'videoWrapper iframeWrapper', data: {panorama_url: panorama_url(configuration) }) do %>
+    <% end %>
+    <%= shadow_div :opacity => configuration['gradient_opacity'] %>
+  </div>
+
+  <div class="content">
+    <div class="controls">
+      <span class="hint"><%= t('.start') %></span>
+      <%= info_box(configuration) %>
+      <div class="vjs-control-bar view-control">
+        <div class="play_button vjs-controls vjs-default-skin vjs-player">
+          <a class="vjs-play-control vjs-play vjs-control" tabindex="4" title="<%= t('.start') %>"><span></span></a>
+        </div>
+        <div class="control_bar_text">
+          <%= t('.start') %>
+        </div>
+      </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>
+              <%= background_image_tag(configuration['fallback_image_id'], {"class" => "print_image"}) %>
+            </h2>
+          </div>
+          <div class="contentText">
+            <p><%= raw configuration['text'] %></p>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1 @@
+json.providers Pageflow::Panorama.config.providers

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/panorama/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/de.yml

@@ -0,0 +1,39 @@
+de:
+  activerecord:
+    attributes:
+      pageflow/page:
+        panorama_package_id: KRPano
+        panorama_source: Panorama Quelle
+        panorama_url: Panorama URL
+    values:
+      pageflow/page:
+        panorama_source:
+          package: KRPano
+          url: Externes Panorama
+  pageflow:
+    editor:
+      files:
+        stages:
+          unpacking:
+            active: Wird entpackt.
+            failed: Fehler beim entpacken.
+            finished: Erfolgreich entpackt.
+            pending: Noch nicht entpackt.
+        tabs:
+          pageflow_panorama_packages: KRPanos
+    panorama:
+      help_entries:
+        page_type:
+          menu_item: 360° Panorama
+          text: ! "# 360° Panorama\n\nBettet ein interaktives Panorama ein. Zwei verschiedene Quellen werden unterstützt:\n\n### Externes Panorama \n\nVon Drittanbieter erstellte Panoramen, die bereits über eine URL erreichbar sind können direkt eingebunden werden. Wähle dazu \"Externes Panorama\" als Panorama Quelle und füge die URL in das Textfeld ein.\n\n### Hochgeladene Zip Datei\n\nAlternativ können Panoramen mit dem Programm KRPano erstellt und unter \"Dateien verwalten > KRPano\" hochgeladen werden. Wähle danach \"KRPano\" als Panorama Quelle und wähle das gewünschte Panorama aus.\n\nTypische Anwendungsbeispiele: Beeindruckende Orte, Reiseberichte, Darstellung von Architektur"
+      page:
+        close: Schließen
+        close_title: 360°-Ansicht verlassen und Text einblenden
+        start: 360°-Ansicht starten
+      page_type_category_name: Interaktiv
+      page_type_description: Interaktive Panorama-Ansicht mit KRPano.
+      page_type_name: 360° Ansicht
+      validation:
+        missing_index_document: Index-Dokument nicht gefunden.
+        missing_preview: Vorschau-Bild nicht gefunden.
+        missing_tiles_directory: Tiles-Verzeichnis nicht gefunden.

data/config/locales/en.yml

@@ -0,0 +1,57 @@
+en:
+  activerecord:
+    attributes:
+      pageflow/page:
+        panorama_package_id: KRPano
+        panorama_source: Panorama Source
+        panorama_url: Panorama URL
+    values:
+      pageflow/page:
+        panorama_source:
+          package: KRPano
+          url: External Panorama
+  pageflow:
+    editor:
+      files:
+        stages:
+          unpacking:
+            active: Unpacking.
+            failed: Error while unpacking.
+            finished: Successfully unpacked.
+            pending: Not yet unpacked.
+        tabs:
+          pageflow_panorama_packages: KRPanos
+    panorama:
+      help_entries:
+        page_type:
+          menu_item: 360° Panorama
+          text: ! '# 360° Panorama
+
+
+            Embeds an interactive panorama.
+
+
+            ### External Panorama
+
+
+            Panoramas that are already available on the web can be embedded via an URL. Choose "External Panorama" as Panorama Source and paste the URL.
+
+
+            ### Uploaded Zip File
+
+
+            Alternatively, panoramas can be created using the program KRPano. Visit "Manage Files > KRPano" and upload the resulting zip file. Now choose "KRPano" as Panorama Source and select an uploaded panorama.
+
+
+            Typical use cases: Impressing places, travel reports, architecture'
+      page:
+        close: Close
+        close_title: Close 360° panorama and display text
+        start: Start 360° panorama
+      page_type_category_name: Interactive
+      page_type_description: Interactive panorama using KRPano.
+      page_type_name: 360° Panorama
+      validation:
+        missing_index_document: Index document not found.
+        missing_preview: Preview image not found.
+        missing_tiles_directory: Tiles directory not found.

data/config/pageflow-panorama-proxies.conf.example

@@ -0,0 +1,17 @@
+# Example Nginx configuration for pageflow-panorama
+# vi: ft=nginx
+
+location /panogate/ {
+  proxy_pass http://www.panogate.de/;
+  proxy_redirect http://www.panogate.de/ $scheme://$host/panogate/;
+}
+
+location /palmfilms/ {
+  proxy_pass http://www.palmfilms.com/;
+  proxy_redirect http://www.palmfilms.com/ $scheme://$host/palmfilms/;
+}
+
+location /bucket/ {
+  proxy_pass http://BUCKET_NAME.s3-website-eu-west-1.amazonaws.com/;
+  proxy_redirect http://BUCKET_NAME.s3-website-eu-west-1.amazonaws.com/ $scheme://$host/bucket/;
+}

data/config/pageflow_panorama.rb.example

@@ -0,0 +1,16 @@
+# Rails initializer example for Pageflow-panorama
+# vi: ft=ruby
+
+Pageflow::Panorama.configure do |config|
+  config.providers = [{
+    name: "palmsfilm.com",
+    base_path: "/panorama",
+    url: "http://palmsfilm.com/"
+  },{
+    name: "panogate.de",
+    base_path: "/panogate",
+    url: "http://www.panogate.de/"
+  }]
+
+  config.packages_base_path = "/bucket"
+end

data/db/migrate/20140915133249_create_packages.rb

@@ -0,0 +1,12 @@
+class CreatePackages < ActiveRecord::Migration
+  def change
+    create_table :pageflow_panorama_packages do |t|
+      Pageflow::HostedFile.columns(t)
+
+      t.integer(:unpacking_progress)
+      t.string(:unpacking_error_message)
+      t.string(:index_document)
+      t.attachment(:thumbnail)
+    end
+  end
+end

data/lib/pageflow-panorama.rb

@@ -0,0 +1,17 @@
+require 'pageflow/panorama/engine'
+
+module Pageflow
+  module Panorama
+    def self.config
+      @config ||= Panorama::Configuration.new
+    end
+
+    def self.configure(&block)
+      block.call(config)
+    end
+
+    def self.page_type
+      Panorama::PageType.new
+    end
+  end
+end

data/lib/pageflow/panorama/configuration.rb

@@ -0,0 +1,12 @@
+module Pageflow
+  module Panorama
+    class Configuration
+      attr_accessor :providers, :packages_base_path
+
+      def initialize
+        @providers = []
+        @packages_base_path = ''
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/engine.rb

@@ -0,0 +1,11 @@
+require 'pageflow/panorama/zip_entry_paperclip_io_adapter'
+
+module Pageflow
+  module Panorama
+    class Engine < Rails::Engine
+      isolate_namespace Pageflow::Panorama
+
+      config.autoload_paths << File.join(config.root, 'lib')
+    end
+  end
+end

data/lib/pageflow/panorama/job_status_attributes.rb

@@ -0,0 +1,40 @@
+module Pageflow
+  module Panorama
+    class JobStatusAttributes < Struct.new(:record, :stage_name)
+      def self.handle(record, options = {}, &block)
+        new(record, options[:stage]).call(&block)
+      end
+
+      def call(&block)
+        update_progress(0)
+
+        with_error_message_handling do
+          block.call do |percent|
+            update_progress(percent)
+          end
+        end
+      end
+
+      private
+
+      def update_progress(percent)
+        record.update(stage_attribute_name(:progress) => percent,
+                      stage_attribute_name(:error_message) => nil)
+      end
+
+      def with_error_message_handling
+        yield
+      rescue StandardError => e
+        if e.respond_to?(:message_i18n_key)
+          record[stage_attribute_name(:error_message)] = e.message_i18n_key
+        end
+
+        raise
+      end
+
+      def stage_attribute_name(suffix)
+        [stage_name, suffix].compact.join('_')
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/page_type.rb

@@ -0,0 +1,31 @@
+module Pageflow
+  module Panorama
+    class PageType < Pageflow::PageType
+      name 'panorama'
+
+      def view_helpers
+        [
+          Pageflow::Panorama::PackagesHelper
+        ]
+      end
+
+      def file_types
+        [
+          FileType.new(model: Package,
+                       editor_partial: 'pageflow/panorama/editor/packages/package')
+        ]
+      end
+
+      def json_seed_template
+        'pageflow/panorama/page_type.json.jbuilder'
+      end
+
+      def thumbnail_candidates
+        [
+          {attribute: 'thumbnail_image_id', file_collection: 'image_files'},
+          {attribute: 'panorama_package_id', file_collection: 'pageflow_panorama_packages'}
+        ]
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/unpack_to_s3.rb

@@ -0,0 +1,58 @@
+require 'zip'
+
+module Pageflow
+  module Panorama
+    class UnpackToS3
+      attr_reader :archive, :destination_bucket, :destination_base_path
+
+      def initialize(options)
+        @archive = options.fetch(:archive)
+        @destination_bucket = options.fetch(:destination_bucket)
+        @destination_base_path = options.fetch(:destination_base_path)
+      end
+
+      def upload(&progress)
+        archive.entries.each_with_index do |entry, index|
+          yield(100.0 * index / archive.entries.size) if block_given?
+          upload_entry(entry)
+        end
+      end
+
+      private
+
+      def upload_entry(entry)
+        return unless entry.file?
+        with_retry do
+          s3_object(entry.name).write(entry.get_input_stream,
+                                      acl: :public_read,
+                                      content_length: entry.size)
+        end
+      end
+
+      def s3_object(file_name)
+        destination_bucket.objects[destination_path(file_name)]
+      end
+
+      def destination_path(file_name)
+        File.join(destination_base_path, file_name)
+      end
+
+      def with_retry(&block)
+        retries = 0
+
+        begin
+          yield
+        rescue AWS::S3::Errors::SlowDown
+          retries += 1
+
+          if retries <= 5
+            sleep((2 ** retries) * 0.5)
+            retry
+          else
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/validation.rb

@@ -0,0 +1,9 @@
+module Pageflow
+  module Panorama
+    module Validation
+      def self.parse(archive)
+        KrPano.new(archive.entries).parse
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/validation/error.rb

@@ -0,0 +1,14 @@
+module Pageflow
+  module Panorama
+    module Validation
+      class Error < StandardError
+        attr_reader :message_i18n_key
+
+        def initialize(message_i18n_key)
+          super("Archive is not valid: #{message_i18n_key}")
+          @message_i18n_key = message_i18n_key
+        end
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/validation/kr_pano.rb

@@ -0,0 +1,34 @@
+module Pageflow
+  module Panorama
+    module Validation
+      class KrPano < Struct.new(:entries)
+        def parse
+          find_tiles_directory!
+
+          Result.new(find_index_document!,
+                     find_thumbnail!)
+        end
+
+        private
+
+        def find_tiles_directory!
+          find_file!('*.tiles/*', :missing_tiles_directory)
+        end
+
+        def find_index_document!
+          find_file!('*.html', :missing_index_document)
+        end
+
+        def find_thumbnail!
+          find_file!('**/mobile_f.jpg', :missing_preview)
+        end
+
+        def find_file!(glob, message_i18n_key)
+          entries.map(&:name).find do |name|
+            File.fnmatch(glob, name)
+          end || raise(Error.new("pageflow.panorama.validation.#{message_i18n_key}"))
+        end
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/validation/result.rb

@@ -0,0 +1,8 @@
+module Pageflow
+  module Panorama
+    module Validation
+      class Result < Struct.new(:index_document, :thumbnail)
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/zip_entry_paperclip_io_adapter.rb

@@ -0,0 +1,37 @@
+require 'zip'
+require 'paperclip'
+
+module Pageflow
+  module Panorama
+    class ZipEntryPaperclipIOAdapter < Paperclip::AbstractAdapter
+      # Paperclip < 3.3.1 compatibility
+      unless Paperclip::AbstractAdapter.instance_methods.include?(:original_filename=)
+        attr_writer(:original_filename)
+      end
+
+      def initialize(entry)
+        @entry = entry
+        cache_current_values
+      end
+
+      private
+
+      def cache_current_values
+        self.original_filename = @entry.name
+        @tempfile = copy_to_tempfile(@entry)
+        @content_type = Paperclip::ContentTypeDetector.new(@tempfile.path).detect
+        @size = @entry.size
+      end
+
+      def copy_to_tempfile(entry)
+        override_existing_file = proc { true }
+        @entry.extract(destination.path, &override_existing_file)
+        destination
+      end
+    end
+
+    Paperclip.io_adapters.register(ZipEntryPaperclipIOAdapter) do |entry|
+      Zip::Entry === entry
+    end
+  end
+end

data/pageflow-panorama.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "pageflow-panorama"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Codevise Solutions"]
+  spec.email         = ["info@codevise.de"]
+  spec.summary       = "Pagetype for iframe embedded 360° panoramas"
+  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"
+  spec.add_runtime_dependency "rubyzip", "~> 1.1"
+
+  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 "mysql2"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: pageflow-panorama
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Codevise Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pageflow
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- info@codevise.de
+executables:
+- rails
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/images/pageflow/ov-panorama.png
+- app/assets/images/pageflow/panorama_pictogram.png
+- app/assets/images/pageflow/panorama_pictogram_small.png
+- app/assets/images/pageflow/panorama_sprite.png
+- app/assets/javascripts/pageflow/panorama.js
+- app/assets/javascripts/pageflow/panorama/editor.js
+- app/assets/javascripts/pageflow/panorama/editor/config.js
+- app/assets/javascripts/pageflow/panorama/editor/models/configuration_mixin.js
+- app/assets/javascripts/pageflow/panorama/editor/models/package.js
+- app/assets/javascripts/pageflow/panorama/editor/views/configuration_editor.js
+- app/assets/javascripts/pageflow/panorama/page_type.js
+- app/assets/stylesheets/pageflow/panorama.css.scss
+- app/assets/stylesheets/pageflow/panorama/editor.css.scss
+- app/helpers/pageflow/panorama/packages_helper.rb
+- app/jobs/pageflow/panorama/unpack_package_job.rb
+- app/models/pageflow/panorama/package.rb
+- app/views/pageflow/panorama/editor/packages/_package.json.jbuilder
+- app/views/pageflow/panorama/page.html.erb
+- app/views/pageflow/panorama/page_type.json.jbuilder
+- bin/rails
+- config/locales/de.yml
+- config/locales/en.yml
+- config/pageflow-panorama-proxies.conf.example
+- config/pageflow_panorama.rb.example
+- db/migrate/20140915133249_create_packages.rb
+- lib/pageflow-panorama.rb
+- lib/pageflow/panorama/configuration.rb
+- lib/pageflow/panorama/engine.rb
+- lib/pageflow/panorama/job_status_attributes.rb
+- lib/pageflow/panorama/page_type.rb
+- lib/pageflow/panorama/unpack_to_s3.rb
+- lib/pageflow/panorama/validation.rb
+- lib/pageflow/panorama/validation/error.rb
+- lib/pageflow/panorama/validation/kr_pano.rb
+- lib/pageflow/panorama/validation/result.rb
+- lib/pageflow/panorama/zip_entry_paperclip_io_adapter.rb
+- pageflow-panorama.gemspec
+homepage: ''
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Pagetype for iframe embedded 360° panoramas
+test_files: []