last-resort 0.0.8 → 0.0.10

data/.gitignore

@@ -15,4 +15,5 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp
+schedule.rb

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--drb
+--format d

data/README.md

@@ -1,41 +1,41 @@
-Last Resort is a Ruby gem for monitoring critical emails sent by automated services ("Server down!", 
-"Resource limit matched!", etc.) and calling your phone to tell you about it. It can be deployed in a 
-reliable environment and perform up to 1500 emergency calls for free, using the free and trial tiers 
-available from [context.io](http://context.io), [twilio](http://twilio.com) and [heroku](http://heroku.com).
+Last Resort is a Ruby gem for monitoring email sent by automated services (monit, logging packages,
+external ping services, etc.) and calling your phone to tell you about the important ones. Using free and trial tiers
+available from [context.io](http://context.io), [twilio](http://twilio.com) and [heroku](http://heroku.com),
+Last Resort can be deployed in a reliable environment and perform up to 1500 emergency calls **for free**.
 
-### Installation
+### Requirements
+* Ruby 1.9.x
+* Accounts with [context.io](http://context.io), [twilio](http://twilio.com) and optionally [heroku](http://heroku.com),
+  but don't worry -- our commandline utility will help you through the process.
+* Git (if you're deploying to Heroku)
 
+### Installation
 ```sh
 $ gem install last-resort
 ```
 
 ### Getting started
-
 ```sh
 $ last-resort new my-awesome-project
 ```
-This will create a scheduling project with a sample `my-awesome-project/config.rb` file.
+This will create a new monitoring project with a sample `my-awesome-project/schedule.rb` file, and all that's
+needed to get up and running on a Rack server (or Heroku) quickly.
 
-### Example config.rb file
+### Example schedule.rb file
 
 ```ruby
-configure :host => "",
-          :twilio_sid => "",
-          :twilio_auth_token => "",
-          :contextio_account => "",
-          :contextio_key => "",
-          :contextio_secret => ""
+configure :from_env
 
 # DEFINE YOUR CONTACTS
 
-contact :ian, ""
-contact :scott, ""
-contact :victor, ""
+contact :ian, "416-123-1234"
+contact :scott, "416-321-4321"
+contact :victor, "416-123-4321"
 
 # DEFINE WHAT EMAILS YOU WANT TO WATCH FOR
 
-match :subject => /server down/ # rackspace ping
-match :subject => /resource limit reached/ # monit
+match :subject => /Server down/ # external ping service
+match :subject => /Resource limit matched/ # monit
 
 # DEFINE WHO TO CALL AND WHEN
 
@@ -52,7 +52,10 @@ between :all_hours, :on => :weekends do
 end
 ```
 
+### Roadmap
+If there is sufficient demand, we plan on adding more complicated schedules.
+
 ### Credit
 Victor Mota ([@vimota](http://www.twitter.com/vimota))  
 Scott Hyndman ([@scotthyndman](http://www.twitter.com/scotthyndman))  
-Ian Ha ([@ianpha](http://www.twitter.com/ianpha))
+Ian Ha ([@ianpha](http://www.twitter.com/ianpha))  

data/Rakefile

@@ -1,2 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+desc "Run the rspec tests"
+task :spec do
+  system "rspec spec"
+end

data/bin/last-resort

@@ -1,5 +1,42 @@
 #!/usr/bin/env ruby
 
-# Parse options
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib/last-resort')
 
-# Perform command
+require 'version'
+require 'commands'
+require 'rubygems'
+require 'colored'
+require 'gli';
+
+include GLI
+
+
+program_desc 'Last Resort is a Ruby gem for monitoring critical emails sent by automated services (monit, logging packages, external ping services, etc.) and calling your phone to tell you about it.'
+version LastResort::VERSION
+
+desc 'Creates a new Last Resort project'
+arg_name 'project name'
+command :new do |c|
+  c.desc 'skip Q&A session'
+  c.switch [:s, :skip]
+
+  c.action do |global_options, options, args|
+    raise "Please specify a project name" if args.empty?
+    LastResort::Commands::q_and_a args[0]
+  end
+end
+
+desc 'Run the last-resort server'
+command :run do |c|
+  c.action do |global_options, options, args|
+    LastResort::Commands.run_heroku_or_rackup
+  end
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit GLI.run(ARGV)

data/last-resort.gemspec

@@ -4,23 +4,27 @@ require File.expand_path('../lib/last-resort/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Ian Ha", "Victor Mota", "Scott Hyndman"]
   gem.email         = ["ianha0@gmail.com", "vimota@gmail.com", "scotty.hyndman@gmail.com"]
-  gem.description   = "Call your phone when critical emails arrive" # TODO Improve this
-  gem.summary       = "Call your phone when critical emails arrive" # TODO Improve this
-  gem.homepage      = ""
+  gem.summary       = "Calls your phone when critical emails arrive"
+  gem.description   = "Last Resort is a Ruby gem for monitoring email sent by automated services (monit, logging packages, external ping services, etc.) and calling your phone to tell you about the important ones. Using free and trial tiers available from context.io, twilio and heroku, Last Resort can be deployed in a reliable environment and perform up to 1500 emergency calls for free."
+  gem.homepage      = "https://github.com/ianha/LastResort"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "last-resort"
   gem.require_paths = ["lib"]
-  gem.version       = Last::Resort::VERSION
+  gem.version       = LastResort::VERSION
 
   gem.add_dependency "sinatra", "~> 1.3"
   gem.add_dependency "twilio-ruby", "~> 3.6"
-  gem.add_dependency "thor", "~> 0.14"
   gem.add_dependency "oauth", "~> 0.4"
   gem.add_dependency "gli", "~> 1.6"
+  gem.add_dependency "colored"
+  gem.add_dependency "launchy", "~> 2.1"
   gem.add_development_dependency 'rspec', '~> 2.9.0'
   gem.add_development_dependency 'webmock', '~> 1.8.5'
   gem.add_development_dependency "awesome_print"
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "nokogiri"
 end

data/lib/last-resort.rb

@@ -1,23 +1,16 @@
 require "rubygems"
 require "bundler/setup"
-require "sinatra"
+require "sinatra/base"
 
 FILE_DIR = File.expand_path(File.dirname(__FILE__))
 
-# BRING IN DEPENDENCIES
+require 'last-resort/version'
+require 'last-resort/config'
+require 'last-resort/contextio'
+require 'last-resort/scheduler'
+require 'last-resort/twilio'
+require 'last-resort/webhooks'
+require 'last-resort/application'
 
-$LOAD_PATH << FILE_DIR
-Dir["#{FILE_DIR}/last-resort/*.rb"].each do |file_path|
-  require file_path
-end
-
-
-# SINATRA BASICS
-
-set :port, 80
-
-get "/" do
-  "Last Resort server running"
-end
-
-# LastResort::WebHookCreator.create_hooks
+# Run the application if called directly
+LastResort::Application.run! if $0 == __FILE__

data/lib/last-resort/application.rb

@@ -0,0 +1,120 @@
+require 'sinatra/base'
+
+module LastResort
+  # The main Sinatra application. Defines the API interface and webhooks called by Twilio and ContextIO
+  # for call handling logic and email matching, respectively.
+  class Application < Sinatra::Base
+
+    def initialize
+      super
+    end
+
+    # The exception session keeps state between twilio and context-io webhooks. Currently, the
+    # system can only handle one call session at a time, although we plan to change that in future
+    # versions.
+    def self.exception_session
+      @exception_session
+    end
+
+    def self.exception_session=(session)
+      @exception_session = session
+    end
+
+    # ====== SERVER CHECK ROUTE
+
+    get "/" do
+      "Last Resort server running"
+    end
+
+    # ====== CONTEXT-IO TWILIO ENDPOINTS
+
+    # This is the webhook callback from context-io, called context-io has detected a matching pattern
+    post '/matched_email' do
+      scheduler = new_scheduler
+      matching_schedule = scheduler.get_matching_schedule
+
+      return if matching_schedule.nil?
+
+      matched_email = JSON.parse(get_request_body)
+      contacts = matching_schedule[:contacts].map { |name| LastResort::Contact.new(name.to_s, @config.contacts[name][:phone]) }
+
+      Application.exception_session = new_exception_session(contacts, matched_email["message_data"]["subject"])
+      Application.exception_session.notify
+    end
+
+
+    # ====== SINATRA TWILIO ENDPOINTS
+
+    # Service check method
+    get '/twilio' do
+      "Twilio callbacks up and running!"
+    end
+
+    # Performs a test call based on the user's configuration
+    get '/twilio/test' do
+      Application.exception_session.notify
+    end
+
+    # Method invoked to determine how the machine should interact with the user.
+    post '/twilio/call' do
+      content_type 'text/xml'
+      puts "call with #{params.inspect}"
+
+      if params[:CallStatus] == 'no-answer'
+        return Twilio::TwiML::Response.new { |r| r.Hangup }.text
+      end
+
+      response = Twilio::TwiML::Response.new do |r|
+        r.Say "Hello #{Application.exception_session.callee_name}. The following error has occured: #{Application.exception_session.description}", :voice => 'man'
+        r.Gather :numDigits => 1, :action => "http://#{HOST}/twilio/gather_digits" do |d|
+          d.Say "Please enter 1 to handle this bug that you probably didn't even create or 0 or hangup to go back to spending quality time with your family."
+        end
+      end
+      response.text
+    end
+
+    # Called when a user's call ends
+    post '/twilio/status_callback' do
+      puts "status_callback with #{params.inspect}"
+
+      Application.exception_session.call_next
+    end
+
+    # Called to respond to user phone input
+    post '/twilio/gather_digits' do
+      puts "gather_digits with #{params.inspect}"
+
+      content_type 'text/xml'
+      digit = params[:Digits].to_i
+
+      case digit
+      when 1 # User handles call, so don't call anyone else
+        Application.exception_session.end
+
+        response = Twilio::TwiML::Response.new do |r|
+          r.Say "Thank you for handling this exception. Goodbye.", :voice => 'man'
+          r.Hangup
+        end
+        return response.text
+      else # Hangup this call and go to the next person
+        return Twilio::TwiML::Response.new {|r| r.Hangup}.text
+      end
+    end
+
+    private
+
+    # ===== The following methods are wrappers to make our code more testable.
+
+    def new_scheduler
+      LastResort::Scheduler.new
+    end
+
+    def get_request_body
+      request_body.read
+    end
+
+    def new_exception_session *args
+      LastResort::ExceptionSession.new(*args)
+    end
+  end
+end

data/lib/last-resort/commands.rb

@@ -0,0 +1,159 @@
+require 'launchy'
+require 'config'
+
+module LastResort
+  class Commands
+    def self.q_and_a project_name
+      @last_resort_path = File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../../')
+
+      puts "#{"Last Resort".green} is a Ruby gem for monitoring critical emails sent by automated services (monit, logging packages, external \nping services, etc.) and calling your phone to tell you about it.\n\n"
+
+      get_twillio_info
+      get_contextio_info
+
+      create_project project_name
+    end
+
+    def self.ask_yes_no message
+      begin
+        answer = ask message
+      end while !(answer.casecmp('y') == 0 or answer.casecmp('n') == 0)
+      answer.casecmp('y') == 0
+    end
+
+    def self.ask message
+      begin
+        print message
+        response = $stdin.gets.strip
+        if response.empty?
+          puts "Sorry you must enter something."
+        end
+      end while response.empty?
+
+      response
+    end
+
+    def self.get_twillio_info
+      answer = ask_yes_no "Do you already have a #{'Twillio'.red} account? [Y/n]"
+      Launchy.open("http://www.twilio.com/try-twilio") unless answer
+      @twillio_sid = ask "#{'Twillio'.red} SID: "
+      @twillio_auth_token = ask "#{'Twillio'.red} Auth Token: "
+      puts ''
+    end
+
+    def self.get_contextio_info
+      answer = ask_yes_no "Do you already have a #{'ContextIO'.yellow} account? [Y/n]"
+      Launchy.open("http://www.context.io") unless answer
+      puts ''
+      puts "Please find the ContextIO key and secret tokens, as well as the ContextIO Account ID of the email account you wish to monitor."
+      @contextio_key = ask "#{'ContextIO'.yellow} Key: "
+      @contextio_secret = ask "#{'ContextIO'.yellow} Secret: "
+      @contextio_account = ask "#{'ContextIO'.yellow} Email Account ID: "
+    end
+
+    def self.create_project project_name
+      @project_path = project_name.to_s
+
+      create_project_folder
+      copy_files
+      copy_schedule_and_add_utc
+      
+      old_dir = Dir.pwd
+      Dir.chdir("#{@project_path}")
+
+      `bundle install`
+      set_up_heroku unless ask_if_heroku
+      set_up_git unless @no_heroku
+      create_heroku_project unless @no_heroku
+      create_env
+      `git push heroku master` unless @no_heroku
+
+      Dir.chdir("#{old_dir}")
+    end
+
+    def self.create_project_folder
+      puts "\nCreating project folder"
+      FileUtils.mkdir @project_path
+    end
+
+    def self.copy_files
+      puts '* creating .gitignore'.green
+      FileUtils.cp "#{@last_resort_path}/support/dot_gitignore", "#{@project_path}/.gitignore"
+
+      puts '* creating config.ru'.green
+      FileUtils.cp "#{@last_resort_path}/support/config.ru", "#{@project_path}"
+
+      puts '* creating Gemfile'.green
+      FileUtils.cp "#{@last_resort_path}/support/Gemfile", "#{@project_path}"
+    end
+
+    def self.copy_schedule_and_add_utc
+      puts '* creating schedule.rb'.green
+      schedule_file = open(@project_path + '/schedule.rb', 'w') do |f|
+        f.puts open(@last_resort_path + '/support/schedule.rb').read % { 
+          :utc_offset => Time.now.utc_offset/60/60 
+        }
+      end
+    end
+
+    def self.ask_if_heroku
+      puts ''
+      @no_heroku = !(ask_yes_no "Do you want it to be hosted on #{'Heroku'.magenta} (recommended)? [Y/n] ")
+    end
+
+    def self.set_up_heroku
+      puts 'Installing heroku'.green
+      `gem install heroku --no-rdoc --no-ri`
+      `heroku plugins:install git://github.com/ddollar/heroku-config.git`
+
+      answer = ask "Do you already have a #{'Heroku'.magenta} account? [Y/n]"
+      Launchy.open("http://heroku.com") if answer.casecmp('n') == 0
+      puts 'Please login to Heroku'
+      system 'heroku login'
+    end
+
+    def self.set_up_git
+      puts 'Initiating git repo'.green
+      `git init`
+      `git add .`
+      `git commit -m "Initializing git"`
+    end
+
+    def self.create_heroku_project
+      puts 'Creating Heroku project'.green
+      heroku_output = `heroku create --stack cedar`
+      @host = heroku_output.match(/http(.*).com\//)[0]
+    end
+
+    def self.create_env
+      open('.env', 'w') do |f|
+        f.puts open(@last_resort_path + '/support/dot_env').read % {
+          :host => (@no_heroku) ? '' : @host,
+          :twilio_sid => @twillio_sid,
+          :twilio_auth_token => @twillio_auth_token,
+          :contextio_account => @contextio_account,
+          :contextio_key => @contextio_key,
+          :contextio_secret => @contextio_secret,
+          :no_heroku => @no_heroku
+        }
+      end
+
+      if @no_heroku
+        puts 'Settings for Last Resort are stored in a .env file that can be found in the project directory.'.yellow
+        puts 'In order to run your project, you must modify the .env to include the domain name of your server.'.yellow 
+      end
+    end
+
+    # ====== RUN
+
+    def self.run_heroku_or_rackup
+      begin
+        LastResort::Config::populate_env_if_required
+      rescue
+        puts 'Make sure to run "last-resort run" from a last-resort project'.yellow
+        return
+      end
+
+    end
+  end
+end