twilio-ruby 5.40.3 → 5.74.1

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+gem 'simplecov', require: false, group: :test
 gemspec

data/{LICENSE.md → LICENSE}

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

data/Makefile

@@ -1,33 +1,34 @@
-.PHONY: githooks install test lint docs docker-build docker-push
+.PHONY: githooks install test test-docker lint docs docker-build docker-push
 
 githooks:
 	ln -sf ../../githooks/pre-commit .git/hooks/pre-commit
 
-install: githooks
+install:
 	bundle install --with development; bundle exec rake install
 
-test: lint
+test:
 	bundle exec rake spec
 
-lint:
-	rubocop --cache true --parallel
+test-docker:
+	docker build -t twilio/twilio-ruby .
+	docker run twilio/twilio-ruby bundle exec rake spec
 
 docs:
-	yard doc --output-dir ./doc
+	bundle exec 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
 
 API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
+CURRENT_TAG=$(shell expr "${GITHUB_TAG}" : ".*-rc.*" >/dev/null && echo "rc" || echo "latest")
 docker-build:
 	docker build -t twilio/twilio-ruby .
-	docker tag twilio/twilio-ruby twilio/twilio-ruby:${TRAVIS_TAG}
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:${GITHUB_TAG}
 	docker tag twilio/twilio-ruby twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
-	docker tag twilio/twilio-ruby twilio/twilio-ruby:latest
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:${CURRENT_TAG}
 
 docker-push:
-	echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
-	docker push twilio/twilio-ruby:${TRAVIS_TAG}
+	docker push twilio/twilio-ruby:${GITHUB_TAG}
 	docker push twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
-	docker push twilio/twilio-ruby:latest
+	docker push twilio/twilio-ruby:${CURRENT_TAG}

data/PULL_REQUEST_TEMPLATE.md

@@ -3,7 +3,7 @@ We appreciate the effort for this pull request but before that please make sure
 
 Please format the PR title appropriately based on the type of change:
   <type>[!]: <description>
-Where <type> is one of: docs, chore, feat, fix, test.
+Where <type> is one of: docs, chore, feat, fix, test, misc.
 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.**
@@ -19,13 +19,13 @@ Closes #2
 A short description of what this PR does.
 
 ### Checklist
-- [ ] I acknowledge that all my contributions will be made under the project's license
+- [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](CONTRIBUTING.md) and my PR follows them
+- [ ] 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 necessary documentation about the functionality in the appropriate .md file
+- [ ] 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,11 +1,9 @@
 # twilio-ruby
 
-[![Build Status](https://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![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)
 
-**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
-
 ## Documentation
 
 The documentation for the Twilio API can be found [here][apidocs].
@@ -24,6 +22,8 @@ This library supports the following Ruby implementations:
 * Ruby 2.5
 * Ruby 2.6
 * Ruby 2.7
+* Ruby 3.0
+* Ruby 3.1
 
 ### Migrating from 4.x
 
@@ -34,13 +34,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.40.3'
+gem 'twilio-ruby', '~> 5.74.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.40.3
+gem install twilio-ruby -v 5.74.1
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -66,6 +66,20 @@ 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:
@@ -83,6 +97,22 @@ 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
@@ -127,6 +157,14 @@ message_sid = 'SMxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
 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).
 
+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
+```
+
 ### Handling Errors
 
 ```ruby
@@ -218,7 +256,7 @@ If you've instead found a bug in the library or would like new features added, g
 [bundler]: https://bundler.io
 [rubygems]: https://rubygems.org
 [gem]: https://rubygems.org/gems/twilio
-[travis]: https://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/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/http/http_client.rb

@@ -16,25 +16,41 @@ module Twilio
         @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 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 = send(request)
-        if response.body && !response.body.empty?
+        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

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/rest/accounts/v1/auth_token_promotion.rb

@@ -0,0 +1,186 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Accounts < Domain
+      class V1 < Version
+        class AuthTokenPromotionList < ListResource
+          ##
+          # Initialize the AuthTokenPromotionList
+          # @param [Version] version Version that contains the resource
+          # @return [AuthTokenPromotionList] AuthTokenPromotionList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Accounts.V1.AuthTokenPromotionList>'
+          end
+        end
+
+        class AuthTokenPromotionPage < Page
+          ##
+          # Initialize the AuthTokenPromotionPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [AuthTokenPromotionPage] AuthTokenPromotionPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of AuthTokenPromotionInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [AuthTokenPromotionInstance] AuthTokenPromotionInstance
+          def get_instance(payload)
+            AuthTokenPromotionInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Accounts.V1.AuthTokenPromotionPage>'
+          end
+        end
+
+        class AuthTokenPromotionContext < InstanceContext
+          ##
+          # Initialize the AuthTokenPromotionContext
+          # @param [Version] version Version that contains the resource
+          # @return [AuthTokenPromotionContext] AuthTokenPromotionContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/AuthTokens/Promote"
+          end
+
+          ##
+          # Update the AuthTokenPromotionInstance
+          # @return [AuthTokenPromotionInstance] Updated AuthTokenPromotionInstance
+          def update
+            payload = @version.update('POST', @uri)
+
+            AuthTokenPromotionInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Accounts.V1.AuthTokenPromotionContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Accounts.V1.AuthTokenPromotionContext #{context}>"
+          end
+        end
+
+        class AuthTokenPromotionInstance < InstanceResource
+          ##
+          # Initialize the AuthTokenPromotionInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [AuthTokenPromotionInstance] AuthTokenPromotionInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'auth_token' => payload['auth_token'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {}
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [AuthTokenPromotionContext] AuthTokenPromotionContext for this AuthTokenPromotionInstance
+          def context
+            unless @instance_context
+              @instance_context = AuthTokenPromotionContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that the secondary Auth Token was created for
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The promoted Auth Token
+          def auth_token
+            @properties['auth_token']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 formatted date and time in UTC when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 formatted date and time in UTC when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the AuthTokenPromotionInstance
+          # @return [AuthTokenPromotionInstance] Updated AuthTokenPromotionInstance
+          def update
+            context.update
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Accounts.V1.AuthTokenPromotionInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Accounts.V1.AuthTokenPromotionInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end