twilio-ruby 5.20.0 → 5.47.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at open-source@twilio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -11,6 +11,7 @@ even better than it is today! Here are the guidelines we'd like you to follow:
  - [Submission Guidelines](#submit)
  - [Coding Rules](#rules)
 
+
 ## <a name="coc"></a> Code of Conduct
 
 Help us keep `twilio-ruby` open and inclusive. Please be kind to and considerate
@@ -104,7 +105,7 @@ Before you submit your pull request consider the following guidelines:
 * Make your changes in a new git branch:
 
     ```shell
-    git checkout -b my-fix-branch master
+    git checkout -b my-fix-branch main
     ```
 
 * Create your patch, **including appropriate test cases**.
@@ -131,7 +132,7 @@ Before you submit your pull request consider the following guidelines:
     git push origin my-fix-branch
     ```
 
-In GitHub, send a pull request to `twilio-ruby:master`.
+In GitHub, send a pull request to `twilio-ruby:main`.
 If we suggest changes, then:
 
 * Make the required updates.
@@ -154,6 +155,7 @@ you are working:
 * All features or bug fixes **must be tested** by one or more tests.
 * All classes and methods **must be documented**.
 
+
 [docs-link]: https://www.twilio.com/docs/libraries/ruby
 [issue-link]: https://github.com/twilio/twilio-ruby/issues/new
 [github]: https://github.com/twilio/twilio-ruby

data/Dockerfile

@@ -1,9 +1,9 @@
-FROM ruby:2.4.0
+FROM ruby:2.4
 
 RUN mkdir /twilio
 WORKDIR /twilio
 
 COPY . .
 
-RUN bundle install 
+RUN bundle install
 RUN bundle exec rake install

data/Gemfile

@@ -1,11 +1,2 @@
 source 'https://rubygems.org'
-
 gemspec
-
-group :test do
-  gem 'equivalent-xml', '~> 0.6'
-  gem 'fakeweb', '~> 1.3'
-  gem 'rack', '~> 1.3'
-  gem 'rake', '~> 10.1'
-  gem 'rspec', '~> 3.0'
-end

data/ISSUE_TEMPLATE.md

@@ -1,9 +1,18 @@
-*Note: These issues are for bugs and feature requests for the helper libraries.
-If you need help or support, please email help@twilio.com and one of our experts
-will assist you!*
+<!--
+If this is a feature request, make sure you search Issues for an existing request before creating a new one!
 
+Please utilize the template below to help us resolve your issue.
 
-**Version:**
+Note that many issues can be resolved by updating to the latest version.
+-->
+
+### Issue Summary
+A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples.
+
+### Steps to Reproduce
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
 
 ### Code Snippet
 ```ruby
@@ -12,15 +21,10 @@ will assist you!*
 
 ### Exception/Log
 ```
-<place exception/log here>
+# paste exception/log here
 ```
 
-### Steps to Reproduce
-1.
-2.
-3.
-
+### Technical details:
+* twilio-ruby version: 
+* ruby version:
 
-### Feature Request
-_If this is a feature request, make sure you search Issues for an existing
-request before creating a new one!_

data/{LICENSE.md → LICENSE}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2019, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2021, 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
@@ -18,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.
+SOFTWARE.

data/Makefile

@@ -1,33 +1,24 @@
-.PHONY: githooks test lint-changed lint docs
+.PHONY: githooks install test lint docs docker-build docker-push
 
-CHANGED_RUBY_FILES = $(shell git status --porcelain | grep ".rb" | awk -F ' ' '{print $2}' | tr '\n' ' ')
+githooks:
+	ln -sf ../../githooks/pre-commit .git/hooks/pre-commit
 
 install: githooks
-	bundle install; bundle exec rake install
-
-test-install:
-	bundle install
+	bundle install --with development; bundle exec rake install
 
 test: lint
 	bundle exec rake spec
 
-docs:
-	yard doc --output-dir ./doc
-
 lint:
 	rubocop --cache true --parallel
 
-githooks:
-	cp githooks/pre-commit .git/hooks/pre-commit
-	chmod +x .git/hooks/pre-commit
+docs:
+	yard doc --output-dir ./doc
 
 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
 
-gem:
-	bundle exec rake build | sed -e 's/.*pkg/pkg/g' | sed -e "s/\.$$//g" | xargs gem push
-
 API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
 docker-build:
 	docker build -t twilio/twilio-ruby .

data/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,31 @@
-Please ensure the following steps have been run before submitting this pull request:
+<!--
+We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines, then fill out the blanks below.
 
-- [ ] Run `make test` and ensure it passes locally
-- [ ] Run `make lint` to appease Rubocop
+Please format the PR title appropriately based on the type of change:
+  <type>[!]: <description>
+Where <type> is one of: docs, chore, feat, fix, test.
+Add a '!' after the type for breaking changes (e.g. feat!: new breaking feature).
+
+**All third-party contributors acknowledge that any contributions they provide will be made under the same open-source license that the open-source project is provided under.**
+
+Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
+e.g.
+Fixes #1
+Closes #2
+-->
+
+# Fixes #
+
+A short description of what this PR does.
+
+### Checklist
+- [x] I acknowledge that all my contributions will be made under the project's license
+- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
+- [ ] I have read the [Contribution Guidelines](https://github.com/twilio/twilio-ruby/blob/main/CONTRIBUTING.md) and my PR follows them
+- [ ] I have titled the PR appropriately
+- [ ] I have updated my branch with the main branch
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have added the necessary documentation about the functionality in the appropriate .md file
+- [ ] I have added inline documentation to the code I modified
+
+If you have questions, please file a [support ticket](https://twilio.com/help/contact), or create a GitHub Issue in this repository.

data/README.md

@@ -1,39 +1,46 @@
 # 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)](https://rubygems.org/gems/twilio-ruby)
-[![Code Quality](http://img.shields.io/codeclimate/github/twilio/twilio-ruby.svg)][codeclimate]
+[![Build Status](https://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Gem Version](https://img.shields.io/gem/v/twilio-ruby.svg)](https://rubygems.org/gems/twilio-ruby)
+[![Learn with TwilioQuest](https://img.shields.io/static/v1?label=TwilioQuest&message=Learn%20to%20contribute%21&color=F22F46&labelColor=1f243c&style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAASFBMVEUAAAAZGRkcHBwjIyMoKCgAAABgYGBoaGiAgICMjIyzs7PJycnMzMzNzc3UoBfd3d3m5ubqrhfrMEDu7u739/f4vSb/3AD///9tbdyEAAAABXRSTlMAAAAAAMJrBrEAAAKoSURBVHgB7ZrRcuI6EESdyxXGYoNFvMD//+l2bSszRgyUYpFAsXOeiJGmj4NkuWx1Qeh+Ekl9DgEXOBwOx+Px5xyQhDykfgq4wG63MxxaR4ddIkg6Ul3g84vCIcjPBA5gmUMeXESrlukuoK33+33uID8TWeLAdOWsKpJYzwVMB7bOzYSGOciyUlXSn0/ABXTosJ1M1SbypZ4O4MbZuIDMU02PMbauhhHMHXbmebmALIiEbbbbbUrpF1gwE9kFfRNAJaP+FQEXCCTGyJ4ngDrjOFo3jEL5JdqjF/pueR4cCeCGgAtwmuRS6gDwaRiGvu+DMFwSBLTE3+jF8JyuV1okPZ+AC4hDFhCHyHQjdjPHUKFDlHSJkHQXMB3KpSwXNGJPcwwTdZiXlRN0gSp0zpWxNtM0beYE0nRH6QIbO7rawwXaBYz0j78gxjokDuv12gVeUuBD0MDi0OQCLvDaAho4juP1Q/jkAncXqIcCfd+7gAu4QLMACCLxpRsSuQh0igu0C9Svhi7weAGZg50L3IE3cai4IfkNZAC8dfdhsUD3CgKBVC9JE5ABAFzg4QL/taYPAAWrHdYcgfLaIgAXWJ7OV38n1LEF8tt2TH29E+QAoDoO5Ve/LtCQDmKM9kPbvCEBApK+IXzbcSJ0cIGF6e8gpcRhUDogWZ8JnaWjPXc/fNnBBUKRngiHgTUSivSzDRDgHZQOLvBQgf8rRt+VdBUUhwkU6VpJ+xcOwQUqZr+mR0kvBUgv6cB4+37hQAkXqE8PwGisGhJtN4xAHMzrsgvI7rccXqSvKh6jltGlrOHA3Xk1At3LC4QiPdX9/0ndHpGVvTjR4bZA1ypAKgVcwE5vx74ulwIugDt8e/X7JgfkucBMIAr26ndnB4UCLnDOqvteQsHlgX9N4A+c4cW3DXSPbwAAAABJRU5ErkJggg==)](https://twil.io/learn-open-source)
 
-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]
+**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
 
-## Recent Update
+## Documentation
+
+The documentation for the Twilio API can be found [here][apidocs].
+
+The Ruby library documentation can be found [here][libdocs] and individual releases [here][refdocs].
+
+## Versions
 
-As of release 5.1.0, Beta and Developer Preview products are now exposed via
-the main `twilio-ruby` artifact. Releases of the `alpha` branch have been
-discontinued.
+`twilio-ruby` uses a modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.
 
-If you were using the `alpha` release line, you should be able to switch back
-to the normal release line without issue.
+### Supported Ruby Versions
 
-If you were using the normal release line, you should now see several new
-product lines that were historically hidden from you due to their Beta or
-Developer Preview status. Such products are explicitly documented as
-Beta/Developer Preview both in the Twilio docs and console, as well as through
-in-line code documentation here in the library.
+This library supports the following Ruby implementations:
 
+* Ruby 2.4
+* Ruby 2.5
+* Ruby 2.6
+* Ruby 2.7
+
+### Migrating from 4.x
+
+[Upgrade Guide][upgrade]
 
 ## Installation
 
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.20.0'
+gem 'twilio-ruby', '~> 5.47.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.20.0
+gem install twilio-ruby -v 5.47.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -44,18 +51,6 @@ cd twilio-ruby
 make install
 ```
 
-### Migration from 4.x
-[Upgrade Guide][upgrade]
-
-## Documentation
-[Here][documentation]
-
-## Docker Image
-The `Dockerfile` present in this repository and its respective `twilio/twilio-ruby` Docker image are currently used by Twilio for testing purposes only.
-
-## 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
@@ -71,10 +66,57 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
+### Use An API Key
+
+```ruby
+require 'twilio-ruby'
+
+# put your own credentials here
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+api_key_sid = 'zzzzzzzzzzzzzzzzzzzzzz'
+api_key_secret = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
+
+# set up a client to talk to the Twilio REST API using an API Key
+@client = Twilio::REST::Client.new api_key_sid, api_key_secret, account_sid
+```
+
+### Specify a Region and/or Edge
+
+To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/docs/global-infrastructure), specify the target Region and/or Edge for the client:
+
+```ruby
+# set up a client to talk to the Twilio REST API over a specific region and edge
+@client = Twilio::REST::Client.new account_sid, auth_token, nil, 'au1'
+@client.edge = 'sydney'
+
+# you may also specify the region and/or edge after client creation
+@client = Twilio::REST::Client.new account_sid, auth_token
+@client.region = 'au1'
+@client.edge = 'sydney'
+```
+
+### Enable Debug logging
+
+In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
+
+```ruby
+@client = Twilio::REST::Client.new account_sid, auth_token
+myLogger = Logger.new(STDOUT)
+myLogger.level = Logger::DEBUG
+@client.logger = myLogger
+
+@client = Twilio::REST::Client.new account_sid, auth_token
+myLogger = Logger.new('my_log.log')
+myLogger.level = Logger::DEBUG
+@client.logger = myLogger
+```
+
+This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
+
 ### Make a Call
 
 ```ruby
-@client.api.account.calls.create(
+@client.calls.create(
   from: '+14159341234',
   to: '+16105557069',
   url: 'http://example.com'
@@ -84,7 +126,7 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ### Send an SMS
 
 ```ruby
-@client.api.account.messages.create(
+@client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
   body: 'Hey there!'
@@ -94,7 +136,7 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ### List your SMS Messages
 
 ```ruby
-@client.api.account.messages.list
+@client.messages.list(limit: 20)
 ```
 
 ### Fetch a single SMS message by Sid
@@ -102,21 +144,34 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ```ruby
 # put the message sid you want to retrieve here:
 message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-@client.api.account.messages(message_sid).fetch
+@client.messages(message_sid).fetch
 ```
 
 ### 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:
+
+`twilio-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
 
 ```ruby
 @client.http_client.adapter = :typhoeus
 ```
 
-## Getting Started With Client Capability Tokens
+To use a custom HTTP client with this helper library, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/custom-http-clients).
 
-If you just need to generate a Capability Token for use with Twilio Client, you
-can do this:
+### Handling Errors
+
+```ruby
+begin
+  messages = @client.messages.list(limit: 20)
+rescue Twilio::REST::RestError => e
+  puts e.message
+end
+```
+
+For more descriptive exception types, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/usage-guide#error-handling).
+
+### 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 'twilio-ruby'
@@ -140,10 +195,11 @@ capability.add_scope(incoming_scope)
 @token = capability.to_s
 ```
 
-There is a slightly more detailed document in the [Capability][capability]
-section of the wiki.
+There is a slightly more detailed document in the [Capability][capability] section of the wiki.
+
+### Generating TwiML
 
-## Getting Started With TwiML
+To control phone calls, your application needs to output [TwiML][twiml].
 
 You can construct a TwiML response like this:
 
@@ -173,25 +229,26 @@ This will print the following (except for the whitespace):
 </Response>
 ```
 
-## Supported Ruby Versions
+## Docker Image
+
+The `Dockerfile` present in this repository and its respective `twilio/twilio-ruby` Docker image are currently used by Twilio for testing purposes only.
+
+## Getting help
 
-This library supports and is [tested against][travis] the following Ruby
-implementations:
+If you need help installing or using the library, please check the [Twilio Support Help Center](https://support.twilio.com) first, and [file a support ticket](https://twilio.com/help/contact) if you don't find an answer to your question.
 
-- Ruby 2.5.0
-- Ruby 2.4.0
-- Ruby 2.3.0
-- Ruby 2.2.0
+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!
 
+[apidocs]: https://www.twilio.com/docs/api
+[twiml]: https://www.twilio.com/docs/api/twiml
+[libdocs]: https://www.twilio.com/docs/libraries/ruby
+[refdocs]: https://twilio.github.io/twilio-ruby
 [capability]: https://github.com/twilio/twilio-ruby/wiki/JWT-Tokens
-[examples]: https://github.com/twilio/twilio-ruby/blob/master/examples
-[documentation]: http://twilio.github.io/twilio-ruby
 [wiki]: https://github.com/twilio/twilio-ruby/wiki
-[bundler]: http://bundler.io
-[rubygems]: http://rubygems.org
+[bundler]: https://bundler.io
+[rubygems]: https://rubygems.org
 [gem]: https://rubygems.org/gems/twilio
-[travis]: http://travis-ci.org/twilio/twilio-ruby
-[codeclimate]: https://codeclimate.com/github/twilio/twilio-ruby
+[travis]: https://travis-ci.org/twilio/twilio-ruby
 [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