twilio-ruby 5.63.0 → 5.63.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 582f6e6561bd6ee40a9aadaefc0e2550df5d565f
-  data.tar.gz: 8ec0f4c692bd66e1da3a7ea99d58f4ddaa8b6d0c
+  metadata.gz: 713fb3456ac1cc81c84708c98ab9182982c87e9e
+  data.tar.gz: 19b87b511ac9133faca93426a3ba61faadfbd7d3
 SHA512:
-  metadata.gz: 5864ca88585ee5e2f4952218d1c85180caac3e0b0c4361836e8cc850c2e1fc716f20d0fcd931df29e03e05e54ad4c5bb9c93d46eda5e6e94f8d3aee5a6aa0e64
-  data.tar.gz: 26560b4c09aa1161baac7ba7ac3c83bebe154b4a923e71e550e03742614c1d51e4ef086b747e83645c27f2092eb05a8c811f23f0f7636f0b8f6e191407513fa0
+  metadata.gz: '08a2bb565a77837293ad33f4d80c6a2ba1b7f6d853097ce420576aab813651e84887244f8618e79a638e33c8a52d97c5450028bf1be9de1d08a62777e521d923'
+  data.tar.gz: 34bc361cb1f619c6cad3d89bfe6022518c72dd73ba2f7a17884784a317520adc1e0c0adccba6dab264da3d747ccedd1b5beec0e3ddf46911a7696c711535e5c0

data/.github/workflows/test-and-deploy.yml

@@ -18,10 +18,11 @@ jobs:
     strategy:
       matrix:
         ruby: [ 2.4, 2.5, 2.6, 2.7, '3.0', ruby-head, jruby-9.2 ]
-    continue-on-error: ${{ matrix.ruby == 'ruby-head' }}
     steps:
       - name: Checkout twilio-ruby
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -29,11 +30,34 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
+      # Excludes incompatible versions of ruby
+      - name: Set up linter
+        run: bundle add rubocop --version "~> 1.24.1" --group "development" --skip-install
+        if: ${{ matrix.ruby != '2.4' }}
+
       - run: bundle install --with development
       - run: bundle exec rake install
+
+      - name: Run linter
+        run: bundle exec rubocop -d --cache true --parallel
+        if: ${{ matrix.ruby != '2.4' }}
+
       - name: Run Unit Tests
         run: make test
 
+      - name: Fix code coverage paths
+        if: ${{ (github.event_name == 'pull_request' || github.ref_type == 'branch') && matrix.ruby == '3.0' && !github.event.pull_request.head.repo.fork }}
+        working-directory: ./coverage
+        run: |
+          sed -i 's@'$GITHUB_WORKSPACE'@/github/workspace/@g' coverage.json
+
+      - name: SonarCloud Scan
+        if: ${{ (github.event_name == 'pull_request' || github.ref_type == 'branch') && matrix.ruby == '3.0' && !github.event.pull_request.head.repo.fork }}
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+
   deploy:
     name: Deploy
     if: success() && github.ref_type == 'tag'

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
     - 'lib/twilio-ruby/rest/**/*'
     - 'spec/integration/**/*'

data/.rubocop_todo.yml

@@ -1,14 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-29 14:57:47 -0500 using RuboCop version 0.82.0.
+# on 2022-01-13 21:45:15 UTC using RuboCop version 1.24.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
 # Include: **/*.gemspec
 Gemspec/OrderedDependencies:
   Exclude:
@@ -28,13 +28,6 @@ Layout/EmptyLineAfterGuardClause:
     - 'lib/rack/twilio_webhook_authentication.rb'
     - 'lib/twilio-ruby/framework/serialize.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'twilio-ruby.gemspec'
-
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
@@ -53,6 +46,24 @@ Layout/SpaceInsideHashLiteralBraces:
     - 'spec/jwt/access_token_spec.rb'
     - 'spec/jwt/client_capability_spec.rb'
 
+# Offense count: 3
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/rest/client_spec.rb'
+
+# Offense count: 1
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/error.rb'
+
+# Offense count: 1
+Lint/SelfAssignment:
+  Exclude:
+    - 'lib/twilio-ruby/framework/rest/version.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
@@ -70,6 +81,7 @@ Lint/UnusedMethodArgument:
     - 'spec/holodeck/holodeck.rb'
 
 # Offense count: 1
+# Cop supports --auto-correct.
 # Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
 Lint/UselessAccessModifier:
   Exclude:
@@ -80,8 +92,14 @@ Lint/UselessAssignment:
   Exclude:
     - 'spec/rack/twilio_webhook_authentication_spec.rb'
 
+# Offense count: 6
+# Configuration parameters: Max, CountKeywordArgs.
+Metrics/ParameterLists:
+  MaxOptionalParameters: 6
+
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Naming/FileName:
   Exclude:
@@ -89,20 +107,28 @@ Naming/FileName:
 
 # Offense count: 2
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
     - 'lib/twilio-ruby/security/request_validator.rb'
 
 # Offense count: 19
-# Configuration parameters: EnforcedStyle.
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers.
 # SupportedStyles: snake_case, camelCase
 Naming/VariableName:
   Exclude:
     - 'spec/jwt/client_capability_spec.rb'
     - 'spec/jwt/task_router_spec.rb'
 
-# Offense count: 39
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/CaseLikeIf:
+  Exclude:
+    - 'lib/twilio-ruby/framework/serialize.rb'
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 40
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
@@ -119,28 +145,36 @@ Style/ExpandPathArguments:
     - 'spec/spec_helper.rb'
     - 'twilio-ruby.gemspec'
 
-# Offense count: 23
+# Offense count: 24
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'spec/rest/client_spec.rb'
+
 # Offense count: 3
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/twilio-ruby/framework/rest/page.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never
 Style/HashSyntax:
   Exclude:
+    - 'Gemfile'
     - 'spec/jwt/access_token_spec.rb'
 
-# Offense count: 12
+# Offense count: 13
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
@@ -150,6 +184,20 @@ Style/IfUnlessModifier:
     - 'lib/twilio-ruby/jwt/client_capability.rb'
     - 'lib/twilio-ruby/jwt/jwt.rb'
 
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/RedundantAssignment:
+  Exclude:
+    - 'lib/twilio-ruby/jwt/access_token.rb'
+    - 'lib/twilio-ruby/jwt/client_capability.rb'
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantFileExtensionInRequire:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
 # Offense count: 4
 # Cop supports --auto-correct.
 Style/RedundantFreeze:
@@ -173,15 +221,30 @@ Style/RegexpLiteral:
     - 'lib/twilio-ruby/framework/rest/version.rb'
     - 'spec/rack/twilio_webhook_authentication_spec.rb'
 
-# Offense count: 5
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'examples/print_call_log.rb'
+    - 'lib/twilio-ruby/framework/request.rb'
+    - 'lib/twilio-ruby/framework/rest/error.rb'
+    - 'lib/twilio-ruby/framework/serialize.rb'
+    - 'lib/twilio-ruby/http/http_client.rb'
+    - 'lib/twilio-ruby/jwt/client_capability.rb'
+    - 'spec/framework/request_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 7
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
   Exclude:
+    - 'Gemfile'
     - 'spec/framework/serialize_spec.rb'
 
-# Offense count: 14
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: AllowNamedUnderscoreVariables.
 Style/TrailingUnderscoreVariable:
@@ -190,7 +253,7 @@ Style/TrailingUnderscoreVariable:
     - 'spec/jwt/client_capability_spec.rb'
     - 'spec/jwt/task_router_spec.rb'
 
-# Offense count: 15
+# Offense count: 16
 # Cop supports --auto-correct.
 # Configuration parameters: MinSize, WordRegex.
 # SupportedStyles: percent, brackets

data/CHANGES.md

@@ -1,6 +1,27 @@
 twilio-ruby changelog
 =====================
 
+[2022-01-26] Version 5.63.1
+---------------------------
+**Library - Fix**
+- [PR #590](https://github.com/twilio/twilio-ruby/pull/590): Validate signatures in Rack middleware for non-form-data payloads. Thanks to [@gabrielg](https://github.com/gabrielg)!
+
+**Library - Chore**
+- [PR #589](https://github.com/twilio/twilio-ruby/pull/589): Add sonarcloud analysis. Thanks to [@BrimmingDev](https://github.com/BrimmingDev)!
+- [PR #588](https://github.com/twilio/twilio-ruby/pull/588): support for rubocop linting on ruby-head. Thanks to [@Hunga1](https://github.com/Hunga1)!
+
+**Insights**
+- Added new endpoint to fetch Conference Participant Summary
+- Added new endpoint to fetch Conference Summary
+
+**Messaging**
+- Add government_entity parameter to brand apis
+
+**Verify**
+- Add Access Token fetch endpoint to retrieve a previously created token.
+- Add Access Token payload to the Access Token creation endpoint, including a unique Sid, so it's addressable while it's TTL is valid.
+
+
 [2022-01-12] Version 5.63.0
 ---------------------------
 **Library - Feature**

data/Makefile

@@ -6,12 +6,9 @@ githooks:
 install:
 	bundle install --with development; bundle exec rake install
 
-test: lint
+test:
 	bundle exec rake spec
 
-lint:
-	bundle exec rubocop -d --cache true --parallel
-
 docs:
 	bundle exec yard doc --output-dir ./doc
 

data/README.md

@@ -35,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.63.0'
+gem 'twilio-ruby', '~> 5.63.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.63.0
+gem install twilio-ruby -v 5.63.1
 ```
 
 To build and install the development branch yourself from the latest source:

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/rest/flex_api/v1/flex_flow.rb

@@ -115,8 +115,13 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
           # @param [flex_flow.IntegrationType] integration_type The software that will
@@ -151,10 +156,10 @@ module Twilio
           # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
-          # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
-          #   default is 3. Optional when `integrationType` is `external`, not applicable
-          #   otherwise.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Created FlexFlowInstance
           def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -246,8 +251,13 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
           # @param [flex_flow.IntegrationType] integration_type The software that will
@@ -282,10 +292,10 @@ module Twilio
           # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
-          # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
-          #   default is 3. Optional when `integrationType` is `external`, not applicable
-          #   otherwise.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -475,8 +485,13 @@ module Twilio
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
-          # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
-          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
+          # @param [flex_flow.ChannelType] channel_type The channel type. One of `web`,
+          #   `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio’s Send to
+          #   Flex widget passes it on to the Task attributes for Tasks created based on this
+          #   Flex Flow. The Task attributes will be used by the Flex UI to render the
+          #   respective Task as appropriate (applying channel-specific design and length
+          #   limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex
+          #   widget should set the Task Channel to Programmable Chat.
           # @param [String] contact_identity The channel contact's Identity.
           # @param [Boolean] enabled Whether the new Flex Flow is enabled.
           # @param [flex_flow.IntegrationType] integration_type The software that will
@@ -511,10 +526,10 @@ module Twilio
           # @param [Boolean] janitor_enabled When enabled, the Messaging Channel Janitor
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
-          # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
-          #   default is 3. Optional when `integrationType` is `external`, not applicable
-          #   otherwise.
+          # @param [String] integration_retry_count The number of times to retry the Studio
+          #   Flow or webhook in case of failure. Takes integer values from 0 to 3 with the
+          #   default being 3. Optional when `integrationType` is `studio` or `external`, not
+          #   applicable otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             context.update(