telephony 1.0.3

data/config/wopr.yml.example

@@ -0,0 +1,38 @@
+###
+# Because wopr places real calls through twilio and interact with pusher
+# only one person can run it at the time with one set of credentials
+# Therefore every developer should have his/her own account and make
+# sure that callbacks go to different hosts and/or ports
+#
+# Instructions:
+# 1. Buy yourself numbers on twilio
+# 2. Create and setup your personal app in pusher
+# 3. cp config/wopr.yml.example config/wopr.yml
+# 4. open wopr.yml and change corresponding ports and numbers
+###
+
+twilio_account_sid:
+twilio_auth_token:
+
+# The port that capybara starts it's server on
+# This port needs to be able to receive callbacks from twilio
+widget_host_port: 3500
+# This will start a local wopr server on this port
+wopr_server_port: 4500
+# This is the address that wopr's twilio will call back to.
+callback_root: http://yourhost.com:4500
+
+# These bots get the numbers that you bought through twilio
+bots:
+  customer:
+    id: 0
+    phone_number: 3235551212
+  agent1:
+    id: 1
+    phone_number: 3235551213
+  agent2:
+    id: 2
+    phone_number: 3235551214
+  agent3:
+    id: 3
+    phone_number: 3235551215

data/db/migrate/20130806213053_bootstrap_db.rb

@@ -0,0 +1,105 @@
+class BootstrapDb < ActiveRecord::Migration
+  def up
+    create_table "telephony_agents", :force => true do |t|
+      t.integer  "csr_id",                                                               :null => false
+      t.string   "status",                                        :default => "offline"
+      t.datetime "created_at",                                                           :null => false
+      t.datetime "updated_at",                                                           :null => false
+      t.string   "name"
+      t.string   "phone_ext"
+      t.string   "phone_number"
+      t.string   "csr_type"
+      t.integer  "timestamp_of_last_presence_event", :limit => 8, :default => 0
+      t.string   "phone_type",                                    :default => "phone",   :null => false
+      t.string   "sip_number"
+      t.string   "call_center_name"
+      t.text     "transferable_agents"
+      t.boolean  "generate_caller_id",                            :default => false
+    end
+
+    add_index "telephony_agents", ["csr_id"], :name => "index_telephony_agents_on_csr_id"
+    add_index "telephony_agents", ["status"], :name => "index_telephony_agents_on_status"
+
+    create_table "telephony_calls", :force => true do |t|
+      t.string   "sid"
+      t.datetime "created_at",       :null => false
+      t.datetime "updated_at",       :null => false
+      t.string   "state"
+      t.datetime "connected_at"
+      t.datetime "terminated_at"
+      t.integer  "conversation_id"
+      t.integer  "participant_id"
+      t.string   "participant_type"
+      t.string   "number"
+      t.integer  "agent_id"
+    end
+
+    add_index "telephony_calls", ["agent_id"], :name => "index_telephony_calls_on_agent_id"
+    add_index "telephony_calls", ["conversation_id"], :name => "index_telephony_calls_on_conversation_id"
+    add_index "telephony_calls", ["number"], :name => "index_telephony_calls_on_number"
+    add_index "telephony_calls", ["sid"], :name => "index_telephony_calls_on_sid"
+
+    create_table "telephony_conversation_events", :force => true do |t|
+      t.string   "type"
+      t.integer  "conversation_id"
+      t.string   "conversation_state"
+      t.integer  "call_id"
+      t.string   "call_state"
+      t.datetime "created_at",                         :null => false
+      t.datetime "updated_at",                         :null => false
+      t.string   "message_data",       :limit => 2048
+    end
+
+    add_index "telephony_conversation_events", ["call_id"], :name => "index_telephony_conversation_events_on_call_id"
+    add_index "telephony_conversation_events", ["conversation_id"], :name => "index_telephony_conversation_events_on_conversation_id"
+
+    create_table "telephony_conversations", :force => true do |t|
+      t.string   "state"
+      t.integer  "loan_id"
+      t.string   "transfer_to"
+      t.string   "transfer_type"
+      t.datetime "created_at",                                :null => false
+      t.datetime "updated_at",                                :null => false
+      t.string   "transfer_ext"
+      t.integer  "transfer_id"
+      t.integer  "initiator_id"
+      t.string   "transfer_status"
+      t.string   "caller_id"
+      t.string   "number"
+      t.string   "conversation_type", :default => "outbound", :null => false
+      t.integer  "transferee_id"
+    end
+
+    add_index "telephony_conversations", ["created_at"], :name => "index_telephony_conversations_on_created_at"
+    add_index "telephony_conversations", ["loan_id"], :name => "index_telephony_conversations_on_loan_id"
+    add_index "telephony_conversations", ["state"], :name => "index_telephony_conversations_on_state"
+
+    create_table "telephony_playable_listeners", :force => true do |t|
+      t.integer  "playable_id", :null => false
+      t.integer  "csr_id",      :null => false
+      t.datetime "created_at",  :null => false
+      t.datetime "updated_at",  :null => false
+    end
+
+    add_index "telephony_playable_listeners", ["csr_id"], :name => "index_telephony_playable_listeners_on_csr_id"
+    add_index "telephony_playable_listeners", ["playable_id"], :name => "index_telephony_playable_listeners_on_playable_id"
+
+    create_table "telephony_playables", :force => true do |t|
+      t.integer  "call_id"
+      t.string   "url"
+      t.datetime "start_time"
+      t.integer  "duration"
+      t.datetime "created_at",                                     :null => false
+      t.datetime "updated_at",                                     :null => false
+      t.string   "type",       :default => "Telephony::Recording"
+      t.integer  "csr_id"
+    end
+
+    add_index "telephony_playables", ["call_id"], :name => "index_telephony_playables_on_call_id"
+    add_index "telephony_playables", ["type"], :name => "index_telephony_recordings_on_type"
+  end
+
+  def down
+    # Just drop the database, honestly
+  end
+end

data/db/migrate/20131009204026_create_telephony_blacklisted_numbers.rb

@@ -0,0 +1,11 @@
+class CreateTelephonyBlacklistedNumbers < ActiveRecord::Migration
+  def change
+    create_table :telephony_blacklisted_numbers do |t|
+      t.string :number, limit: 10
+
+      t.timestamps
+    end
+
+    add_index :telephony_blacklisted_numbers, :number, unique: true
+  end
+end

data/lib/agent_generator.rb

@@ -0,0 +1,24 @@
+##
+# Generate bunch of fake Agents in development database
+#
+
+class AgentGenerator
+  def self.generate
+    return if Rails.env.production?
+
+    require 'faker'
+
+    100.times do
+      opts = {
+        name: Faker::Name.name,
+        csr_id: rand(10000),
+        csr_type: ["A", "B"].sample,
+        phone_number: Faker::PhoneNumber.phone_number,
+        phone_ext: rand(500),
+        status: ["available", "offline", "on_a_call", "not_available"].sample
+      }
+
+      Telephony::Agent.create opts
+    end
+  end
+end

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
+  task 'db:test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/jasmine.rake

@@ -0,0 +1,8 @@
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/lib/tasks/telephony_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :telephony do
+#   # Task goes here
+# end

data/lib/telephony.rb

@@ -0,0 +1,34 @@
+require 'telephony/engine'
+require 'telephony/helper'
+require 'telephony/providers/twilio_provider'
+
+module Telephony
+  mattr_accessor :provider,
+                 :whitelist,
+                 :pop_url_finder,
+                 :hold_music,
+                 :wait_music
+
+  def self.whitelisted? number
+    ! whitelist || begin
+      normalized_number = americanize number
+      whitelist.any? do |whitelisted_number|
+        americanize(whitelisted_number) == normalized_number
+      end
+    end
+  end
+
+  def self.with_whitelisting number
+    if whitelisted? number
+      number
+    else
+      provider.uncallable_number
+    end
+  end
+
+  def self.americanize number
+    number
+      .gsub(/\D/, '')
+      .last(10)
+  end
+end

data/lib/telephony/concerns/controllers/twilio_request_verifier.rb

@@ -0,0 +1,39 @@
+module Telephony::Concerns::Controllers::TwilioRequestVerifier
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :verify_twilio_request, if: :use_twilio_digest_auth?
+  end
+
+  def verify_twilio_request
+    unless twilio_request_validated?
+      render :text => "Twilio request signature verification failed.", :status => :unauthorized
+    end
+  end
+
+  def twilio_request_validated?
+    validator = Twilio::Util::RequestValidator.new(twilio_config[:auth_token])
+    # Only use the POST parameters, not the url params or the rails-added params
+    twilio_params = request.request_parameters
+    signature = request.headers['HTTP_X_TWILIO_SIGNATURE']
+
+    validator.validate(callback_url, twilio_params, signature)
+  end
+
+  private
+
+  def callback_url
+    domain = twilio_config[:callback_domain]
+    protocol = twilio_config[:behind_https_proxy] ? "https://" : "http://"
+
+    "#{protocol}#{domain}#{request.fullpath}"
+  end
+
+  def twilio_config
+    TWILIO_CONFIG
+  end
+
+  def use_twilio_digest_auth?
+    twilio_config[:use_twilio_digest_auth]
+  end
+end

data/lib/telephony/conversation_data.rb

@@ -0,0 +1,67 @@
+module Telephony
+  class ConversationData
+    def self.filter(params = {})
+      conversations = Conversation.scoped
+
+      if params[:state]
+        conversations = conversations.where(state: params[:state])
+      end
+
+      if params[:since]
+        since = params[:since].to_datetime
+        conversations = conversations.where created_at: since..Time.now
+      end
+
+      conversations.all
+    end
+
+    def self.counts(args = {})
+      # FIXME: Add pagination support
+      conversation_counts = Conversation
+        .group(:initiator_id)
+        .where('initiator_id IS NOT NULL')
+      conversation_counts = if args[:start_date].present? &&
+        args[:end_date].present?
+        conversation_counts.where('created_at BETWEEN ? and ?',
+                        DateTime.parse(args[:start_date]).utc,
+                        DateTime.parse(args[:end_date]).utc)
+      else
+        conversation_counts.where('created_at > ?', 30.days.ago)
+      end.count
+    end
+
+    def self.search(args = {})
+      conversations = Conversation.scoped
+        .includes(:events, calls: [:recordings, :voicemail])
+        .order("telephony_conversations.created_at")
+          .reverse_order
+        .page(args[:page])
+        .per(10)
+
+      if args[:csr_id].present?
+        agent = Agent.find_by_csr_id args[:csr_id]
+        agent_id = agent ? agent.id : -1
+        conversations = conversations.where("telephony_conversations.id in (#{Call.select(:conversation_id).where(agent_id: agent_id).to_sql})")
+      end
+
+      if args[:q].present?
+        query = args[:q].to_s.strip
+        condition = "telephony_conversations.loan_id = ? OR telephony_conversations.id = ? OR telephony_calls.number like ?"
+        subquery = Conversation.select("telephony_conversations.id").joins(:calls).where(condition, query, query, "%#{query}%").to_sql
+        conversations = conversations.where("telephony_conversations.id in (#{subquery})")
+      end
+
+      if args[:start_date].present?
+        conversations = conversations.where('telephony_conversations.created_at >= ?',
+          DateTime.parse(args[:start_date]).utc)
+      end
+
+      if args[:end_date].present?
+        conversations = conversations.where('telephony_conversations.created_at <= ?',
+          DateTime.parse(args[:end_date]).utc)
+      end
+
+      conversations
+    end
+  end
+end

data/lib/telephony/engine.rb

@@ -0,0 +1,19 @@
+require 'state_machine'
+require 'kaminari'
+
+module Telephony
+  class Engine < ::Rails::Engine
+    isolate_namespace Telephony
+
+    config.autoload_paths += Dir["#{config.root}/lib"]
+
+    config.generators do |generators|
+      generators.test_framework :rspec, view_specs:  false
+    end
+
+    config.active_record.observers = 'Telephony::CallObserver',
+      'Telephony::AgentObserver',
+      'Telephony::EventObserver',
+      'Telephony::ConversationObserver'
+  end
+end

data/lib/telephony/error.rb

@@ -0,0 +1,8 @@
+module Telephony
+  module Error
+  end
+end
+
+require_relative 'error/base'
+require_relative 'error/not_in_progress'
+require_relative 'error/queue_empty'

data/lib/telephony/error/agent_on_a_call.rb

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