twilio-ruby 4.6.1 → 6.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b9b36e2c61169c57d4560c5579c0fc8d55c65b2
-  data.tar.gz: c76f3204db498ccbd78e46b93a74a70c5582b757
+  metadata.gz: 5940e1a9e503399cd8005c296a5b2aca2be6824a
+  data.tar.gz: d4662a6202207667e369d54c72dd29258b9273d5
 SHA512:
-  metadata.gz: 9b88991891f9da398edc153ea409da44be754f7b99f018c42db78a71c39804059f2298a69bea3bbaad00a637b739c5a8a706571d8127b3fc659b6b700b5dc0da
-  data.tar.gz: b8d84f2af3576b336f59e6fb89694620cdb40048d9c019d1fed8d187971916923600ab0656f04d9b96d341cd9a76752c594a8c36f5c75f3fdb46ce4ac835b862
+  metadata.gz: '091b6be8f4a24aea0397c5811dce00e9fd09b742bf7d0c2095dab428f1b7a4cd4c5914f3bf387a26e3c19cdf717272ff678b42dff02bd2a704d89174eded90bc'
+  data.tar.gz: 1841f2201242ac99a614357318543b55a56582555cb23b7a31fd9b4202a9095ce1dbfa08503146e0949eed3e754fe728e67a362d907cf07ad04976289ef951d3

data/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

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,139 @@
+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', '3.2', 'ruby-head', 'jruby-9.2', 'jruby-9.3', 'jruby-9.4' ]
+    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: Run Cluster Test
+        if: (!github.event.pull_request.head.repo.fork)
+        env:
+          TWILIO_ACCOUNT_SID: ${{ secrets.TWILIO_ACCOUNT_SID }}
+          TWILIO_API_KEY: ${{ secrets.TWILIO_CLUSTER_TEST_API_KEY}}
+          TWILIO_API_SECRET: ${{ secrets.TWILIO_CLUSTER_TEST_API_KEY_SECRET }}
+          TWILIO_FROM_NUMBER: ${{ secrets.TWILIO_FROM_NUMBER }}
+          TWILIO_TO_NUMBER: ${{ secrets.TWILIO_TO_NUMBER }}
+        run: make cluster-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,8 +1,21 @@
 *~
-.*
+!.rubocop_todo.yml
+!.rubocop.yml
+!.travis.yml
+!.dockerignore
 pkg/*
 doc/*
 Gemfile.lock
 *.gem
 bin
 docs/_build
+*.bak
+*.iml
+.bundle
+.rakeTasks
+.yardoc
+.openapi-generator*
+.idea/
+
+
+coverage

data/.rubocop.yml

@@ -0,0 +1,59 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'lib/twilio-ruby/rest/**/*'
+    - 'spec/integration/**/*'
+    - 'lib/twilio-ruby/version.rb'
+    - 'lib/twilio-ruby/twiml/**/*'
+    - 'lib/twilio-ruby/util/configuration.rb'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - twilio-ruby.gemspec
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 175
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/ParameterLists:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,261 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# 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: 2
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/rack/twilio_webhook_authentication.rb'
+    - 'lib/twilio-ruby/framework/serialize.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - '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.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'spec/rack/twilio_webhook_authentication_spec.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/twilio-ruby.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:
+    - 'lib/twilio-ruby/jwt/access_token.rb'
+
+# Offense count: 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, 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:
+    - 'lib/twilio-ruby.rb'
+
+# Offense count: 2
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# 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, AllowedIdentifiers.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/jwt/task_router_spec.rb'
+
+# 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
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'twilio-ruby.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'twilio-ruby.gemspec'
+
+# 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: 2
+# Cop supports --auto-correct.
+# 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: 13
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - '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:
+  Exclude:
+    - 'lib/twilio-ruby/jwt/task_router.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/twilio-ruby/framework/serialize.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - '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: 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: 15
+# Cop supports --auto-correct.
+# Configuration parameters: AllowNamedUnderscoreVariables.
+Style/TrailingUnderscoreVariable:
+  Exclude:
+    - 'spec/jwt/access_token_spec.rb'
+    - 'spec/jwt/client_capability_spec.rb'
+    - 'spec/jwt/task_router_spec.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: brackets

data/AUTHORS.md

@@ -4,35 +4,49 @@ Authors
 A huge thanks to all of our contributors:
 
 
-- Adam Ballai
-- Alexander Murmann & Ryan Spore
-- Alexandre Payment
-- Andrew Benton
-- Brian Levine
-- Caley Woods
-- Carlos Diaz-Padron
-- Connor Montgomery
-- Doug Black
-- Elaine Tsai
-- Fiona Tay & Will Read
-- Geoff Petrie
-- Guille Carlos
-- Jeremy Franz
-- Josh Hull
-- Joël Franusic
-- K Gautam Pai
-- Karl Freeman
-- Kevin Burke
-- Kyle Conroy
-- Leo Adamek
-- Oscar
-- Oscar Sanchez
-- Phil Nash
-- Rafael Chacon
-- Ryan Cavicchioni
-- Ryan Spore
-- Sam Kimbrel
-- Tom Moor
-- Torey Heinz
-- Vipul A M
-- vfrride
+- Adam Ballai 
+- Alexander Murmann & Ryan Spore 
+- Alexandre Payment 
+- Andres Jaan Tack 
+- Andrew Benton 
+- Billy Chia 
+- Brian Levine 
+- Caley Woods 
+- Carlos Diaz-Padron 
+- Connor Montgomery 
+- Doug Black 
+- Elaine Tsai 
+- Fiona Tay & Will Read 
+- Geoff Petrie 
+- Guille Carlos 
+- Jeremy Franz 
+- Jingming Niu 
+- Josh Hull 
+- Joël Franusic 
+- K Gautam Pai 
+- Karl Freeman 
+- Karthik Sirasanagandla 
+- Kevin Burke 
+- Kush Kella 
+- Kyle Conroy 
+- Leo Adamek 
+- Matt Eldridge 
+- Matt Nowack 
+- Michael Wawra 
+- Moncef Belyamani 
+- Nate Berkopec 
+- Oscar 
+- Oscar Sanchez 
+- Phil Nash 
+- Rafael Chacon 
+- Ryan Bigg 
+- Ryan Cavicchioni 
+- Ryan Spore 
+- Sam Kimbrel 
+- Senthil Ramakrishnan 
+- Tom Moor 
+- Torey Heinz 
+- Vipul A M 
+- liz rush 
+- matt 
+- vfrride