twilio-ruby 5.19.0 → 5.77.0

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

data/examples/examples.rb

@@ -69,7 +69,7 @@ puts @client.messages('SMXXXXXXXX').fetch.body
 @client.messages.create(
   from: '+14159341234',
   to: '+16105557069',
-  media_urls: 'http://example.com/media.png'
+  media_url: 'http://example.com/media.png'
 )
 
 ################ PHONE NUMBERS ################

data/lib/rack/twilio_webhook_authentication.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rack/media_type'
+
 module Rack
   # Middleware that authenticates webhooks from Twilio using the request
   # validator.
@@ -19,6 +21,10 @@ module Rack
   # doesn't validate then the middleware responds immediately with a 403 status.
 
   class TwilioWebhookAuthentication
+    # Rack's FORM_DATA_MEDIA_TYPES can be modified to taste, so we're slightly
+    # more conservative in what we consider form data.
+    FORM_URLENCODED_MEDIA_TYPE = Rack::MediaType.type('application/x-www-form-urlencoded')
+
     def initialize(app, auth_token, *paths, &auth_token_lookup)
       @app = app
       @auth_token = auth_token
@@ -30,7 +36,7 @@ module Rack
       return @app.call(env) unless env['PATH_INFO'].match(@path_regex)
       request = Rack::Request.new(env)
       original_url = request.url
-      params = request.post? ? request.POST : {}
+      params = extract_params!(request)
       auth_token = @auth_token || get_auth_token(params['AccountSid'])
       validator = Twilio::Security::RequestValidator.new(auth_token)
       signature = env['HTTP_X_TWILIO_SIGNATURE'] || ''
@@ -44,5 +50,23 @@ module Rack
         ]
       end
     end
+
+    # Extract the params from the the request that we can use to determine the
+    # signature. This _may_ modify the passed in request since it may read/rewind
+    # the body.
+    def extract_params!(request)
+      return {} unless request.post?
+
+      if request.media_type == FORM_URLENCODED_MEDIA_TYPE
+        request.POST
+      else
+        request.body.rewind
+        body = request.body.read
+        request.body.rewind
+        body
+      end
+    end
+
+    private :extract_params!
   end
 end

data/lib/twilio-ruby/framework/{domain.rb → rest/domain.rb}

@@ -20,7 +20,7 @@ module Twilio
         url = uri.match(/^http/) ? uri : absolute_url(uri)
 
         @client.request(
-          @host,
+          @base_url,
           @port,
           method,
           url,

data/lib/twilio-ruby/framework/{error.rb → rest/error.rb}

@@ -11,12 +11,12 @@ module Twilio
     end
 
     class RestError < TwilioError
-      attr_reader :message, :response, :code, :status_code, :detail, :more_info, :error_message
+      attr_reader :message, :response, :code, :status_code, :details, :more_info, :error_message
 
       def initialize(message, response)
         @status_code = response.status_code
         @code = response.body.fetch('code', @status_code)
-        @detail = response.body.fetch('detail', nil)
+        @details = response.body.fetch('details', nil)
         @error_message = response.body.fetch('message', nil)
         @more_info = response.body.fetch('more_info', nil)
         @message = format_message(message)
@@ -39,7 +39,7 @@ module Twilio
       def format_message(initial_message)
         message = "[HTTP #{status_code}] #{code} : #{initial_message}"
         message += "\n#{error_message}" if error_message
-        message += "\n#{detail}" if detail
+        message += "\n#{details}" if details
         message += "\n#{more_info}" if more_info
         message + "\n\n"
       end

data/lib/twilio-ruby/framework/{version.rb → rest/version.rb}

@@ -57,7 +57,7 @@ module Twilio
         Twilio::REST::RestError.new(header, response)
       end
 
-      def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def fetch(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -68,7 +68,8 @@ module Twilio
           timeout
         )
 
-        if response.status_code < 200 || response.status_code >= 300
+        # Note that 3XX response codes are allowed for fetches.
+        if response.status_code < 200 || response.status_code >= 400
           raise exception(response, 'Unable to fetch record')
         end
 
@@ -93,7 +94,7 @@ module Twilio
         response.body
       end
 
-      def delete(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def delete(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         response = request(
           method,
           uri,
@@ -112,22 +113,17 @@ module Twilio
       end
 
       def read_limits(limit = nil, page_size = nil)
-        page_limit = nil
-
-        unless limit.nil?
-          # If there is no user-specified page_size, pick the most network efficient size
+        unless limit.nil? || page_size
           page_size = limit
-          page_limit = (limit / page_size.to_f).ceil
         end
 
         {
           limit: limit || nil,
-          page_size: page_size || nil,
-          page_limit: page_limit
+          page_size: page_size || nil
         }
       end
 
-      def page(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+      def page(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
         request(
           method,
           uri,

data/lib/twilio-ruby/http/http_client.rb

@@ -8,38 +8,49 @@ module Twilio
       attr_accessor :adapter
       attr_reader :timeout, :last_response, :last_request
 
-      def initialize(proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil, ssl_ca_file = nil,
-                     timeout: nil)
-        @proxy_addr = proxy_addr
-        @proxy_port = proxy_port
-        @proxy_user = proxy_user
-        @proxy_pass = proxy_pass
+      def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil,
+                     ssl_ca_file = nil, timeout: nil)
+        @proxy_prot = proxy_prot
+        @proxy_path = "#{proxy_addr}:#{proxy_port}" if proxy_addr && proxy_port
+        @proxy_auth = "#{proxy_user}:#{proxy_pass}@" if proxy_pass && proxy_user
         @ssl_ca_file = ssl_ca_file
         @timeout = timeout
         @adapter = Faraday.default_adapter
+        @configure_connection_blocks = []
       end
 
-      def _request(request)
+      def configure_connection(&block)
+        raise ArgumentError, "#{__method__} must be given a block!" unless block_given?
+
+        @configure_connection_blocks << block
+        nil
+      end
+
+      def _request(request) # rubocop:disable Metrics/MethodLength
         @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_user}:#{@proxy_pass}@#{@proxy_addr}:#{@proxy_port}"
+          if Faraday::VERSION.start_with?('2.')
+            f.request(:authorization, :basic, request.auth[0], request.auth[1])
+          else
+            f.request(:basic_auth, request.auth[0], request.auth[1])
           end
+          f.proxy = "#{@proxy_prot}://#{@proxy_auth}#{@proxy_path}" if @proxy_prot && @proxy_path
           f.options.open_timeout = request.timeout || @timeout
           f.options.timeout = request.timeout || @timeout
+
+          @configure_connection_blocks.each { |block| block.call(f) }
+          f.adapter @adapter
         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?
+        response = send(request)
+        if (500..599).include?(response.status)
+          object = { message: "Server error (#{response.status})", code: response.status }.to_json
+        elsif response.body && !response.body.empty?
           object = response.body
         elsif response.status == 400
           object = { message: 'Bad request', code: 400 }.to_json
@@ -51,6 +62,14 @@ module Twilio
         twilio_response
       end
 
+      def send(request)
+        @connection.send(request.method.downcase.to_sym,
+                         request.url,
+                         request.method == 'GET' ? request.params : request.data)
+      rescue Faraday::Error => e
+        raise Twilio::REST::TwilioError, e
+      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)

data/lib/twilio-ruby/http.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, 'http/**/*.rb')].sort.each do |file|
+  require file
+end

data/lib/twilio-ruby/jwt/access_token.rb

@@ -20,7 +20,8 @@ module Twilio
                     :grants,
                     :nbf,
                     :ttl,
-                    :valid_until
+                    :valid_until,
+                    :region
 
       def initialize(
         account_sid,
@@ -30,7 +31,8 @@ module Twilio
         identity: nil,
         nbf: nil,
         ttl: 3600,
-        valid_until: nil
+        valid_until: nil,
+        region: nil
       )
         super(secret_key: secret,
               issuer: signing_key_sid,
@@ -46,6 +48,7 @@ module Twilio
         @grants = grants
         @ttl = ttl
         @valid_until = valid_until
+        @region = region
       end
 
       def add_grant(grant)
@@ -76,6 +79,8 @@ module Twilio
           cty: 'twilio-fpa;v=1'
         }
 
+        headers[:twr] = region unless region&.nil?
+
         headers
       end
 
@@ -262,6 +267,19 @@ module Twilio
           payload
         end
       end
+
+      class PlaybackGrant
+        include AccessTokenGrant
+        attr_accessor :grant
+
+        def _key
+          'player'
+        end
+
+        def _generate_payload
+          grant
+        end
+      end
     end
   end
 end

data/lib/twilio-ruby/jwt/jwt.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
+require 'jwt'
+
 module Twilio
   module JWT
+    autoload :AccessToken, File.join(File.dirname(__FILE__), 'access_token.rb')
+    autoload :ClientCapability, File.join(File.dirname(__FILE__), 'client_capability.rb')
+    autoload :TaskRouterCapability, File.join(File.dirname(__FILE__), 'task_router.rb')
+
     class BaseJWT
       # valid_until overrides ttl if specified
       def initialize(secret_key: nil, issuer: nil, subject: nil, nbf: nil, ttl: 3600, valid_until: nil)

data/lib/twilio-ruby/jwt/task_router.rb

@@ -84,8 +84,8 @@ module Twilio
           [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces'].join('/')
         end
 
-        def self.workspace(worskspace_sid)
-          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', worskspace_sid].join('/')
+        def self.workspace(workspace_sid)
+          [TASK_ROUTER_BASE_URL, TASK_ROUTER_VERSION, 'Workspaces', workspace_sid].join('/')
         end
 
         def self.all_workspaces