pageflow 13.6.0 → 14.0.0.beta1

data/app/models/pageflow/image_file_css_background_image_urls.rb

@@ -4,12 +4,12 @@ module Pageflow
     def call(image_file)
       {
         default: {
-          desktop: image_file.attachment.url(:large),
-          mobile: image_file.attachment.url(:medium)
+          desktop: image_file.ready? ? image_file.attachment.url(:large) : '',
+          mobile: image_file.ready? ? image_file.attachment.url(:medium) : ''
         },
         panorama: {
-          desktop: image_file.attachment.url(:panorama_large),
-          mobile: image_file.attachment.url(:panorama_medium)
+          desktop: image_file.ready? ? image_file.attachment.url(:panorama_large) : '',
+          mobile: image_file.ready? ? image_file.attachment.url(:panorama_medium) : ''
         }
       }
     end

data/app/models/pageflow/image_file_url_templates.rb

@@ -9,11 +9,11 @@ module Pageflow
     private
 
     def styles
-      ImageFile::STYLES.call(example_file.attachment).keys
+      example_file.attachment_styles(example_file.attachment).keys
     end
 
     def example_file
-      @example_file ||= ImageFile.new(id: 0, processed_attachment_file_name: ':basename.jpg')
+      @example_file ||= ImageFile.new(id: 0, file_name: ':basename.jpg')
     end
   end
 end

data/app/models/pageflow/positioned_file.rb

@@ -34,7 +34,7 @@ module Pageflow
       end
 
       def thumbnail_url(*args)
-        ImageFile.new.processed_attachment.url(*args)
+        ImageFile.new.attachment.url(*args)
       end
 
       def blank?

data/app/models/pageflow/text_track_file.rb

@@ -1,41 +1,24 @@
 module Pageflow
   class TextTrackFile < ApplicationRecord
     include HostedFile
+    include ProcessedFileStateMachine
 
-    processing_state_machine do
-      state 'processing'
-      state 'processed'
-      state 'processing_failed'
-
-      event :process do
-        transition any => 'processing'
-      end
-
-      job ProcessFileJob do
-        on_enter 'processing'
-        result :ok, state: 'processed'
-        result :error, state: 'processing_failed'
-      end
-    end
-
-    has_attached_file(:processed_attachment,
-                      Pageflow.config.paperclip_s3_default_options
-                        .merge(styles: {
-                                 vtt: {
-                                   format: 'vtt',
-                                   processors: [:pageflow_vtt],
-                                   s3_headers: {
-                                     'Content-Type' => 'text/vtt'
-                                   }
-                                 }
-                               }))
-
-    def ready?
-      processed?
+    def attachment_styles(_attachment)
+      {
+        vtt: {
+          format: 'vtt',
+          processors: [:pageflow_vtt],
+          s3_headers: {
+            'Content-Type' => 'text/vtt'
+          }
+        }
+      }
     end
 
-    def unprocessed_attachment
-      attachment_on_s3
+    # used in paperclip initializer to interpolate the storage path
+    # needs to be "processed_attachments" for text tracks for legacy reasons
+    def attachments_path_name
+      'processed_attachments'
     end
 
     def meta_data_attributes=(attributes)

data/app/models/pageflow/text_track_file_url_templates.rb

@@ -2,15 +2,14 @@ module Pageflow
   class TextTrackFileUrlTemplates
     def call
       {
-        vtt: UrlTemplate.from_attachment(example_file.processed_attachment, :vtt)
+        vtt: UrlTemplate.from_attachment(example_file.attachment, :vtt)
       }
     end
 
     private
 
     def example_file
-      @example_file ||= TextTrackFile.new(id: 0,
-                                          processed_attachment_file_name: ':basename.vtt')
+      @example_file ||= TextTrackFile.new(id: 0, file_name: ':basename.vtt')
     end
   end
 end

data/app/models/pageflow/video_file.rb

@@ -40,7 +40,7 @@ module Pageflow
     end
 
     def attachment_s3_url
-      "s3://#{File.join(attachment_on_s3.bucket_name, attachment_on_s3.path)}"
+      "s3://#{File.join(attachment.bucket_name, attachment.path)}"
     end
 
     def encode_highdef?

data/app/models/pageflow/video_file_url_templates.rb

@@ -26,7 +26,7 @@ module Pageflow
 
     def example_file
       @example_file ||= VideoFile.new(id: 0).tap do |video_file|
-        video_file.attachment_on_s3_file_name = ':basename.mp4'
+        video_file.file_name = ':basename.mp4'
         video_file.poster_file_name = video_file.zencoder_poster.original_filename
       end
     end

data/app/state_machines/pageflow/{image_file_state_machine.rb → processed_file_state_machine.rb}

@@ -1,19 +1,17 @@
 module Pageflow
-  module ImageFileStateMachine
+  module ProcessedFileStateMachine
     extend ActiveSupport::Concern
 
     included do
-      state_machine :initial => 'not_processed' do
+      processing_state_machine do
         extend StateMachineJob::Macro
 
-        state 'not_processed'
         state 'processing'
         state 'processed'
-
-        state 'processing_to_s3_failed'
+        state 'processing_failed'
 
         event :process do
-          transition 'not_processed' => 'processing'
+          transition 'uploaded' => 'processing'
           transition 'processing_failed' => 'processing'
         end
 
@@ -29,10 +27,6 @@ module Pageflow
       process!
     end
 
-    def publish!
-      process!
-    end
-
     def retryable?
       processing_failed?
     end

data/app/views/pageflow/editor/files/_file.json.jbuilder

@@ -7,6 +7,10 @@ json.call(file,
           :rights,
           :usage_id)
 
+if file.can_upload?
+  json.direct_upload_config(file.direct_upload_config)
+end
+
 json.retryable(file.retryable?)
 json.file_name(file.attachment.original_filename)
 

data/app/views/pageflow/entries/edit.html.erb

@@ -28,8 +28,8 @@
 <div class="editor" id="editor_menu_container">
 </div>
 
-<%= form_for editor_entry_files_path(@entry, collection_name: 'image_files'), :html => {:multipart => true, :id => 'upload'} do |f| %>
-  <%= f.file_field :attachment, :multiple => true, :name => 'image_file[attachment]' %>
+<%= form_tag '#', :multipart => true, :id => 'upload' do %>
+  <%= file_field_tag :file, :multiple => true %>
 <% end %>
 
 <script>

data/app/views/pageflow/entries/mobile_navigation/_page.html.erb

@@ -1,5 +1,6 @@
 <li class="<%= page_navigation_css_class(page) %>">
   <%= link_to "##{page.perma_id}", data: {link: page.id, chapter_id: page.chapter_id} do %>
     <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:thumbnail_overview_mobile))}) %>
+    <%= page.title %>
   <% end %>
 </li>

data/app/views/pageflow/entries/navigation/_page.html.erb

@@ -1,6 +1,7 @@
 <li class="<%= page_navigation_css_class(page) %>">
   <%= link_to "##{page.perma_id}", :data => {:link => page.id, :chapter_id => page.chapter_id} do %>
-      <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:navigation_thumbnail_small))}, width: 85, height: 47) %>
+    <%= image_tag('', data: {src: asset_path(page.thumbnail_url(:navigation_thumbnail_small))}, width: 85, height: 47) %>
+    <%= page.title %>
   <% end %>
   <div class="navigation_site_detail">
     <%= page.title %>

data/config/initializers/paperclip.rb

@@ -10,6 +10,12 @@ Paperclip.interpolates(:class_basename) do |attachment, style|
   Pageflow::PaperclipInterpolations::Support.class_basename(attachment, style)
 end
 
+Paperclip.interpolates(:attachments_path_name) do |attachment, style|
+  record = attachment.instance
+  return record.attachments_path_name if record.respond_to?(:attachments_path_name)
+  self.attachment(attachment, style)
+end
+
 Paperclip.interpolates(:pageflow_placeholder) do |attachment, style|
   Pageflow::PaperclipInterpolations::Support.pageflow_placeholder(attachment, style)
 end

data/config/routes.rb

@@ -55,9 +55,9 @@ Pageflow::Engine.routes.draw do
         resources :files,
                   path: 'files/:collection_name',
                   only: [:index, :create, :update, :destroy] do
-          post :empty, on: :collection, to: 'files#create'
           post :reuse, on: :collection
           post :retry, on: :member
+          put :publish, on: :member
         end
       end
 

data/db/migrate/20181115165746_change_processed_attachment_to_attachment_on_s3_for_images.rb

@@ -0,0 +1,16 @@
+class ChangeProcessedAttachmentToAttachmentOnS3ForImages < ActiveRecord::Migration[5.2]
+  def change
+    rename_column :pageflow_image_files,
+                  :processed_attachment_file_name,
+                  :attachment_on_s3_file_name
+    rename_column :pageflow_image_files,
+                  :processed_attachment_content_type,
+                  :attachment_on_s3_content_type
+    rename_column :pageflow_image_files,
+                  :processed_attachment_file_size,
+                  :attachment_on_s3_file_size
+    rename_column :pageflow_image_files,
+                  :processed_attachment_updated_at,
+                  :attachment_on_s3_updated_at
+  end
+end

data/db/migrate/20190306161431_copy_file_attributes_of_failed_uploads.rb

@@ -0,0 +1,25 @@
+class CopyFileAttributesOfFailedUploads < ActiveRecord::Migration[5.2]
+  def up
+    %w(audio text_track video).each do |hosted_file_type|
+      execute("UPDATE pageflow_#{hosted_file_type}_files hf
+                   SET hf.attachment_on_s3_file_name = hf.attachment_on_filesystem_file_name,
+                       hf.attachment_on_s3_content_type = hf.attachment_on_filesystem_content_type,
+                       hf.attachment_on_s3_file_size = hf.attachment_on_filesystem_file_size,
+                       hf.attachment_on_s3_updated_at = hf.attachment_on_filesystem_updated_at,
+                       hf.state = 'uploading_failed'
+                   WHERE hf.state = 'uploading_to_s3_failed';")
+    end
+  end
+
+  def down
+    %w(audio text_track video).each do |hosted_file_type|
+      execute("UPDATE pageflow_#{hosted_file_type}_files hf
+                   SET hf.attachment_on_s3_file_name = NULL,
+                       hf.attachment_on_s3_content_type = NULL,
+                       hf.attachment_on_s3_file_size = NULL,
+                       hf.attachment_on_s3_updated_at = NULL,
+                       hf.state = 'uploading_to_s3_failed'
+                   WHERE hf.state = 'uploading_failed';")
+    end
+  end
+end

data/lib/pageflow/configuration.rb

@@ -1,10 +1,6 @@
 module Pageflow
   # Options to be defined in the pageflow initializer of the main app.
   class Configuration
-    # Default options for paperclip attachments which are supposed to
-    # use filesystem storage.
-    attr_accessor :paperclip_filesystem_default_options
-
     # Default options for paperclip attachments which are supposed to use
     # s3 storage.
     attr_accessor :paperclip_s3_default_options
@@ -26,6 +22,16 @@ module Pageflow
     # @since 13.0
     attr_accessor :paperclip_s3_root
 
+    # Upload options provided to direct upload form.
+    # Defaults to S3 storage options.
+    # returns a hash with keys:
+    # - url: The URL to use as the action of the form
+    # - fields: A hash of fields that will be included in the direct upload form.
+    #           This hash should include the signed POST policy, the access key ID and
+    #           security token (if present), etc.
+    #           These fields will be included as input elements of type 'hidden' on the form
+    attr_accessor :paperclip_direct_upload_options
+
     # Refer to the pageflow initializer template for a list of
     # supported options.
     attr_accessor :zencoder_options
@@ -314,9 +320,21 @@ module Pageflow
       @paperclip_filesystem_root = Rails.public_path.join('system/uploads')
       @paperclip_s3_root = 'main'
 
-      @paperclip_filesystem_default_options = Defaults::PAPERCLIP_FILESYSTEM_DEFAULT_OPTIONS.dup
       @paperclip_s3_default_options = Defaults::PAPERCLIP_S3_DEFAULT_OPTIONS.dup
 
+      @paperclip_direct_upload_options = lambda { |attachment|
+        max_upload_size = 4_294_967_296 # max file size in bytes
+        presigned_post_config = attachment.s3_bucket
+                                          .presigned_post(key: attachment.path,
+                                                          success_action_status: '201',
+                                                          acl: 'public-read',
+                                                          content_length_range: 0..max_upload_size)
+        {
+          url: presigned_post_config.url,
+          fields: presigned_post_config.fields
+        }
+      }
+
       @zencoder_options = {}
 
       @mailer_sender = 'pageflow@example.com'

data/lib/pageflow/configuration/defaults.rb

@@ -1,20 +1,13 @@
 module Pageflow
   class Configuration
     module Defaults
-      PAPERCLIP_FILESYSTEM_DEFAULT_OPTIONS = {
-        storage: :filesystem,
-        path: ':pageflow_filesystem_root/:class/:attachment/:id_partition/:style/:filename',
-        url: 'not_uploaded_yet',
-        validate_media_type: false
-      }.freeze
-
       PAPERCLIP_S3_DEFAULT_OPTIONS = {
         storage: :s3,
         s3_headers: {'Cache-Control' => 'public, max-age=31536000'},
 
         url: ':s3_alias_url',
-        path: ':pageflow_s3_root/:class_basename/:attachment/' \
-          ':id_partition/:pageflow_attachments_version:style/:filename',
+        path: ':pageflow_s3_root/:class_basename/:attachments_path_name/' \
+              ':id_partition/:pageflow_attachments_version:style/:filename',
 
         validate_media_type: false,
 

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = '13.6.0'.freeze
+  VERSION = '14.0.0.beta1'.freeze
 end

data/spec/factories/audio_files.rb

@@ -4,7 +4,8 @@ module Pageflow
       entry
       uploader { create(:user) }
 
-      attachment_on_s3 { File.open(Engine.root.join('spec', 'fixtures', 'et.ogg')) }
+      attachment { File.open(Engine.root.join('spec', 'fixtures', 'et.ogg')) }
+      state { 'encoded' }
 
       transient do
         used_in { nil }
@@ -18,16 +19,23 @@ module Pageflow
         create(:file_usage, :file => file, :revision => evaluator.used_in) if evaluator.used_in
       end
 
-      trait :on_filesystem do
-        attachment_on_filesystem { File.open(Engine.root.join('spec', 'fixtures', 'et.ogg')) }
-        attachment_on_s3 { nil }
-        state { 'not_uploaded_to_s3' }
+      trait :uploading do
+        attachment { nil }
+        file_name { 'et.ogg' }
+        state { 'uploading' }
+
+        after :create do |audio_file|
+          simulate_direct_upload(audio_file)
+        end
+      end
+
+      trait :uploaded do
+        uploading
+        state { 'uploaded' }
       end
 
-      trait :uploading_to_s3_failed do
-        attachment_on_filesystem { File.open(Engine.root.join('spec', 'fixtures', 'et.ogg')) }
-        attachment_on_s3 { nil }
-        state { 'uploading_to_s3_failed' }
+      trait :uploading_failed do
+        state { 'uploading_failed' }
       end
 
       trait :waiting_for_confirmation do
@@ -39,7 +47,6 @@ module Pageflow
       end
 
       trait :encoded do
-        state { 'encoded' }
       end
     end
   end

data/spec/factories/hosted_files.rb

@@ -1,8 +1,8 @@
 module Pageflow
   FactoryBot.define do
     factory :hosted_file, class: 'Pageflow::TestHostedFile' do
-      attachment_on_s3 { File.open(Engine.root.join('spec', 'fixtures', 'image.png')) }
-      state { 'uploaded_to_s3' }
+      attachment { File.open(Engine.root.join('spec', 'fixtures', 'image.png')) }
+      state { 'uploaded' }
 
       transient do
         used_in { nil }
@@ -12,19 +12,21 @@ module Pageflow
         create(:file_usage, file: file, revision: evaluator.used_in) if evaluator.used_in
       end
 
-      trait :on_filesystem do
-        attachment_on_filesystem { File.open(Engine.root.join('spec', 'fixtures', 'image.png')) }
-        attachment_on_s3 { nil }
-        state { 'not_uploaded_to_s3' }
+      trait :uploading do
+        attachment { nil }
+        file_name { 'image.jpg' }
+        state { 'uploading' }
+
+        after :create do |hosted_file|
+          simulate_direct_upload(hosted_file)
+        end
       end
 
-      trait :uploading_to_s3_failed do
-        attachment_on_filesystem { File.open(Engine.root.join('spec', 'fixtures', 'image.png')) }
-        attachment_on_s3 { nil }
-        state { 'uploading_to_s3_failed' }
+      trait :uploaded do
       end
 
-      trait :uploaded_to_s3 do
+      trait :uploading_failed do
+        state { 'uploading_failed' }
       end
     end
   end