twilio-ruby 5.39.2 → 5.60.0

data/CONTRIBUTING.md

@@ -105,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**.
@@ -132,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.

data/Gemfile

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

data/ISSUE_TEMPLATE.md

@@ -1,5 +1,9 @@
 <!--
 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.
+
+Note that many issues can be resolved by updating to the latest version.
 -->
 
 ### Issue Summary
@@ -21,6 +25,6 @@ A summary of the issue and the environment in which it occurs. If suitable, incl
 ```
 
 ### Technical details:
-* twilio-ruby version:
+* twilio-ruby version: 
 * ruby version:
 

data/{LICENSE.md → LICENSE}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2020, 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

data/PULL_REQUEST_TEMPLATE.md

@@ -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 master branch
+- [ ] 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,9 +1,11 @@
 # twilio-ruby
 
-[![Build Status](https://img.shields.io/travis/twilio/twilio-ruby.svg)][travis]
+[![Build Status](https://app.travis-ci.com/twilio/twilio-ruby.svg?branch=main)][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)
 
+**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].
@@ -22,6 +24,7 @@ This library supports the following Ruby implementations:
 * Ruby 2.5
 * Ruby 2.6
 * Ruby 2.7
+* Ruby 3.0
 
 ### Migrating from 4.x
 
@@ -32,13 +35,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.39.2'
+gem 'twilio-ruby', '~> 5.60.0'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.39.2
+gem install twilio-ruby -v 5.60.0
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -64,6 +67,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:
@@ -81,6 +98,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
@@ -125,6 +158,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
@@ -212,12 +253,11 @@ If you've instead found a bug in the library or would like new features added, g
 [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
 [wiki]: https://github.com/twilio/twilio-ruby/wiki
 [bundler]: https://bundler.io
 [rubygems]: https://rubygems.org
 [gem]: https://rubygems.org/gems/twilio
-[travis]: https://travis-ci.org/twilio/twilio-ruby
+[travis]: https://travis-ci.com/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

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/twilio-ruby/framework/{version.rb → rest/version.rb}

@@ -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
 
@@ -112,18 +113,13 @@ 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
 

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

@@ -16,25 +16,37 @@ module Twilio
         @ssl_ca_file = ssl_ca_file
         @timeout = timeout
         @adapter = Faraday.default_adapter
+        @configure_connection_blocks = []
+      end
+
+      def configure_connection(&block)
+        raise ArgumentError, "#{__method__} must be given a block!" unless block_given?
+
+        @configure_connection_blocks << block
+        nil
       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])
+          f.request(:basic_auth, request.auth[0], request.auth[1])
           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 response.status == 504
+          object = { message: 'Request timeout', code: 504 }.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