concerto_remote_video 0.0.2

data/LICENSE

@@ -0,0 +1,14 @@
+  Copyright 2013 Concerto Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

data/README.md

@@ -0,0 +1,11 @@
+# Concerto 2 Remote Video Plugin
+This plugin provides support to play remotely hosted videos, like YouTube videos, in Concerto 2.
+
+1.  Add to your Gemfile: ```gem 'concerto_remote_video'```
+2.  ```bundle install```
+3.  ```./script/rails generate concerto_remote_video:install install```
+
+## Supported hosts:
+* YouTube
+
+Concerto 2 Remove Video is licensed under the Apache License, Version 2.0.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ConcertoRemoteVideo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/stylesheets/concerto_remote_video/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/concerto_remote_video/application_controller.rb

@@ -0,0 +1,4 @@
+module ConcertoRemoteVideo
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/concerto_remote_video/application_helper.rb

@@ -0,0 +1,4 @@
+module ConcertoRemoteVideo
+  module ApplicationHelper
+  end
+end

data/app/models/remote_video.rb

@@ -0,0 +1,100 @@
+class RemoteVideo < Content
+  after_initialize :set_kind, :create_config, :load_info
+
+  after_find :load_config
+  before_validation :save_config
+
+  validate :video_id_must_exist
+  validates :duration, :numericality => { :greater_than => 0 }
+
+  DISPLAY_NAME = 'YouTube Video'
+
+  attr_accessor :config
+
+  # Automatically set the kind for the content
+  # if it is new.  We use this hidden type that no fields
+  # render so Dynamic Content meta content never gets displayed.
+  def set_kind
+    return unless new_record?
+    self.kind = Kind.where(:name => 'Graphics').first
+  end
+
+  # Create a new configuration hash if one does not already exist.
+  # Called during `after_initialize`, where a config may or may not exist.
+  def create_config
+    self.config = {} if !self.config
+  end
+
+  # Load a configuration hash.
+  # Converts the JSON data stored for the content into the configuration.
+  # Called during `after_find`.
+  def load_config
+    self.config = JSON.load(self.data)
+  end
+
+  # Prepare the configuration to be saved.
+  # Compress the config hash back into JSON to be stored in the database.
+  # Called during `before_valication`.
+  def save_config
+    self.data = JSON.dump(self.config)
+  end
+
+  def self.form_attributes
+    attributes = super()
+    attributes.concat([:config => [:video_id, :allow_flash]])
+  end
+
+  # Load some info about this video from YouTube.
+  def load_info
+    return if self.config['video_id'].nil? || !self.duration.nil?
+    require 'net/http'
+    #begin
+      video_id = URI.escape(self.config['video_id'])
+      url = "http://gdata.youtube.com/feeds/api/videos?q=#{video_id}&v=2&max-results=1&format=5&alt=jsonc"
+      json = Net::HTTP.get_response(URI.parse(url)).body
+      data = ActiveSupport::JSON.decode(json)
+    #rescue
+    #  Rails.logger.debug("YouTube not reachable @ #{url}.")
+    #  config['video_id'] = ''
+    #  return
+    #end
+    if data['data']['totalItems'].to_i <= 0
+      Rails.logger.debug('No video found from ' + url)
+      self.config['video_id'] = ''
+      return
+    end
+    video_data = data['data']['items'][0]
+    self.config['video_id'] = video_data['id']
+    self.duration = video_data['duration'].to_i
+    self.config['thumb_url'] = video_data['thumbnail']['hqDefault']
+  end
+
+  # Build a URL for an iframe player.
+  def player_url(params={})
+    url = "https://www.youtube.com/embed/#{self.config['video_id']}"
+    if self.config['allow_flash'] == '0'
+      params['html5'] = 1
+    end
+    url += '?' + URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
+    return url
+  end
+
+  def video_id_must_exist
+    if config['video_id'].empty?
+      errors.add(:video_id, 'could not be found')
+    end
+  end
+
+  def render_details
+    settings = {
+      :autoplay => 1,  # Autostart the video
+      :end => self.duration,  # Stop it around the duration
+      :controls => 0,  # Don't show any controls
+      :modestbranding => 1,  # Use the less fancy branding
+      :rel => 0,  # Don't show related videos
+      :showinfo => 0,  # Don't show the video info
+      :iv_load_policy => 3  # Don't show any of those in-video labels
+    }
+    {:path => player_url(settings)}
+  end
+end

data/app/views/contents/remote_video/_form_middle.html.erb

@@ -0,0 +1,21 @@
+<fieldset>
+  <legend><span><%=t(:provide_details)%></span></legend>
+  <div class="clearfix">
+    <%= form.label :name %>
+    <div class="input">
+      <%= form.text_field :name %>
+    </div>
+  </div>
+
+  <%= render :partial => 'contents/form_elements/dates', :locals => {:form => form} %>
+</fieldset>
+
+<fieldset>
+  <legend><span><%=t(:select_feed)%></span></legend>
+  <label>&nbsp;</label>
+  <div class="input">
+    <% if @content.new_record? %>
+      <%= render :partial => 'contents/form_elements/feeds' %>
+    <% end %>
+  </div>
+</fieldset>

data/app/views/contents/remote_video/_form_top.html.erb

@@ -0,0 +1,17 @@
+<fieldset>
+  <legend><span>YouTube Video</span></legend>
+  <%= form.fields_for :config do |config| %>
+    <div class="clearfix">
+      <%= config.label :video_id %>
+      <div class="input">
+        <%= config.text_field :video_id, :placeholder => 'DGbqvYbPZBY', :size => 15 %>
+      </div>
+    </div>
+    <div class="clearfix">
+      <%= config.label :allow_flash, 'Allow Flash?' %>
+      <div class="input">
+        <%= config.select :allow_flash, [["No", 0], ["Yes", 1]] %>
+      </div>
+    </div>
+  <% end %>
+</fieldset>

data/app/views/contents/remote_video/_render_default.html.erb

@@ -0,0 +1,4 @@
+<div style="width: 100%; height: 100%; text-align: center;">
+  <% player_settings = {:end => content.duration, :rel => 0, :theme => 'light', :iv_load_policy => 3} %>
+  <iframe id="player" type="text/html" width="100%" height="100%" src="<%=raw content.player_url(player_settings) %>" frameborder="0"></iframe>
+</div>

data/app/views/contents/remote_video/_render_tile.html.erb

@@ -0,0 +1 @@
+<div style="background-image:url(<%= content.config['thumb_url'] %>); background-size: cover; width: 100%; height: 100%;"></div>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :remote_videos, :controller => :contents, :except => [:index, :show], :path => "content"
+end

data/lib/concerto_remote_video.rb

@@ -0,0 +1,4 @@
+require "concerto_remote_video/engine"
+
+module ConcertoRemoteVideo
+end

data/lib/concerto_remote_video/engine.rb

@@ -0,0 +1,9 @@
+module ConcertoRemoteVideo
+  class Engine < ::Rails::Engine
+    isolate_namespace ConcertoRemoteVideo
+
+    initializer "register content type" do |app|
+      app.config.content_types << RemoteVideo
+    end
+  end
+end

data/lib/concerto_remote_video/version.rb

@@ -0,0 +1,3 @@
+module ConcertoRemoteVideo
+  VERSION = "0.0.2"
+end

data/lib/generators/concerto_remote_video/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+module ConcertoRemoteVideo
+  class InstallGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../../../../', __FILE__)
+
+    desc 'Copy the RemoteVideo JavaScript to the frontend and register it.'
+
+    def install
+     copy_js
+     register
+    end
+
+  private
+    def copy_js
+      copy_file 'public/frontend_js/contents/remote_video.js', 'public/frontend_js/contents/remote_video.js'
+    end
+
+    def register
+      append_file 'public/frontend_js/content_types.js', "goog.require('concerto.frontend.Content.RemoteVideo');\n"
+    end
+  end
+end

data/lib/tasks/concerto_remote_video_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :concerto_remote_video do
+#   # Task goes here
+# end

data/public/frontend_js/contents/remote_video.js

@@ -0,0 +1,75 @@
+goog.provide('concerto.frontend.Content.RemoteVideo');
+
+goog.require('concerto.frontend.Content');
+goog.require('concerto.frontend.ContentTypeRegistry');
+goog.require('goog.Uri');
+goog.require('goog.dom');
+goog.require('goog.events');
+goog.require('goog.events.EventType');
+goog.require('goog.style');
+
+
+
+/**
+ * Remote Video.
+ *
+ * @param {Object} data Properties for this piece of content.
+ * @constructor
+ * @extends {concerto.frontend.Content}
+ */
+concerto.frontend.Content.RemoteVideo = function(data) {
+  concerto.frontend.Content.call(this, data);
+
+  /**
+   * The height of the field the image is being shown in.
+   * @type {number}
+   * @private
+   */
+  this.field_height_ = data.field.size.height;
+
+  /**
+   * The width of the field the image is being shown in.
+   * @type {number}
+   * @private
+   */
+  this.field_width_ = data.field.size.width;
+
+  /**
+   * The iframe being displayed.
+   * @type {Object}
+   */
+  this.iframe = null;
+
+  /**
+   * The URL for the video / iframe.
+   * @type {string}
+   */
+  this.video_url = data['render_details']['path'];
+
+  /**
+   * Bump the duration of this content by 1 second.
+   * This attempts to account for 1 second of load time and should be
+   * improved in the future.
+   */
+  this.duration = this.duration + 1;
+};
+goog.inherits(concerto.frontend.Content.RemoteVideo, concerto.frontend.Content);
+
+// Register the content type.
+concerto.frontend.ContentTypeRegistry['RemoteVideo'] =
+    concerto.frontend.Content.RemoteVideo;
+
+
+/**
+ * Build the embed iframe and signal that we're ready to use it.
+ * @private
+ */
+concerto.frontend.Content.RemoteVideo.prototype.load_ = function() {
+  this.iframe = goog.dom.createElement('iframe');
+  this.iframe.src = this.video_url;
+  this.iframe.frameborder = 0;
+  goog.style.setSize(this.iframe, '100%', '100%');
+  goog.style.setStyle(this.iframe, 'border', 0);
+  goog.dom.appendChild(this.div_, this.iframe);
+  this.finishLoad();
+};

data/test/concerto_remote_video_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ConcertoRemoteVideoTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ConcertoRemoteVideo
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.