network_executive 0.0.1.alpha.1 → 0.0.2

data/app/models/network_executive/channel.rb

@@ -0,0 +1,46 @@
+require 'network_executive/network'
+require 'network_executive/scheduling'
+
+module NetworkExecutive
+  class Channel < EventMachine::Channel
+    include Scheduling
+
+    # Example
+    # every :monday, play:'morning_show'
+    # every :day,    play:'stoplight',    for_the_first:'15mins',  of:'each hour', ending_at:'11am'
+    # every :day,    play:'tweets',       for_the_last: '15mins',  of:'every hour'
+    # every :day,    play:'sales',        for_the_first:'15mins',  of:'each hour', between:'2pm and 5pm'
+    # every :friday, play:'lunch_menu',   between:'11am and 13pm', commercial_free:true
+
+    def name
+      self.class.name.demodulize.underscore
+    end
+
+    def display_name
+      name.gsub %r{_}, ' '
+    end
+    alias_method :to_s, :display_name
+
+    def show( scheduled_program )
+      program = Program.find_by_name scheduled_program.program_name
+
+      raise ProgramNotFoundError.new("#{scheduled_program.program_name} is not a registered channel") unless program
+
+      push program.play
+    end
+
+    class << self
+      def inherited( klass )
+        Network.channels << klass.new
+      end
+
+      # TODO: Is this the right place for this?
+      def find_by_name( name )
+        Network.channels.find do |c|
+          c.name == name
+        end
+      end
+    end
+
+  end
+end

data/app/models/network_executive/channel_schedule.rb

@@ -0,0 +1,13 @@
+module NetworkExecutive
+  class ChannelSchedule < Array
+
+    def add( program )
+      unshift program
+    end
+
+    def find_by_showtime( time )
+      find{ |p| p.include? time }
+    end
+
+  end
+end

data/app/models/network_executive/lineup.rb

@@ -0,0 +1,66 @@
+# Represents a channel's programming line up for a given time span.
+module NetworkExecutive
+  # TODO: Why does this subclass Hash?
+  class Lineup < Hash
+
+    Interval = 15  # In minutes.
+    Range    = 1.5 # In hours.
+
+    def initialize( start = Time.now, stop = nil )
+      self.start_time = start || Time.now
+      self.stop_time  = stop  || Time.now + Range.hours
+
+      self[:channels] = generate
+    end
+
+    def generate
+      with_each_channel do |channel, lineup|
+        lineup << {
+          name:     channel.display_name,
+          schedule: whats_on?( channel ) do |show|
+            show.program_name.titleize
+          end
+        }
+      end
+    end
+
+    def start_time=( time )
+      @start_time = floor time
+    end
+
+    def start_time
+      @start_time
+    end
+
+    def stop_time=( time )
+      @stop_time = floor time
+    end
+
+    def stop_time
+      @stop_time
+    end
+
+  private
+
+    # Rounds the specific time to the nearest interval
+    def floor( time, nearest = nil )
+      nearest ||= Interval.minutes
+
+      Time.at((time.to_f / nearest.to_i).floor * nearest.to_i)
+    end
+
+    # TODO: Decouple
+    def with_each_channel
+      Network.channels.each_with_object([]) do |channel, lu|
+        yield channel, lu
+      end
+    end
+
+    # TODO: Decouple
+    def whats_on?( channel )
+      channel.whats_on?( start_time, stop_time, interval:Interval ) do |show|
+        yield show
+      end
+    end
+  end
+end

data/app/models/network_executive/lineup_range.rb

@@ -0,0 +1,34 @@
+module NetworkExecutive
+  class LineupRange
+
+    def initialize( start, stop, options = {} )
+      @start, @stop, @options = start, stop, options
+
+      @options[:interval] ||= 15
+    end
+
+    def each
+      showtime = @start.dup
+
+      while showtime < @stop
+        yield showtime
+
+        showtime += @options[:interval].minutes
+      end
+    end
+
+    def each_with_object( obj )
+      each do |showtime|
+        yield showtime, obj
+      end
+
+      obj
+    end
+
+    # Divides a time span into segments specified by the 'interval' option
+    def segments
+      ( ( (@stop - @start) / 1.hour ) / @options[:interval] ).minutes.to_i
+    end
+
+  end
+end

data/app/models/network_executive/network.rb

@@ -0,0 +1,10 @@
+module NetworkExecutive
+  class Network
+
+    cattr_accessor :channels, :programming
+
+  end
+
+  Network.channels    = []
+  Network.programming = []
+end

data/app/models/network_executive/program.rb

@@ -0,0 +1,39 @@
+require 'multi_json'
+
+module NetworkExecutive
+  class Program
+
+    def name
+      self.class.name.demodulize.underscore
+    end
+
+    def url
+      ''
+    end
+
+    def as_json
+      {
+        name: name,
+        url:  url
+      }
+    end
+
+    def play
+      MultiJson.encode( as_json )
+    end
+
+    class << self
+      def inherited( klass )
+        Network.programming << klass.new
+      end
+
+      # TODO: Is this the right place for this?
+      def find_by_name( name )
+        Network.programming.find do |p|
+          p.name == name
+        end
+      end
+    end
+
+  end
+end

data/app/models/network_executive/program_schedule.rb

@@ -0,0 +1,148 @@
+# Example
+# every :monday, play:'morning_show'
+# every :day,    play:'stoplight',    for_the_first:'15mins',  of:'each hour'
+# every :day,    play:'stoplight',    for_the_first:'15mins',  of:'each hour', starting_at:'11am'
+# every :day,    play:'stoplight',    for_the_first:'15mins',  of:'each hour', ending_at:'11am'
+# every :day,    play:'stoplight',    for_the_first:'15mins',  of:'each hour', starting_at:'10am', ending_at:'11am'
+# every :day,    play:'tweets',       for_the_last: '15mins',  of:'every hour'
+# every :day,    play:'sales',        for_the_first:'15mins',  of:'each hour', between:'2pm and 5pm'
+# every :friday, play:'lunch_menu',   between:'11am and 13pm', commercial_free:true
+
+module NetworkExecutive
+
+  class ProgramSchedule
+    attr_accessor :day, :program_name
+
+    Weekdays = %w{sunday monday tuesday wednesday thursday friday saturday}
+    BaseDate = { month:2, day:15, year:1978 }
+
+    def initialize( day, options = {} )
+      options.symbolize_keys!
+
+      raise ProgramNameError unless options[:play]
+
+      if options[:starting_at] || options[:ending_at]
+        range = []
+        range << ( options[:starting_at] || '12am' )
+        range << ( options[:ending_at]   || '11:59pm' )
+        options[:between] = range.join ' and '
+      end
+
+      self.day          = day
+      self.program_name = options[:play]
+      @between          = options[:between]
+      @for_the_first    = options[:for_the_first]
+      @for_the_last     = options[:for_the_last]
+      @period           = options[:of]
+      @commercial_free  = options[:commercial_free]
+    end
+
+    def day=( new_day )
+      new_day = :any if new_day == :day
+
+      @day = new_day
+    end
+
+    def include?( date )
+      day_matches? date \
+        and time_matches? date
+    end
+
+    def commercials?
+      @commercial_free.nil? ? true : !@commercial_free
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      range = @between || '12am and 11:59pm'
+
+      %Q{<#{self.class} program_name="#{program_name}" day="#{@day}" between="#{range}" for_the_first="#{@for_the_first || 'nil'}" for_the_last="#{@for_the_last || 'nil'}" commercial_free=#{!commercials?}>}
+    end
+
+  private
+
+    def day_matches?( date )
+      if day == :any
+        true
+      elsif day.to_s == Weekdays[date.wday]
+        true
+      end
+    end
+
+    def time_matches?( date )
+      comparator = date.dup.change BaseDate
+
+      validations = []
+
+      validations << time_span.cover?( comparator ) if time_span?
+
+      validations << pattern.cover?( comparator ) if repeating?
+
+      validations.none? { |v| v == false }
+    end
+
+    def time_span?
+      @between
+    end
+
+    def time_span
+      if matches = @between.match( %r{(?<start>\d+:?\w*)\s*\S+\s*(?<stop>\d+:?\w*)} )
+        # Normalize the range to an arbitrary date since we only care about Time.
+        start = Time.parse( matches[:start] ).change BaseDate
+        stop  = Time.parse( matches[:stop] ).change BaseDate
+
+        start...stop
+      end
+    end
+
+    def repeating?
+      @for_the_first || @for_the_last
+    end
+
+    def pattern
+      return TimePattern.new @period, first:@for_the_first if @for_the_first
+      return TimePattern.new @period, last:@for_the_last   if @for_the_last
+
+      raise StandardError, 'No parsable time pattern'
+    end
+
+  end
+
+  class TimePattern
+    # TODO: Add support for :period
+    def initialize( period, pattern )
+      @period   = period
+      @boundary = pattern.keys.first
+      @pattern  = parse pattern
+    end
+
+    def cover?( date )
+      range = if @boundary == :first
+        0...@pattern[:value]
+      elsif @boundary == :last
+        (60 - @pattern[:value])..59
+      else
+        raise ArgumentError, 'Missing a valid pattern boundary'
+      end
+
+      range.include? date.send( @pattern[:unit] )
+    end
+
+  private
+
+    def parse( p )
+      value, unit = p[@boundary].split( %r{(\d+)\s*(\w+)} )[1..-1]
+
+      unit = case unit[0]
+      when 'm' then :min
+      end
+
+      { value:value.to_i, unit:unit }
+    end
+
+  end
+
+end

data/app/models/network_executive/viewer.rb

@@ -0,0 +1,76 @@
+module NetworkExecutive
+  class Viewer
+
+    attr_accessor :id, :heartbeat
+
+    def initialize( env )
+      @env = env
+    end
+
+    def ip
+      @ip ||= begin
+        if addr = @env['HTTP_X_FORWARDED_FOR']
+          (addr.split(',').grep(/\d\./).first || @env['REMOTE_ADDR']).to_s.strip
+        else
+          @env['REMOTE_ADDR']
+        end
+      end
+    end
+
+    def channel
+      Channel.find_by_name( channel_name ).tap do |ch|
+        raise ChannelNotFoundError unless ch
+      end
+    end
+
+    def stream
+      @stream ||= Faye::EventSource.new @env
+    end
+
+    def tune_in
+      Rails.logger.debug "Tuning in to the #{channel} channel for #{ip} at #{Time.now}"
+
+      self.id = channel.subscribe { |msg| stream.send msg }
+
+      stream.onclose = method(:tune_out).to_proc
+    end
+
+    def tune_out( event )
+      Rails.logger.debug "Tuning out of the #{channel} channel for #{ip} at #{Time.now}"
+
+      channel.unsubscribe id
+
+      heartbeat.cancel
+
+      @stream = nil
+    end
+
+    def response
+      stream.rack_response
+    end
+
+    def channel_name
+      @env['PATH_INFO'].split('/').last
+    end
+
+    def keep_alive!
+      self.heartbeat = EM.add_periodic_timer( 30 ) do
+        stream.ping
+
+        Rails.logger.debug "Completed PING for #{ip} on the #{channel} channel at #{Time.now}"
+      end
+    end
+
+    class << self
+      def change_channel( env )
+        viewer = Viewer.new( env )
+
+        viewer.tune_in
+        viewer.keep_alive!
+
+        viewer.response
+      end
+    end
+
+  end
+end

data/app/views/network_executive/network/index.html.erb

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <title>Network Executive: <%= network_name %></title>
+    <link href='//fonts.googleapis.com/css?family=Lekton:400,700|Quicksand:300,400,700' rel='stylesheet' type='text/css'>
+    <%= stylesheet_link_tag 'network_executive/application', media:'all' %>
+  </head>
+  <body>
+    <iframe id="program" class="gui-comp"></iframe>
+    <div id="smpte">
+      <h1 id="smpte_message" class="msg"></h1>
+      <aside class="network-name"><%= network_name %></aside>
+    </div>
+    <div id="osd" class="gui-comp">
+      <header>
+        <h1 class="network-name">
+          <%= network_name %>
+          <aside class="osd-now">
+            <time class="osd-now-time">
+              <%= Time.now.strftime( '%l:%M%P') %>
+            </time>
+            <small class="osd-now-date">
+              <%= Time.now.strftime( '%B %e, %Y' ) %>
+            </small>
+          </aside>
+        </h1>
+      </header>
+      <article>
+        <% @channels.each do |channel| %>
+          <a href="/channels/<%= channel.name %>" class="channel"><%= channel.display_name %></a>
+        <% end %>
+      </article>
+    </div>
+
+    <%= javascript_include_tag 'application' %>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+NetworkExecutive::Engine.routes.draw do
+  mount NetworkExecutive::Station => '/tune_in', as:'station'
+
+  match 'channels/:channel_name' => 'network#index'
+
+  root to:'network#index'
+end

data/lib/generators/network_executive/install_generator.rb

@@ -0,0 +1,96 @@
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+
+module NetworkExecutive
+  class InstallGenerator < Rails::Generators::Base
+    desc 'NetworkExecutive installation generator'
+
+    source_root File.expand_path( '../templates', __FILE__ )
+
+    def install
+      say 'Installing NetworkExecutive...', :magenta
+
+      create_initializer
+      mount_engine
+      add_channels_folder
+      add_programs_folder
+
+      say 'Done!', :green
+    end
+
+  private
+
+    def create_initializer
+      if initializer
+        say "You already have an initializer so I'm generating a new one at 'network_executive.rb.example' that you can review", :yellow
+
+        @network_name = NetworkExecutive.config.name
+
+        template 'initializer.erb', 'config/initializers/network_executive.rb.example', force:true
+      else
+        say 'What would you like to name your network?', :yellow
+
+        @network_name = ask("  Press <enter> for [#{default_network_name}] >").presence || default_network_name
+
+        NetworkExecutive.config.name = @network_name
+
+        template 'initializer.erb', 'config/initializers/network_executive.rb'
+      end
+    end
+
+    def mount_engine
+      if mounted?
+        say 'NetworkExecutive is already mounted, skipping routes update', :yellow
+      else
+        say 'Where do you want to mount NetworkExecutive?', :yellow
+
+        mount_at = ask("  Press <enter> for [/#{default_mount_location}] >").presence || default_mount_location
+
+        mount_at = sanitize mount_at
+
+        route "mount NetworkExecutive::Engine => '/#{mount_at}', as:'network_executive'"
+      end
+    end
+
+    # TODO: Uninstall steps
+    def add_channels_folder
+      create_file 'app/channels/.gitkeep'
+    end
+
+    # TODO: Uninstall steps
+    def add_programs_folder
+      create_file 'app/programs/.gitkeep'
+    end
+
+    def mounted?
+      routes =~ %r{mount NetworkExecutive::Engine}
+    end
+
+    def sanitize( path )
+      if path == '/'
+        ''
+      else
+        path.gsub %r{\A/}, ''
+      end
+    end
+
+    def routes
+      File.open(Rails.root.join('config/routes.rb')).try :read
+    end
+
+    def initializer
+      (File.open(Rails.root.join('config/initializers/network_executive.rb')) rescue nil).try :read
+    end
+
+    def default_network_name
+      NetworkExecutive.config.defaults['name']
+    end
+
+    def default_mount_location
+      NetworkExecutive.config.name.gsub(' ','').underscore
+    end
+
+  end
+end

data/lib/generators/network_executive/templates/initializer.erb

@@ -0,0 +1,5 @@
+# NetworkExecutive config file. Generated on <%= DateTime.now.to_s(:long) %>
+
+NetworkExecutive.configure do |config|
+  config.name = '<%= @network_name %>'
+end

data/lib/generators/network_executive/uninstall_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module NetworkExecutive
+  class UninstallGenerator < Rails::Generators::Base
+    source_root File.expand_path( '../templates', __FILE__ )
+
+    desc 'NetworkExecutive uninstall'
+
+    def uninstall
+      say 'Uninstalling NetworkExecutive...', :magenta
+
+      remove_file 'config/initializers/network_executive.rb'
+      remove_file 'config/initializers/network_executive.rb.example'
+
+      gsub_file 'config/routes.rb', /mount NetworkExecutive::Engine => \'\/.+\', as:\S*\'network_executive\'/, ''
+
+      say 'Done!', :green
+    end
+  end
+end

data/lib/network_executive/configuration.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/hash'
+
+module NetworkExecutive
+  class Configuration
+    attr_accessor :name
+
+    @@defaults = HashWithIndifferentAccess.new(
+      name: 'My Network'
+    )
+
+    def initialize
+      @@defaults.dup.each_pair { |k, v| self.send "#{k}=", v }
+    end
+
+    def defaults
+      @@defaults
+    end
+
+    def attributes
+      self.class.defaults.keys.each_with_object(HashWithIndifferentAccess.new) do |k, hash|
+        hash[k] = self.send k
+      end
+    end
+    alias_method :to_hash, :attributes
+  end
+end

data/lib/network_executive/engine.rb

@@ -0,0 +1,28 @@
+# TODO: Only load when needed (enables asset pipeline)
+require 'sass-rails'
+
+module NetworkExecutive
+
+  class Engine < Rails::Engine
+    engine_name :network_executive
+
+    isolate_namespace NetworkExecutive
+
+    initializer 'network_executive.eager_load_channels' do |app|
+      eager_load_models_in 'channels', app
+    end
+
+    initializer 'network_executive.eager_load_programs' do |app|
+      eager_load_models_in 'programs', app
+    end
+
+  private
+
+    def eager_load_models_in( sub_path, app )
+      Dir[ File.join(app.root, 'app', sub_path, '*') ].each do |c|
+        require c
+      end
+    end
+
+  end
+end