twilio_base 1.8.0

data/app/services/twilio_base/routers/voice/default.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module Routers
+    module Voice
+      module Default
+        module_function
+
+        def init(protocol:, routing_method: nil)
+          routing_method ||= ENV.fetch('ROUTING_METHOD')
+
+          klass = {
+            'direct_dial' => TwilioBase::Routers::Voice::DirectDial,
+            'task_router' => TwilioBase::Routers::Voice::TaskRouter
+          }.fetch(routing_method, TwilioBase::Routers::Voice::DirectDial)
+
+          klass.new(
+            protocol: protocol
+          )
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/routers/voice/direct_dial.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module Routers
+    module Voice
+      class DirectDial < Base
+      end
+    end
+  end
+end

data/app/services/twilio_base/routers/voice/task_router.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module Routers
+    module Voice
+      class TaskRouter < Base
+        def route
+          yield_response = yield if block_given?
+          (yield_response || voice_response).enqueue(enqueue_params) do |e|
+            e.task task_attributes
+          end.to_s
+        end
+
+        private
+
+        def enqueue_params
+          {
+            action: protocol.action_url,
+            wait_url: protocol.wait_url,
+            workflow_sid: workflow_sid
+          }
+        end
+
+        def task_attributes
+          { outbound_contact_uri: protocol.endpoint }
+        end
+
+        def workflow_sid
+          @workflow_sid ||= TwilioBase::GlobalConfig.first.workflow_sid
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/sync/service.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module Sync
+    class Service
+      DEFAULT_FRIENDLY_NAME = 'Default Sync Service'
+
+      class << self
+        include TwilioBase::Clients
+
+        def create(name: nil)
+          friendly_name = name || DEFAULT_FRIENDLY_NAME
+          rest_client.sync.v1.services.create(friendly_name: friendly_name)
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/activity.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Activity < Base
+      AVAILABLE_ACTIVITY_NAME = 'Available'
+      ASSIGNMENT_ACTIVITY_NAME = 'Busy'
+      IDLE_ACTIVITY_NAME = 'Idle'
+      OFFLINE_ACTIVITY_NAME = 'Offline'
+      RESERVATION_ACTIVITY_NAME = 'Reserved'
+
+      class << self
+        def available
+          list.detect do |activity|
+            activity.friendly_name == AVAILABLE_ACTIVITY_NAME
+          end
+        end
+
+        def busy
+          list.detect do |activity|
+            activity.friendly_name == ASSIGNMENT_ACTIVITY_NAME
+          end
+        end
+
+        def idle
+          list.detect do |activity|
+            activity.friendly_name == IDLE_ACTIVITY_NAME
+          end
+        end
+
+        def list
+          workspace.activities.list
+        end
+
+        def offline
+          list.detect do |activity|
+            activity.friendly_name == OFFLINE_ACTIVITY_NAME
+          end
+        end
+
+        def reserved
+          list.detect do |activity|
+            activity.friendly_name == RESERVATION_ACTIVITY_NAME
+          end
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Base
+      class << self
+        include TwilioBase::Clients
+
+        private
+
+        def workspace
+          rest_client.taskrouter.workspaces(workspace_sid)
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/task.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Task < Base
+      class << self
+        def create(task_attributes:, **options)
+          workspace.tasks.create(
+            attributes: task_attributes.to_json,
+            workflow_sid: workflow_sid,
+            **options
+          )
+        end
+
+        def find(sid)
+          workspace.tasks(sid).fetch
+        end
+
+        def where(attributes)
+          workspace.tasks.list(
+            evaluate_task_attributes: evaluable_attributes(attributes)
+          )
+        end
+
+        private
+
+        def evaluable_attributes(attributes)
+          attributes.map { |k, v| "#{k} == '#{v}'" }.join(' AND ')
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/task_queue.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class TaskQueue
+      class << self
+        def find_or_create_by(workspace:, friendly_name:, target_workers: nil)
+          attributes = {
+            workspace: workspace,
+            friendly_name: friendly_name,
+            target_workers: target_workers
+          }.to_a
+
+          find_by(attributes[0..1].to_h) || create(attributes.to_h)
+        end
+
+        def find_by(workspace:, friendly_name:)
+          workspace.task_queues.list(friendly_name: friendly_name).first
+        end
+
+        def create(workspace:, friendly_name:, target_workers:)
+          workspace.task_queues.create(
+            assignment_activity_sid: assignment_activity_sid(workspace),
+            friendly_name: friendly_name,
+            reservation_activity_sid: reservation_activity_sid(workspace),
+            target_workers: target_workers
+          )
+        end
+
+        def assignment_activity_sid(workspace)
+          workspace.activities.list(friendly_name: 'Busy').first.sid
+        end
+
+        def reservation_activity_sid(workspace)
+          workspace.activities.list(friendly_name: 'Reserved').first.sid
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/worker.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Worker < Base
+      class << self
+        def create(name:, attributes:)
+          workspace.workers.create(
+            friendly_name: name,
+            activity_sid: idle_activity.sid,
+            attributes: attributes.to_json
+          )
+        end
+
+        def find(worker_sid)
+          workspace.workers(worker_sid).fetch
+        end
+
+        private
+
+        def idle_activity
+          TwilioBase::TaskRouter::Activity.idle
+        end
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/workflow.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Workflow
+      class << self
+        include Rails.application.routes.url_helpers
+        include TwilioBase::Clients
+
+        def create(workspace:, attributes:)
+          workspace.workflows.create(
+            attributes
+          )
+        end
+
+        private
+
+        attr_accessor :params
+      end
+    end
+  end
+end

data/app/services/twilio_base/task_router/workspace.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  module TaskRouter
+    class Workspace
+      class << self
+        include TwilioBase::Clients
+
+        DEFAULT_TEMPLATE = 'FIFO'
+        REQUIRED_EVENTS = %w[
+          task.canceled
+          task.completed
+          task.updated
+          workflow.timeout
+        ].freeze
+
+        def create(friendly_name:)
+          workspace_client.create(
+            event_callback_url: event_callback_url,
+            events_filter: events,
+            friendly_name: friendly_name,
+            multi_task_enabled: true,
+            template: DEFAULT_TEMPLATE
+          )
+        end
+
+        def find(sid)
+          workspace_client(sid)
+        end
+
+        private
+
+        def event_callback_url
+          TwilioBase::Engine.routes.url_helpers.task_router_callbacks_url
+        end
+
+        def workspace_client(sid = nil)
+          if sid
+            rest_client.taskrouter.v1.workspaces(sid)
+          else
+            rest_client.taskrouter.v1.workspaces
+          end
+        end
+
+        def events
+          REQUIRED_EVENTS.join(',')
+        end
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "twilio_base"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path(
+  '../lib/twilio_base/engine', __dir__
+)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/circle.yml

@@ -0,0 +1,36 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1-node-browsers
+        environment:
+          PGHOST: 127.0.0.1
+          PGUSER: twilio_base
+          RAILS_ENV: test
+      - image: postgres:9.5
+        environment:
+          POSTGRES_USER: twilio_base
+          POSTGRES_DB: twilio_base_test
+          POSTGRES_PASSWORD: ""
+    steps:
+      - checkout
+      - run: bundle install
+      - run: cp spec/twilio_base_dummy/config/database.example.yml spec/twilio_base_dummy/config/database.yml
+      - run: bundle exec rake db:setup
+      - run:
+          name: Parallel RSpec
+          command: bundle exec rspec spec/
+      - run:
+          name: Rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Publish gem to gemfury
+          command: |
+            if [ "${CIRCLE_BRANCH}" == "master" ]
+            then
+              gem install gemfury
+              gem build twilio_base.gemspec
+              fury push $(ls | grep twilio_base-) --as=dvelp --api-token=$BUNDLE_GEM__FURY__IO
+            else
+              echo "Publishing to gemfury allowed only for master branch"
+            fi

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+TwilioBase::Engine.routes.draw do
+end

data/db/migrate/20171214105252_create_twilio_base_global_configs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateTwilioBaseGlobalConfigs < ActiveRecord::Migration[5.0]
+  def change
+    create_table :twilio_base_global_configs do |t|
+      t.string :api_key_secret
+      t.string :api_key_sid
+      t.string :application_sid
+      t.string :chat_service_sid
+      t.string :phone_number
+      t.string :sync_service_sid
+      t.string :workflow_sid
+      t.string :workspace_sid
+
+      t.timestamps
+    end
+  end
+end

data/lib/twilio_base/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  class Engine < ::Rails::Engine
+    isolate_namespace TwilioBase
+  end
+end

data/lib/twilio_base/helpers/protocols.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Helpers
+  module Protocols
+    module_function
+
+    def extract_mpoa(str)
+      /((?<=sip:))?(?<number>\d+)(?=@|\d*)/ =~ str
+      number.nil? ? str : '+' + number.to_s
+    end
+  end
+end

data/lib/twilio_base/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  VERSION = '1.8.0'
+end

data/lib/twilio_base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'twilio_base/engine'
+require 'twilio_base/version'
+require 'addressable'
+require 'twilio-ruby'
+
+Gem.find_files('twilio_base/**/*.rb').each { |f| require f }
+
+module TwilioBase
+end

data/spec/factories/channel_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :channel_sid do |n|
+    "CH#{format('%06i', n)}"
+  end
+end

data/spec/factories/chat_member_id.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :chat_member_id do |n|
+    "15111#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/activity_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :activity_sid do |n|
+    "WA#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/api_key_secret.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :api_key_secret do |n|
+    "Secret#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/api_key_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :api_key_sid do |n|
+    "SK#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/application_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :application_sid do |n|
+    "AP#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/chat_service_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :chat_service_sid do |n|
+    "IS#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/conference_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :conference_sid do |n|
+    "WT#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/message_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :message_sid do |n|
+    "MS#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/phone_number.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :phone_number do |n|
+    "+447777#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/recording_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :recording_sid do |n|
+    "RE#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/sync_service_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :sync_service_sid do |n|
+    "IS#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/task_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :task_sid do |n|
+    "WT#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/voice_call_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :voice_call_sid do |n|
+    "CA#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/worker_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :worker_sid do |n|
+    "WK#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/workflow_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :workflow_sid do |n|
+    "WW#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_config/workspace_sid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  sequence :workspace_sid do |n|
+    "WS#{format('%06i', n)}"
+  end
+end

data/spec/factories/global_configs.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module TwilioBase
+  FactoryBot.define do
+    factory :global_config, class: TwilioBase::GlobalConfig do
+      api_key_sid
+      api_key_secret
+      application_sid
+      chat_service_sid
+      phone_number
+      sync_service_sid
+      workflow_sid
+      workspace_sid
+    end
+
+    trait :empty do
+      api_key_sid { nil }
+      api_key_secret { nil }
+      application_sid { nil }
+      chat_service_sid { nil }
+      message_sid { nil }
+      phone_number { nil }
+      sync_service_sid { nil }
+      workflow_sid { nil }
+      workspace_sid { nil }
+    end
+  end
+end