twilio-ruby 5.47.0 → 5.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6700c468ebeba0a532743b8fda07b0611eba016340131154d55d96066e7b2dd8
-  data.tar.gz: ffc4dcf43f721f14576d2088c86c224d5b62a46cc78d61858010a0f0e89f1208
+SHA1:
+  metadata.gz: 9f1304a55ded86707fbad7aeae0ab4ae00aee341
+  data.tar.gz: 6f48062af91bc83b1322bb4b4bb8eb2bdd304140
 SHA512:
-  metadata.gz: 2ded7f1d5f29833cda6ccd65c7d732a4c21f747cee61564898ec73ca3bce24d866046010ca7665f504537dcaf59e4c1b56f18719bc0ead92ed6185ef6646d6ad
-  data.tar.gz: 9636e0a2664beb12524698215bdb20104d6415d0be295cb363886ead20e43febd4797edd9b159239ee58607a3ac0adaf5fa3f10129a6d18382d0a4c8e6a48240
+  metadata.gz: c26962f53539a87ddbcc81754acb97e154dd437f77ddc92e5fca0308ba8074a5058241629a05f0d03cfdac432187a3f51dd7c6a5f1b190b3888497bf574d91ee
+  data.tar.gz: f79c209c112d8b914d1f625508673a1fef96e83d3e67c1fb8b654e9a21c30e7ce63754f1b6e47d98397dffadf6cd79d988ba3df184fa710dbadc6186a0bcd552

data/.github/workflows/pr-lint.yml

@@ -0,0 +1,21 @@
+name: Lint PR
+on:
+  pull_request_target:
+    types: [ opened, edited, synchronize, reopened ]
+
+jobs:
+  validate:
+    name: Validate title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        with:
+          types: |
+            chore
+            docs
+            fix
+            feat
+            misc
+            test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,129 @@
+name: Test and Deploy
+on:
+  push:
+    branches: [ '*' ]
+    tags: [ '*' ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    # Run automatically at 8AM PST Monday-Friday
+    - cron: '0 15 * * 1-5'
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', 'ruby-head', 'jruby-9.2' ]
+    steps:
+      - name: Checkout twilio-ruby
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          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'
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout twilio-ruby
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.4
+          bundler-cache: true
+
+      - run: bundle install
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_AUTH_TOKEN }}
+
+      # The expression strips off the shortest match from the front of the string to yield just the tag name as the output
+      - name: Get tagged version
+        run: echo "GITHUB_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+
+      - name: Create GitHub Release
+        uses: sendgrid/dx-automator/actions/release@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and Push image
+        run: make docker-build && make docker-push
+      - name: Publish to Rubygems
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+
+      - name: Submit metric to Datadog
+        uses: sendgrid/dx-automator/actions/datadog-release-metric@main
+        env:
+          DD_API_KEY: ${{ secrets.DATADOG_API_KEY }}
+
+  notify-on-failure:
+    name: Slack notify on failure
+    if: failure() && github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || github.ref_type == 'tag')
+    needs: [ test, deploy ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_COLOR: failure
+          SLACK_ICON_EMOJI: ':github:'
+          SLACK_MESSAGE: ${{ format('Test *{0}*, Deploy *{1}*, {2}/{3}/actions/runs/{4}', needs.test.result, needs.deploy.result, github.server_url, github.repository, github.run_id) }}
+          SLACK_TITLE: Action Failure - ${{ github.repository }}
+          SLACK_USERNAME: GitHub Actions
+          SLACK_MSG_AUTHOR: twilio-dx
+          SLACK_FOOTER: Posted automatically using GitHub Actions
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          MSG_MINIMAL: true

data/.gitignore

@@ -1,5 +1,4 @@
 *~
-.*
 !.rubocop_todo.yml
 !.rubocop.yml
 !.travis.yml
@@ -12,3 +11,8 @@ bin
 docs/_build
 *.bak
 *.iml
+.bundle
+.rakeTasks
+.yardoc
+
+coverage

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  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.
@@ -66,10 +77,11 @@ Lint/UnusedBlockArgument:
 Lint/UnusedMethodArgument:
   Exclude:
     - 'lib/twilio-ruby.rb'
-    - 'lib/twilio-ruby/framework/page.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
     - '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,37 +145,59 @@ 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/page.rb'
+    - '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:
-    - 'lib/twilio-ruby/framework/page.rb'
-    - 'lib/twilio-ruby/framework/version.rb'
+    - 'lib/twilio-ruby/framework/rest/page.rb'
+    - 'lib/twilio-ruby/framework/rest/version.rb'
     - 'lib/twilio-ruby/jwt/access_token.rb'
     - '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:
@@ -168,20 +216,35 @@ Style/RedundantSelf:
 # SupportedStyles: slashes, percent_r, mixed
 Style/RegexpLiteral:
   Exclude:
-    - 'lib/twilio-ruby/framework/domain.rb'
-    - 'lib/twilio-ruby/framework/helper.rb'
-    - 'lib/twilio-ruby/framework/version.rb'
+    - 'lib/twilio-ruby/framework/rest/domain.rb'
+    - 'lib/twilio-ruby/framework/rest/helper.rb'
+    - '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