telephony 1.0.3

data/lib/telephony/error/base.rb

@@ -0,0 +1,3 @@
+class Telephony::Error::Base < StandardError
+end
+

data/lib/telephony/error/connection.rb

@@ -0,0 +1,2 @@
+class Telephony::Error::Connection < Telephony::Error::Base
+end

data/lib/telephony/error/not_in_progress.rb

@@ -0,0 +1,2 @@
+class Telephony::Error::NotInProgress < Telephony::Error::Base
+end

data/lib/telephony/error/queue_empty.rb

@@ -0,0 +1,2 @@
+class Telephony::Error::QueueEmpty < Telephony::Error::Base
+end

data/lib/telephony/helper.rb

@@ -0,0 +1,11 @@
+module Telephony
+  module NumberHelper
+    def normalize_number(number)
+      number.gsub(/\D/, '').gsub(/^1/, '')
+    end
+
+    def extract_area_code(number)
+      normalize_number(number)[0..2]
+    end
+  end
+end

data/lib/telephony/jobs/agent_offline.rb

@@ -0,0 +1,28 @@
+module Telephony
+  module Jobs
+    class AgentOffline
+      attr_accessor :id, :timestamp
+
+      def initialize id, timestamp
+        @id = id
+        @timestamp = timestamp
+      end
+
+      def update_status
+        Agent.find_with_lock(id) do |agent|
+          agent.update_status_by_event Agent::OFFLINE, timestamp
+        end
+      end
+
+      def perform
+        update_status
+      end
+
+      def failure
+        Rails.logger.error "#{self.class}: #{self.as_json}"
+        ActiveSupport::Notifications
+          .instrument("telephony.agent_offline_failure", self)
+      end
+    end
+  end
+end

data/lib/telephony/jobs/pusher_event.rb

@@ -0,0 +1,21 @@
+module Telephony
+  module Jobs
+    class PusherEvent
+      attr_reader :event
+
+      def initialize(event)
+        @event = event
+      end
+
+      def perform
+        Telephony::PusherEventPublisher.push(@event)
+      end
+
+      def failure
+        Rails.logger.error "#{self.class}: #{self.as_json}"
+        ActiveSupport::Notifications
+          .instrument("telephony.agent_offline_failure", self)
+      end
+    end
+  end
+end

data/lib/telephony/providers/twilio_provider.rb

@@ -0,0 +1,162 @@
+module Telephony
+  module Providers
+    class TwilioProvider
+      include Telephony::NumberHelper
+
+      RING_TIMEOUT_IN_SECONDS = 60
+      RING_TRANSFER_TIMEOUT_IN_SECONDS = 15
+      REQUEST_TIMEOUT_IN_SECONDS = 6
+
+      attr_accessor :account_sid,
+        :auth_token,
+        :outbound_caller_id,
+        :callback_root,
+        :voice_url,
+        :sms_application_sid,
+        :twilio_provider_url
+
+      def initialize(config)
+        self.account_sid = config[:account_sid]
+        self.auth_token = config[:auth_token]
+        self.outbound_caller_id = config[:outbound_caller_id]
+        self.callback_root = config[:callback_root]
+        self.voice_url = config[:voice_url]
+        self.sms_application_sid = config[:sms_application_sid]
+        self.twilio_provider_url = "#{callback_root}/providers/twilio/calls"
+        @incoming_phone_numbers_cache = {}
+      end
+
+      def call(call_id, destination, caller_id)
+        create_call number: destination,
+          caller_id: caller_id,
+          callback_url: "#{twilio_provider_url}/#{call_id}/connect",
+          call_id: call_id,
+          timeout: RING_TIMEOUT_IN_SECONDS
+      end
+
+      def redirect_to_dial(call_id, sid)
+        redirect_or_raise sid, "#{twilio_provider_url}/#{call_id}/dial"
+      end
+
+      def redirect_to_inbound_connect(csr_id, sid)
+        redirect_or_raise sid, "#{callback_root}/providers/twilio/inbound_calls/connect?csr_id=#{csr_id}"
+      end
+
+      def redirect_to_conference(call_id, sid)
+        redirect_or_raise sid, "#{twilio_provider_url}/#{call_id}/join_conference"
+      end
+
+      def redirect_to_hold(call_id, sid)
+        redirect_or_raise sid, "#{twilio_provider_url}/#{call_id}/complete_hold"
+      end
+
+      def dial_into_conference(call_id, destination, caller_id)
+        create_call number: destination,
+          caller_id: caller_id,
+          callback_url:  "#{twilio_provider_url}/#{call_id}/join_conference",
+          call_id: call_id,
+          timeout: RING_TRANSFER_TIMEOUT_IN_SECONDS
+      end
+
+      def hangup(sid)
+        call = client.account.calls.find sid
+        call.hangup
+      rescue => error
+        log_error(error, "Error during hangup for call sid: '#{sid}'")
+        false
+      end
+
+      def caller_id_for(area_code)
+        incoming_phone_number_from_cache(area_code) ||
+            fetch_existing_incoming_phone_numbers(area_code) ||
+            buy_number_for_area_code(area_code) ||
+            normalize_number(outbound_caller_id)
+      end
+
+      def buy_number_for_area_code(area_code)
+        number = buy_number(area_code)
+        @incoming_phone_numbers_cache[area_code] = number
+        number
+      rescue Exception => error
+        Rails.logger.info "Failed attempt to buy a phone number in area code '#{area_code}': #{error.message}"
+        nil
+      end
+
+      def uncallable_number
+        'this-number-is-not-whitelisted'
+      end
+
+      def call_ended?(sid)
+        call = client.account.calls.find sid
+        call.status.in?(%w(completed failed busy no-answer))
+      rescue ::Twilio::REST::RequestError, NoMethodError
+        false
+      rescue => error
+        log_error(error, "Error when verifying if call ended")
+        false
+      end
+
+      def client
+        @client ||= ::Twilio::REST::Client.new account_sid, auth_token, timeout: REQUEST_TIMEOUT_IN_SECONDS
+      end
+
+      private
+
+      def incoming_phone_number_from_cache(area_code)
+        @incoming_phone_numbers_cache[area_code]
+      end
+
+      def fetch_existing_incoming_phone_numbers(area_code)
+        raise_on_error('Failed to fetch incoming phone numbers') do
+          numbers = client.account.incoming_phone_numbers.list(phone_number: "+1#{area_code}*******")
+          numbers.each do |num|
+            @incoming_phone_numbers_cache[extract_area_code(num.phone_number)] = normalize_number(num.phone_number)
+          end
+          @incoming_phone_numbers_cache[area_code]
+        end
+      end
+
+      def buy_number(area_code)
+        response = client.account.incoming_phone_numbers.create area_code: area_code,
+            voice_url: voice_url,
+            sms_application_sid: sms_application_sid
+        normalize_number(response.phone_number)
+      end
+
+      def create_call(args)
+        raise_on_error('Failed to create a call') do
+          client.account.calls.create(from: args[:caller_id],
+                                      to: args[:number],
+                                      url: args[:callback_url],
+                                      status_callback: "#{twilio_provider_url}/#{args[:call_id]}/done",
+                                      timeout: args[:timeout])
+        end
+      end
+
+      def redirect_or_raise(sid, to)
+        raise_on_error("Failed to redirect #{sid} to #{to}") do
+          call = client.account.calls.find sid
+          call.redirect_to to
+          true
+        end
+      end
+
+      def raise_on_error(msg = 'Error')
+        begin
+          yield
+        rescue => error
+          log_error(error, msg)
+          if error.respond_to?(:code) && error.code == 21220
+            raise Telephony::Error::NotInProgress.new("#{msg} - #{error.message}")
+          else
+            raise Telephony::Error::Connection.new("#{msg} - #{error.message}")
+          end
+        end
+      end
+
+      def log_error(error, msg)
+        Rails.logger.error "Twilio provider - #{msg} - #{error.class} - #{error.message}"
+      end
+    end
+  end
+end

data/lib/telephony/version.rb

@@ -0,0 +1,3 @@
+module Telephony
+  VERSION = '1.0.3'
+end

data/spec/controllers/telephony/agents_controller_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+module Telephony
+  describe AgentsController do
+    before do
+      @routes = Engine.routes
+    end
+
+    describe "#terminate_active_call" do
+      context "given an invalid csr id" do
+        before do
+         post :terminate_active_call, id: :bogus_id
+        end
+        it "responds with a status 400" do
+          response.should be_bad_request
+        end
+      end
+      context "given a valid csr id" do
+        before do
+         create :available_agent, :csr_id => 123
+         Agent.any_instance.should_receive(:terminate_active_call)
+         post :terminate_active_call, id: 123
+        end
+        it "responds successfully" do
+           response.should be_success
+        end
+      end
+    end
+
+    describe "#update" do
+      context "given an invalid agent params" do
+        before do
+          agent = create :invalid_agent
+
+          put :update,
+            csr_phone_type: 'invalid',
+            csr_type: "B",
+            csr_id: agent.csr_id,
+            id: agent.csr_id
+        end
+
+        it "responds with a status 400" do
+          response.should be_bad_request
+        end
+
+        it "renders errors" do
+          body = JSON.parse response.body
+          body['errors'].should == ["Phone type is not included in the list"]
+        end
+      end
+    end
+
+    describe '#status' do
+      before do
+        @agent = create :available_agent, :csr_id => 123
+        put :status, :event => 'not_available', :id => @agent.csr_id
+        @agent.reload
+      end
+
+      it 'transitions status based on the given event' do
+        @agent.status.should == Telephony::Agent::NOT_AVAILABLE
+      end
+
+      it 'returns the updated agent as JSON' do
+        json = JSON response.body
+        json.should include('status' => @agent.status)
+        json.should include('csr_id' => @agent.csr_id)
+      end
+    end
+
+    describe '#show_by_csr_id' do
+      before do
+        @agent = create :available_agent, :csr_id => 123
+        Agent.any_instance.stub(:active_conversation_id).and_return(321)
+        get :show_by_csr_id, :csr_id => @agent.csr_id
+      end
+
+      it 'returns the agent' do
+        json = JSON response.body
+        json.should include('active_conversation_id' => 321)
+      end
+    end
+
+    describe "#index" do
+      context "by default" do
+        it "returns a list of agents" do
+          create :available_agent, csr_id: 123
+          create :offline_agent, csr_id: 11
+          create :available_agent, csr_id: 12
+          get :index
+
+          res = JSON(response.body)
+          res.size.should == 3
+          res[0].should include('csr_id' => 123)
+          res[1].should include('csr_id' => 12)
+          res[2].should include('csr_id' => 11)
+        end
+      end
+
+      context "given a csr id" do
+        it "returns a list of transferable agents for that agent" do
+          agent = create :available_agent,
+            csr_id: 123,
+            transferable_agents: [11, 12]
+          create :offline_agent, csr_id: 11
+          create :available_agent, csr_id: 12
+          get :index, csr_id: agent.csr_id
+
+          res = JSON(response.body)
+          res.size.should == 2
+          res[0].should include('csr_id' => 12)
+          res[1].should include('csr_id' => 11)
+        end
+      end
+    end
+  end
+end

data/spec/controllers/telephony/call_centers_controller_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Telephony
+  describe CallCentersController do
+
+    before do
+      @routes = Engine.routes
+    end
+
+    describe '#index' do
+      before do
+        get :index
+      end
+
+      it 'returns a list of the available call centers' do
+        response.should be_ok
+        response.content_type.should == "application/json"
+
+        call_centers = JSON.parse(response.body)
+        call_centers.first['name'].should == 'hollywood'
+        call_centers.first['host'].should == '192.168.1.1'
+      end
+    end
+  end
+end

data/spec/controllers/telephony/conversations_controller_spec.rb

@@ -0,0 +1,229 @@
+require "spec_helper"
+
+module Telephony
+  describe ConversationsController do
+    before do
+      @routes = Engine.routes
+    end
+
+    describe '#hold' do
+      context 'when hold works' do
+        before do
+          @conversation = mock(id: 1)
+          @customer     = mock
+
+          Conversation.stub(:find).and_return(@conversation)
+          @conversation.stub(:hold!).and_return true
+        end
+
+        it "tells twilio to redirect the customer's call leg to the hold queue" do
+          @conversation.should_receive(:hold!)
+          xhr :post, :hold, id: @conversation.id
+        end
+
+        it "renders an empty json" do
+          xhr :post, :hold, id: @conversation.id
+
+          body = JSON.parse response.body
+          body.should be_empty
+        end
+      end
+
+      context 'when hold fails' do
+        before do
+          @conversation = Conversation.new
+          @customer     = mock
+
+          Conversation.stub(:find).and_return(@conversation)
+        end
+
+        context 'because of a twilio issue' do
+          before do
+            @conversation.stub(:hold!).and_raise(Telephony::Error::Connection.new("Some error"))
+          end
+
+          it "renders json errors" do
+            xhr :post, :hold, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Hold failed. Please try again in a few seconds.'
+            body['errors'].last.should == 'Some error'
+          end
+        end
+
+        context 'because the customer has hung up' do
+          before do
+            @conversation.stub(:hold!).and_raise(Telephony::Error::NotInProgress.new("Some error"))
+          end
+
+          it "renders json errors" do
+            xhr :post, :hold, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Hold failed. Please try again in a few seconds.'
+            body['errors'].last.should == 'Some error'
+          end
+        end
+
+        context 'because the call is in the wrong state' do
+          it "renders json errors" do
+            xhr :post, :hold, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Hold failed. Please try again in a few seconds.'
+            body['errors'].last.should =~ /cannot transition/
+          end
+        end
+      end
+    end
+
+    describe "#resume" do
+      context "when resume works" do
+        before do
+          @conversation = Conversation.new
+
+          Conversation.stub(:find).and_return(@conversation)
+          @conversation.stub(:resume!).and_return true
+        end
+
+        it "tells twilio to redirect the customer's call leg to the conference's room" do
+          @conversation.should_receive :resume!
+          xhr :post, :resume, id: 1
+
+          body = JSON.parse response.body
+          body.should be_empty
+        end
+      end
+
+      context 'when resume fails' do
+        before do
+          @conversation = Conversation.new
+
+          Conversation.stub(:find).and_return(@conversation)
+        end
+
+        context 'because of a twilio issue' do
+          before do
+            @conversation.stub(:resume!).and_raise(Telephony::Error::Connection.new("Some error"))
+          end
+
+          it "renders json errors" do
+            xhr :post, :resume, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Resume failed. Please try again in a few seconds.'
+            body['errors'].last.should == 'Some error'
+          end
+        end
+
+        context 'because the customer has hung up' do
+          before do
+            @conversation.stub(:resume!).and_raise(Telephony::Error::NotInProgress.new("Some error"))
+          end
+
+          it "renders json errors" do
+            xhr :post, :resume, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Resume failed. Please try again in a few seconds.'
+            body['errors'].last.should == 'Some error'
+          end
+        end
+
+        context 'because the call is in the wrong state' do
+          it "renders json errors" do
+            xhr :post, :resume, id: 1
+
+            body = JSON.parse response.body
+            body['errors'].first.should == 'Resume failed. Please try again in a few seconds.'
+            body['errors'].last.should =~ /cannot transition/
+          end
+        end
+      end
+    end
+
+    describe "#search" do
+      before do
+        @conversation = create :conversation
+        xhr :get, :search
+      end
+
+      it "returns conversations as json" do
+        body = JSON.parse response.body
+        body['conversations'][0]['id'].should == @conversation.id
+        body['total_count'].should == 1
+      end
+    end
+
+    describe "#create", :vcr do
+      context "by default" do
+        before do
+          agent = create :agent
+          attributes = {
+            from:      '310-456-7890',
+            to:        '310-765-4321',
+            loan_id:   1,
+            from_id:   agent.csr_id,
+            from_type: 'csr'
+          }
+          @existing_whitelist = Telephony.whitelist
+          Telephony.whitelist = [attributes[:from], attributes[:to]]
+          @conversation_count = Conversation.count
+          # Twilio doesn't allow you to buy new numbers using a test account
+          Telephony.provider.stub(:caller_id_for).and_return attributes[:from]
+
+          xhr :post, :create, attributes
+        end
+
+        after do
+          Telephony.whitelist = @existing_whitelist
+        end
+
+        it "creates a new conversation" do
+          Conversation.count.should == @conversation_count + 1
+        end
+
+        it 'creates a new call' do
+          Call.count.should == 2
+        end
+
+        it 'returns the conversation as JSON' do
+          conversation = Conversation.last
+          json = JSON response.body
+          json['id'].should == conversation.id
+        end
+      end
+
+      context "when an exception occurs" do
+        before do
+          agent = create :agent
+          attributes = {
+            from:      '310-456-7890',
+            to:        '310-765-4321',
+            loan_id:   1,
+            from_id:   agent.csr_id,
+            from_type: 'csr'
+          }
+
+          Conversation
+            .stub(:begin!)
+            .and_raise(Telephony::Error::Connection.new("Call failed"))
+
+          xhr :post, :create, attributes
+        end
+
+        it 'return a 500 failure response' do
+          response.code.should == "500"
+        end
+
+        it 'returns an error message as JSON' do
+          json = JSON response.body
+          json.should include('errors')
+          errors = json['errors']
+          errors.should have(2).error
+          errors[1].should == 'Call failed'
+        end
+      end
+    end
+  end
+end