pageflow 0.8.2 → 0.9.0

data/README.md

@@ -0,0 +1,179 @@
+# Pageflow
+
+[![Gem Version](https://badge.fury.io/rb/pageflow.svg)](http://badge.fury.io/rb/pageflow)
+[![Build Status](https://travis-ci.org/codevise/pageflow.svg?branch=master)](https://travis-ci.org/codevise/pageflow)
+
+Multimedia story telling for the web.
+
+For a high level introduction and example Pageflow stories see
+[pageflow.io](http://pageflow.io).
+
+In addition to this README, there is also a [Getting Started Wiki page](https://github.com/codevise/pageflow/wiki/Getting-Started)
+to guide you through the steps of setting up a Rails application with Pageflow
+on your development machine.
+
+## Updating
+
+For instructions on how to update from a prior version of the gem see
+the
+[Updating Pageflow](https://github.com/codevise/pageflow/wiki/Updating-Pageflow)
+wiki page.
+
+## Ingredients
+
+Pageflow is a Rails engine which roughly consists of the following
+components:
+
+* A full MVC stack to manage and display Pageflow stories
+* User and permission management with support for isolated accounts
+  and user collaboration
+* A client side application for live preview editing of stories
+* Background jobs to process and encode images, audios and videos
+* Generators to quickly bootstrap a new Rails application
+
+Pageflow assumes the following choice of libraries:
+
+* [Devise](https://github.com/plataformatec/devise) for authentication
+* [CanCan](https://github.com/ryanb/cancan) for authorization
+* [ActiveAdmin](http://activeadmin.info/) for administration
+* [Resque](https://github.com/resque/resque) for background jobs
+* [FriendlyId](https://github.com/norman/friendly_id) for pretty URLs
+* [Paperclip](https://github.com/thoughtbot/paperclip) for attachment handling
+* [Backbone](http://backbonejs.org/) [Marionette](http://marionettejs.com/) for client side development
+
+
+## Requirements
+
+Pageflow runs in environments with:
+
+* Ruby >= 1.9.3 and < 2.2.0 because of [ActiveAdmin](https://github.com/activeadmin/activeadmin/issues/3715)
+* Rails 4.0 or 4.1
+* Redis server (for Resque)
+* A database server supported by Active Record (tested with MySQL)
+* ImageMagick
+
+Accounts of the following cloud services have to be registered:
+
+* [Amazon Web Services](http://aws.amazon.com) for S3 file storage and
+  (optionally) Cloudfront content delivery
+* [Zencoder](http://zencoder.com) for video/audio encoding
+
+## Installation
+
+Generate a new Rails application using the MySQL database adapter:
+
+    $ rails new my_pageflow --database=mysql
+    $ cd my_pageflow
+
+Do not name your application `"pageflow"` since it will cause conflicts
+which constant names created by Pageflow itself.
+
+### Database Setup
+
+Enter valid MySQL credentials inside `config/database.yml` and create
+the database:
+
+    $ rake db:create
+
+### Gem Dependencies
+
+Add this line to your application's Gemfile:
+
+    # Gemfile
+    gem 'pageflow'
+
+At the moment, Pageflow depends on a frozen version of Active Admin
+since, back when development started, no Rails 4 compatible version of
+Active Admin was available as a gem. You therefore need to bundle the
+`rails4` branch that we have forked into our github organization:
+
+    # Gemfile
+    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'
+    # Only required for Rails 4.1:
+    gem 'state_machine', git: 'https://github.com/codevise/state_machine.git'
+
+Run bundler to install dependencies:
+
+    $ bundle install
+
+### Running the Generator
+
+Now you can run the generator to setup Pageflow and its dependencies:
+
+    $ rails generate pageflow:install
+
+The generator will invoke Active Admin and Devise generators in turn
+and apply some configuration changes. When asked to overwrite the
+`db/seeds.rb` file, choose yes.
+
+To better understand Pageflow's configuration choices, you can run the
+single steps of the `install` generator one by one. See the wiki page
+[The Install Generator in Detail](https://github.com/codevise/pageflow/wiki/The-Install-Generator-in-Detail)
+for more. If you'd rather not look behind the scenes for now, you can
+safely read on.
+
+### Database Migration
+
+_Devise migration name fix_: In some cases, the Devise generator creates
+a migration file without file extension. This needs to be fixed manually
+at the moment:
+
+    $ mv db/migrate/*_devise_create_users{,.rb}
+
+Now you can migrate the database.
+
+    $ rake db:migrate
+
+Finally, you can populate the database with some example data, so
+things do not look too blank in development mode.
+
+    $ rake db:seed
+
+## Configuration
+
+Pageflow stores files in S3 buckets also in development
+mode. Otherwise there's no way to have Zencoder encode them. See the
+wiki page [Setting up external services](https://github.com/codevise/pageflow/wiki/Setting-up-External-Services).
+
+The host application can utilize environment variables to configure the API keys for S3 and Zencoder. The variables can be found in the generated Pageflow initializer.
+
+For available configuration options and examples see the inline docs
+in `config/initializers/pageflow.rb` in your generated rails app.
+
+Ensure you have defined default url options in your environments
+files. Here is an example of `default_url_options` appropriate for a
+development environment in `config/environments/development.rb`:
+
+    config.action_mailer.default_url_options = {host: 'localhost:3000'}
+
+In production, `:host` should be set to the actual host of your
+application.
+
+## Running Pageflow
+
+In addition to the Rails server, you need to start two Rake tasks for
+the background job processing. First, start a Resque worker which handles
+jobs from all queues:
+
+    $ QUEUE=* rake resque:work
+
+Image and video processing are examples of jobs that are executes by these workers.
+
+Some jobs need to be executed repeatedly. For example, while videos are being
+encoded by Zencoder, there is a job that runs every few seconds to fetch the
+current progress. This delayed invocation of jobs is handled by the Resque
+Scheduler Rake task:
+
+     $ QUEUE=* rake resque:scheduler
+
+Consider using the [foreman gem](https://github.com/ddollar/foreman) to start all of
+these processes (including the Rails server) with a single command in your
+development environment.
+
+## Troubleshooting
+
+If you run into problems during the installation of Pageflow, please refer to the [Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting) wiki
+page. If that doesn't help, consider [filing an issue](https://github.com/codevise/pageflow/issues?state=open).

data/admins/pageflow/accounts.rb

@@ -23,12 +23,13 @@ module Pageflow
     end
 
     controller do
+      helper Pageflow::Admin::FeaturesHelper
       helper ThemesHelper
       helper WidgetsHelper
 
       def new
         @account = Account.new
-        @account.default_theming = Theming.new
+        @account.build_default_theming
       end
 
       def create
@@ -39,7 +40,9 @@ module Pageflow
       end
 
       def update
-        super
+        update! do |success, failure|
+          success.html { redirect_to(admin_account_path(resource, params.slice(:tab))) }
+        end
         update_widgets
       end
 
@@ -54,7 +57,47 @@ module Pageflow
       end
 
       def permitted_params
-        params.permit(:account => [:name, :default_file_rights, :default_theming_attributes => [:cname, :theme_name, :imprint_link_url, :imprint_link_label, :copyright_link_url, :copyright_link_label, :home_url, :home_button_enabled_by_default]])
+        result = params.permit(account: permitted_account_attributes)
+
+        if result[:account]
+          feature_states = params[:account][:feature_states].try(:permit!)
+          result[:account].merge!(feature_states: feature_states || {})
+        end
+
+        result
+      end
+
+      private
+
+      def permitted_account_attributes
+        [
+          :name,
+          :default_file_rights,
+          default_theming_attributes: permitted_theming_attributes
+        ] +
+          permitted_attributes_for(:account)
+      end
+
+      def permitted_theming_attributes
+        [
+          :cname,
+          :theme_name,
+          :imprint_link_url,
+          :imprint_link_label,
+          :copyright_link_url,
+          :copyright_link_label,
+          :home_url,
+          :home_button_enabled_by_default
+        ] +
+          permitted_attributes_for(:theming)
+      end
+
+      def permitted_attributes_for(resource_name)
+        if params[:id]
+          Pageflow.config_for(resource).admin_form_inputs.permitted_attributes_for(resource_name)
+        else
+          []
+        end
       end
     end
   end

data/admins/pageflow/entry.rb

@@ -51,6 +51,8 @@ module Pageflow
         if authorized?(:manage, Folder)
           f.input :folder, :collection => collection_for_folders(f.object.account), :include_blank => true
         end
+
+        Pageflow.config_for(f.object).admin_form_inputs.build(:entry, f)
       end
       f.actions
     end
@@ -60,10 +62,32 @@ module Pageflow
         button_to(I18n.t('pageflow.admin.entries.depublish'),
                   pageflow.current_entry_revisions_path(entry),
                   :method => :delete,
-                  :data => {:rel => 'depublish', :confirm => I18n.t('pageflow.admin.entries.confirm_depublish')})
+                  :data => {
+                    :rel => 'depublish',
+                    :confirm => I18n.t('pageflow.admin.entries.confirm_depublish')
+                  })
+      end
+    end
+
+    action_item :only => :show do
+      if authorized?(:duplicate, entry)
+        button_to(I18n.t('pageflow.admin.entries.duplicate'),
+                  duplicate_admin_entry_path(entry),
+                  :method => :post,
+                  :data => {
+                    :rel => 'duplicate',
+                    :confirm => I18n.t('pageflow.admin.entries.confirm_duplicate')
+                  })
       end
     end
 
+    member_action :duplicate, :method => :post do
+      entry = Entry.find(params[:id])
+      authorize!(:duplicate, entry)
+      new_entry = entry.duplicate
+      redirect_to(edit_admin_entry_path(new_entry))
+    end
+
     member_action :snapshot, :method => :post do
       entry = Entry.find(params[:id])
       authorize!(:snapshot, entry)
@@ -104,16 +128,20 @@ module Pageflow
       end
 
       def permitted_params
-        result = params.permit(:entry => [:title, :account_id, :theming_id, :folder_id])
-        restrict_attributes(params[:id], result[:entry]) if result[:entry]
-        result
+        params.permit(entry: permitted_attributes)
       end
 
       private
 
-      def restrict_attributes(id, attributes)
-        attributes.except!(:account_id, :theming_id) unless authorized?(:read, Account)
-        attributes.except!(:folder_id) unless authorized?(:manage, Folder)
+      def permitted_attributes
+        result = [:title]
+
+        target = params[:id] ? resource : current_user.account
+        result += Pageflow.config_for(target).admin_form_inputs.permitted_attributes_for(:entry)
+
+        result += [:account_id, :theming_id] if authorized?(:read, Account)
+        result << :folder_id if authorized?(:manage, Folder)
+        result
       end
     end
   end

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

@@ -0,0 +1,62 @@
+//= require_self
+//= require ./audio/player_pool
+//= require ./audio/multi_player
+
+pageflow.Audio = function(options) {
+  this.getSources = options.getSources || function(audioFileId) {
+    return options.audioFiles[audioFileId] || '';
+  };
+
+  /**
+   * Creates a player for the given audio file.
+   *
+   * @param [String|Numberic] audioFileId  Id of the audio file to play possibly with a suffix.
+   * @param [Object] options  Options to pass on player creation
+   *
+   * The audio file id can be of the form `"5.suffix"` to distinguish
+   * multiple occurences of the same audio file for example inside a
+   * pageflow.Audio.PlayerPool;
+   */
+  this.createPlayer = function(audioFileId, options) {
+    var sources = this.getSources(removeSuffix(audioFileId));
+
+    if (sources) {
+      return new pageflow.AudioPlayer(sources, _.extend({
+        volumeFading: true
+      }, options || {}));
+    }
+    else {
+      return new pageflow.AudioPlayer.Null();
+    }
+  };
+
+  /**
+   * @option options [Numeric] fadeDuration  Time in milliseconds to fade
+   *   audios in and out.
+   * @option options [Boolean] playFromBeginning  Always restart audio
+   *   files from the beginning. Defaults to false.
+   * @option options [Boolean] rewindOnChange  Play from beginning when
+   *   changing audio files. Defaults to false.
+   *
+   * Furthermore all options supported by pageflow.AudioPlayer can be
+   * passed.
+   */
+  this.createMultiPlayer = function(options) {
+    return new pageflow.Audio.MultiPlayer(
+      new pageflow.Audio.PlayerPool(this, options),
+      options
+    );
+  };
+
+  function removeSuffix(id) {
+    if (!id) {
+      return id;
+    }
+
+    return parseInt(id.toString().split('.')[0], 10);
+  }
+};
+
+pageflow.Audio.setup = function(options) {
+  pageflow.audio = new pageflow.Audio(options);
+};

data/app/assets/javascripts/pageflow/audio/multi_player.js

@@ -0,0 +1,127 @@
+pageflow.Audio.MultiPlayer = function(pool, options) {
+  if (options.crossFade && options.playFromBeginning) {
+    throw 'pageflow.Audio.MultiPlayer: The options crossFade and playFromBeginning can not be used together at the moment.';
+  }
+
+  var current = new pageflow.AudioPlayer.Null();
+  var currentId = null;
+  var that = this;
+
+  this.resume = function() {
+    return current.play();
+  };
+
+  this.resumeAndFadeIn = function() {
+    return current.playAndFadeIn(options.fadeDuration);
+  };
+
+  this.seek = function(position) {
+    return current.seek(position);
+  };
+
+  this.pause = function() {
+    return current.pause();
+  };
+
+  this.paused = function() {
+    return current.paused();
+  };
+
+  this.fadeOutAndPause = function() {
+    return current.fadeOutAndPause(options.fadeDuration);
+  };
+
+  this.position = function() {
+    return current.position;
+  };
+
+  this.duration = function() {
+    return current.duration;
+  };
+
+  this.fadeTo = function(id) {
+    return changeCurrent(id, function(player) {
+      return player.playAndFadeIn(options.fadeDuration);
+    });
+  };
+
+  this.play = function(id) {
+    return changeCurrent(id, function(player) {
+      return player.play();
+    });
+  };
+
+  this.changeVolumeFactor = function(factor) {
+    return current.changeVolumeFactor(factor, options.fadeDuration);
+  };
+
+  this.formatTime = function(time) {
+    return current.formatTime(time);
+  };
+
+  function changeCurrent(id, callback) {
+    if (!options.playFromBeginning && id === currentId && !current.paused()) {
+      return;
+    }
+
+    var player = pool.get(id);
+    currentId = id;
+
+    var fadeOutPromise = current.fadeOutAndPause(options.fadeDuration);
+
+    fadeOutPromise.then(function() {
+      stopEventPropagation(current);
+    });
+
+    handleCrossFade(fadeOutPromise).then(function() {
+      current = player;
+      startEventPropagation(current, id);
+
+      handlePlayFromBeginning(player).then(function() {
+        callback(player);
+      });
+    });
+  }
+
+  function handleCrossFade(fadePomise) {
+    if (options.crossFade) {
+      return new $.Deferred().resolve().promise();
+    }
+    else {
+      return fadePomise;
+    }
+  }
+
+  function handlePlayFromBeginning(player) {
+    if (options.playFromBeginning || options.rewindOnChange) {
+      return player.rewind();
+    }
+    else {
+      return new $.Deferred().resolve().promise();
+    }
+  }
+
+  function startEventPropagation(player, id) {
+    that.listenTo(player, 'play', function() {
+      that.trigger('play', {audioFileId: id});
+    });
+
+    that.listenTo(player, 'pause', function() {
+      that.trigger('pause', {audioFileId: id});
+    });
+
+    that.listenTo(player, 'timeupdate', function() {
+      that.trigger('timeupdate', {audioFileId: id});
+    });
+
+    that.listenTo(player, 'ended', function() {
+      that.trigger('ended', {audioFileId: id});
+    });
+  }
+
+  function stopEventPropagation(player) {
+    that.stopListening(player);
+  }
+};
+
+_.extend(pageflow.Audio.MultiPlayer.prototype, Backbone.Events);