pageflow 0.11.4 → 12.0.0.rc1

data/config/routes.rb

@@ -9,19 +9,19 @@ Pageflow::Engine.routes.draw do
 
       resources :storylines, only: [:create, :update, :destroy] do
         collection do
-          patch :order
+          put :order
           post :scaffold
         end
 
         resources :chapters, only: [:create, :update, :destroy] do
           collection do
-            patch :order
+            put :order
             post :scaffold
           end
 
           resources :pages, only: [:create, :update, :destroy] do
             collection do
-              patch :order
+              put :order
             end
           end
         end
@@ -34,10 +34,6 @@ Pageflow::Engine.routes.draw do
       resources :entries, :only => :index, :shallow => true do
         get :seed, :on => :member
 
-        resources :files, :path => 'files/:collection_name', :only => [:index, :create, :update] do
-          get :retry, :on => :member
-        end
-
         resources :file_usages, :only => [:create, :destroy]
 
         resources :encoding_confirmations, :only => [:create] do
@@ -49,6 +45,15 @@ Pageflow::Engine.routes.draw do
         end
       end
 
+      resources :entries, only: [] do
+        resources :files,
+                  path: 'files/:collection_name',
+                  only: [:index, :create, :update, :destroy] do
+          post :reuse, on: :collection
+          post :retry, on: :member
+        end
+      end
+
       resources :subjects, path: '/subjects/:collection_name', only: [] do
         resources :widgets, :only => [:index] do
           patch :batch, :on => :collection
@@ -63,8 +68,11 @@ Pageflow::Engine.routes.draw do
   get ':entry_id/audio/:id', :to => 'files#show', :as => :short_audio_file, :defaults => {:collection_name => 'audio_files'}
 
   resources :entries, :only => [:show]
-  get ':id', :to => 'entries#show', :as => :short_entry
-  get '/', :to => 'entries#index', :as => :public_root
 
-  get ':id/pages/:page_index', :to => 'entries#page'
+  get ':id', to: 'entries#show', as: :short_entry
+  get ':id/embed', to: 'entries#show', defaults: {embed: '1'}, as: :entry_embed
+
+  get '/', to: 'entries#index', as: :public_root
+
+  get ':id/pages/:page_index', to: 'entries#page'
 end

data/db/migrate/20150825133449_update_audio_loop_pages_to_use_atmo.rb

@@ -0,0 +1,24 @@
+class UpdateAudioLoopPagesToUseAtmo < ActiveRecord::Migration
+  # Pageflow::Page might have gotten out of sync with schema at this
+  # point. Use local model instead.
+  class MigratedPage < ActiveRecord::Base
+    self.table_name = 'pageflow_pages'
+
+    serialize :configuration, JSON
+
+    def configuration
+      super || {}
+    end
+  end
+
+  def change
+    MigratedPage.where(template: 'audio_loop').find_each do |page|
+      page.template = 'background_image'
+
+      audio_file_id = page.configuration.delete('audio_file_id')
+      page.configuration['atmo_audio_file_id'] = audio_file_id
+
+      page.save!
+    end
+  end
+end

data/db/migrate/20160304072911_rename_membership_entry_and_make_polymorphic.rb

@@ -0,0 +1,19 @@
+class RenameMembershipEntryAndMakePolymorphic < ActiveRecord::Migration
+  def change
+    rename_column :pageflow_memberships, :entry_id, :entity_id
+    add_column :pageflow_memberships, :entity_type, :string
+    reversible do |dir|
+      dir.up do
+        update_each_membership_to_reference_an_entity_of_type_entry
+      end
+    end
+  end
+
+  private
+
+  def update_each_membership_to_reference_an_entity_of_type_entry
+    execute(<<-SQL)
+      UPDATE pageflow_memberships SET entity_type = 'Pageflow::Entry'
+    SQL
+  end
+end

data/db/migrate/20160304151327_add_role_to_membership.rb

@@ -0,0 +1,19 @@
+class AddRoleToMembership < ActiveRecord::Migration
+  def change
+    add_column :pageflow_memberships, :role, :string, null: false, default: 'editor'
+
+    reversible do |dir|
+      dir.up do
+        update_each_membership_to_have_default_role
+      end
+    end
+  end
+
+  private
+
+  def update_each_membership_to_have_default_role
+    execute(<<-SQL)
+      UPDATE pageflow_memberships SET role = 'publisher'
+    SQL
+  end
+end

data/db/migrate/20160504093145_replace_role_and_account_on_user.rb

@@ -0,0 +1,42 @@
+class ReplaceRoleAndAccountOnUser < ActiveRecord::Migration
+  def up
+    add_account_member_membership_for_each_user
+    update_membership_role_to_manager_for_each_account_manager
+
+    add_column :users, :admin, :boolean, null: false, default: false
+
+    set_admin_to_true_for_each_admin
+
+    remove_column :users, :role, :string, default: 'editor', null: false
+    remove_column :users, :account_id, :integer
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+
+  private
+
+  def add_account_member_membership_for_each_user
+    execute(<<-SQL)
+      INSERT INTO pageflow_memberships (role, user_id, entity_id, entity_type, created_at)
+      SELECT 'member', id, account_id, 'Pageflow::Account', created_at FROM users
+    SQL
+  end
+
+  def update_membership_role_to_manager_for_each_account_manager
+    execute(<<-SQL)
+      UPDATE pageflow_memberships INNER JOIN users ON
+      pageflow_memberships.user_id = users.id AND
+      pageflow_memberships.entity_type = 'Pageflow::Account' AND
+      users.role = 'account_manager'
+      SET pageflow_memberships.role = 'manager'
+    SQL
+  end
+
+  def set_admin_to_true_for_each_admin
+    execute(<<-SQL)
+      UPDATE users SET users.admin = TRUE WHERE users.role = 'admin'
+    SQL
+  end
+end

data/db/migrate/20160531152500_update_users_count.rb

@@ -0,0 +1,27 @@
+class UpdateUsersCount < ActiveRecord::Migration
+  def self.up
+    add_column :pageflow_entries, :users_count, :integer, default: 0, null: false
+
+    execute(<<-SQL)
+      UPDATE pageflow_accounts SET users_count = (
+        SELECT COUNT(*)
+        FROM pageflow_memberships
+        WHERE pageflow_memberships.entity_id = pageflow_accounts.id AND
+        pageflow_memberships.entity_type = 'Pageflow::Account'
+      );
+    SQL
+
+    execute(<<-SQL)
+      UPDATE pageflow_entries SET users_count = (
+        SELECT COUNT(*)
+        FROM pageflow_memberships
+        WHERE pageflow_memberships.entity_id = pageflow_entries.id AND
+        pageflow_memberships.entity_type = 'Pageflow::Entry'
+      );
+    SQL
+  end
+
+  def self.down
+    remove_column :pageflow_entries, :users_count
+  end
+end

data/db/migrate/20160707125400_add_output_presences_to_video_files.rb

@@ -0,0 +1,5 @@
+class AddOutputPresencesToVideoFiles < ActiveRecord::Migration
+  def change
+    add_column :pageflow_video_files, :output_presences, :text
+  end
+end

data/db/migrate/20160824115000_add_parent_file_to_video_files.rb

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

data/db/migrate/20160824115100_add_parent_file_to_audio_files.rb

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

data/db/migrate/20160824115200_add_parent_file_to_image_files.rb

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

data/db/migrate/20160929102700_add_configuration_to_files.rb

@@ -0,0 +1,7 @@
+class AddConfigurationToFiles < ActiveRecord::Migration
+  def change
+    add_column :pageflow_audio_files, :configuration, :text
+    add_column :pageflow_image_files, :configuration, :text
+    add_column :pageflow_video_files, :configuration, :text
+  end
+end

data/db/migrate/20161007144500_add_text_track_files.rb

@@ -0,0 +1,31 @@
+class AddTextTrackFiles < ActiveRecord::Migration
+  def change
+    create_table :pageflow_text_track_files do |t|
+      t.belongs_to(:entry, index: true)
+      t.belongs_to(:uploader, index: true)
+
+      t.string(:state)
+      t.string(:rights)
+
+      t.string(:attachment_on_filesystem_file_name)
+      t.string(:attachment_on_filesystem_content_type)
+      t.integer(:attachment_on_filesystem_file_size, limit: 8)
+      t.datetime(:attachment_on_filesystem_updated_at)
+
+      t.string(:attachment_on_s3_file_name)
+      t.string(:attachment_on_s3_content_type)
+      t.integer(:attachment_on_s3_file_size, limit: 8)
+      t.datetime(:attachment_on_s3_updated_at)
+
+      t.timestamps
+
+      t.integer(:parent_file_id)
+      t.string(:parent_file_model_type)
+
+      t.text(:configuration)
+    end
+
+    add_index :pageflow_text_track_files, [:parent_file_id, :parent_file_model_type],
+              name: 'index_text_track_files_on_parent_id_and_parent_model_type'
+  end
+end

data/db/migrate/20161216175734_move_configuration_from_file_to_file_usage.rb

@@ -0,0 +1,27 @@
+class MoveConfigurationFromFileToFileUsage < ActiveRecord::Migration
+  def up
+    add_column :pageflow_file_usages, :configuration, :text
+
+    {
+      pageflow_image_files: 'Pageflow::ImaegFile',
+      pageflow_video_files: 'Pageflow::VideoFile',
+      pageflow_audio_files: 'Pageflow::AudioFile'
+    }.each do |table_name, type_name|
+      execute(<<-SQL)
+        UPDATE pageflow_file_usages
+        INNER JOIN #{table_name} ON
+          pageflow_file_usages.file_id = #{table_name}.id AND
+          pageflow_file_usages.file_type = "#{type_name}"
+        SET pageflow_file_usages.configuration = #{table_name}.configuration
+      SQL
+    end
+
+    remove_column :pageflow_image_files, :configuration
+    remove_column :pageflow_video_files, :configuration
+    remove_column :pageflow_audio_files, :configuration
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/db/migrate/20161230144429_add_processed_attachment_to_text_track_files.rb

@@ -0,0 +1,8 @@
+class AddProcessedAttachmentToTextTrackFiles < ActiveRecord::Migration
+  def change
+    add_column :pageflow_text_track_files, :processed_attachment_file_name, :string
+    add_column :pageflow_text_track_files, :processed_attachment_content_type, :string
+    add_column :pageflow_text_track_files, :processed_attachment_file_size, :integer, limit: 8
+    add_column :pageflow_text_track_files, :processed_attachment_updated_at, :datetime
+  end
+end

data/db/migrate/20170222124848_update_video_file_output_presences.rb

@@ -0,0 +1,12 @@
+class UpdateVideoFileOutputPresences < ActiveRecord::Migration
+  def up
+    execute(<<-SQL)
+      UPDATE pageflow_video_files
+        SET output_presences = '{"high":true,"medium":true,"low":true}'
+        WHERE output_presences IS NULL;
+    SQL
+  end
+
+  def down
+  end
+end

data/db/migrate/20170421112300_turn_background_video_pages_into_background_image_pages.rb

@@ -0,0 +1,22 @@
+class TurnBackgroundVideoPagesIntoBackgroundImagePages < ActiveRecord::Migration
+  # Pageflow::Page might have gotten out of sync with schema at this
+  # point. Use local model instead.
+  class MigratedPage < ActiveRecord::Base
+    self.table_name = 'pageflow_pages'
+
+    serialize :configuration, JSON
+
+    def configuration
+      super || {}
+    end
+  end
+
+  def change
+    MigratedPage.where(template: 'background_video').find_each do |page|
+      page.template = 'background_image'
+      page.configuration['background_type'] = 'video'
+
+      page.save!
+    end
+  end
+end

data/lib/generators/pageflow/assets/assets_generator.rb

@@ -14,6 +14,8 @@ module Pageflow
         template 'application.js', 'app/assets/javascripts/pageflow/application.js'
         template 'application.scss', 'app/assets/stylesheets/pageflow/application.scss'
 
+        template 'components.js', 'app/assets/javascripts/components.js'
+
         append_to_file 'app/assets/javascripts/active_admin.js.coffee' do
           "#= require pageflow/admin\n"
         end

data/lib/generators/pageflow/assets/templates/components.js

@@ -0,0 +1,4 @@
+//= require i18n
+//= require i18n/translations
+
+//= require pageflow/components

data/lib/generators/pageflow/initializer/templates/pageflow.rb

@@ -3,14 +3,9 @@ Pageflow.configure do |config|
   # users.
   config.mailer_sender = 'change-me-at-config-initializers-pageflow@example.com'
 
-  # Page types available in the editor. Add futher page types from
-  # page type engines below.
-  config.page_types.register(Pageflow::BuiltInPageType.background_image)
-  config.page_types.register(Pageflow::BuiltInPageType.background_video)
-  config.page_types.register(Pageflow::BuiltInPageType.video)
-  config.page_types.register(Pageflow::BuiltInPageType.audio)
-  config.page_types.register(Pageflow::BuiltInPageType.audio_loop)
-  # config.page_types.register(Pageflow::Rainbow::PageType.new)
+  # Plugins provide page types and widget types.
+  config.plugin(Pageflow.built_in_page_types_plugin)
+  # config.plugin(Pageflow::Rainbow.plugin)
 
   # Add custom themes by invoking the pageflow:theme generator and
   # registering the theme here.
@@ -53,25 +48,33 @@ Pageflow.configure do |config|
   # use s3 storage. All options allowed in paperclip has_attached_file
   # calls are allowed.
   config.paperclip_s3_default_options.merge!(
-    :s3_credentials => {
-      :bucket => ENV.fetch('S3_BUCKET', 'com-example-pageflow-development'),
-      :access_key_id => ENV.fetch('S3_ACCESS_KEY', 'xxx'),
-      :secret_access_key => ENV.fetch('S3_SECRET_KEY', 'xxx'),
-      :s3_host_name => ENV.fetch('S3_HOST_NAME', 's3-eu-west-1.amazonaws.com')
+    s3_credentials: {
+      bucket: ENV.fetch('S3_BUCKET', 'com-example-pageflow-development'),
+      access_key_id: ENV.fetch('S3_ACCESS_KEY', 'xxx'),
+      secret_access_key: ENV.fetch('S3_SECRET_KEY', 'xxx'),
+      s3_host_name: ENV.fetch('S3_HOST_NAME', 's3-eu-west-1.amazonaws.com')
     },
-    :s3_host_alias => ENV.fetch('S3_HOST_ALIAS', 'com-example-pageflow.s3-website-eu-west-1.amazonaws.com'),
-    :s3_protocol => ENV.fetch('S3_PROTOCOL', 'http')
+    s3_host_alias: ENV.fetch('S3_HOST_ALIAS',
+                             'com-example-pageflow.s3-website-eu-west-1.amazonaws.com'),
+    s3_protocol: ENV.fetch('S3_PROTOCOL', 'http')
   )
 
   # Default options for paperclip attachments which are supposed to
   # use filesystem storage. All options allowed in paperclip has_attached_file
   # calls are allowed.
   config.zencoder_options.merge!(
-    :api_key => ENV.fetch('ZENCODER_API_KEY', 'xxx'),
-    :output_bucket => ENV.fetch('S3_OUTPUT_BUCKET', 'com-example-pageflow-out'),
-    :s3_host_alias => ENV.fetch('S3_OUTPUT_HOST_ALIAS', 'com-example-pageflow-out.s3-website-eu-west-1.amazonaws.com'),
-    :s3_protocol => ENV.fetch('S3_PROTOCOL','http'),
-    :attachments_version => 'v1'
+    api_key: ENV.fetch('ZENCODER_API_KEY', 'xxx'),
+    output_bucket: ENV.fetch('S3_OUTPUT_BUCKET', 'com-example-pageflow-out'),
+    s3_host_alias: ENV.fetch('S3_OUTPUT_HOST_ALIAS',
+                             'com-example-pageflow-out.s3-website-eu-west-1.amazonaws.com'),
+    s3_protocol: ENV.fetch('S3_PROTOCOL', 'http'),
+    attachments_version: 'v1',
+
+    # Zencoder can generate SMIL files which can be used to have
+    # Akamai generate HLS-playlists. By default, Pageflow makes
+    # Zencoder generate HLS-playlists. To prevent hitting Zencoder's
+    # 20 outputs limit, we disable smil outputs.
+    skip_smil: true
   )
 
   # Specify default meta tags to use in published stories.

data/lib/generators/pageflow/seeds/templates/seeds.rb

@@ -4,27 +4,93 @@ include Pageflow::Seeds
 # a production system.
 default_user_password('!Pass123')
 
+publisher_account = account(name: 'Acme Corporation')
+editor_account = account(name: 'General Products')
+previewer_account = account(name: 'Oscorp')
+member_account = account(name: 'Stagg Enterprises')
+account(name: 'Waterloo Road Comprehensive')
+
 account(name: 'Pageflow') do |account|
-  entry = sample_entry(account: account, title: 'Example Entry')
+  politics_entry = sample_entry(account: account, title: 'Story in Politics')
+  sports_entry = sample_entry(account: account, title: 'Story in Sports')
+  finance_entry = sample_entry(account: account, title: 'Story in Finance')
+  entertainment_entry = sample_entry(account: account, title: 'Story in Entertainment')
+  sample_entry(account: account, title: 'Story in Science')
 
-  user(account: account,
-       role: 'admin',
-       email: 'admin@example.com',
+  user(email: 'admin@example.com',
        first_name: 'Alice',
-       last_name: 'Adminson')
+       last_name: 'Adminson',
+       admin: true) do |admin|
+    membership(user: admin, entity: account, role: :member)
+  end
+
+  user(email: 'accountmanager@example.com',
+       first_name: 'Anne',
+       last_name: 'McManager') do |account_manager|
+    membership(user: account_manager, entity: account, role: :manager)
+    membership(user: account_manager, entity: publisher_account, role: :publisher)
+    membership(user: account_manager, entity: editor_account, role: :editor)
+    membership(user: account_manager, entity: previewer_account, role: :previewer)
+    membership(user: account_manager, entity: member_account, role: :member)
+  end
+
+  user(email: 'accountpublisher@example.com',
+       first_name: 'Alina',
+       last_name: 'Publisha') do |account_publisher|
+    membership(user: account_publisher, entity: account, role: :publisher)
+    membership(user: account_publisher, entity: publisher_account, role: :editor)
+    membership(user: account_publisher, entity: editor_account, role: :previewer)
+    membership(user: account_publisher, entity: previewer_account, role: :member)
+  end
+
+  user(email: 'accounteditor@example.com',
+       first_name: 'Annalena',
+       last_name: 'Editorian') do |account_editor|
+    membership(user: account_editor, entity: account, role: :editor)
+    membership(user: account_editor, entity: publisher_account, role: :previewer)
+    membership(user: account_editor, entity: editor_account, role: :member)
+  end
 
-  user(account: account,
-       role: 'account_manager',
-       email: 'accountmanager@example.com',
-       first_name: 'Alfred',
-       last_name: 'Mc Count')
+  user(email: 'accountpreviewer@example.com',
+       first_name: 'Agnieszka',
+       last_name: 'Previewski') do |account_previewer|
+    membership(user: account_previewer, entity: account, role: :previewer)
+    membership(user: account_previewer, entity: publisher_account, role: :member)
+  end
+
+  user(email: 'accountmember@example.com',
+       first_name: 'Asuna',
+       last_name: 'Membergami') do |account_member|
+    membership(user: account_member, entity: account, role: :member)
+  end
+
+  user(email: 'entrymanager@example.com',
+       first_name: 'Evgen',
+       last_name: 'Managerov') do |entry_manager|
+    membership(user: entry_manager, entity: politics_entry, role: :manager)
+    membership(user: entry_manager, entity: sports_entry, role: :publisher)
+    membership(user: entry_manager, entity: finance_entry, role: :editor)
+    membership(user: entry_manager, entity: entertainment_entry, role: :previewer)
+  end
+
+  user(email: 'entrypublisher@example.com',
+       first_name: 'Elmar',
+       last_name: 'Publishero') do |entry_publisher|
+    membership(user: entry_publisher, entity: politics_entry, role: :publisher)
+    membership(user: entry_publisher, entity: sports_entry, role: :editor)
+    membership(user: entry_publisher, entity: finance_entry, role: :previewer)
+  end
 
-  user(account: account,
-       email: 'editor@example.com',
-       role: 'editor',
+  user(email: 'entryeditor@example.com',
        first_name: 'Ed',
-       last_name: 'Edison') do |editor|
+       last_name: 'Edison') do |entry_editor|
+    membership(user: entry_editor, entity: politics_entry, role: :editor)
+    membership(user: entry_editor, entity: sports_entry, role: :previewer)
+  end
 
-    membership(user: editor, entry: entry)
+  user(email: 'entrypreviewer@example.com',
+       first_name: 'Émile',
+       last_name: 'Previewère') do |entry_previewer|
+    membership(user: entry_previewer, entity: politics_entry, role: :previewer)
   end
 end