last-resort 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+# Specify your gem's dependencies in last-resort.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    last-resort (0.0.1)
+      activesupport (~> 3.2)
+      gli (~> 1.6)
+      oauth (~> 0.4)
+      sinatra (~> 1.3)
+      thor (~> 0.14)
+      twilio-ruby (~> 3.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.0.2)
+    builder (3.0.0)
+    gli (1.6.0)
+    i18n (0.6.0)
+    json (1.6.6)
+    jwt (0.1.4)
+      json (>= 1.2.4)
+    multi_json (1.3.1)
+    oauth (0.4.5)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+    twilio-ruby (3.6.0)
+      builder (>= 2.1.2)
+      jwt (>= 0.1.2)
+      multi_json (>= 1.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  last-resort!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott Hyndman, Ian Ha, Victor Mota
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+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).
+
+### 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.
+
+### Example config.rb file
+
+```ruby
+configure :host => "",
+          :twilio_sid => "",
+          :twilio_auth_token => "",
+          :contextio_account => "",
+          :contextio_key => "",
+          :contextio_secret => ""
+
+# DEFINE YOUR CONTACTS
+
+contact :ian, ""
+contact :scott, ""
+contact :victor, ""
+
+# DEFINE WHAT EMAILS YOU WANT TO WATCH FOR
+
+match :subject => /server down/ # rackspace ping
+match :subject => /resource limit reached/ # monit
+
+# DEFINE WHO TO CALL AND WHEN
+
+between 19..22, :on => [:wednesday, :thursday] do
+  call :victor
+end
+
+between :off_hours, :on => :weekdays do
+  call :scott
+end
+
+between :all_hours, :on => :weekends do
+  call [:ian, :scott, :victor]
+end
+```
+
+### 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))

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/last-resort

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+# Parse options
+
+# Perform command

data/config/config.rb

@@ -0,0 +1,35 @@
+configure :host => "",
+          :twilio_sid => "",
+          :twilio_auth_token => "",
+          :contextio_account => "",
+          :contextio_key => "",
+          :contextio_secret => ""
+
+
+# DEFINE YOUR CONTACTS
+
+contact :ian, ""
+contact :scott, ""
+contact :victor, ""
+
+
+# DEFINE WHAT EMAILS YOU WANT TO WATCH FOR
+
+match :subject => /server down/ # rackspace ping
+match :subject => /resource limit reached/ # monit
+
+
+# DEFINE WHO TO CALL AND WHEN
+
+between 19..22, :on => [:wednesday, :thursday] do
+  call :victor
+end
+
+between :off_hours, :on => :weekdays do
+  call :scott
+end
+
+between :all_hours, :on => :weekends do
+  call [:ian, :scott, :victor]
+end
+

data/last-resort.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+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.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.add_dependency "sinatra", "~> 1.3"
+  gem.add_dependency "twilio-ruby", "~> 3.6"
+  gem.add_dependency "activesupport", "~> 3.2"
+  gem.add_dependency "thor", "~> 0.14"
+  gem.add_dependency "oauth", "~> 0.4"
+  gem.add_dependency "gli", "~> 1.6"
+  gem.add_development_dependency "awesome_print"
+end

data/lib/last-resort/config-lang.rb

@@ -0,0 +1,74 @@
+module LastResort
+  class Config
+
+    CONFIG_PATH = "#{PROJECT_ROOT}/config/config.rb"
+
+    attr_accessor :host,
+                  :contacts,
+                  :matchers,
+                  :schedules,
+                  :twilio_sid, :twilio_auth_token,
+                  :contextio_account, :contextio_key, :contextio_secret
+
+    def initialize
+      @contacts = {}
+      @matchers = []
+      @schedules = []
+      run_config_in_context
+    end
+
+    protected
+
+    def run_config_in_context
+      source = open(CONFIG_PATH).read
+      self.instance_eval source
+    end
+
+    def configure params
+      @host = params[:host]
+      @twilio_sid = params[:twilio_sid]
+      @twilio_auth_token = params[:twilio_auth_token]
+      @contextio_key = params[:contextio_key]
+      @contextio_secret = params[:contextio_secret]
+      @contextio_account = params[:contextio_account]
+    end
+
+    def contact name, phone
+      @contacts[name] = { :name => name, :phone => scrub_phone(phone) }
+    end
+
+    def match matcher
+      @matchers << matcher
+    end
+
+    def between hours, options
+      hours = hours.is_a?(Array) ? hours : [hours]
+
+      days = options[:on] || :everyday
+      days = days.is_a?(Array) ? days : [days]
+
+      @current_schedule = {
+        :hours => hours,
+        :days => days
+      }
+
+      yield
+
+      @schedules << @current_schedule
+      @current_schedule = nil
+    end
+
+    def call contacts
+      contacts = contacts.is_a?(Array) ? contacts : [contacts]
+      @current_schedule[:contacts] = contacts
+    end
+
+    def scrub_phone phone
+      phone.gsub!(/\D/, '')
+      phone = "+1#{phone}" unless phone.start_with? "+1"
+      phone
+    end
+  end
+end
+
+CONFIG = LastResort::Config.new

data/lib/last-resort/contextio.rb

@@ -0,0 +1,66 @@
+require 'oauth'
+require 'json'
+require 'net/http'
+
+module ContextIO
+  class Connection
+    VERSION = "2.0"
+
+    def initialize(key='', secret='', server='https://api.context.io')
+      @consumer = OAuth::Consumer.new(key, secret, {:site => server, :sheme => :header})
+      @token    = OAuth::AccessToken.new @consumer
+    end
+
+    def createWebhook(accountId, parameters)
+      post accountId, 'webhooks', parameters
+    end
+
+    def listWebhooks(accountId)
+      get accountId, 'webhooks'
+    end
+
+    def deleteWebhook(accountId, webhook_id)
+      delete accountId, "webhooks/#{webhook_id}"
+    end
+
+    def deleteAllWebhooks(accountId)
+      webhooks = listWebhooks(accountId)
+      webhooks.each do |webhook|
+        deleteWebhook accountId, webhook["webhook_id"]
+      end
+    end
+
+    private
+
+    def url(accountId, url, *args)
+      if args.empty?
+        "/#{VERSION}/accounts/#{accountId}/#{url}"
+      else
+        "/#{VERSION}/accounts/#{accountId}/#{url}?#{parametrize args}"
+      end
+    end
+
+    def get(accountId, url, *args)
+      response_body = @token.get(url(accountId, url, *args), "Accept" => "application/json").body
+      JSON.parse(response_body)
+    end
+
+    def post(accountId, url, parameters)
+      @token.post(url(accountId, url), parameters)
+    end
+
+    def delete(accountId, url, *args)
+      @token.delete(url(accountId, url, *args))
+    end
+
+    def parametrize(options)
+      URI.escape(
+        options.collect do |k, v|
+          v = v.to_i if k == :since
+          v = v.join(',') if v.instance_of?(Array)
+          k = k.to_s.gsub('_', '')
+          "#{k}=#{v}"
+        end.join('&'))
+    end
+  end
+end

data/lib/last-resort/controller.rb

@@ -0,0 +1,78 @@
+# 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.
+exception_session = nil
+
+
+# ====== CONTEXT-IO TWILIO ENDPOINTS
+
+post '/matched_email' do
+  return if LastResort::Scheduler.new.get_matching_schedule.nil?
+
+  contact_names = LastResort::Scheduler.new.get_matching_schedule[:contacts]
+  contacts = []
+  contact_names.each do |name|
+    contacts.push(LastResort::Contact.new(name.to_s, CONFIG.contacts[name][:phone]))
+  end
+
+  hookData = JSON.parse(request_body.read)
+  exception_session = LastResort::ExceptionSession.new(contacts, hookData["message_data"]["subject"])
+  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
+  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 #{exception_session.callee_name}. The following error has occured: #{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}"
+  exception_session.call_next
+end
+
+# Callback to determine user 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
+    puts "User entered 1"
+    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

data/lib/last-resort/scheduler.rb

@@ -0,0 +1,73 @@
+require 'active_support/core_ext'
+
+module LastResort
+  class Scheduler
+
+    def initialize
+      @config = CONFIG
+    end
+
+    def get_matching_schedule
+      matched_schedule = @config.schedules.find do |schedule|
+        match?(schedule)
+      end
+
+      if matched_schedule.nil?
+        puts "No matched schedule"
+        nil
+      else
+        puts "Schedule found -- calling #{matched_schedule[:contacts]}"
+        matched_schedule
+      end
+
+
+    end
+
+    def match? schedule
+      match_hours?(schedule[:hours]) and match_days?(schedule[:days])
+    end
+
+    def match_hours? hours, time_to_match = Time.now
+      expanded_hours = []
+      hours.each do |hour|
+        expanded_hours += expand_if_possible(hour)
+      end
+
+      expanded_hours.any? do |hour|
+        if hour.is_a? Range
+          hour.include? time_to_match.hour
+        elsif hour.is_a? Fixnum
+          hour == time_to_match.hour
+        end
+      end
+    end
+
+    def match_days? days, time_to_match = Time.now
+      day_of_week = time_to_match.strftime("%A").downcase.to_sym
+
+      expanded_days = []
+      days.each do |day|
+        expanded_days += expand_if_possible(day)
+      end
+
+      expanded_days.any? do |day|
+        day == day_of_week
+      end
+    end
+
+    def expand_if_possible symbol
+      case symbol
+      when :all_hours
+        [0..23]
+      when :off_hours
+        [0..8, 17..23]
+      when :weekdays
+        [:monday, :tuesday, :wednesday, :thursday, :friday]
+      when :weekends
+        [:saturday, :sunday]
+      else
+        [symbol]
+      end
+    end
+  end
+end

data/lib/last-resort/twilio.rb

@@ -0,0 +1,70 @@
+require 'twilio-ruby'
+
+# Sandbox code
+ACCOUNT_SID = ""
+AUTH_TOKEN = ""
+FROM_NUMBER = ""
+HOST = ""
+
+module LastResort
+
+	class Contact
+		attr_accessor :name, :number
+
+		def initialize(name = "", number = "")
+			@name = name
+			@number = number
+		end
+	end
+
+	class ExceptionSession
+
+		# Array of strings representing numbers
+		attr_accessor :contacts, :client, :call, :index, :description, :handled
+
+		def initialize(contacts = [], description = "a general exception has occurred")
+			@contacts = contacts
+			@description = description
+			@client = Twilio::REST::Client.new ACCOUNT_SID, AUTH_TOKEN
+			@index = -1
+			@handled = false
+		end
+
+	    # Return false if call was not made
+		def call_next
+			@index += 1
+
+			return false if @contacts.empty? || @index >= @contacts.size ||	@handled
+
+			# Make the call
+			@call = @client.account.calls.create(
+			  :from => FROM_NUMBER,
+			  :to => @contacts[@index].number,
+			  :url => "http://#{HOST}/twilio/call",
+			  :status_callback => "http://#{HOST}/twilio/status_callback"
+			)
+
+			return true
+		end
+
+		# Called when someone in the queue has handled this
+		def end
+			@handled = true
+		end
+
+		# Begin the notification cycle
+		def notify
+			self.call_next
+		end
+
+		# Name of the latest callee (latest call)
+		def callee_name
+			@contacts[@index].name
+		end
+
+		# Number of latest callee (latest call)
+		def callee_number
+			@contacts[@index].number
+		end
+	end
+end

data/lib/last-resort/version.rb

@@ -0,0 +1,5 @@
+module Last
+  module Resort
+    VERSION = "0.0.1"
+  end
+end

data/lib/last-resort/webhooks.rb

@@ -0,0 +1,19 @@
+module LastResort
+  class WebHookCreator
+    def self.create_hooks
+      contextio = ContextIO::Connection.new(CONFIG.contextio_key, CONFIG.contextio_secret)
+
+      # Delete everything
+      contextio.deleteAllWebhooks CONFIG.contextio_account
+
+      # then recreate based on the configuration
+      CONFIG.matchers.each do |matcher|
+        contextio.createWebhook CONFIG.contextio_account,
+          :callback_url => "http://#{CONFIG.host}/matched_email",
+          :failure_notif_url => "http://google.ca",
+          :filter_subject => matcher[:subject].source,
+          :sync_period => "immediate"
+      end
+    end
+  end
+end

data/lib/last-resort.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler/setup"
+require "sinatra"
+require "awesome_print"
+
+FILE_DIR = File.expand_path(File.dirname(__FILE__))
+PROJECT_ROOT = File.expand_path("#{FILE_DIR}/..")
+
+# BRING IN DEPENDENCIES
+
+$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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: last-resort
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Ha
+- Victor Mota
+- Scott Hyndman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70344951605780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951605780
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: &70344951603920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951603920
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70344951602680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951602680
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70344951600840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951600840
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70344951595260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951595260
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: &70344951593480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70344951593480
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70344951592620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70344951592620
+description: Call your phone when critical emails arrive
+email:
+- ianha0@gmail.com
+- vimota@gmail.com
+- scotty.hyndman@gmail.com
+executables:
+- last-resort
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/last-resort
+- config/config.rb
+- last-resort.gemspec
+- lib/last-resort.rb
+- lib/last-resort/config-lang.rb
+- lib/last-resort/contextio.rb
+- lib/last-resort/controller.rb
+- lib/last-resort/scheduler.rb
+- lib/last-resort/twilio.rb
+- lib/last-resort/version.rb
+- lib/last-resort/webhooks.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Call your phone when critical emails arrive
+test_files: []
+has_rdoc: