RubyGems - twilio-test-toolkit2 - Versions diffs - 3.4.0 - Mend

twilio-test-toolkit2 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +260 -0
data/Rakefile +38 -0
data/lib/twilio-test-toolkit/call_in_progress.rb +56 -0
data/lib/twilio-test-toolkit/call_scope.rb +243 -0
data/lib/twilio-test-toolkit/dsl.rb +15 -0
data/lib/twilio-test-toolkit/version.rb +3 -0
data/lib/twilio-test-toolkit.rb +4 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/controllers/twilio_controller.rb +8 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/app/views/layouts/twilio.layout.xml.erb +4 -0
data/spec/dummy/app/views/twilio/test_action.xml.erb +2 -0
data/spec/dummy/app/views/twilio/test_dial_with_action.xml.erb +3 -0
data/spec/dummy/app/views/twilio/test_dial_with_no_action.xml.erb +3 -0
data/spec/dummy/app/views/twilio/test_dial_with_sip.xml +6 -0
data/spec/dummy/app/views/twilio/test_gather_finish_on_asterisk.xml.erb +3 -0
data/spec/dummy/app/views/twilio/test_hangup.xml.erb +1 -0
data/spec/dummy/app/views/twilio/test_play.xml.erb +1 -0
data/spec/dummy/app/views/twilio/test_record.xml +2 -0
data/spec/dummy/app/views/twilio/test_redirect.xml.erb +1 -0
data/spec/dummy/app/views/twilio/test_say.xml.erb +1 -0
data/spec/dummy/app/views/twilio/test_start.xml.erb +5 -0
data/spec/dummy/config/application.rb +59 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +16 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/schema.rb +16 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/requests/call_scope_spec.rb +388 -0
data/spec/requests/dsl_spec.rb +54 -0
data/spec/spec_helper.rb +20 -0
metadata +226 -0

data/spec/dummy/config/initializers/mime_types.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'a97e0b618b2e11a39b0c155d46c6f8e0f15a17edcd595e3baca48956a204ef15d988fd26274e0180192058ad8cbb9df002f6341acb8e92075798ea4e278d6561'

data/spec/dummy/config/initializers/session_store.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb ADDED Viewed

@@ -0,0 +1,16 @@
+Dummy::Application.routes.draw do
+  resources :twilio do
+    get "test_start", :on => :collection
+    post "test_start", :on => :collection
+    post "test_action", :on => :collection
+    post "test_gather_finish_on_asterisk", :on => :collection
+    post "test_hangup", :on => :collection
+    post "test_dial_with_no_action", :on => :collection
+    post "test_dial_with_action", :on => :collection
+    post "test_dial_with_sip", :on => :collection
+    post "test_redirect", :on => :collection
+    post "test_say", :on => :collection
+    post "test_play", :on => :collection
+    post "test_record", :on => :collection
+  end
+end

data/spec/dummy/config.ru ADDED Viewed

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/db/schema.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+ActiveRecord::Schema.define(:version => 0) do
+end

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/requests/call_scope_spec.rb ADDED Viewed

@@ -0,0 +1,388 @@
+require 'spec_helper'
+describe TwilioTestToolkit::CallScope do
+  before(:each) do
+    @our_number = "2065551212"
+    @their_number = "2065553434"
+  end
+  describe "basics" do
+    before(:each) do
+      @call = ttt_call(test_start_twilio_index_path, @our_number, @their_number)
+    end
+    it "should be a CallScope" do
+      @call.should be_a(TwilioTestToolkit::CallScope)
+    end
+    it "should have the informational methods" do
+      @call.should respond_to(:current_path)
+      @call.should respond_to(:response_xml)
+    end
+    it "should have the right path" do
+      @call.current_path.should == test_start_twilio_index_path
+    end
+    it "should have a response xml value" do
+      @call.response_xml.should_not be_blank
+    end
+    it "should have the right root call" do
+      @call.should respond_to(:root_call)
+      @call.root_call.should == @call
+    end
+  end
+  describe "redirect" do
+    describe "success" do
+      before(:each) do
+        @call = ttt_call(test_redirect_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the redirect methods" do
+        @call.should respond_to(:has_redirect?)
+        @call.should respond_to(:has_redirect_to?)
+        @call.should respond_to(:follow_redirect)
+        @call.should respond_to(:follow_redirect!)
+      end
+      it "should have the right value for has_redirect?" do
+        @call.should have_redirect
+      end
+      it "should have the right values for has_redirect_to?" do
+        @call.has_redirect_to?("http://foo").should be_false
+        @call.has_redirect_to?(test_start_twilio_index_path).should be_true
+        @call.has_redirect_to?(test_start_twilio_index_path + ".xml").should be_true    # Should force normalization
+      end
+      it "should follow the redirect (immutable version)" do
+        # follow_redirect returns a new CallScope
+        newcall = @call.follow_redirect
+        # Make sure it followed
+        newcall.current_path.should == test_start_twilio_index_path
+        # And is not the same call
+        newcall.response_xml.should_not == @call.response_xml
+        # But it's linked
+        newcall.root_call.should == @call
+        # And we did not modify the original call
+        @call.current_path.should == test_redirect_twilio_index_path
+      end
+      it "should follow the redirect (mutable version)" do
+        # follow_redirect! modifies the CallScope
+        @call.follow_redirect!
+        # Make sure it followed
+        @call.current_path.should == test_start_twilio_index_path
+      end
+      it "should submit default params on follow_redirect" do
+        default_request_params = {
+          :format => :xml,
+          :From => "2065551212",
+          :Digits => "",
+          :To => "2065553434",
+          :AnsweredBy => "human",
+          :CallStatus => "in-progress"
+        }
+        Capybara.current_session.driver
+          .should_receive(:post)
+          .with("/twilio/test_start", hash_including(default_request_params))
+          .and_call_original
+        @call.follow_redirect
+      end
+      it "should consider options for follow_redirect!" do
+        Capybara.current_session.driver
+          .should_receive(:post)
+          .with("/twilio/test_start", hash_including(:CallStatus => "completed"))
+          .and_call_original
+        @call.follow_redirect!(call_status: "completed")
+      end
+      it "should consider options for follow_redirect" do
+        Capybara.current_session.driver
+          .should_receive(:post)
+          .with("/twilio/test_start", hash_including(:CallStatus => "completed"))
+          .and_call_original
+        @call.follow_redirect(call_status: "completed")
+      end
+    end
+    describe "failure" do
+      before(:each) do
+        # Initiate a call that's not on a redirect - various calls will fail
+        @call = ttt_call(test_say_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the right value for has_redirect?" do
+        @call.should_not have_redirect
+      end
+      it "should have the right values for has_redirect_to?" do
+        @call.has_redirect_to?("http://foo").should be_false
+        @call.has_redirect_to?(test_start_twilio_index_path).should be_false
+        @call.has_redirect_to?(test_start_twilio_index_path + ".xml").should be_false
+      end
+      it "should raise an error on follow_redirect" do
+        lambda {@call.follow_redirect}.should raise_error
+      end
+      it "should raise an error on follow_redirect!" do
+        lambda {@call.follow_redirect!}.should raise_error
+      end
+    end
+  end
+  describe "say" do
+    before(:each) do
+      @call = ttt_call(test_say_twilio_index_path, @our_number, @their_number)
+    end
+    it "should have the expected say methods" do
+      @call.should respond_to(:has_say?)
+    end
+    it "should have the right values for has_say?" do
+      @call.has_say?("Blah blah").should be_false
+      @call.has_say?("This is a say page.").should be_true
+      @call.has_say?("This is").should be_true      # Partial match
+    end
+  end
+  describe "play" do
+    before(:each) do
+      @call = ttt_call(test_play_twilio_index_path, @our_number, @their_number)
+    end
+    it "should have the expected say play methods" do
+      @call.should respond_to(:has_play?)
+    end
+    it "should have the right values for has_say?" do
+      @call.has_play?("/path/to/a/different/audio/clip.mp3").should be_false
+      @call.has_play?("/path/to/an/audio/clip.mp3").should be_true
+      @call.has_play?("clip.mp3").should be_false
+    end
+  end
+  describe "dial" do
+    before(:each) do
+      @call = ttt_call(test_dial_with_action_twilio_index_path, @our_number, @their_number)
+    end
+    it "should have the expected dial methods" do
+      @call.should respond_to(:has_dial?)
+    end
+    it "should have the right values for has_dial?" do
+      @call.has_dial?("911").should be_false
+      @call.has_dial?("18001234567").should be_true
+      @call.has_dial?("12345").should be_true     # Partial match
+    end
+    it "should not match the dial action if there isn't one" do
+      @call = ttt_call(test_dial_with_no_action_twilio_index_path, @our_number, @their_number)
+      @call.has_action_on_dial?("http://example.org:3000/call_me_back").should eq false
+    end
+    it "should match the action on dial if there is one" do
+      @call.has_action_on_dial?("http://example.org:3000/call_me_back").should be_true
+    end
+    it "should not match the action on dial if it's different than the one specified" do
+      @call.has_action_on_dial?("http://example.org:3000/dont_call").should be_false
+    end
+    it "should dial a sip peer with the correct structure" do
+      @call = ttt_call(test_dial_with_sip_twilio_index_path, @our_number, @their_number)
+      @call.within_dial do |dial|
+        dial.has_sip?.should be_true
+        dial.within_sip do |sip|
+          sip.has_uri?("18885551234@sip.foo.bar").should be_true
+          sip.has_username_on_uri?("foo").should be_true
+          sip.has_password_on_uri?("bar").should be_true
+        end
+      end
+    end
+  end
+  describe "hangup" do
+    describe "success" do
+      before(:each) do
+        @call = ttt_call(test_hangup_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the expected hangup methods" do
+        @call.should respond_to(:has_hangup?)
+      end
+      it "should have the right value for has_hangup?" do
+        @call.should have_hangup
+      end
+    end
+    describe "failure" do
+      before(:each) do
+        @call = ttt_call(test_start_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the right value for has_hangup?" do
+        @call.should_not have_hangup
+      end
+    end
+  end
+  describe "gather" do
+    describe "success" do
+      before(:each) do
+        @call = ttt_call(test_start_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the expected gather methods" do
+        @call.should respond_to(:has_gather?)
+        @call.should respond_to(:within_gather)
+        @call.should respond_to(:gather?)
+        @call.should respond_to(:gather_action)
+        @call.should respond_to(:press)
+      end
+      it "should have the right value for has_gather?" do
+        @call.has_gather?.should be_true
+      end
+      it "should have the right value for gather?" do
+        # Although we have a gather, the current call scope is not itself a gather, so this returns false.
+        @call.gather?.should be_false
+      end
+      it "should fail on gather-scoped methods outside of a gather scope" do
+        lambda {@call.gather_action}.should raise_error
+        lambda {@call.press "1234"}.should raise_error
+      end
+      it "should gather" do
+        # We should not have a say that's contained within a gather.
+        @call.should_not have_say("Please enter some digits.")
+        # Now enter the gather block.
+        @call.within_gather do |gather|
+          # We should have a say here
+          gather.should have_say("Please enter some digits.")
+          # We should be in a gather
+          gather.gather?.should be_true
+          # And we should have an action
+          gather.gather_action.should == test_action_twilio_index_path
+          # And we should have the right root call
+          gather.root_call.should == @call
+          # Press some digits.
+          gather.press "98765"
+        end
+        # This should update the path
+        @call.current_path.should == test_action_twilio_index_path
+        # This view says the digits we pressed - make sure
+        @call.should have_say "You entered 98765."
+      end
+      it "should gather without a press" do
+        @call.within_gather do |gather|
+          # Do nothing
+        end
+        # We should still be on the same page
+        @call.current_path.should == test_start_twilio_index_path
+      end
+      it "should respond to the default finish key of hash" do
+        @call.within_gather do |gather|
+          gather.press "98765#"
+        end
+        @call.should have_say "You entered 98765."
+      end
+    end
+    describe "with finishOnKey specified" do
+      before(:each) do
+        @call = ttt_call(test_gather_finish_on_asterisk_twilio_index_path, @our_number, @their_number)
+      end
+      it "should strip the finish key from the digits" do
+        @call.within_gather do |gather|
+          gather.press "98765*"
+        end
+        @call.should have_say "You entered 98765."
+      end
+      it "should still accept the digits without a finish key (due to timeout)" do
+        @call.within_gather do |gather|
+          gather.press "98765"
+        end
+        @call.should have_say "You entered 98765."
+      end
+    end
+    describe "failure" do
+      before(:each) do
+        @call = ttt_call(test_say_twilio_index_path, @our_number, @their_number)
+      end
+      it "should have the right value for has_gather?" do
+        @call.has_gather?.should be_false
+      end
+      it "should have the right value for gather?" do
+        @call.gather?.should be_false
+      end
+      it "should fail on within_gather if there is no gather" do
+        lambda {@call.within_gather do |gather|; end}.should raise_error
+      end
+      it "should fail on gather-scoped methods outside of a gather scope" do
+        lambda {@call.gather_action}.should raise_error
+        lambda {@call.press "1234"}.should raise_error
+      end
+    end
+  end
+  describe "record" do
+    before(:each) do
+      @call = ttt_call(test_record_twilio_index_path, @our_number, @their_number)
+    end
+    it "should have the expected say record methods" do
+      @call.should respond_to(:has_record?)
+    end
+    it "should have the right action for record"  do
+      @call.has_action_on_record?("http://example.org:3000/record_this_call").should be_true
+    end
+    it "should have the right maxLength for record"  do
+      @call.has_max_length_on_record?("20").should be_true
+    end
+    it "should have the right finishOnKey for record"  do
+      @call.has_finish_on_key_on_record?("*").should be_true
+    end
+  end
+end

data/spec/requests/dsl_spec.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require 'spec_helper'
+describe TwilioTestToolkit::DSL do
+  before(:each) do
+    @our_number = "2065551212"
+    @their_number = "2065553434"
+  end
+  describe "ttt_call" do
+    describe "basics" do
+      before(:each) do
+        @call = ttt_call(test_start_twilio_index_path, @our_number, @their_number)
+      end
+      it "should assign the call" do
+        @call.should_not be_nil
+      end
+      it "should have a sid" do
+        @call.sid.should_not be_blank
+      end
+      it "should default the method to post" do
+        @call.http_method.should == :post
+      end
+      it "should have the right properties" do
+        @call.initial_path.should == test_start_twilio_index_path
+        @call.from_number.should == @our_number
+        @call.to_number.should == @their_number
+        @call.is_machine.should be_false
+      end
+    end
+    describe "with a sid, method and machine override" do
+      before(:each) do
+        @mysid = "1234567"
+        @call = ttt_call(test_start_twilio_index_path, @our_number, @their_number, :call_sid => @mysid, :is_machine => true, :method => :get)
+      end
+      it "should have the right sid" do
+        @call.sid.should == @mysid
+      end
+      it "should be a machine call" do
+        @call.is_machine.should be_true
+      end
+      it "should be a get call" do
+        @call.http_method.should == :get
+      end
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+Rails.backtrace_cleaner.remove_silencers!
+require 'rspec/rails'
+# Set up capybara integration
+require 'capybara/rspec'
+require 'capybara/rails'
+# Our gem
+require 'twilio-test-toolkit'
+RSpec.configure do |config|
+  config.include TwilioTestToolkit::DSL, :type => :request
+end