hell 0.1.0 → 0.1.1

data/Rakefile

@@ -23,7 +23,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Hell is an open source web interface that exposes a set of capistrano recipes as a json api, for usage within large teams}
   gem.email = "jose@seatgeek.com"
   gem.authors = ["Jose Diaz-Gonzalez"]
-  # dependencies defined in Gemfile
+  gem.executables = ["hell", "hell-pusher"]
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/bin/hell

@@ -6,7 +6,7 @@ require 'hell/lib/cli'
 ENV["RACK_ENV"] ||= "development"
 
 unicorn_path = File.expand_path('../../unicorn', __FILE__)
-options, op = Hell::CLI.option_parser(ARGV, unicorn_path)
+options, op = Hell::CLI.unicorn_options(ARGV, unicorn_path)
 
 unless File.directory? options[:log_path]
   abort('Missing hell log path %s' % options[:log_path])

data/bin/hell-pusher

@@ -0,0 +1,20 @@
+#!/this/will/be/overwritten/or/wrapped/anyways/do/not/worry/ruby
+# -*- encoding: binary -*-
+require 'pusher'
+require 'hell/lib/helpers'
+
+TASK_ID = ENV.fetch('HELL_TASK_ID', nil)
+HELL_LOG_PATH = ENV.fetch('HELL_LOG_PATH', File.join(Dir.pwd, 'log'))
+HELL_SENTINEL_STRINGS = ENV.fetch('HELL_SENTINEL_STRINGS', 'Hellish Task Completed').split(',')
+abort('Missing hell task id') unless TASK_ID
+
+unless Hell::Helpers.valid_log(TASK_ID)
+  Hell::Helpers::pusher_error(TASK_ID, "log file '#{TASK_ID}' not found")
+  abort("log file '#{TASK_ID}' not found")
+end
+
+Pusher.app_id = ENV.fetch('HELL_PUSHER_APP_ID', nil)
+Pusher.key = ENV.fetch('HELL_PUSHER_KEY', nil)
+Pusher.secret = ENV.fetch('HELL_PUSHER_SECRET', nil)
+
+Hell::Helpers::pusher_success(TASK_ID, "tail -n 1000 -f %s" % File.join(HELL_LOG_PATH, TASK_ID + ".log"))

data/hell.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "hell"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Diaz-Gonzalez"]
   s.date = "2013-02-21"
   s.description = "Hell is an open source web interface that exposes a set of capistrano recipes as a json api, for usage within large teams"
   s.email = "jose@seatgeek.com"
-  s.executables = ["hell"]
+  s.executables = ["hell", "hell-pusher"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.markdown"
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/hell",
+    "bin/hell-pusher",
     "config.ru",
     "hell.gemspec",
     "lib/hell.rb",

data/lib/hell/app.rb

@@ -14,7 +14,7 @@ require 'hell/lib/cli'
 require 'hell/lib/monkey_patch'
 require 'hell/lib/helpers'
 
-options, op = Hell::CLI.option_parser(ARGV, nil, true)
+options, op = Hell::CLI.option_parser(ARGV)
 op = nil
 
 HELL_DIR              = Dir.pwd
@@ -112,6 +112,8 @@ module Hell
       verbose = "LOGGING=debug" if params[:verbose] == "on"
 
       task_id = run_in_background!("bundle exec cap -l STDOUT %s %s" % [original_cmd, verbose]) unless tasks.empty?
+      tail_in_background!(task_id) if USE_PUSHER
+
       response = {}
       response[:status] = tasks.empty? ? 404 : 200,
       response[:message] = tasks.empty? ? "Task not found" : "Running task in background",
@@ -145,16 +147,6 @@ module Hell
       end
     end
 
-    def self.init_send
-      if USE_PUSHER
-        alias_method :send_error, :_pusher_error
-        alias_method :send_success, :_pusher_success
-      else
-        alias_method :send_error, :_stream_error
-        alias_method :send_success, :_stream_success
-      end
-    end
-
     def cap
       FileUtils.chdir HELL_APP_ROOT do
         @cap ||= Capistrano::CLI.parse(["-T"])
@@ -162,23 +154,7 @@ module Hell
       return @cap
     end
 
-    def _pusher_error(task_id, message)
-      Pusher[task_id].trigger('start', {:data => ''})
-      Pusher[task_id].trigger('message', ws_message("<p>#{message}</p>"))
-      Pusher[task_id].trigger('end', {:data => ''})
-    end
-
-    def _pusher_success(task_id, command, opts = {})
-      opts = {:prepend => false}.merge(opts)
-      Pusher[task_id].trigger('start', {:data => ''})
-      Pusher[task_id].trigger('message', ws_message("<p>#{command}</p>")) unless opts[:prepend] == false
-      IO.popen(command, 'rb') do |io|
-        io.each {|line| push_line(task_id, line, out, io)}
-      end
-      Pusher[task_id].trigger('end', {:data => ''})
-    end
-
-    def _stream_error(task_id, message)
+    def send_error(task_id, message)
       stream do |out|
         out << "event: start\ndata:\n\n" unless out.closed?
         out << "data: " + ws_message("<p>#{message}</p>")  + "\n\n" unless out.closed?
@@ -187,7 +163,7 @@ module Hell
       end
     end
 
-    def _stream_success(task_id, command, opts = {})
+    def send_success(task_id, command, opts = {})
       opts = {:prepend => false}.merge(opts)
       stream do |out|
         out << "event: start\ndata:\n\n" unless out.closed?
@@ -199,6 +175,5 @@ module Hell
       end
     end
 
-    init_send
   end
 end

data/lib/hell/lib/cli.rb

@@ -4,7 +4,7 @@ require 'optparse'
 
 module Hell
   class CLI
-    def self.default_options(unicorn_path=nil, sinatra_opts=false)
+    def self.default_options(unicorn_path=nil)
       rackup_opts = Unicorn::Configurator::RACKUP || {}
       rackup_opts[:port] = 4567
 
@@ -14,21 +14,35 @@ module Hell
 
       options[:log_path] = ENV.fetch('HELL_LOG_PATH', File.join(Dir.pwd, 'log'))
 
-      if sinatra_opts
-        options[:app_root] = ENV.fetch('HELL_APP_ROOT', Dir.pwd)
-        options[:base_path] = ENV.fetch('HELL_BASE_PATH', '/')
-        options[:require_env] = !!ENV.fetch('HELL_REQUIRE_ENV', true)
-        options[:sentinel] = ENV.fetch('HELL_SENTINEL_STRINGS', 'Hellish Task Completed').split(',')
-        options[:pusher_app_id] = ENV.fetch('HELL_PUSHER_APP_ID', nil)
-        options[:pusher_key] = ENV.fetch('HELL_PUSHER_KEY', nil)
-        options[:pusher_secret] = ENV.fetch('HELL_PUSHER_SECRET', nil)
-      end
+      options[:app_root] = ENV.fetch('HELL_APP_ROOT', Dir.pwd)
+      options[:base_path] = ENV.fetch('HELL_BASE_PATH', '/')
+      options[:require_env] = !!ENV.fetch('HELL_REQUIRE_ENV', true)
+      options[:sentinel] = ENV.fetch('HELL_SENTINEL_STRINGS', 'Hellish Task Completed').split(',')
+      options[:pusher_app_id] = ENV.fetch('HELL_PUSHER_APP_ID', nil)
+      options[:pusher_key] = ENV.fetch('HELL_PUSHER_KEY', nil)
+      options[:pusher_secret] = ENV.fetch('HELL_PUSHER_SECRET', nil)
 
       options
     end
 
-    def self.option_parser(args, unicorn_path=nil, sinatra_opts=false)
-      options = Hell::CLI.default_options(unicorn_path, sinatra_opts)
+    def self.unicorn_options(args, unicorn_path=nil)
+      options, op = Hell::CLI.option_parser(args, unicorn_path)
+
+      [
+        :app_root,
+        :base_path,
+        :require_env,
+        :sentinel,
+        :pusher_app_id,
+        :pusher_key,
+        :pusher_secret,
+      ].each {|key| options.delete(key)}
+
+      [options, op]
+    end
+
+    def self.option_parser(args, unicorn_path=nil)
+      options = Hell::CLI.default_options(unicorn_path)
 
       op = OptionParser.new("", 24, '  ') do |opts|
         cmd = File.basename($0)
@@ -114,7 +128,8 @@ module Hell
         # config files and make things unnecessarily complicated with multiple
         # places to look for a config option.
 
-        opts.separator "Common options:"
+        opts.separator "Common options"
+        opts.separator "Note: will not work under unicorn, use environment variables instead"
 
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
@@ -126,39 +141,39 @@ module Hell
           exit
         end
 
-        opts.on('-a', '--app-root APP_ROOT', 'directory from which capistrano should run') do |opt|
-          options[:app_root] = opt if opt && sinatra_opts
+        opts.on('-a', '--app-root APP_ROOT', 'directory from which capistrano should run') do |app_root|
+          options[:app_root] = app_root if app_root
         end
 
-        opts.on('-b', '--base-path BASE_PATH', 'base directory path to use in the web ui') do |opt|
-          options[:base_path] = opt if opt && sinatra_opts
+        opts.on('-b', '--base-path BASE_PATH', 'base directory path to use in the web ui') do |base_path|
+          options[:base_path] = base_path if base_path
         end
 
-        opts.on('-L', '--log-path LOG_PATH', 'directory path to hell logs') do |opt|
-          options[:log_path] = opt if opt
+        opts.on('-L', '--log-path LOG_PATH', 'directory path to hell logs') do |log_path|
+          options[:log_path] = log_path if log_path
         end
 
-        opts.on('-R', '--require-env REQUIRE_ENV', 'whether or not to require specifying an environment') do |opt|
-          options[:require_env] = !!opt if opt && sinatra_opts
+        opts.on('-R', '--require-env REQUIRE_ENV', 'whether or not to require specifying an environment') do |require_env|
+          options[:require_env] = !!require_env if require_env
         end
 
-        opts.on('-S', '--sentinel SENTINAL_PHRASE', 'sentinel phrase used to denote the end of a task run') do |opt|
-          options[:sentinel] = opt.split(',') if opt && sinatra_opts
+        opts.on('-S', '--sentinel SENTINAL_PHRASE', 'sentinel phrase used to denote the end of a task run') do |sentinel|
+          options[:sentinel] = sentinel.split(',') if sentinel
         end
 
-        opts.on('--pusher-app-id PUSHER_APP_ID', 'pusher app id') do |opt|
-          options[:pusher_app_id] = opt if opt && sinatra_opts
+        opts.on('--pusher-app-id PUSHER_APP_ID', 'pusher app id') do |pusher_app_id|
+          options[:pusher_app_id] = pusher_app_id if pusher_app_id
         end
 
-        opts.on('--pusher-key PUSHER_KEY', 'pusher key') do |opt|
-          options[:pusher_key] = opt if opt && sinatra_opts
+        opts.on('--pusher-key PUSHER_KEY', 'pusher key') do |pusher_key|
+          options[:pusher_key] = pusher_key if pusher_key
         end
 
-        opts.on('--pusher-secret PUSHER_SECRET', 'pusher secret') do |opt|
-          options[:pusher_secret] = opt if opt && sinatra_opts
+        opts.on('--pusher-secret PUSHER_SECRET', 'pusher secret') do |pusher_secret|
+          options[:pusher_secret] = pusher_secret if pusher_secret
         end
 
-        opts.parse! ARGV
+        opts.parse! args
       end
 
       [options, op]

data/lib/hell/lib/helpers.rb

@@ -5,6 +5,7 @@ module Hell
   class TailDone < StandardError; end
 
   module Helpers
+
     def escape_to_html(data)
       {
         1 => :nothing,
@@ -44,11 +45,11 @@ module Hell
     end
 
     def ansi_escape(message)
-      escape_to_html(utf8_dammit(message))
+      Hell::Helpers::escape_to_html(Hell::Helpers::utf8_dammit(message))
     end
 
     def ws_message(message)
-      message = {:message => ansi_escape(message)}.to_json
+      {:message => Hell::Helpers::ansi_escape(message)}
     end
 
     def stream_line(task_id, line, out, io)
@@ -60,11 +61,11 @@ module Hell
       end
     end
 
-    def push_line(task_id, line, out, io)
+    def push_line(task_id, line, io)
       begin
-        Pusher[task_id].trigger('message', ws_message(line))
+        Pusher[task_id].trigger('message', MultiJson.dump(Hell::Helpers::ws_message(line)))
         raise TailDone if HELL_SENTINEL_STRINGS.any? { |w| line =~ /#{w}/ }
-      rescue
+      rescue StandardError => e
         Process.kill("KILL", io.pid)
       end
     end
@@ -98,6 +99,11 @@ module Hell
       log_file
     end
 
+    def tail_in_background!(task_id)
+      cmd = "cd #{HELL_LOG_PATH} && HELL_TASK_ID='#{task_id}' HELL_SENTINEL_STRINGS='#{HELL_SENTINEL_STRINGS.join(',')}' HELL_LOG_PATH='#{HELL_LOG_PATH}' bundle exec hell-pusher"
+      system("sh -c \"#{cmd}\" &")
+    end
+
     def verify_task(cap, name)
       original_cmd = name.gsub('+', ' ').gsub!(/\s+/, ' ').strip
       cmd = original_cmd.split(' ')
@@ -134,5 +140,34 @@ module Hell
     def json_encode(data)
       MultiJson.dump(data)
     end
+
+    def pusher_error(task_id, message)
+      Pusher[task_id].trigger('start', MultiJson.dump(Hell::Helpers::ws_message("<p>start</p>")))
+      Pusher[task_id].trigger('message', MultiJson.dump(Hell::Helpers::ws_message("<p>#{message}</p>")))
+      Pusher[task_id].trigger('end', MultiJson.dump(Hell::Helpers::ws_message("<p>end</p>")))
+    end
+
+    def pusher_success(task_id, command, opts = {})
+      out = nil
+      opts = {:prepend => false}.merge(opts)
+      Pusher[task_id].trigger('start', MultiJson.dump(Hell::Helpers::ws_message("<p>start</p>")))
+      Pusher[task_id].trigger('message', MultiJson.dump(Hell::Helpers::ws_message("<p>#{command}</p>"))) unless opts[:prepend] == false
+      IO.popen(command, 'rb') do |io|
+        io.each do |line|
+          Hell::Helpers::push_line(task_id, line, io)
+        end
+      end
+      Pusher[task_id].trigger('end', MultiJson.dump(Hell::Helpers::ws_message("<p>end</p>")))
+    end
+
+    module_function :pusher_error
+    module_function :pusher_success
+    module_function :push_line
+    module_function :valid_log
+    module_function :ws_message
+    module_function :utf8_dammit
+    module_function :ansi_escape
+    module_function :escape_to_html
+
   end
 end

data/lib/hell/public/assets/js/hell.js

@@ -139,6 +139,8 @@ $(function() {
     _executePusher: function (task_id, name) {
       var that = this;
 
+      HellApp.setupPusher();
+
       // Create a new channel
       var channel = HellApp.pusher.subscribe(task_id);
 
@@ -152,13 +154,12 @@ $(function() {
       channel.bind('end', function(data) {
         HellApp.set_flash("Received the last response " + name, "info");
         that.setStatus("finished");
-        pusher.unsubscribe(task_id);
+        HellApp.pusher.unsubscribe(task_id);
       });
 
       // Append the messages to the .task-output div
       channel.bind('message', function(data) {
-        var message = jQuery.parseJSON(data);
-        $('.task-output').append(message.message.replace(/~+$/, ''));
+        $('.task-output').append(data.message.replace(/~+$/, ''));
         $(".task-output").animate({scrollTop: $(".task-output").prop("scrollHeight")}, 1);
       });
     },
@@ -454,14 +455,15 @@ $(function() {
         src = null;
       }
     },
+    setupPusher: function() {
+      if (HellApp.use_pusher) {
+        HellApp.pusher = HellApp.pusher || new Pusher(HellApp.pusher_key);
+      }
+    },
     collection: new TaskCollectionView(),
     form: new TaskFormView()
   });
 
-  if (HellApp.use_pusher) {
-    HellApp.pusher = Pusher(HellApp.pusher_key);
-  }
-
   // HACK: This should be moved into a Backbone View or Router
 
   // Function to activate the tab

data/lib/hell/views/index.erb

@@ -125,6 +125,7 @@
       HellApp.pusher_secret = <%= json_encode(@pusher_secret) %>;
     </script>
 
+    <script src="http://js.pusher.com/1.12/pusher.min.js"></script>
     <%= js :jquery %>
     <script src="<%= @www_base_dir %>assets/js/bootstrap.js"></script>
     <script src="<%= @www_base_dir %>assets/js/underscore.js"></script>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -176,6 +176,7 @@ description: Hell is an open source web interface that exposes a set of capistra
 email: jose@seatgeek.com
 executables:
 - hell
+- hell-pusher
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -188,6 +189,7 @@ files:
 - Rakefile
 - VERSION
 - bin/hell
+- bin/hell-pusher
 - config.ru
 - hell.gemspec
 - lib/hell.rb
@@ -236,7 +238,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2323718854434206367
+      hash: -2842994347166960270
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: