twilio-ruby 5.23.0 → 7.2.3

data/README.md

@@ -1,38 +1,51 @@
 # 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)
+[![Tests](https://github.com/twilio/twilio-ruby/actions/workflows/test-and-deploy.yml/badge.svg)][github-actions]
+[![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]
+## Documentation
+
+The documentation for the Twilio API can be found [here][apidocs].
+
+The individual releases [here][refdocs].
+
+## Versions
+
+`twilio-ruby` uses a modified version of [Semantic Versioning](https://semver.org) for all changes. [See this document](VERSIONS.md) for details.
+
+### Supported Ruby Versions
 
-## Recent Update
+This library supports the following Ruby implementations:
 
-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.
+* Ruby 2.4
+* Ruby 2.5
+* Ruby 2.6
+* Ruby 2.7
+* Ruby 3.0
+* Ruby 3.1
+* Ruby 3.2
 
-If you were using the `alpha` release line, you should be able to switch back
-to the normal release line without issue.
+* JRuby 9.2
+* JRuby 9.3
+* JRuby 9.4
 
-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.
+### Migrating from 5.x
 
+[Upgrade Guide][upgrade]
 
 ## Installation
 
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.23.0'
+gem 'twilio-ruby', '~> 7.2.3'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.23.0
+gem install twilio-ruby -v 7.2.3
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -43,40 +56,86 @@ cd twilio-ruby
 make install
 ```
 
-### Migration from 4.x
-[Upgrade Guide][upgrade]
+> **Info**
+> If the command line gives you an error message that says Permission Denied, try running the above commands with sudo.
+>
+> For example: `sudo gem install twilio-ruby`
 
-## Documentation
-[Here][documentation]
+### Test your installation
 
-## 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.
+To make sure the installation was successful, try sending yourself an SMS message, like this:
 
-## Getting help
+```rb
+require "twilio-ruby"
 
-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.
+# Your Account SID and Auth Token from console.twilio.com
+account_sid = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+auth_token = "your_auth_token"
 
-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!
+@client = Twilio::REST::Client.new account_sid, auth_token
+message = @client.messages.create(
+  body: "Hello from Ruby",
+  to: "+12345678901",  # Text this number
+  from: "+15005550006", # From a valid Twilio number
+)
+
+puts message.sid
+```
 
-## Getting Started
+> **Warning**
+> It's okay to hardcode your credentials when testing locally, but you should use environment variables to keep them secret before committing any code or deploying to production. Check out [How to Set Environment Variables](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html) for more information.
 
-### Setup Work
+## Usage
+
+### Authenticate the Client
 
 ```ruby
 require 'twilio-ruby'
 
-# put your own credentials here
+# Your Account SID and Auth Token from console.twilio.com
 account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 
-# set up a client to talk to the Twilio REST API
+# Initialize the Twilio Client with your credentials
 @client = Twilio::REST::Client.new account_sid, auth_token
 ```
 
+### Use An API Key
+
+```ruby
+require 'twilio-ruby'
+
+# Your Account SID from console.twilio.com
+account_sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+# API Key from twilio.com/console/project/api-keys
+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'
+```
+
+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'
@@ -86,7 +145,7 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ### Send an SMS
 
 ```ruby
-@client.api.account.messages.create(
+@client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
   body: 'Hey there!'
@@ -96,7 +155,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
@@ -104,21 +163,116 @@ 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
+```
+
+### Iterate through records
+
+The library automatically handles paging for you. Collections, such as `calls` and `messages`, have `list` and stream methods that page under the hood. With both `list` and `stream`, you can specify the number of records you want to receive (`limit`) and the maximum size you want each page fetch to be (`page_size`). The library will then handle the task for you.
+
+`list` eagerly fetches all records and returns them as a list, whereas `stream` returns an enumerator and lazily retrieves pages of records as you iterate over the collection. You can also page manually using the `page` method.
+
+For more information about these methods, view the [auto-generated library docs](https://www.twilio.com/docs/libraries/reference/twilio-ruby).
+
+```rb
+require 'twilio-ruby'
+
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+@client.calls.list
+       .each do |call|
+         puts call.direction
+       end
 ```
 
-### 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:
+### 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
+```
+
+### Handle Exceptions {#exceptions}
+
+If the Twilio API returns a 400 or a 500 level HTTP response, the `twilio-ruby`
+library will throw a `Twilio::REST::RestError`. 400-level errors are normal
+during API operation (`“Invalid number”`, `“Cannot deliver SMS to that number”`,
+for example) and should be handled appropriately.
+
+```rb
+require 'twilio-ruby'
+
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new account_sid, auth_token
+
+begin
+  messages = @client.messages.list(limit: 20)
+rescue Twilio::REST::RestError => e
+  puts e.message
+end
+```
+
+### Debug API requests
+
+To assist with debugging, the library allows you to access the underlying request and response objects. This capability is built into the default HTTP client that ships with the library.
+
+For example, you can retrieve the status code of the last response like so:
+
+```ruby
+require 'rubygems' # Not necessary with ruby 1.9 but included for completeness
+require 'twilio-ruby'
+
+# Your Account SID and Auth Token from console.twilio.com
+account_sid = 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+auth_token = 'your_auth_token'
+
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+@message = @client.messages.create(
+  to: '+14158675309',
+  from: '+14258675310',
+  body: 'Ahoy!'
+)
+
+# Retrieve the status code of the last response from the HTTP client
+puts @client.http_client.last_response.status_code
+```
+
+### Customize 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:
 
 ```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 [advanced example of how to do so](./advanced-examples/custom-http-client.md).
+
+To apply customizations such as middleware, you can use the `configure_connection` method like so:
+
+```ruby
+@client.http_client.configure_connection do |faraday|
+  faraday.use SomeMiddleware
+end
+```
+
+### Get started With Client Capability Tokens
 
-If you just need to generate a Capability Token for use with Twilio Client, you
-can do this:
+If you just need to generate a Capability Token for use with Twilio Client, you can do this:
 
 ```ruby
 require 'twilio-ruby'
@@ -142,10 +296,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.
 
-## Getting Started With TwiML
+### Generate TwiML
+
+To control phone calls, your application needs to output [TwiML][twiml].
 
 You can construct a TwiML response like this:
 
@@ -175,24 +330,26 @@ This will print the following (except for the whitespace):
 </Response>
 ```
 
-## Supported Ruby Versions
+## Docker Image
 
-This library supports and is [tested against][travis] the following Ruby
-implementations:
+The `Dockerfile` present in this repository and its respective `twilio/twilio-ruby` Docker image are currently used by Twilio for testing purposes only.
 
-- Ruby 2.5.0
-- Ruby 2.4.0
-- Ruby 2.3.0
-- Ruby 2.2.0
+## Getting help
+
+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.
+
+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/reference/twilio-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
+[github-actions]: https://github.com/twilio/twilio-ruby/actions/workflows/test-and-deploy.yml
 [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,57 +8,3 @@ 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/UPGRADE.md

@@ -3,6 +3,27 @@
 _After `5.0.0` all `MINOR` and `MAJOR` version bumps will have upgrade notes
 posted here._
 
+[2024-01-19] 6.x.x to 7.x.x
+-----------------------------
+### Overview
+
+##### Twilio Ruby Helper Library’s major version 7.0.0 is now available. We ensured that you can upgrade to Ruby helper Library 7.0.0 version without any breaking changes of existing apis
+
+Behind the scenes Ruby Helper is now auto-generated via OpenAPI with this release. This enables us to rapidly add new features and enhance consistency across versions and languages. 
+We're pleased to inform you that version 7.0.0 adds support for the application/json content type in the request body.
+
+To learn more about the Ruby Helper Library, check out [our docs](https://www.twilio.com/docs/libraries/ruby).
+
+[2023-05-03] 5.x.x to 6.x.x
+-----------------------------
+### Overview
+
+##### Twilio Ruby Helper Library’s major version 6.0.0 is now available. We ensured that you can upgrade to Ruby helper Library 6.0.0 version without any breaking changes
+
+Behind the scenes Ruby Helper is now auto-generated via OpenAPI with this release. This  enables us to rapidly add new features and enhance consistency across versions and languages.
+
+To learn more about the Ruby Helper Library, check out [our docs](https://www.twilio.com/docs/libraries/ruby).
+
 [2017-09-29] 5.x.x to 5.3.x
 ---------------------------
 

data/VERSIONS.md

@@ -5,11 +5,11 @@ 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`
+Semantic Versions take the form of `MAJOR.MINOR.PATCH`
 
-When bugs are fixed in the library in a backwards compatible way, the `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.
+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
@@ -19,8 +19,8 @@ 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. Breaking changes that requires extensive reworking of code
-will case the `MAJOR` version to be incremented by one, and the `MINOR` and
+the helper library. Breaking changes that require extensive reworking of code
+will cause the `MAJOR` version to be incremented by one, and the `MINOR` and
 `PATCH` versions will be reset to zero. Twilio understands that this can be very
 disruptive, so we will only introduce this type of breaking change when
 absolutely necessary. New `MAJOR` versions will be communicated in advance with
@@ -28,9 +28,8 @@ absolutely necessary. New `MAJOR` versions will be communicated in advance with
 
 ## 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 bug fixes and security updates, but no new
-features.
+Only the current `MAJOR` version of `twilio-ruby` is supported. New
+features, functionality, bug fixes, and security updates will only be added to
+the current `MAJOR` version.
 
-[semver]: http://semver.org/
+[semver]: https://semver.org

data/advanced-examples/custom-http-client.md

@@ -0,0 +1,170 @@
+# Custom HTTP Clients for the Twilio Ruby Helper Library
+
+If you are working with the Twilio Ruby Helper Library, and you need to be able to modify the HTTP requests that the library makes to the Twilio servers, you’re in the right place. The most common need to alter the HTTP request is to connect and authenticate with an enterprise’s proxy server. We’ll provide sample code that you can drop right into your app to handle this use case.
+
+Connect and authenticate with a proxy server
+To connect and provide credentials to a proxy server that may be between your app and Twilio, you need a way to modify the HTTP requests that the Twilio helper library makes on your behalf to invoke the Twilio REST API.
+
+The Twilio Ruby helper library uses the [Faraday](https://rubygems.org/gems/faraday) gem under the hood to make the HTTP requests. The following example shows a typical request, without a custom `http_client`:
+
+```rb
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+message = @client.messages
+  .create(
+    to: "+15558675310",
+    body: "Hey there!",
+    from: "+15017122661",
+  )
+```
+
+Out of the box, the helper library is creating a default `Twilio::Http::Client` for you, using the Twilio credentials you provide. However, you can create your own `Twilio::Http::Client`, and pass it to any Twilio REST API resource action you want.
+
+Here’s an example of sending an SMS message with a custom client:
+
+```rb
+# Download the helper library from https://www.twilio.com/docs/ruby/install
+require "rubygems"
+require "twilio-ruby"
+require "dotenv/load"
+
+# Custom HTTP Client
+require_relative "MyRequestClass"
+
+# Your Account Sid and Auth Token from twilio.com/console
+account_sid = ENV["ACCOUNT_SID"]
+auth_token = ENV["AUTH_TOKEN"]
+proxy_address = ENV["PROXY_ADDRESS"]
+proxy_protocol = ENV["PROXY_PROTOCOL"]
+proxy_port = ENV["PROXY_PORT"]
+
+my_request_client = MyRequestClass.new(proxy_protocol, proxy_address, proxy_port)
+
+@client = Twilio::REST::Client.new(account_sid, auth_token,
+                                   nil, nil, my_request_client)
+
+message = @client.messages
+  .create(
+    to: "+593978613041",
+    body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?",
+    from: "+13212855389",
+  )
+
+puts "Message SID: #{message.sid}"
+```
+
+## Create your custom TwilioRestClient
+
+When you take a closer look at the constructor for `Twilio::Http::Client`, you see that this class provides it to the Twilio helper library to make the necessary HTTP requests.
+
+## Call Twilio through the proxy server
+
+Now that we understand how all the components fit together, we can create our own `http_client` that can connect through a proxy server. To make this reusable, here’s a class that you can use to create this `http_client` whenever you need one.
+
+```rb
+class MyRequestClass
+  attr_accessor :adapter
+  attr_reader :timeout, :last_response, :last_request
+
+  def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, timeout: nil)
+    @proxy_prot = proxy_prot
+    @proxy_addr = proxy_addr
+    @proxy_port = proxy_port
+    @timeout = timeout
+    @adapter = Faraday.default_adapter
+  end
+
+  def _request(request)
+    @connection = Faraday.new(url: request.host + ":" + request.port.to_s, ssl: { verify: true }) do |f|
+      f.options.params_encoder = Faraday::FlatParamsEncoder
+      f.request :url_encoded
+      f.adapter @adapter
+      f.headers = request.headers
+      f.basic_auth(request.auth[0], request.auth[1])
+      if @proxy_addr
+        f.proxy = "#{@proxy_prot}://#{@proxy_addr}:#{@proxy_port}"
+      end
+      f.options.open_timeout = request.timeout || @timeout
+      f.options.timeout = request.timeout || @timeout
+    end
+
+    @last_request = request
+    @last_response = nil
+    response = @connection.send(request.method.downcase.to_sym,
+                                request.url,
+                                request.method == "GET" ? request.params : request.data)
+
+    if response.body && !response.body.empty?
+      object = response.body
+    elsif response.status == 400
+      object = { message: "Bad request", code: 400 }.to_json
+    end
+
+    twilio_response = Twilio::Response.new(response.status, object, headers: response.headers)
+    @last_response = twilio_response
+
+    twilio_response
+  end
+
+  def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+    request = Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
+    _request(request)
+  end
+end
+```
+
+In this example, we are using some environment variables loaded at the program startup to retrieve various configuration settings:
+
+- Your Twilio Account Sid and Auth Token ([found here, in the Twilio console](https://console.twilio.com))
+- A proxy address in the form of `http://127.0.0.1:8888`
+
+These settings are located in a file like `.env` like so:
+
+```env
+ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+AUTH_TOKEN= your_auth_token
+
+HTTPS_PROXY=https://127.0.0.1:8888
+HTTP_PROXY=http://127.0.0.1:8888
+```
+
+Here’s the full console program that sends a text message and shows how it all can work together. It loads the `.env` file.
+
+```rb
+# Download the helper library from https://www.twilio.com/docs/ruby/install
+require "rubygems"
+require "twilio-ruby"
+require "dotenv/load"
+
+# Custom HTTP Client
+require_relative "MyRequestClass"
+
+# Your Account Sid and Auth Token from twilio.com/console
+account_sid = ENV["ACCOUNT_SID"]
+auth_token = ENV["AUTH_TOKEN"]
+proxy_address = ENV["PROXY_ADDRESS"]
+proxy_protocol = ENV["PROXY_PROTOCOL"]
+proxy_port = ENV["PROXY_PORT"]
+
+my_request_client = MyRequestClass.new(proxy_protocol, proxy_address, proxy_port)
+
+@client = Twilio::REST::Client.new(account_sid, auth_token,
+                                   nil, nil, my_request_client)
+
+message = @client.messages
+  .create(
+    to: "+593978613041",
+    body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?",
+    from: "+13212855389",
+  )
+
+puts "Message SID: #{message.sid}"
+```
+
+## What else can this technique be used for?
+
+Now that you know how to inject your own `http_client` into the Twilio API request pipeline, you could use this technique to add custom HTTP headers and authorization to the requests (perhaps as required by an upstream proxy server).
+
+You could also implement your own `http_client` to mock the Twilio API responses so your unit and integration tests can run quickly without the need to make a connection to Twilio. In fact, there’s already an example online showing [how to do exactly that with Node.js and Prism](https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec).
+
+We can’t wait to see what you build!