twilio-ruby 4.13.0 → 5.0.0.alpha1

data/Gemfile

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

data/LICENSE.md

@@ -1,21 +1,21 @@
-Copyright (c) 2010-2014 Andrew Benton.
+MIT License
 
-The MIT License (MIT)
+Copyright (C) 2017, Twilio, Inc. <help@twilio.com>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -1,15 +1,25 @@
+.PHONY: test lint-changed lint
+
+CHANGED_RUBY_FILES = $(shell git status --porcelain | grep ".rb" | awk -F ' ' '{print $2}' | tr '\n' ' ')
+
 install:
-	bundle exec rake install
+	bundle install; bundle exec rake install
 
 test-install:
 	bundle install
 
-test:
+test: lint
 	bundle exec rake spec
 
+docs:
+	yard doc
+
+lint:
+	rubocop --cache true --parallel
+
 authors:
 	echo "Authors\n=======\n\nA huge thanks to all of our contributors:\n\n" > AUTHORS.md
 	git log --raw | grep "^Author: " | cut -d ' ' -f2- | cut -d '<' -f1 | sed 's/^/- /' | sort | uniq >> AUTHORS.md
 
-deploy:
+gem:
 	bundle exec rake build | sed -e 's/.*pkg/pkg/g' | sed -e "s/\.$$//g" | xargs gem push

data/README.md

@@ -1,9 +1,9 @@
-[![Gem Version](http://img.shields.io/gem/v/twilio-ruby.svg)][gem]
+# twilio-ruby
+
 [![Build Status](http://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Gem Version](http://img.shields.io/gem/v/twilio-ruby.svg)][gem]
 [![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]
 
 ## Installation
@@ -11,13 +11,13 @@ A module for using the Twilio REST API and generating valid [TwiML](http://www.t
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 4.11.1'
+gem 'twilio-ruby', '~> 5.0.0.rc26'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby
+gem install twilio-ruby -v 5.0.0.rc26
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -28,12 +28,20 @@ cd twilio-ruby
 make install
 ```
 
-## Getting Started With REST
+### Migration from 4.x
+[Upgrade Guide][upgrade]
+
+## Documentation
+[Here][documentation]
+
+## Feedback
+During the Release Candidate period of this library, please leave all feedback and issues in the [Github Issues][issues] for `twilio-ruby`.
+
+## Getting Started
 
 ### Setup Work
 
-``` ruby
-require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+```ruby
 require 'twilio-ruby'
 
 # put your own credentials here
@@ -53,101 +61,39 @@ end
 @client = Twilio::REST::Client.new
 ```
 
-### Send an SMS
+### Make a Call
 
-``` ruby
-@client.messages.create(
+```ruby
+@client.api.account.calls.create(
   from: '+14159341234',
   to: '+16105557069',
-  body: 'Hey there!'
+  url: 'http://example.com'
 )
 ```
 
-### Send an MMS
+### Send an SMS
 
-``` ruby
-@client.messages.create(
+```ruby
+@client.api.account.messages.create(
   from: '+14159341234',
   to: '+16105557069',
-  body: 'Hey there!',
-  media_url: 'http://example.com/smileyface.jpg'
-)
-```
-
-### Do Some Stuff With Calls
-
-``` ruby
-# make a new outgoing call
-@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.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662')
-
-# redirect an in-progress call
-@call.redirect_to('http://example.com/call-redirect')
-
-# hangup a call, no matter whether it is ringing or connected
-@call.hangup
-```
-
-### List Calls after a certain time
-
-``` ruby
-# list calls made or received on or after May 13, 2013
-@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.available_phone_numbers.get('US').local.list(
-  contains: 'AWESOME'
+  body: 'Hey there!'
 )
-@numbers.each {|num| puts num.phone_number}
-
-# buy the first one
-@number = @numbers[0].phone_number
-@client.incoming_phone_numbers.create(phone_number: @number)
 ```
 
-## Create a Task with TaskRouter
-
-If you need to create a Task to TaskRouter, you can do so by using the TaskRouterClient.
-
-Additional resources had off of the workspace object (task_queues, workers, workflows, activities, tasks, statistics, events).
-
-``` ruby
-require 'rubygems'
-require 'twilio-ruby'
-
-# put your own account credentials here:
-account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-auth_token  = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
-workspace_sid = 'WSzzzzzzzzzzzzzzzzzzzzzzzzzzz'
-
-# set up a client
-client = Twilio::REST::TaskRouterClient.new account_sid, auth_token, workspace_sid
+### Customizing your HTTP Client
+twilio-ruby uses [Faraday][faraday] to make HTTP requests. You can tell Twilio::REST::Client to use any of the Faraday adapters like so:
 
-# create a task
-workflow_sid = 'WWffffffffffffffffffffffffffff'
-client.workspace.tasks.create(attributes: '{"foo": "bar"}', workflow_sid: "WWfffffffffffffffffffffffffffffff")
+```ruby
+@client.http_client.adapter = :typhoeus
 ```
 
-## Create a Twilio Client Capability Token
+## Getting Started With Client Capability Tokens
 
 If you just need to generate a Capability Token for use with Twilio Client, you
 can do this:
 
-``` ruby
-require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+```ruby
 require 'twilio-ruby'
 
 # put your own account credentials here:
@@ -155,69 +101,46 @@ account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
 # set up
-capability = Twilio::Util::Capability.new account_sid, auth_token
+capability = Twilio::JWT::ClientCapability.new account_sid, auth_token
+
 
 # allow outgoing calls to an application
-capability.allow_client_outgoing 'AP89a0180a1a4ddf1da954efca349b7a20'
+outgoingScope = Twilio::JWT::ClientCapability::OutgoingClientScope.new 'AP11111111111111111111111111111111'
+capability.add_scope(outgoingScope)
 
 # allow incoming calls to 'andrew'
-capability.allow_client_incoming 'andrew'
+incomingScope = Twilio::JWT::ClientCapability::IncomingClientScope.new 'tom'
+capability.add_scope(incomingScope)
 
 # generate the token string
-@token = capability.generate
+@token = capability.to_s
 ```
 
 There is a slightly more detailed document in the [Capability][capability]
 section of the wiki.
 
-## Lookup Phone Number information
-
-You can look up details on phone numbers with the Lookups API.
-
-```ruby
-require 'twilio-ruby'
-
-# put your own credentials here
-account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
-
-# set up a client to talk to the Twilio REST API
-@lookups_client = Twilio::REST::LookupsClient.new account_sid, auth_token
-
-# lookup a number
-number = @lookups_client.phone_numbers.get('+14159341234')
-
-# investigate the number
-number.national_format
-# => "(415) 934-1234"
-number.country_code
-# => "US"
-```
-
 ## Getting Started With TwiML
 
 TwiML support is based on the [Builder][builder] library. You can construct a
 TwiML response like this:
 
-``` ruby
-require 'rubygems' # not necessary with ruby 1.9 but included for completeness
+```ruby
 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|
-    d.Client 'jenny'
+response = Twilio::TwiML::VoiceResponse.new do |r|
+  r.say('hello there', voice: 'alice')
+  r.dial(caller_id: '+14159992222') do |d|
+    d.client 'jenny'
   end
 end
 
 # print the result
-puts response.text
+puts response.to_s
 ```
 
 This will print the following (except for the whitespace):
 
-``` xml
+```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
   <Say voice="alice">hello there</Say>
@@ -232,34 +155,22 @@ This will print the following (except for the whitespace):
 This library supports and is [tested against][travis] the following Ruby
 implementations:
 
+- Ruby 2.4.0
+- Ruby 2.3.0
 - Ruby 2.2.0
 - Ruby 2.1.0
 - Ruby 2.0.0
-- Ruby 1.9.3
-- [JRuby][jruby]
-- [Rubinius][rubinius]
-
-## Getting help
-
-If you need help installing or using the library, please contact Twilio Support at help@twilio.com first. Twilio's Support staff are well-versed in all of the Twilio Helper Libraries, and usually reply within 24 hours.
-
-If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
-
-## More Information
-
-There are more detailed examples in the included [examples][examples]
-directory. Also for those 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
+[documentation]: http://twilio.github.io/twilio-ruby
 [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
+[upgrade]: https://github.com/twilio/twilio-ruby/wiki/Ruby-Version-5.x-Upgrade-Guide
+[issues]: https://github.com/twilio/twilio-ruby/issues
+[faraday]: https://github.com/lostisland/faraday

data/Rakefile

@@ -8,3 +8,57 @@ RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 task test: :spec
+
+task :authors do
+  `make authors`
+end
+
+task :deploy, [:version] => [:spec, :authors] do |t, args|
+  current_version = Twilio::VERSION
+
+  if args.version.nil?
+    version = Twilio::VERSION
+    version_parts = version.split('.')
+    increment = version_parts.pop
+    increment_prefix = increment.split(/\d/)[0]
+
+    increment = increment[increment_prefix.length..-1] if increment_prefix
+
+    increment = increment.to_i + 1
+    increment = "#{increment_prefix}#{increment}" if increment_prefix
+
+    version = [*version_parts, increment].join('.')
+  else
+    version = args.version
+  end
+
+  puts("Deploying #{version}")
+
+  # Update version.rb
+  version_file = <<SRC
+module Twilio
+  VERSION = '#{version}'
+end
+SRC
+  File.write('lib/twilio-ruby/version.rb', version_file)
+
+  # Update README.md
+  current_readme = File.read('README.md')
+  new_readme = current_readme.gsub(Regexp.new(current_version.gsub('.', '\.')), version)
+  File.write('README.md', new_readme)
+
+  # Make a git commit
+  `git commit -am "Bumping to version #{version}"`
+
+  # Do the gem deployment
+  `make gem`
+
+  # Push the branch back up
+  `git push`
+
+  # Tag the branch
+  `git tag #{version}`
+
+  # Push the tags
+  `git push --tags`
+end

data/VERSIONS.md

@@ -0,0 +1,64 @@
+# Versioning Strategy
+
+`twilio-ruby` uses a modified version of [Semantic Versioning][semver] for all 
+changes to the helper library.  It is strongly encouraged that you pin at least 
+the major version and potentially the minor version to avoid pulling in breaking 
+changes.
+
+Semantic Versions take the form of `MAJOR`.`MINOR`.`PATCH`
+
+When bugs are fixed in the library in a backwards compatible way, the `PATCH` 
+level will be incremented by one.  When new features are added to the library 
+in a backwards compatible way, the `PATCH` level will be incremented by one.
+`PATCH` changes should _not_ break your code and are generally safe for upgrade.
+
+When a new large feature set comes online or a small breaking change is 
+introduced, the `MINOR` version will be incremented by one and the `PATCH` 
+version reset to zero. `MINOR` changes _may_ require some amount of manual code
+change for upgrade. These backwards-incompatible changes will generally be limited 
+to a small number of function signature changes.
+
+The `MAJOR` version is used to indicate the family of technology represented by 
+the helper library.  It increased from `4.x.x` to `5.x.x` when Twilio moved to 
+auto generation of helper libraries.  Breaking changes that requires extensive 
+reworking of code (like the `4.x.x` to `5.x.x` upgrade) will case the `MAJOR` 
+version to be incremented by one, the `MINOR` and `PATCH` versions will be reset 
+to zero.  Twilio understands that this can be very disruptive, we will only 
+introduce this type of breaking change when absolutely necessary. New `MAJOR` 
+versions will be communicated in advance with `Release Candidates` and a 
+schedule.
+
+## Supported Versions
+
+`twilio-ruby` follows an evergreen model of support.  New features and 
+functionality will only be added to the current version.  The current version - 
+1 will continue to be supported with bugfixes and security updates, but no new 
+features.
+
+## Edge Features (alpha Branch)
+
+Twilio frequently rolls out new features in public and private beta periods.
+Twilio strives to ship early and often and bake customer feedback back into our 
+products.  To support that mission, the `twilio-ruby` helper library has an 
+`Edge` version based of the `alpha` branch.  This version is identified with an
+`alpha` metadata tag on the version number.
+
+The way the `Edge` artifact is created is by playing the `Edge` features on top
+of our stable artifact.  The `Edge` artifact will always have the same version 
+number as the stable artifact it was created from, but with an `alpha` suffix.
+
+For example, `5.0.0-alpha-1` is the `5.0.0` branch with `Edge` features included.
+If there is a change to one of the `Edge` features we may regenerate the `Edge`
+artifact and release a new `5.0.0-alpha-2`, new `Edge` artifacts simply increment
+the number after the `alpha` suffix.  All `Edge` features are considered 
+unstable and a backwards incompatible change in an `Edge` feature will not cause
+any version change so you should take care when upgrading from one `alpha` 
+version to another.  
+
+Once an `Edge` feature has matured it will be considered `Mainline` and included
+in the stable artifact, with a `MAJOR` or `MINOR` version bump.
+
+To use an `Edge` artifact in your Ruby project you will have to make sure that 
+you pin the artifact with `alpha` stability in your `pom.xml`.
+
+[semver]: http://semver.org/