last-resort 0.0.8 → 0.0.10

data/lib/last-resort/config.rb

@@ -0,0 +1,131 @@
+module LastResort
+  # The configuration class is used to build up contact and scheduling information for
+  # Last Resort.
+  #
+  # Instances of this class power the schedule.rb's DSL. By default it will attempt to
+  # load in and evaluate a schedule.rb file upon construction, but it can also be manually
+  # configured.
+  class Config
+
+    DOT_ENV_PATH = ".env"
+    CONFIG_PATH = "schedule.rb"
+
+    attr_accessor :host, # The host provided to services for webhooks
+                  :contacts, # A map of symbolized names to contact hashes
+                  :matchers, # A list of objects describing emails that trigger alerts
+                  :schedules, # A list of day and hour ranges and their associated contacts
+                  :local_utc_offset_in_seconds, # The developer's local time offset, used server side to determine when to call
+                  :twilio_sid, :twilio_auth_token, # Twilio creds
+                  :contextio_account, :contextio_key, :contextio_secret # Context.io creds
+
+    # If skip_schedule_load is true, the config instance will not attempt to load
+    # schedule.rb. Useful for unit testing or programmatic configuration.
+    def initialize skip_schedule_load = false
+      @contacts = {}
+      @matchers = []
+      @schedules = []
+      run_config_in_context unless skip_schedule_load
+    end
+
+    protected
+
+    def run_config_in_context
+      raise "No config file found at #{CONFIG_PATH}" unless File.exist? CONFIG_PATH
+
+      source = open(CONFIG_PATH).read
+      self.instance_eval source, File.absolute_path(CONFIG_PATH)
+    end
+
+    def configure(params)
+      params = extract_env_config if params == :using_env
+
+      assert_complete_config 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 local_utc_offset(offset_in_hours)
+      @local_utc_offset_in_seconds = offset_in_hours * 60 * 60
+    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
+
+    class << self
+      def populate_env_if_required
+        # Check if ENV is already populated
+        return if ENV.has_key? 'LAST_RESORT_HOST'
+
+        # Raises an exception if a .env can't be found
+        raise "No .env file found in working directory" unless File.exists? DOT_ENV_PATH
+
+        # Set the environment variables
+        open(DOT_ENV_PATH).lines.each do |line|
+          parts = line.split('=')
+          ENV[parts[0]] = parts[1]
+        end
+      end
+    end
+
+    private
+
+    def scrub_phone(phone)
+      if phone.start_with? "+"
+        phone = "+#{phone[1..-1].gsub(/\D/, '')}"
+      else
+        phone.gsub!(/\D/, '')
+      end
+
+      phone
+    end
+
+    def extract_env_config
+      Config.populate_env_if_required
+
+      { :host => ENV['LAST_RESORT_HOST'],
+        :twilio_sid => ENV['TWILIO_SID'],
+        :twilio_auth_token => ENV['TWILIO_AUTH_TOKEN'],
+        :contextio_account => ENV['CONTEXTIO_ACCOUNT'],
+        :contextio_key => ENV['CONTEXTIO_KEY'],
+        :contextio_secret => ENV['CONTEXTIO_SECRET'] }
+    end
+
+    def assert_complete_config(params)
+      [:host, :twilio_sid, :twilio_auth_token, :contextio_account, :contextio_key, :contextio_secret ].each do |config_key|
+        raise "#{config_key} not found in configuration" if params[:config_key].nil?
+      end
+    end
+  end
+end

data/lib/last-resort/contextio.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'net/http'
 
 module ContextIO
+  # Defines the API interface connection to ContextIO.
   class Connection
     VERSION = "2.0"
 

data/lib/last-resort/scheduler.rb

@@ -1,14 +1,17 @@
 module LastResort
+  # The schedule as defined in the 'schedule.rb' file.
   class Scheduler
 
-    def initialize
-      @config = CONFIG
+    ALL_DAYS = [:monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday]
+    WEEKDAYS = [:monday, :tuesday, :wednesday, :thursday, :friday]
+    WEEKENDS = [:saturday, :sunday]
+
+    def initialize config = Config.new
+      @config = config
     end
 
     def get_matching_schedule
-      matched_schedule = @config.schedules.find do |schedule|
-        match?(schedule)
-      end
+      matched_schedule = @config.schedules.find { |schedule| match?(schedule) }
 
       if matched_schedule.nil?
         puts "No matched schedule"
@@ -19,11 +22,15 @@ module LastResort
       end
     end
 
-    def match? schedule
-      match_hours?(schedule[:hours]) and match_days?(schedule[:days])
+    def zone_adjusted_time
+      Time.now.utc + @config.local_utc_offset_in_seconds
+    end
+
+    def match?(schedule, time_to_match = zone_adjusted_time)
+      match_hours?(schedule[:hours], time_to_match) && match_days?(schedule[:days], time_to_match)
     end
 
-    def match_hours? hours, time_to_match = Time.now
+    def match_hours?(hours, time_to_match)
       expanded_hours = []
       hours.each do |hour|
         expanded_hours += expand_if_possible(hour)
@@ -38,31 +45,35 @@ module LastResort
       end
     end
 
-    def match_days? days, time_to_match = Time.now
+    def match_days?(days, time_to_match)
       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
+      expanded_days.include? day_of_week
     end
 
-    def expand_if_possible symbol
-      case symbol
+    def expand_if_possible(symbol_or_time_unit)
+      return [symbol_or_time_unit] if
+        symbol_or_time_unit.is_a? Fixnum or symbol_or_time_unit.is_a? Range
+
+      case symbol_or_time_unit
       when :all_hours
         [0..23]
       when :off_hours
         [0..8, 17..23]
+      when :everyday
+        ALL_DAYS
       when :weekdays
-        [:monday, :tuesday, :wednesday, :thursday, :friday]
+        WEEKDAYS
       when :weekends
-        [:saturday, :sunday]
+        WEEKENDS
+      when :monday, :tuesday, :wednesday, :thursday, :friday
+        [symbol_or_time_unit]
       else
-        [symbol]
+        raise "#{symbol_or_time_unit} is not a recognized expandable symbol"
       end
     end
   end

data/lib/last-resort/twilio.rb

@@ -8,63 +8,65 @@ HOST = ""
 
 module LastResort
 
-	class Contact
-		attr_accessor :name, :number
+  class Contact
+    attr_accessor :name, :number
 
-		def initialize(name = "", number = "")
-			@name = name
-			@number = number
-		end
-	end
+    def initialize(name = "", number = "")
+      @name = name
+      @number = number
+    end
+  end
 
-	class ExceptionSession
+  # Represents the email notification (exception) from ContextIO.
+  # Created when our webhook is called from ContextIO.
+  class ExceptionSession
 
-		# Array of strings representing numbers
-		attr_accessor :contacts, :client, :call, :index, :description, :handled
+    # 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
+    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
+    # Call the next Contact in the queue. Returns false if call was not made
+    def call_next
+      @index += 1
 
-			return false if @contacts.empty? || @index >= @contacts.size ||	@handled
+      return false if @handled || @index >= @contacts.size
 
-			# 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"
-			)
+      # 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
+      return true
+    end
 
-		# Called when someone in the queue has handled this
-		def end
-			@handled = 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
+    # Begin the notification cycle
+    def notify
+      self.call_next
+    end
 
-		# Name of the latest callee (latest call)
-		def callee_name
-			@contacts[@index].name
-		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
+    # Number of latest callee (latest call)
+    def callee_number
+      @contacts[@index].number
+    end
+  end
 end

data/lib/last-resort/version.rb

@@ -1,5 +1,3 @@
-module Last
-  module Resort
-    VERSION = "0.0.8"
-  end
+module LastResort
+  VERSION = "0.0.10"
 end

data/lib/last-resort/webhooks.rb

@@ -1,13 +1,14 @@
 module LastResort
   class WebHookCreator
     def self.create_hooks
-      contextio = ContextIO::Connection.new(CONFIG.contextio_key, CONFIG.contextio_secret)
+      config = Config.new
+      contextio = ContextIO::Connection.new(config.contextio_key, config.contextio_secret)
 
-      # Delete everything
-      contextio.deleteAllWebhooks CONFIG.contextio_account
+      # Delete everything...
+      contextio.deleteAllWebhooks config.contextio_account
 
-      # then recreate based on the configuration
-      CONFIG.matchers.each do |matcher|
+      # ...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",

data/spec/controller_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'last-resort/twilio'
+
+
+describe 'LastResort' do
+  include Rack::Test::Methods
+
+  def app
+    LastResort::Application
+  end
+
+  it "should be up and running" do
+    get '/twilio'
+    last_response.should be_ok
+    last_response.body.should == "Twilio callbacks up and running!"
+  end
+
+  describe "on a phone call" do
+    before(:each) do
+      @exception_session = double("LastResort::ExceptionSession")
+      @exception_session.stub("callee_name").and_return("Ian Ha")
+      @exception_session.stub("description").and_return("+111")
+      LastResort::Application.exception_session = @exception_session
+    end
+
+  	it "should hang up when the user does not answer the call" do
+			post "/twilio/call", {:CallStatus => 'no-answer'}
+  		last_response.body.should eq Twilio::TwiML::Response.new { |r| r.Hangup }.text
+  	end
+
+  	it "should gather a single digit response if the user picks up" do
+  		post "/twilio/call", {:CallStatus => 'completed'}
+  		doc = Nokogiri::XML(last_response.body)
+  		doc.xpath('//Gather[@numDigits="1"]').size.should eq 1
+  	end
+
+    it "should call the next person when a call ends" do
+      @exception_session.should_receive("call_next")
+      post '/twilio/status_callback', {}
+    end
+
+    context "when receiving user input" do
+
+      it "should hangup if selected digit is not 1" do
+        post '/twilio/gather_digits', {:Digits => "0"}
+        last_response.body.should eq Twilio::TwiML::Response.new { |r| r.Hangup }.text
+      end
+
+      it "should end the call queue when receiving a digit of 1" do
+        @exception_session.should_receive("end")
+        post '/twilio/gather_digits', {:Digits => "1"}
+      end
+
+      it "should say a final message and hangup when receiving a digit of 1" do
+        @exception_session.should_receive("end")
+        post '/twilio/gather_digits', {:Digits => "1"}
+        doc = Nokogiri::XML(last_response.body)
+        doc.xpath('//Hangup').size.should eq 1
+        doc.xpath('//Say').size.should eq 1
+      end
+    end
+  end
+
+  describe "on receiving a matched email" do
+    before (:each) do
+      $exception_session = double("LastResort::ExceptionSession")
+      $exception_session.stub("callee_name").and_return("Ian Ha")
+      $exception_session.stub("description").and_return("+111")
+      $exception_session.should_receive(:notify)
+
+      $scheduler = double("LastResort::Scheduler")
+      $scheduler.should_receive(:get_matching_schedule).with(any_args()).and_return({:contacts => []})
+
+      JSON.should_receive(:parse).with(any_args()).and_return({"message_data" => {"subject" => 'foo'}})
+
+      # Here we break open the class so we can stub out certain methods. This, unfortunately, is
+      # necessary (until we figure out something better) because the "app" method above can only
+      # return a class, not a hacked up instance.
+      #
+      # Also, global variables. Sorry. :(
+      class LastResort::Application
+        def new_scheduler
+          $scheduler
+        end
+
+        def new_exception_session(*args)
+          $exception_session
+        end
+
+        def get_request_body(*args)
+          ""
+        end
+      end
+
+      # puts LastResort::ExceptionSession.methods.sort
+      # LastResort::ExceptionSession.should_receive(:new).with(any_args()).and_return(@exception_session)
+      # LastResort::ExceptionSession.should_receive("exception_session").and_return(@exception_session)
+    end
+
+    it "should begin call sequence" do
+      post '/matched_email', {}
+    end
+  end
+
+
+end