twilio-ruby 3.11.5 → 4.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7ab94258630ce056a2ec9062bcead79026e6ace5
-  data.tar.gz: dee171b3ef56e709b2a83e9266ec0afd4ea49ba2
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTVlYzExOGM0MDgwMzg3NmE4MTM0M2M1MjAyNTY1MmU5Yjk3NjY1Mw==
+  data.tar.gz: !binary |-
+    MTBlYzkxM2NjYjViMzY2OGU5NzUyMjBhMjNjOGQ5ZWVmN2I5YTdjYw==
 SHA512:
-  metadata.gz: 51e94cefd327185a93ae3fadf1151a13affae35f4d7af2bd0fbc418d25a82ac800ca79974b719edf6e572f3649db87364c5794f56597db3fdcc2452823173372
-  data.tar.gz: 921bede6c840a2dcb37495e1778982c322c6d04406466b56964f003f0ffcb0263a9cccf71b4b5564e1a64033f8f9e8cd62219e4cc8616dff5f09c29140f37793
+  metadata.gz: !binary |-
+    Mjk0ZDNjYjIwYTc2NjZiYjAzNmM4NGQ4NWQ4NWJlNGM0NzA2NTI5NmI1OTI4
+    Y2E5ZDEzYzQ0MjNiNTEzM2Y0MWQ5MzBiMTFiM2MwNThmODNjMjY4NmE2MTdi
+    MDM4NWY3OWU0ZGY1NWI4YjU2MTM4NzRiZTRjNmQ4MzNjZDEyOWU=
+  data.tar.gz: !binary |-
+    ODBhZjRmYWQ4ZTU3MTA3ZjE5MjEyNjYyODI2ZDk0Njk3Mjg3YjRjYTgyYTA4
+    NGEyMjExNzUzYjhjMGE3ZWM1YmI2MzM4YThmOGEwNGRkZTZmNzc5ZmMwMjli
+    OTNkMmE3YjY2NmIxZjRkZGRmMTc3OWE3NmM2ZjE5MGJmOTViN2E=

data/.gitignore

@@ -4,5 +4,5 @@ pkg/*
 doc/*
 Gemfile.lock
 *.gem
-
+bin
 docs/_build

data/.travis.yml

@@ -1,13 +1,24 @@
+sudo: false
 language: ruby
-script: "rake spec"
+cache: bundler
+bundler_args: --without development
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
+  - ruby-head
+  - ruby
+  - 2.2.0
   - 2.1.0
-  - jruby-18mode
+  - 2.0.0
+  - 1.9.3
+  - jruby-head
+  - jruby
   - jruby-19mode
-  - rbx-2.1.1
-  - rbx-2.2.1
-  - ree
+  - rbx-head
+  - rbx-2
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: ruby
+    - rvm: jruby-head
+    - rvm: jruby
+    - rvm: rbx-head

data/AUTHORS.md

@@ -4,28 +4,35 @@ Authors
 A huge thanks to all of our contributors:
 
 
-- Adam Ballai 
-- Alexander Murmann & Ryan Spore 
-- Andrew Benton 
-- Brian Levine 
-- Caley Woods 
-- Carlos Diaz-Padron 
-- Connor Montgomery 
-- Doug Black 
-- Elaine Tsai 
-- Fiona Tay & Will Read 
-- Geoff Petrie 
-- Guille Carlos 
-- Josh Hull 
-- Joël Franusic 
-- K Gautam Pai 
-- Kevin Burke 
-- Kyle Conroy 
-- Oscar 
-- Oscar Sanchez 
-- Rafael Chacon 
-- Ryan Spore 
-- Sam Kimbrel 
-- Torey Heinz 
-- Vipul A M 
-- vfrride 
+- Adam Ballai
+- Alexander Murmann & Ryan Spore
+- Alexandre Payment
+- Andrew Benton
+- Brian Levine
+- Caley Woods
+- Carlos Diaz-Padron
+- Connor Montgomery
+- Doug Black
+- Elaine Tsai
+- Fiona Tay & Will Read
+- Geoff Petrie
+- Guille Carlos
+- Jeremy Franz
+- Josh Hull
+- Joël Franusic
+- K Gautam Pai
+- Karl Freeman
+- Kevin Burke
+- Kyle Conroy
+- Leo Adamek
+- Oscar
+- Oscar Sanchez
+- Phil Nash
+- Rafael Chacon
+- Ryan Cavicchioni
+- Ryan Spore
+- Sam Kimbrel
+- Tom Moor
+- Torey Heinz
+- Vipul A M
+- vfrride

data/CHANGES.md

@@ -0,0 +1,203 @@
+twilio-ruby changelog
+=====================
+
+Version 4.0.0
+-------------
+
+Released April 16, 2015
+
+- Remove support for total
+- Use configuration object instead of defaults hash for REST clients
+- Moves statistics from task router client to individual classes
+  - Deprecates statistics methods on task router client
+
+Version 3.16.1
+--------------
+
+Released March 31, 2015
+
+- Fix bug in PhoneNumbers resource
+
+Version 3.16.0
+--------------
+
+Released March 31, 2015
+
+- Add support for new Twilio Lookups API
+- Update LICENSE wording
+
+Version 3.15.2
+--------------
+
+Released March 10, 2015
+
+- Add missing documentation on TaskRouter client
+
+Version 3.15.1
+--------------
+
+Released February 18, 2015
+
+- For real this time, add TaskRouterClient object and resources for new TaskRouter API
+
+Version 3.15.0
+--------------
+
+Released February 18, 2015
+
+- Adds TaskRouterClient object and resources for new TaskRouter API
+
+Version 3.14.5
+--------------
+
+Released February 9, 2015
+
+- Relaxes JWT gem version requirement
+- Adds Ruby 2.2.0 testing to TravisCI
+
+Version 3.14.4
+--------------
+
+Released January 8, 2015
+
+- Feature: dynamically choose the auth token to validate requests with when using the TwilioWebhookAuthentication middleware.
+- Deprecation: The Twilio::REST::SMS::Message resource is deprecated.
+- More fixing of docs
+
+Version 3.14.3
+--------------
+
+Released January 8, 2015
+
+- Fix nil error in RequestValidator middleware
+- Fix up docs
+
+Version 3.14.2
+--------------
+
+Released November 24, 2014
+
+- Fixed incomplete token support
+
+Version 3.14.1
+--------------
+
+Released November 21, 2014
+
+- Add support for the new Tokens endpoint
+
+Version 3.14.0
+--------------
+
+Released November 13, 2014
+
+- Switch to a constant-time string comparison for TwiML request signature validation
+- Add support for Call and Message deletion/redaction
+
+Version 3.13.1
+--------------
+
+Released October 1, 2014
+
+- Bump required version to 1.9.3
+
+Version 3.13.0
+--------------
+
+Released September 23, 2014
+
+- Deprecates 1.8.7 support
+- Internal code style changes including:
+    - change symbol hash syntax to Ruby 1.9 style
+    - remove curly braces from hash arguments to methods
+    - add spaces around curly braces in blocks
+    - reduces all lines to less than 80 characters
+
+Version 3.12.3
+--------------
+
+Released September 23, 2014
+
+- Added block configure syntax
+
+Version 3.12.2
+--------------
+
+Released August 29, 2014
+
+- `client.account.{resource}` can now be accessed with `client.{resource}`
+- Many doc updates
+
+Version 3.12.1
+--------------
+
+Released August 26, 2014
+
+- Add support for new call feedback endpoints
+
+Version 3.12.0
+--------------
+
+Released August 18, 2014
+
+- Add Rack middleware for Twilio request-signature validation
+- Upgrade dependencies and clean up project files
+- Documentation fixes
+- Add `text` alias for `to_xml` method on TwiML generator objects
+
+Version 3.11.6
+--------------
+
+Released July 25, 2014
+
+- Add #to_xml to TwiML Responses.
+- Updated test / development dependencies.
+- Updated to RSpec 3 syntax.
+
+Version 3.11.5
+--------------
+
+Released February 4, 2014
+
+- Add bangs for twilify to indicate it's a dangerous operation.
+- Remove reference to deprecated OpenSSL Digest parameter.
+- Encode dates properly before passing them to the Twilio API.
+
+Version 3.11.4
+--------------
+
+Released October 21, 2013
+
+- Add support for listing IncomingPhoneNumbers by type.
+- Add support for searching for mobile enabled numbers for
+both IncomingPhoneNumbers and AvailablePhoneNumbers.
+
+Version 3.11.3
+--------------
+
+Released October 15, 2013
+
+- Restore support for versions of Ruby other than 2.0.0, which the
+previous release removed.
+
+Version 3.11.2
+
+Released October 15, 2013
+
+- Restore ability of `sms.messages` to make requests to /SMS/Messages.
+
+Version 3.11.1
+--------------
+
+Released September 24, 2013
+
+- Fix a bug causing request the new messages class to fail.
+
+Version 3.11.0
+-------------
+
+Released September 18, 2013
+
+- Add MMS support.
+- Add SIP-In support.
+- Add docs.

data/Gemfile

@@ -1,3 +1,10 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :test do
+  gem 'rake', '~> 10.1'
+  gem 'rspec', '~> 3.0'
+  gem 'fakeweb', '~> 1.3'
+  gem 'rack', '~> 1.3'
+end

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,6 @@
-Copyright (c) 2010-2012 Andrew Benton.
+Copyright (c) 2010-2014 Andrew Benton.
+
+The MIT License (MIT)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/Makefile

@@ -1,6 +1,5 @@
 install:
-	gem build twilio-ruby.gemspec
-	gem install twilio-ruby-*.gem
+	bundle exec rake install
 
 test-install:
 	bundle install

data/README.md

@@ -1,15 +1,20 @@
-[![Build Status](https://travis-ci.org/twilio/twilio-ruby.png?branch=master)](https://travis-ci.org/twilio/twilio-ruby)
-[![Gem Version](https://badge.fury.io/rb/twilio-ruby.png)](http://badge.fury.io/rb/twilio-ruby)
+[![Gem Version](http://img.shields.io/gem/v/twilio-ruby.svg)][gem]
+[![Build Status](http://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Code Quality](http://img.shields.io/codeclimate/github/twilio/twilio-ruby.svg)][codeclimate]
 
 # twilio-ruby
 
-A module for using the Twilio REST API and generating valid
-[TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup Language").
-[Click here to read the full documentation.][documentation]
+A module for using the Twilio REST API and generating valid [TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup Language"). [Click here to read the full documentation.][documentation]
 
-## Install
+## Installation
 
-Via rubygems.org:
+To install using [Bundler][bundler] grab the latest stable version:
+
+```ruby
+gem 'twilio-ruby', '~> 4.0.0'
+```
+
+To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
 gem install twilio-ruby
@@ -37,26 +42,35 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 # set up a client to talk to the Twilio REST API
 @client = Twilio::REST::Client.new account_sid, auth_token
+
+# alternatively, you can preconfigure the client like so
+Twilio.configure do |config|
+  config.account_sid = account_sid
+  config.auth_token = auth_token
+end
+
+# and then you can create a new client without parameters
+@client = Twilio::REST::Client.new
 ```
 
 ### Send an SMS
 
 ``` ruby
-@client.account.messages.create(
-  :from => '+14159341234',
-  :to => '+16105557069',
-  :body => 'Hey there!'
+@client.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  body: 'Hey there!'
 )
 ```
 
 ### Send an MMS
 
 ``` ruby
-@client.account.messages.create(
-  :from => '+14159341234',
-  :to => '+16105557069',
-  :body => 'Hey there!',
-  :media_url => 'http://example.com/smileyface.jpg',
+@client.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  body: 'Hey there!',
+  media_url: 'http://example.com/smileyface.jpg'
 )
 ```
 
@@ -64,17 +78,17 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 ``` ruby
 # make a new outgoing call
-@call = @client.account.calls.create(
-  :from => '+14159341234',
-  :to => '+18004567890',
-  :url => 'http://example.com/call-handler',
+@call = @client.calls.create(
+  from: '+14159341234',
+  to: '+18004567890',
+  url: 'http://example.com/call-handler'
 )
 
 # hangup a ringing call, but don't touch it if it's connected
 @call.cancel
 
 # if you have the call sid, you can fetch a call object via:
-@call = @client.account.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662')
+@call = @client.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662')
 
 # redirect an in-progress call
 @call.redirect_to('http://example.com/call-redirect')
@@ -87,21 +101,21 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 ``` ruby
 # list calls made or received on or after May 13, 2013
-@client.account.calls.list("start_time>" => "2013-05-13") # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
+@client.calls.list("start_time>" => "2013-05-13") # Notice we omit the "=" in the "start_time>=" parameter because it is automatically added
 ```
 
 ### Buy a Phone Number
 
 ``` ruby
 # print some available numbers
-@numbers = @client.account.available_phone_numbers.get('US').local.list(
-  :contains => 'AWESOME'
+@numbers = @client.available_phone_numbers.get('US').local.list(
+  contains: 'AWESOME'
 )
 @numbers.each {|num| puts num.phone_number}
 
 # buy the first one
 @number = @numbers[0].phone_number
-@client.account.incoming_phone_numbers.create(:phone_number => @number)
+@client.incoming_phone_numbers.create(phone_number: @number)
 ```
 
 ## Getting Started With Client Capability Tokens
@@ -135,7 +149,7 @@ section of the wiki.
 
 ## Getting Started With TwiML
 
-TwiML support is based on the [builder][builder] library. You can construct a
+TwiML support is based on the [Builder][builder] library. You can construct a
 TwiML response like this:
 
 ``` ruby
@@ -144,8 +158,8 @@ require 'twilio-ruby'
 
 # build up a response
 response = Twilio::TwiML::Response.new do |r|
-  r.Say 'hello there', :voice => 'alice'
-  r.Dial :callerId => '+14159992222' do |d|
+  r.Say 'hello there', voice: 'alice'
+  r.Dial callerId: '+14159992222' do |d|
     d.Client 'jenny'
   end
 end
@@ -156,7 +170,7 @@ puts response.text
 
 This will print the following (except for the whitespace):
 
-```
+``` xml
 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
   <Say voice="alice">hello there</Say>
@@ -166,16 +180,33 @@ This will print the following (except for the whitespace):
 </Response>
 ```
 
-## More Information
+## Supported Ruby Versions
 
-There are more detailed examples in the included [examples][examples]
-directory.
+This library supports and is [tested against][travis] the following Ruby
+implementations:
 
-The [upgrade guide][upgrade] is available in the [twilio-ruby github wiki][wiki].
+- Ruby 2.2.0
+- Ruby 2.1.0
+- Ruby 2.0.0
+- Ruby 1.9.3
+- [JRuby][jruby]
+- [Rubinius][rubinius]
 
-[capability]:https://github.com/twilio/twilio-ruby/wiki/Capability
-[builder]:http://builder.rubyforge.org/
-[examples]:https://github.com/twilio/twilio-ruby/blob/master/examples
-[documentation]:http://twilio-ruby.readthedocs.org/en/latest
-[upgrade]:https://github.com/twilio/twilio-ruby/wiki/UpgradeGuide
-[wiki]:https://github.com/twilio/twilio-ruby/wiki
+## More Information
+
+There are more detailed examples in the included [examples][examples]
+directory. Also for thoose upgrading, the [upgrade guide][upgrade] is available in the [twilio-ruby github wiki][wiki].
+
+[capability]: https://github.com/twilio/twilio-ruby/wiki/Capability
+[builder]: http://builder.rubyforge.org/
+[examples]: https://github.com/twilio/twilio-ruby/blob/master/examples
+[documentation]: http://twilio-ruby.readthedocs.org/en/latest
+[upgrade]: https://github.com/twilio/twilio-ruby/wiki/UpgradeGuide
+[wiki]: https://github.com/twilio/twilio-ruby/wiki
+[bundler]: http://bundler.io
+[rubygems]: http://rubygems.org
+[gem]: https://rubygems.org/gems/twilio
+[travis]: http://travis-ci.org/twilio/twilio-ruby
+[codeclimate]: https://codeclimate.com/github/twilio/twilio-ruby
+[jruby]: http://www.jruby.org
+[rubinius]: http://rubini.us

data/Rakefile

@@ -1,12 +1,10 @@
-require 'rubygems'
-require 'rubygems/package_task'
-require 'rspec/core/rake_task'
-
-spec = eval(File.read('twilio-ruby.gemspec'))
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
 
-Gem::PackageTask.new(spec) do |p|
-  p.gem_spec = spec
-end
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
 
-RSpec::Core::RakeTask.new
-task :default => :spec
+task default: :spec
+task test: :spec

data/docs/faq.rst

@@ -34,9 +34,9 @@ Then you can convert user input to phone numbers like this:
     def convert_to_e164(raw_phone)
         Phony.format(
             raw_phone,
-            :format => :international,
-            :spaces => ''
+            format: :international,
+            spaces: ''
         ).gsub(/\s+/, "") # Phony won't remove all spaces
-    end 
+    end
 
     puts convert_to_e164('212 555 1234')   # prints +12125551234

data/docs/getting-started.rst

@@ -19,8 +19,11 @@ Make a Call
     auth_token = "YYYYYYYYYYYYYYYYYY"
 
     @client = Twilio::REST::Client.new account_sid, auth_token
-    @call = @client.account.calls.create({:to => "9991231234", :from => "9991231234",
-        :url => "http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient"})
+    @call = @client.calls.create(
+      to: "9991231234",
+      from: "9991231234",
+      url: "http://twimlets.com/holdmusic?Bucket=com.twilio.music.ambient"
+    )
     puts @call.length
     puts @call.sid
 
@@ -38,10 +41,11 @@ Send an SMS
 
     @client = Twilio::REST::Client.new account_sid, auth_token
 
-    @message = @client.account.messages.create({:to => "+12316851234",
-                                       :from => "+15555555555",
-                                       :body => "Hello there!"})
-
+    @message = @client.messages.create(
+      to: "+12316851234",
+      from: "+15555555555",
+      body: "Hello there!"
+    )
 
 Send an MMS
 ===========
@@ -56,11 +60,12 @@ Send an MMS
 
     @client = Twilio::REST::Client.new account_sid, auth_token
 
-    @message = @client.account.messages.create({:to => "+15558676309",
-                                       :from => "+15555555555",
-                                       :body => "Jenny I need you!",
-                                       :media_url => "http://twilio.com/heart.jpg"})
-
+    @message = @client.messages.create(
+      to: "+15558676309",
+      from: "+15555555555",
+      body: "Jenny I need you!",
+      media_url: "http://twilio.com/heart.jpg"
+    )
 
 Generating TwiML
 =================
@@ -72,7 +77,7 @@ to easily create such responses.
 .. code-block:: ruby
 
     Twilio::TwiML::Response do |r|
-        r.Play "https://api.twilio.com/cowbell.mp3", :loop => 5
+        r.Play "https://api.twilio.com/cowbell.mp3", loop: 5
     end.text
 
 .. code-block:: xml

data/docs/index.rst

@@ -55,6 +55,21 @@ Query the Twilio REST API to create phone calls, send SMS/MMS messages and more!
     usage/queues
     usage/sip
 
+
+TaskRouter
+---------
+
+Query the Twilio TaskRouter API to set up workspaces and task routing, and
+create capability tokens to authorize your client-side code to safely update
+state.
+
+.. toctree::
+    :maxdepth: 1
+
+    usage/taskrouter
+    usage/taskrouter-tokens
+
+
 TwiML
 ---------