adhearsion-twilio

Provides a simple way to use Adhearsion with your existing apps built for Twilio

Build Status Dependency Status Coverage Status Code Climate

Installation

Add this line to your application’s Gemfile:

ruby gem 'adhearsion-twilio', :git => git://github.com/dwilkie/adhearsion-twilio.git

And then execute:

shell $ bundle

Configuration

Configure your voice_request_url and status_callback_url in config/adhearsion.rb or use the environment variables. These should be the same endpoints that you point to in your Twilio configuration and should return valid TwiML.

```ruby Adhearsion.config do |config| # Retrieve and execute the TwiML at this URL when a phone call is received [AHN_TWILIO_VOICE_REQUEST_URL] config.twilio.voice_request_url = “http://localhost:3000/”

# Retrieve and execute the TwiML using this http method [AHN_TWILIO_VOICE_REQUEST_METHOD] config.twilio.voice_request_method = “post”

# Make a request to this URL when a call to this phone number is completed. [AHN_TWILIO_STATUS_CALLBACK_URL] config.twilio.status_callback_url = nil

# Make a request to the status_callback_url using this method when a call to this phone number is completed. [AHN_TWILIO_STATUS_CALLBACK_METHOD] config.twilio.status_callback_method = nil

# The default voice to use for a male speaker (see ‘config.punchblock.default_voice’ for allowed values) [AHN_TWILIO_DEFAULT_MALE_VOICE] config.twilio.default_male_voice = nil

# The default voice to use for a female speaker (see ‘config.punchblock.default_voice’ for allowed values) [AHN_TWILIO_DEFAULT_FEMALE_VOICE] config.twilio.default_female_voice = nil end ```

Usage

In your controller include Adhearsion::Twilio::ControllerMethods, answer the call and notify your voice app like this:

```ruby class CallController < Adhearsion::CallController include Adhearsion::Twilio::ControllerMethods

def run answer notify_voice_request_url end end ```

notify_voice_request_url will send a Twilio Request using the url you configured in voice_request_url then execute any TwiML you respond back with.

Testing

Currently, RSpec is the only testing framework supported.

Add the following lines to your application’s Gemfile

ruby group :test do gem 'vcr' gem 'webmock' gem 'rack-test' end

And then execute:

shell $ bundle

If this is your CallController:

```ruby class CallController < Adhearsion::CallController include Adhearsion::Twilio::ControllerMethods

def run notify_voice_request_url end end ```

Then you can test it like this:

```ruby require ‘spec_helper’ require ‘adhearsion/twilio/spec/helpers’

describe CallController do include Adhearsion::Twilio::Spec::Helpers

subject { CallController.new(mock_call) }

describe “#run” do before do mock_call.stub(:answer) end

it "should answer the call" do
  mock_call.should_receive(:answer)
  expect_call_status_update { subject.run }
end   end end ```

The helper method mock_call returns a mock of a Call with the appropriate methods stubbed out. expect_call_status_update inserts the default cassette hangup using VCR. You can test other methods by inserting different cassette using the :cassette option. For a list of the available cassettes look in: https://github.com/dwilkie/adhearsion-twilio/tree/master/lib/adhearsion/twilio/spec/fixtures/vcr_cassettes. For more info about the test helper methods available look at: https://github.com/dwilkie/adhearsion-twilio/tree/master/lib/adhearsion/twilio/spec/helpers.rb

Documentation

Read through the specs. Each spec contains TwiML examples for each Verb Attribute and Noun along with the relevant documentation from Twilio.

Already Implemented

The following verbs have been already implemented:

Todo

The following verbs are not yet fully implemented:

  • Dial
    • Number
    • Sip
    • Client
    • Conference
    • Queue
  • Record
  • SMS
  • Enqueue
  • Leave
  • Reject
  • Pause

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request