pageflow-panorama 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acb5097faba23f51c911ebbcd0f8bfb1858bf776
-  data.tar.gz: 7507871e96e9c34315fa51730a8d4b6eb6077c0c
+  metadata.gz: 996c50b7bf13b13050dee80f7be7afc680b093f8
+  data.tar.gz: f57ea9aebabb7bb1abc22bccc3a608fc2c49bc45
 SHA512:
-  metadata.gz: c0f19e3b882d533d714f3f113d1fa9a8258eb3ba55d470db41e7e3a5b2576174beb679a79ba340b0019a0320b163a7430d88283d1c8ffd66c25efc783a3aa525
-  data.tar.gz: c4e2071b78cbbdd11a5b504d558a31e28439f692c0a33430a94f0c19670acdf3496c980032f84915739278ce167b36d91be75b544ca14f943c841ce105d4c7cf
+  metadata.gz: bdafd79e06f79f022ded852273a4c98f3406db68765a020ad2ef2f620ddcdf709e26597b410c111ed13d4a0f82d62f8ed281cc0cb3a9cedc3b3cfde46502cda0
+  data.tar.gz: 39288597011f17121c9d22998e6d73dc0c9fb77b638e342bd5151a09bd08f1a4ac7b5ed99d85f7de3313094381192e894bbde5bbead801099c46df182b7f9d6d

data/.gitignore

@@ -14,6 +14,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/dummy
 tmp
 log
 

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm: 2.1
+
+# User container based travis infrastructure which allows caching
+# features for open source projects.
+sudo: false
+cache: bundler
+
+script:
+  - bin/rspec

data/CHANGELOG.md

@@ -1,36 +1,34 @@
 # CHANGELOG
 
-### Version 0.3.0
-
-2016-09-09
-
-[Compare changes](https://github.com/codevise/pageflow-panorama/compare/v0.2.0...v0.3.0)
-
-- Add support for slim player control theme variant
-  ([#8](https://github.com/codevise/pageflow-panorama/pull/8))
-
-### Version 0.2.0
-
-2016-06-09
-
-[Compare changes](https://github.com/codevise/pageflow-panorama/compare/v0.1.0...v0.2.0)
-
-- Bug fix: Assign content types when unpacking to S3 to ensure display
-  in all browsers
-  ([#7](https://github.com/codevise/pageflow-panorama/pull/7))
-- Do not declare bin stubs as executables
-  ([#6](https://github.com/codevise/pageflow-panorama/pull/6))
-- Use configurable page type pictograms
-  ([#5](https://github.com/codevise/pageflow-panorama/pull/5))
-- Add pageflow-public-i18n to gemspec
-  ([#4](https://github.com/codevise/pageflow-panorama/pull/4))
-- Extract publicly visible i18n strings from locale
-  ([#3](https://github.com/codevise/pageflow-panorama/pull/3))
-- Add .idea entry to .gitignore
-  ([#2](https://github.com/codevise/pageflow-panorama/pull/2))
-
-### Version 0.1.0
-
-2015-06-05
-
-Initial release.
+### Version 1.0.0
+
+2017-08-10
+
+[Compare changes](https://github.com/codevise/pageflow-panorama/compare/0-3-stable...v1.0.0)
+
+- Improve thumbnail processing
+  ([#19](https://github.com/codevise/pageflow-panorama/pull/19))
+- Load subdirectories of `config/locales`.
+  ([#18](https://github.com/codevise/pageflow-panorama/pull/18))
+- Fix unpacking progress and improve retry
+  ([#17](https://github.com/codevise/pageflow-panorama/pull/17))
+- Prevent leaving invalid packages on the file system
+  ([#16](https://github.com/codevise/pageflow-panorama/pull/16))
+- Update semmy
+  ([#15](https://github.com/codevise/pageflow-panorama/pull/15))
+- Setup travis
+  ([#14](https://github.com/codevise/pageflow-panorama/pull/14))
+- Migration added index for video files instead of packages
+  ([#13](https://github.com/codevise/pageflow-panorama/pull/13))
+- Allow different thumbnail names
+  ([#12](https://github.com/codevise/pageflow-panorama/pull/12))
+- Support pageflow 12
+  ([#11](https://github.com/codevise/pageflow-panorama/pull/11))
+- Add css class to background for slim controls shadow
+  ([#10](https://github.com/codevise/pageflow-panorama/pull/10))
+- Add nested files support
+  ([#9](https://github.com/codevise/pageflow-panorama/pull/9))
+
+See
+[0-3-stable branch](https://github.com/codevise/pageflow-panorama/blob/0-3-stable/CHANGELOG.md)
+for previous changes.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in panorama.gemspec
 gemspec
+
+gem 'state_machine', git: 'https://github.com/codevise/state_machine.git'

data/README.md

@@ -1,6 +1,7 @@
 # Pageflow Panorama
 
 [![Gem Version](https://badge.fury.io/rb/pageflow-panorama.svg)](http://badge.fury.io/rb/pageflow-panorama)
+[![Build Status](https://travis-ci.org/codevise/pageflow-panorama.svg?branch=master)](https://travis-ci.org/codevise/pageflow-panorama)
 
 Page type showing 360° panoramas in embedded iframes. Currently
 supported are panoramas by palmsfilm.com, panogate.com and KRPano via

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

@@ -1,3 +1,5 @@
+require 'pageflow/panorama/validation'
+
 module Pageflow
   module Panorama
     class UnpackPackageJob
@@ -5,24 +7,48 @@ module Pageflow
 
       extend StateMachineJob
 
-      def self.perform_with_result(package, options)
+      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
+          Archive.for(package) do |archive|
+            parse(package, archive)
+            unpack_to_s3(package, archive, &progress)
+          end
         end
 
         :ok
+      rescue Panorama::Validation::Error
+        :error
       end
 
-      private
+      private_class_method
+
+      def self.unpack_to_s3(package, archive, &progress)
+        bucket = Panorama.bucket_factory.from_attachment(package.attachment_on_s3)
+
+        UnpackToS3
+          .new(archive: archive,
+               destination_bucket: bucket,
+               destination_base_path: package.unpack_base_path,
+               content_type_mapping: Panorama.config.content_type_mapping)
+          .upload(&progress)
+      end
 
-      def self.parse(package)
-        result = Validation.parse(package.archive)
+      def self.parse(package, archive)
+        result = Validation.parse(archive)
 
         package.index_document = result.index_document
-        package.thumbnail = package.archive.find_entry(result.thumbnail)
+        process_thumbnail(package, archive.find_entry(result.thumbnail))
+      end
+
+      def self.process_thumbnail(package, thumbnail_file)
+        package.thumbnail = thumbnail_file
+        package.valid?
+
+        if package.errors.include?(:thumbnail)
+          package.thumbnail = nil
+          raise(Panorama::Validation::Error
+                .new('pageflow.panorama.validation.unprocessable_thumbnail'))
+        end
       end
     end
   end

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

@@ -18,6 +18,10 @@ module Pageflow
           transition 'unpacking_failed' => 'unpacking'
         end
 
+        before_transition on: :retry do |package|
+          JobStatusAttributes.reset(package, stage: :unpacking)
+        end
+
         job UnpackPackageJob do
           on_enter 'unpacking'
           result :ok, state: 'unpacked'
@@ -30,34 +34,18 @@ module Pageflow
                                  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,
-                       content_type_mapping: Panorama.config.content_type_mapping)
+      def unpack_base_path
+        attachment_on_s3.present? ? File.dirname(attachment_on_s3.path(:unpacked)) : nil
       end
     end
   end

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

@@ -6,7 +6,7 @@
     </div>
   </div>
 
-  <div class="backgroundArea">
+  <div class="backgroundArea page_background page_background-for_page_with_player_controls">
     <%= background_image_div(configuration, 'fallback_image') %>
     <%= content_tag(:div, class: 'videoWrapper iframeWrapper', data: {panorama_url: panorama_url(configuration) }) do %>
     <% end %>

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/config/locales/de.yml

@@ -5,6 +5,10 @@ de:
         panorama_package_id: KRPano
         panorama_source: Panorama Quelle
         panorama_url: Panorama URL
+    models:
+      pageflow/panorama/package:
+        one: Panorama Package File
+        other: Panorama Package Files
     values:
       pageflow/page:
         panorama_source:
@@ -24,12 +28,13 @@ de:
     panorama:
       help_entries:
         page_type:
-          menu_item: 360° Panorama
-          text: ! "# 360° Panorama\n\n*Bettet ein interaktives Panorama ein*\n    \nZwei 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"
+          menu_item: 360° Bild
+          text: "# 360° Bild\n\n*Bettet ein interaktives Panorama ein*\n    \nZwei 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_type_category_name: Interaktiv
       page_type_description: Interaktive Panorama-Ansicht mit KRPano.
-      page_type_name: 360° Ansicht
+      page_type_name: 360° Bild
       validation:
         missing_index_document: Index-Dokument nicht gefunden.
         missing_preview: Vorschau-Bild nicht gefunden.
         missing_tiles_directory: Tiles-Verzeichnis nicht gefunden.
+        unprocessable_thumbnail: Thumbnail konnte nicht verarbeitet werden.

data/config/locales/en.yml

@@ -5,6 +5,10 @@ en:
         panorama_package_id: KRPano
         panorama_source: Panorama Source
         panorama_url: Panorama URL
+    models:
+      pageflow/panorama/package:
+        one: Panorama Package File
+        other: Panorama Package Files
     values:
       pageflow/page:
         panorama_source:
@@ -24,12 +28,13 @@ en:
     panorama:
       help_entries:
         page_type:
-          menu_item: 360° Panorama
-          text: ! "# 360° Panorama\n\n*Embeds an interactive panorama*\n    \n### External Panorama\n\nPanoramas that are already available on the web can be embedded via an URL. Choose \"External Panorama\" as Panorama Source and paste the URL.\n\n### Uploaded Zip File\n\nAlternatively, 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.\n\nTypical use cases: Impressing places, travel reports, architecture"
+          menu_item: 360° Image
+          text: "# 360° Image\n\n*Embeds an interactive panorama*\n    \n### External Panorama\n\nPanoramas that are already available on the web can be embedded via an URL. Choose \"External Panorama\" as Panorama Source and paste the URL.\n\n### Uploaded Zip File\n\nAlternatively, 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.\n\nTypical use cases: Impressing places, travel reports, architecture"
       page_type_category_name: Interactive
       page_type_description: Interactive panorama using KRPano.
-      page_type_name: 360° Panorama
+      page_type_name: 360° Image
       validation:
         missing_index_document: Index document not found.
         missing_preview: Preview image not found.
         missing_tiles_directory: Tiles directory not found.
+        unprocessable_thumbnail: Unprocessable thumbnail.

data/db/migrate/20160824115300_add_parent_file_to_packages.rb

@@ -0,0 +1,8 @@
+class AddParentFileToPackages < ActiveRecord::Migration
+  def change
+    add_column :pageflow_panorama_packages, :parent_file_id, :integer
+    add_column :pageflow_panorama_packages, :parent_file_model_type, :string
+    add_index :pageflow_panorama_packages, [:parent_file_id, :parent_file_model_type],
+              name: 'index_package_files_on_parent_id_and_parent_model_type'
+  end
+end

data/lib/generators/pageflow_panorama/install/install_generator.rb

@@ -0,0 +1,17 @@
+module PageflowPanorama
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Install the Pageflow plugin and the necessary migrations.'
+
+    def register_plugin
+      inject_into_file('config/initializers/pageflow.rb',
+                       after: "Pageflow.configure do |config|\n") do
+
+        "  config.page_types.register(Pageflow::Panorama.page_type)\n"
+      end
+    end
+
+    def install_migrations
+      rake "pageflow_panorama:install:migrations"
+    end
+  end
+end

data/lib/pageflow/panorama/archive.rb

@@ -0,0 +1,16 @@
+module Pageflow
+  module Panorama
+    module Archive
+      def self.for(package)
+        tempfile = Paperclip.io_adapters.for(package.attachment)
+
+        begin
+          yield(Zip::File.open(tempfile.path))
+        ensure
+          tempfile.close
+          tempfile.unlink
+        end
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/engine.rb

@@ -7,6 +7,7 @@ module Pageflow
       isolate_namespace Pageflow::Panorama
 
       config.autoload_paths << File.join(config.root, 'lib')
+      config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.yml').to_s]
     end
   end
 end

data/lib/pageflow/panorama/job_status_attributes.rb

@@ -5,6 +5,10 @@ module Pageflow
         new(record, options[:stage]).call(&block)
       end
 
+      def self.reset(record, options = {})
+        new(record, options[:stage]).reset
+      end
+
       def call(&block)
         update_progress(0)
 
@@ -15,6 +19,10 @@ module Pageflow
         end
       end
 
+      def reset
+        update_progress(0)
+      end
+
       private
 
       def update_progress(percent)

data/lib/pageflow/panorama/page_type.rb

@@ -12,7 +12,8 @@ module Pageflow
       def file_types
         [
           FileType.new(model: Package,
-                       editor_partial: 'pageflow/panorama/editor/packages/package')
+                       editor_partial: 'pageflow/panorama/editor/packages/package',
+                       top_level_type: true)
         ]
       end
 

data/lib/pageflow/panorama/s3_bucket.rb

@@ -0,0 +1,25 @@
+module Pageflow
+  module Panorama
+    class S3Bucket
+      attr_reader :bucket
+
+      def initialize(bucket)
+        @bucket = bucket
+      end
+
+      def write(name:, input_stream:, content_length:, content_type:)
+        object = bucket.objects[name]
+        object.write(input_stream,
+                     acl: :public_read,
+                     content_type: content_type,
+                     content_length: content_length)
+      end
+
+      class Factory
+        def from_attachment(attachment)
+          S3Bucket.new(attachment.s3_bucket)
+        end
+      end
+    end
+  end
+end

data/lib/pageflow/panorama/unpack_to_s3.rb

@@ -3,21 +3,22 @@ require 'zip'
 module Pageflow
   module Panorama
     class UnpackToS3
-      attr_reader :archive, :destination_bucket, :destination_base_path,
-                  :content_type_mapping
+      attr_reader :archive, :destination_bucket, :destination_base_path, :content_type_mapping
 
-      def initialize(options)
-        @archive = options.fetch(:archive)
-        @destination_bucket = options.fetch(:destination_bucket)
-        @destination_base_path = options.fetch(:destination_base_path)
-        @content_type_mapping = options.fetch(:content_type_mapping, {})
+      def initialize(archive:, destination_bucket:, destination_base_path:, content_type_mapping: {})
+        @archive = archive
+        @destination_bucket = destination_bucket
+        @destination_base_path = destination_base_path
+        @content_type_mapping = content_type_mapping
       end
 
-      def upload(&progress)
+      def upload
         archive.entries.each_with_index do |entry, index|
           yield(100.0 * index / archive.entries.size) if block_given?
           upload_entry(entry)
         end
+
+        yield(100) if block_given?
       end
 
       private
@@ -25,17 +26,13 @@ module Pageflow
       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,
-                                      content_type: content_type_for(entry.name))
+          destination_bucket.write(name: destination_path(entry.name),
+                                   input_stream: entry.get_input_stream,
+                                   content_length: entry.size,
+                                   content_type: content_type_for(entry.name))
         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
@@ -44,7 +41,7 @@ module Pageflow
         content_type_mapping[File.extname(file_name).delete('.')]
       end
 
-      def with_retry(&block)
+      def with_retry
         retries = 0
 
         begin
@@ -52,12 +49,10 @@ module Pageflow
         rescue AWS::S3::Errors::SlowDown
           retries += 1
 
-          if retries <= 5
-            sleep((2 ** retries) * 0.5)
-            retry
-          else
-            raise
-          end
+          raise if retries > 5
+
+          sleep((2**retries) * 0.5)
+          retry
         end
       end
     end

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

@@ -20,14 +20,18 @@ module Pageflow
         end
 
         def find_thumbnail!
-          find_file!('**/mobile_f.jpg', :missing_preview)
+          find_file!('**/*_f.jpg', :missing_preview)
         end
 
         def find_file!(glob, message_i18n_key)
-          entries.map(&:name).find do |name|
+          ignore_dot_files(entries.map(&:name)).find do |name|
             File.fnmatch(glob, name)
           end || raise(Error.new("pageflow.panorama.validation.#{message_i18n_key}"))
         end
+
+        def ignore_dot_files(names)
+          names.reject { |name| File.basename(name).start_with?('.') }
+        end
       end
     end
   end

data/lib/pageflow/panorama/version.rb

@@ -1,5 +1,5 @@
 module Pageflow
   module Panorama
-    VERSION = '0.3.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/pageflow-panorama.rb

@@ -13,5 +13,13 @@ module Pageflow
     def self.page_type
       Panorama::PageType.new
     end
+
+    def self.bucket_factory
+      @bucket_factory ||= Panorama::S3Bucket::Factory.new
+    end
+
+    def self.bucket_factory=(bucket_factory)
+      @bucket_factory = bucket_factory
+    end
   end
 end

data/pageflow-panorama.gemspec

@@ -16,16 +16,20 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "pageflow", "~> 0.11"
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_runtime_dependency "pageflow", [">= 0.11", "< 13"]
+  spec.add_runtime_dependency 'state_machine_job', ['>= 0.2', '< 2']
   spec.add_runtime_dependency "rubyzip", "~> 1.1"
   spec.add_runtime_dependency 'pageflow-public-i18n', '~> 1.0'
 
+  spec.add_development_dependency 'pageflow-support', '>= 0.11.4'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec-rails", "~> 2.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.0"
   spec.add_development_dependency 'factory_girl_rails'
   spec.add_development_dependency "mysql2"
 
   # Semantic versioning rake tasks
-  spec.add_development_dependency 'semmy', '~> 0.3.0'
+  spec.add_development_dependency 'semmy', '~> 1.0'
 end

data/spec/models/pageflow/panorama/package_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module Pageflow
+  module Panorama
+    describe Package do
+      describe '#process', inline_resque: true do
+        it 'parses thumbnail and index document' do
+          zip_file = File.open(Engine.root.join('spec', 'fixtures', 'krpano.zip'))
+          package = Package.create!(attachment: zip_file)
+
+          package.publish!
+          package.reload
+
+          expect(package.thumbnail).to be_present
+          expect(package.index_document).to be_present
+        end
+
+        it 'uploads files to bucket' do
+          zip_file = File.open(Engine.root.join('spec', 'fixtures', 'krpano.zip'))
+          package = Package.create!(attachment: zip_file)
+          bucket = Doubles.bucket
+
+          Panorama.bucket_factory = TestBucketFactory.new(bucket)
+
+          package.publish!
+          package.reload
+
+          expect(bucket).to have_received(:write)
+            .with(hash_including(name: package.index_document_path))
+        end
+
+        it 'updates unpacking_progress' do
+          zip_file = File.open(Engine.root.join('spec', 'fixtures', 'krpano.zip'))
+          package = Package.create!(attachment: zip_file)
+
+          package.publish!
+          package.reload
+
+          expect(package.unpacking_progress).to eq(100)
+        end
+
+        it 'transitions to failed state if validation fails' do
+          zip_file = File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          package = Package.create!(attachment: zip_file)
+
+          package.publish!
+          package.reload
+
+          expect(package.state).to eq('unpacking_failed')
+        end
+
+        it 'transitions to failed state if thumbnail is unprocessable' do
+          zip_file = File.open(Engine.root.join('spec',
+                                                'fixtures',
+                                                'krpano_with_unprocessable_thumbnail.zip'))
+          package = Package.create!(attachment: zip_file)
+
+          package.publish!
+          package.reload
+
+          expect(package.state).to eq('unpacking_failed')
+        end
+
+        class TestBucketFactory
+          def initialize(bucket)
+            @bucket = bucket
+          end
+
+          def from_attachment(_attachment)
+            @bucket
+          end
+        end
+      end
+
+      describe '#retry', stub_resque: true do
+        it 'resets unpacking progress and error_message' do
+          zip_file = File.open(Engine.root.join('spec', 'fixtures', 'krpano.zip'))
+          package = Package.create!(attachment: zip_file,
+                                    state: 'unpacking_failed',
+                                    unpacking_progress: 50,
+                                    unpacking_error_message: 'failed')
+
+          package.retry!
+
+          expect(package.unpacking_progress).to eq(0)
+          expect(package.unpacking_error_message).to eq(nil)
+        end
+      end
+    end
+  end
+end

data/spec/pageflow/panorama/job_status_attributes_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module Pageflow
+  module Panorama
+    describe JobStatusAttributes do
+      describe '#handle' do
+        it 'updates phase progress attribute when passed block is called' do
+          record = Package.create!(unpacking_progress: 0)
+
+          JobStatusAttributes.handle(record, stage: :unpacking) do |&progress|
+            progress.call(20)
+          end
+
+          expect(record.reload.unpacking_progress).to eq(20)
+        end
+
+        it 'sets phase error message if error with message_i18n_key is raised' do
+          record = Package.create!(unpacking_progress: 0)
+          error_with_message_i18n_key = Class.new(RuntimeError) do
+            def message_i18n_key
+              :i18n_key
+            end
+          end
+
+          begin
+            JobStatusAttributes.handle(record, stage: :unpacking) do |&progress|
+              raise(error_with_message_i18n_key.new)
+            end
+          rescue error_with_message_i18n_key
+          end
+
+          expect(record.unpacking_error_message).to eq('i18n_key')
+        end
+      end
+
+      describe '#reset' do
+        it 'resets progress and error message attrbute' do
+          record = Package.create!(unpacking_progress: 20,
+                                   unpacking_error_message: 'fail')
+
+          JobStatusAttributes.reset(record, stage: :unpacking)
+
+          expect(record.unpacking_progress).to eq(0)
+          expect(record.unpacking_error_message).to eq(nil)
+        end
+      end
+    end
+  end
+end

data/spec/pageflow/panorama/unpack_to_s3_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module Pageflow
+  module Panorama
+    describe UnpackToS3 do
+      describe '#upload' do
+        it 'writes files from zip to bucket' do
+          archive = Zip::File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          bucket = Doubles.bucket
+          unpack_to_s3 = UnpackToS3.new(archive: archive,
+                                        destination_bucket: bucket,
+                                        destination_base_path: 'base')
+
+          unpack_to_s3.upload
+
+          expect(bucket).to have_received(:write).with(hash_including(name: 'base/some.txt'))
+        end
+
+        it 'reports progress' do
+          archive = Zip::File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          bucket = Doubles.bucket
+          unpack_to_s3 = UnpackToS3.new(archive: archive,
+                                        destination_bucket: bucket,
+                                        destination_base_path: 'base')
+
+          expect { |probe|
+            unpack_to_s3.upload(&probe)
+          }.to yielding_successive_args(0, 100)
+        end
+
+        it 'determines content type via mapping' do
+          archive = Zip::File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          bucket = Doubles.bucket
+          unpack_to_s3 = UnpackToS3.new(archive: archive,
+                                        destination_bucket: bucket,
+                                        destination_base_path: 'base',
+                                        content_type_mapping: {
+                                          'txt' => 'text/plain'
+                                        })
+
+          unpack_to_s3.upload
+
+          expect(bucket).to have_received(:write).with(hash_including(content_type: 'text/plain'))
+        end
+
+        it 'retries when write fails' do
+          archive = Zip::File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          bucket = Doubles.bucket_raising_once(AWS::S3::Errors::SlowDown)
+          unpack_to_s3 = UnpackToS3.new(archive: archive,
+                                        destination_bucket: bucket,
+                                        destination_base_path: 'base')
+
+          allow(unpack_to_s3).to receive(:sleep)
+          unpack_to_s3.upload
+
+          expect(bucket).to have_received(:write).twice
+        end
+
+        it 're-raises exception when write fails too often' do
+          archive = Zip::File.open(Engine.root.join('spec', 'fixtures', 'some.txt.zip'))
+          bucket = Doubles.bucket_raising(AWS::S3::Errors::SlowDown)
+          unpack_to_s3 = UnpackToS3.new(archive: archive,
+                                        destination_bucket: bucket,
+                                        destination_base_path: 'base')
+
+          allow(unpack_to_s3).to receive(:sleep)
+
+          expect {
+            unpack_to_s3.upload
+          }.to raise_error(AWS::S3::Errors::SlowDown)
+        end
+      end
+    end
+  end
+end

data/spec/pageflow/panorama/validation/kr_pano_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Pageflow
+  module Panorama
+    module Validation
+      describe KrPano do
+        def entry_double(name, type, size)
+          double(name: name, size: size).tap do |entry|
+            allow(entry).to receive(:file?).and_return(type == :file)
+          end
+        end
+
+        let(:entries_of_valid_archive) do
+          [
+            entry_double('pano.tiles/', :directory, 0),
+            entry_double('pano.tiles/mobile_f.jpg', :file, 40),
+            entry_double('pano.html', :file, 60),
+            entry_double('pano.xml', :file, 60)
+          ]
+        end
+
+        let(:entries_of_archive_without_tiles) do
+          [
+            entry_double('pano.html', :file, 60),
+            entry_double('pano.xml', :file, 60)
+          ]
+        end
+
+        let(:entries_silly_macosx_archive) do
+          [
+            entry_double('__MACOSX/', :directory, 0),
+            entry_double('__MACOSX/pano.tiles/', :directory, 0),
+            entry_double('__MACOSX/pano.tiles/._mobile_f.jpg', :file, 40),
+            entry_double('pano.tiles/', :directory, 0),
+            entry_double('pano.tiles/mobile_f.jpg', :file, 40),
+            entry_double('pano.html', :file, 60),
+            entry_double('pano.xml', :file, 60)
+          ]
+        end
+
+        describe '#parse' do
+          it 'finds thumbnail' do
+            validation = KrPano.new(entries_of_valid_archive)
+
+            result = validation.parse
+
+            expect(result.thumbnail).to eq('pano.tiles/mobile_f.jpg')
+          end
+
+          it 'ignores thumbnails starting with dot' do
+            validation = KrPano.new(entries_silly_macosx_archive)
+
+            result = validation.parse
+
+            expect(result.thumbnail).to eq('pano.tiles/mobile_f.jpg')
+          end
+
+          it 'finds index document' do
+            validation = KrPano.new(entries_of_valid_archive)
+
+            result = validation.parse
+
+            expect(result.index_document).to eq('pano.html')
+          end
+
+          it 'raises validation error if tiles dir is missing' do
+            entries = entries_of_archive_without_tiles
+            validation = KrPano.new(entries)
+
+            expect {
+              validation.parse
+            }.to raise_error(Error)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV['RAILS_ENV'] ||= 'test'
+ENV['PAGEFLOW_PLUGIN_ENGINE'] = 'pageflow_panorama'
+
+require 'pageflow/support'
+Pageflow::Dummy.setup
+
+require 'rspec/rails'
+
+engine_root = File.join(File.dirname(__FILE__), '..')
+Dir[File.join(engine_root, 'spec/support/**/*.rb')].each { |file| require(file) }
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

data/spec/support/config/pageflow_panorama.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    Pageflow::Panorama.bucket_factory = DoubleBucketFactory.new
+  end
+
+  class DoubleBucketFactory
+    def from_attachment(_attachment)
+      Doubles.bucket
+    end
+  end
+end

data/spec/support/config/resque.rb

@@ -0,0 +1,13 @@
+RSpec.configure do |config|
+  config.before(:each, inline_resque: true) do
+    Resque.inline = true
+  end
+
+  config.after(:each, inline_resque: true) do
+    Resque.inline = false
+  end
+
+  config.before(:each, stub_resque: true) do
+    allow(Resque).to receive(:enqueue)
+  end
+end

data/spec/support/helpers/doubles.rb

@@ -0,0 +1,27 @@
+module Doubles
+  extend RSpec::Mocks::ExampleMethods
+  extend self
+
+  def bucket
+    instance_double(Pageflow::Panorama::S3Bucket).as_null_object
+  end
+
+  def bucket_raising_once(error)
+    bucket.tap do |bucket|
+      called = false
+
+      allow(bucket).to receive(:write) do
+        unless called
+          called = true
+          raise error
+        end
+      end
+    end
+  end
+
+  def bucket_raising(error)
+    bucket.tap do |bucket|
+      allow(bucket).to receive(:write).and_raise(error)
+    end
+  end
+end

metadata

@@ -1,29 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: pageflow-panorama
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Codevise Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pageflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: state_machine_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pageflow-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +168,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
 description: 
 email:
 - info@codevise.de
@@ -144,6 +184,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -170,17 +211,22 @@ files:
 - 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
+- bin/rails-cmd
+- bin/rspec
 - 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
+- db/migrate/20160824115300_add_parent_file_to_packages.rb
+- lib/generators/pageflow_panorama/install/install_generator.rb
 - lib/pageflow-panorama.rb
+- lib/pageflow/panorama/archive.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/s3_bucket.rb
 - lib/pageflow/panorama/unpack_to_s3.rb
 - lib/pageflow/panorama/validation.rb
 - lib/pageflow/panorama/validation/error.rb
@@ -189,6 +235,18 @@ files:
 - lib/pageflow/panorama/version.rb
 - lib/pageflow/panorama/zip_entry_paperclip_io_adapter.rb
 - pageflow-panorama.gemspec
+- spec/fixtures/dir_some.txt.zip
+- spec/fixtures/krpano.zip
+- spec/fixtures/krpano_with_unprocessable_thumbnail.zip
+- spec/fixtures/some.txt.zip
+- spec/models/pageflow/panorama/package_spec.rb
+- spec/pageflow/panorama/job_status_attributes_spec.rb
+- spec/pageflow/panorama/unpack_to_s3_spec.rb
+- spec/pageflow/panorama/validation/kr_pano_spec.rb
+- spec/spec_helper.rb
+- spec/support/config/pageflow_panorama.rb
+- spec/support/config/resque.rb
+- spec/support/helpers/doubles.rb
 homepage: https://github.com/codevise/pageflow-panorama
 licenses:
 - MIT
@@ -199,9 +257,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -209,8 +267,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Pagetype for iframe embedded 360° panoramas
-test_files: []
+test_files:
+- spec/fixtures/dir_some.txt.zip
+- spec/fixtures/krpano.zip
+- spec/fixtures/krpano_with_unprocessable_thumbnail.zip
+- spec/fixtures/some.txt.zip
+- spec/models/pageflow/panorama/package_spec.rb
+- spec/pageflow/panorama/job_status_attributes_spec.rb
+- spec/pageflow/panorama/unpack_to_s3_spec.rb
+- spec/pageflow/panorama/validation/kr_pano_spec.rb
+- spec/spec_helper.rb
+- spec/support/config/pageflow_panorama.rb
+- spec/support/config/resque.rb
+- spec/support/helpers/doubles.rb