twilio-ruby 5.74.0 → 7.10.1

data/CONTRIBUTING.md

@@ -21,8 +21,8 @@ it can be.
 ## <a name="question"></a> Got an API/Product Question or Problem?
 
 If you have questions about how to use `twilio-ruby`, please see our
-[docs][docs-link], and if you don't find the answer there, please contact
-[help@twilio.com](mailto:help@twilio.com) with any issues you have.
+[docs](./README.md), and if you don't find the answer there, please contact
+[Twilio Support](https://www.twilio.com/help/contact)  with any issues you have.
 
 ## <a name="issue"></a> Found an Issue?
 
@@ -37,6 +37,14 @@ This code was generated by
       /       /
 """
 ```
+or
+```
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+```
 then it is a generated file and the change will need to be made by us, but
 submitting an issue will help us track it and keep you up-to-date. If the file
 isn't generated, you can help us out even more by submitting a Pull Request with
@@ -68,10 +76,6 @@ you're working on.
 For large fixes, please build and test the documentation before submitting the
 PR to be sure you haven't accidentally introduced layout or formatting issues.
 
-If you want to help improve the docs at
-[https://www.twilio.com/docs/libraries/ruby][docs-link], please contact
-[help@twilio.com](mailto:help@twilio.com).
-
 ## <a name="submit"></a> Submission Guidelines
 
 ### Submitting an Issue
@@ -155,7 +159,5 @@ 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
+[github]: https://github.com/twilio/twilio-ruby

data/Dockerfile

@@ -3,7 +3,8 @@ FROM ruby:2.4
 RUN mkdir /twilio
 WORKDIR /twilio
 
-COPY . .
+COPY Rakefile Gemfile LICENSE README.md twilio-ruby.gemspec ./
+COPY lib ./lib
 
 RUN bundle install
 RUN bundle exec rake install

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 gem 'simplecov', require: false, group: :test
 gemspec
+
+gem "base64"
+gem "benchmark"
+gem "ostruct"
+gem "rexml"

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2022, Twilio, Inc. <help@twilio.com>
+Copyright (C) 2023, Twilio, Inc. <https://www.twilio.com/help/contact>
 
 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

data/Makefile

@@ -32,3 +32,9 @@ docker-push:
 	docker push twilio/twilio-ruby:${GITHUB_TAG}
 	docker push twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
 	docker push twilio/twilio-ruby:${CURRENT_TAG}
+
+cluster-test:
+	bundle exec rspec ./cluster
+
+prettier:
+	bundle exec rubocop -A -d --cache true --parallel

data/README.md

@@ -8,7 +8,7 @@
 
 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].
+The individual releases [here][refdocs].
 
 ## Versions
 
@@ -24,8 +24,13 @@ This library supports the following Ruby implementations:
 * Ruby 2.7
 * Ruby 3.0
 * Ruby 3.1
+* Ruby 3.2
 
-### Migrating from 4.x
+* JRuby 9.2
+* JRuby 9.3
+* JRuby 9.4
+
+### Migrating from 5.x
 
 [Upgrade Guide][upgrade]
 
@@ -34,13 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.74.0'
+gem 'twilio-ruby', '~> 7.10.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.74.0
+gem install twilio-ruby -v 7.10.1
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -51,18 +56,47 @@ cd twilio-ruby
 make install
 ```
 
-## Getting Started
+> **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`
+
+### Test your installation
+
+To make sure the installation was successful, try sending yourself an SMS message, like this:
+
+```rb
+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(
+  body: "Hello from Ruby",
+  to: "+12345678901",  # Text this number
+  from: "+15005550006", # From a valid Twilio number
+)
+
+puts message.sid
+```
+
+> **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
 ```
 
@@ -71,8 +105,9 @@ auth_token = 'yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy'
 ```ruby
 require 'twilio-ruby'
 
-# put your own credentials here
+# 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'
 
@@ -97,22 +132,6 @@ To take advantage of Twilio's [Global Infrastructure](https://www.twilio.com/doc
 
 This will result in the `hostname` transforming from `api.twilio.com` to `api.sydney.au1.twilio.com`.
 
-### 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
-```
-
 ### Make a Call
 
 ```ruby
@@ -147,27 +166,59 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 @client.messages(message_sid).fetch
 ```
 
-### Customizing your HTTP Client
+### Iterate through records
 
-`twilio-ruby` uses [Faraday][faraday] to make HTTP requests. You can tell `Twilio::REST::Client` to use any of the Faraday adapters like so:
+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.
 
-```ruby
-@client.http_client.adapter = :typhoeus
+`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
 ```
 
-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).
+### Enable Debug logging
 
-To apply customizations such as middleware, you can use the `configure_connection` method like so:
+In order to enable debug logging, pass in a 'logger' instance to the client with the level set to at least 'DEBUG'
 
 ```ruby
-@client.http_client.configure_connection do |faraday|
-  faraday.use SomeMiddleware
-end
+@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
 ```
 
-### Handling Errors
+### 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
 
-```ruby
 begin
   messages = @client.messages.list(limit: 20)
 rescue Twilio::REST::RestError => e
@@ -175,9 +226,51 @@ rescue Twilio::REST::RestError => e
 end
 ```
 
-For more descriptive exception types, please see the [Twilio documentation](https://www.twilio.com/docs/libraries/ruby/usage-guide#error-handling).
+### 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
+```
+
+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).
 
-### Getting Started With Client Capability Tokens
+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:
 
@@ -205,7 +298,12 @@ capability.add_scope(incoming_scope)
 
 There is a slightly more detailed document in the [Capability][capability] section of the wiki.
 
-### Generating TwiML
+## OAuth Feature for Twilio APIs
+We are introducing Client Credentials Flow-based OAuth 2.0 authentication. This feature is currently in beta and its implementation is subject to change.
+
+API examples [here](https://github.com/twilio/twilio-ruby/blob/main/examples/public_oauth.rb)
+
+### Generate TwiML
 
 To control phone calls, your application needs to output [TwiML][twiml].
 
@@ -249,7 +347,7 @@ If you've instead found a bug in the library or would like new features added, g
 
 [apidocs]: https://www.twilio.com/docs/api
 [twiml]: https://www.twilio.com/docs/api/twiml
-[libdocs]: https://www.twilio.com/docs/libraries/ruby
+[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
 [wiki]: https://github.com/twilio/twilio-ruby/wiki

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/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!

data/cluster/cluster_oauth_spec.rb

@@ -0,0 +1,19 @@
+require 'rspec/matchers'
+require 'twilio-ruby'
+require './lib/twilio-ruby/credential/client_credential_provider'
+
+describe 'Cluster Test' do
+  before(:each) do
+    @account_sid = ENV['TWILIO_ACCOUNT_SID']
+    @client_secret = ENV['TWILIO_CLIENT_SECRET']
+    @client_id = ENV['TWILIO_CLIENT_ID']
+    @message_sid = ENV['TWILIO_MESSAGE_SID']
+    @credential = Twilio::REST::ClientCredentialProvider.new(@client_id, @client_secret)
+    @client = Twilio::REST::Client.new(@account_sid).credential_provider(@credential)
+  end
+
+  it 'can fetch a message' do
+    response = @client.messages(@message_sid).fetch
+    expect(response).to_not be_nil
+  end
+end

data/cluster/cluster_orgs_spec.rb

@@ -0,0 +1,40 @@
+require 'rspec/matchers'
+require 'twilio-ruby'
+require './lib/twilio-ruby/credential/client_credential_provider'
+
+describe 'Cluster Test' do
+  before(:each) do
+    @client_secret = ENV['TWILIO_ORGS_CLIENT_SECRET']
+    @client_id = ENV['TWILIO_ORGS_CLIENT_ID']
+    @org_sid = ENV['TWILIO_ORG_SID']
+    @user_sid = ENV['TWILIO_USER_SID']
+    @account_sid = ENV['TWILIO_ORGS_ACCOUNT_SID']
+    @credential = Twilio::REST::ClientCredentialProvider.new(@client_id, @client_secret)
+    @client = Twilio::REST::Client.new.credential_provider(@credential)
+  end
+
+  it 'can list accounts' do
+    response = @client.preview_iam.organizations(@org_sid).accounts.list
+    expect(response).to_not be_nil
+  end
+
+  it 'can fetch specific account' do
+    response = @client.preview_iam.organizations(@org_sid).accounts(@account_sid).fetch
+    expect(response).to_not be_nil
+  end
+
+  it 'can access role assignments list' do
+    response = @client.preview_iam.organizations(@org_sid).role_assignments.list(scope: @account_sid)
+    expect(response).to_not be_nil
+  end
+
+  it 'can get user list' do
+    response = @client.preview_iam.organizations(@org_sid).users.list
+    expect(response).to_not be_nil
+  end
+
+  it 'can get single user' do
+    response = @client.preview_iam.organizations(@org_sid).users(@user_sid).fetch
+    expect(response).to_not be_nil
+  end
+end