twilio-ruby 5.76.0 → 6.0.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb7665ff7bea86c44edbe2b4951108e92eab4ade
-  data.tar.gz: a25d219b549fbf644d775f95d11cbe700986771a
+  metadata.gz: 231028f0f7e044931062a37dae8fcf18ad1e3f3b
+  data.tar.gz: 32f55aef766cc5f0471b7e8e992bf4b230e37fee
 SHA512:
-  metadata.gz: 51097797236229d44715a06d7f40719a7a6ec83162d6d3946261da44b5cc80336f35339a2a437430a3cf878387155bedbf82b7b52605523752e66d9d8638bce4
-  data.tar.gz: 1de2ed593ff359e2b2ab5e588f7b3b34d6089f45bbcb9ab81fef38982112717f3ce57d07c79670939e89a836f65722b8fbb36738086cd0f501c896552b48df94
+  metadata.gz: 4dc793687fb876d5a7df9e56ee8392581cf2a99c0e9e7ce0a6856f51449aec5d30b16e8ef92e19487ad240893e0d5fb85903bd8d7de01a235e05275f70c5732c
+  data.tar.gz: a4d1b73c690993495aaf8bc2eed953930114d1bf07c556a18569f2e6b579d31bd56679db91066476e099255ea4308f04986356484111d0d32da84e80d4aa6f7a

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

@@ -17,7 +17,7 @@ jobs:
     timeout-minutes: 20
     strategy:
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', 'ruby-head', 'jruby-9.2' ]
+        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
@@ -45,6 +45,16 @@ jobs:
       - 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

data/.gitignore

@@ -14,5 +14,8 @@ docs/_build
 .bundle
 .rakeTasks
 .yardoc
+.openapi-generator*
+.idea/
+
 
 coverage

data/CHANGES.md

@@ -1,8 +1,15 @@
 twilio-ruby changelog
 =====================
 
-[2023-04-05] Version 5.76.0
----------------------------
+[2023-04-05] Version 6.0.0-rc.2
+-------------------------------
+**Library - Fix**
+- [PR #642](https://github.com/twilio/twilio-ruby/pull/642): remove deprecated Twilio::REST::TwilioError#body. Thanks to [@kridai](https://github.com/kridai)!
+- [PR #641](https://github.com/twilio/twilio-ruby/pull/641): remove deprecated TwilioResponse class. Thanks to [@kridai](https://github.com/kridai)!
+
+**Library - Chore**
+- [PR #643](https://github.com/twilio/twilio-ruby/pull/643): extend ruby & jruby support. Thanks to [@shrutiburman](https://github.com/shrutiburman)!
+
 **Conversations**
 - Expose query parameters `start_date`, `end_date` and `state` in list operation on Conversations resource for sorting and filtering
 
@@ -19,93 +26,52 @@ twilio-ruby changelog
 - Add Brand Registrations OTP API
 
 
-[2023-03-22] Version 5.75.0
----------------------------
+[2023-03-23] Version 6.0.0-rc.1
+-------------------------------
+**Library - Fix**
+- [PR #639](https://github.com/twilio/twilio-ruby/pull/639): add all handcrafted domain files. Thanks to [@charan678](https://github.com/charan678)!
+
 **Library - Chore**
-- [PR #630](https://github.com/twilio/twilio-ruby/pull/630): Accommodate jwt's minor and patch updates. Thanks to [@sato11](https://github.com/sato11)!
+- [PR #631](https://github.com/twilio/twilio-ruby/pull/631): Add Cluster test to rc branch. Thanks to [@rohith-prakash](https://github.com/rohith-prakash)!
+- [PR #627](https://github.com/twilio/twilio-ruby/pull/627): bump jwt max version to 2.6. Thanks to [@claudiachua](https://github.com/claudiachua)!
+
+**Library - Feature**
+- [PR #622](https://github.com/twilio/twilio-ruby/pull/622): Add client base file. Thanks to [@shrutiburman](https://github.com/shrutiburman)!
 
 **Api**
 - Revert Corrected the data type for `friendly_name` in Available Phone Number Local, Mobile and TollFree resources
 - Corrected the data type for `friendly_name` in Available Phone Number Local, Mobile and TollFree resources **(breaking change)**
-
-**Messaging**
-- Add `linkshortening_messaging_service` resource
-- Add new endpoint for GetDomainConfigByMessagingServiceSid
-- Remove `validated` parameter and add `cert_in_validation` parameter to Link Shortening API **(breaking change)**
-
-
-[2023-03-09] Version 5.74.5
----------------------------
-**Api**
 - Add new categories for whatsapp template
-
-**Lookups**
-- Remove `validation_results` from the `default_output_properties`
-
-**Supersim**
-- Add ESimProfile's `matching_id` and `activation_code` parameters to libraries
-
-
-[2023-02-22] Version 5.74.4
----------------------------
-**Api**
 - Remove `scheduled_for` property from message resource
 - Add `scheduled_for` property to message resource
-
-
-[2023-02-08] Version 5.74.3
----------------------------
-**Lookups**
-- Add `disposable_phone_number_risk` package to the lookup response
-- Add `sms_pumping_risk` package to the lookup response
-
-
-[2023-01-25] Version 5.74.2
----------------------------
-**Api**
 - Add `public_application_connect_enabled` param to Application resource
-
-**Messaging**
-- Add new tollfree verification API property (ExternalReferenceId)]
-
-**Verify**
-- Add `device_ip` parameter and channel `auto` for sna/sms orchestration
-
-**Twiml**
-- Add support for `<Application>` noun and `<ApplicationSid>` noun, nested `<Parameter>` to `<Hangup>` and `<Leave>` verb
-
-
-[2023-01-11] Version 5.74.1
----------------------------
-**Library - Chore**
-- [PR #626](https://github.com/twilio/twilio-ruby/pull/626): Bump jwt version max version to 2.6. Thanks to [@MarcPer](https://github.com/MarcPer)!
+- Add `street_secondary` param to address create and update
+- Make `method` optional for user defined message subscription **(breaking change)**
 
 **Conversations**
 - Add support for creating Multi-Channel Rich Content Messages
 
-**Lookups**
-- Changed the no data message for match postal code from `no_data` to `data_not_available` in identity match package
-
-**Messaging**
-- Add update/edit tollfree verification API
-
-
-[2022-12-14] Version 5.74.0
----------------------------
-**Api**
-- Add `street_secondary` param to address create and update
-- Make `method` optional for user defined message subscription **(breaking change)**
-
 **Flex**
 - Flex Conversations is now Generally Available
 - Adding the ie1 mapping for authorization api, updating service base uri and base url response attribute **(breaking change)**
 - Change web channels to GA and library visibility to public
 - Changing the uri for authorization api from using Accounts to Insights **(breaking change)**
 
+**Lookups**
+- Remove `validation_results` from the `default_output_properties`
+- Add `disposable_phone_number_risk` package to the lookup response
+- Add `sms_pumping_risk` package to the lookup response
+- Changed the no data message for match postal code from `no_data` to `data_not_available` in identity match package
+
 **Media**
 - Gate Twilio Live endpoints behind beta_feature for EOS
 
 **Messaging**
+- Add `linkshortening_messaging_service` resource
+- Add new endpoint for GetDomainConfigByMessagingServiceSid
+- Remove `validated` parameter and add `cert_in_validation` parameter to Link Shortening API **(breaking change)**
+- Add new tollfree verification API property (ExternalReferenceId)]
+- Add update/edit tollfree verification API
 - Mark `MessageFlow` as a required field for Campaign Creation **(breaking change)**
 
 **Oauth**
@@ -113,9 +79,14 @@ twilio-ruby changelog
 - Added device code authorization endpoint
 
 **Supersim**
+- Add ESimProfile's `matching_id` and `activation_code` parameters to libraries
 - Allow filtering the SettingsUpdates resource by `status`
 
+**Verify**
+- Add `device_ip` parameter and channel `auto` for sna/sms orchestration
+
 **Twiml**
+- Add support for `<Application>` noun and `<ApplicationSid>` noun, nested `<Parameter>` to `<Hangup>` and `<Leave>` verb
 - Add new Polly Neural voices
 - Add tr-TR, ar-AE, yue-CN, fi-FI languages to SSML `<lang>` element.
 - Add x-amazon-jyutping, x-amazon-pinyin, x-amazon-pron-kana, x-amazon-yomigana alphabets to SSML `<phoneme>` element.
@@ -123,6 +94,10 @@ twilio-ruby changelog
 - Rename `role` attribute to `format` in SSML `<say-as>` element. **(breaking change)**
 
 
+[2023-03-23] Version 6.0.0-rc.0
+---------------------------
+- Release Candidate prep  
+
 [2022-11-30] Version 5.73.4
 ---------------------------
 **Flex**

data/Makefile

@@ -32,3 +32,6 @@ docker-push:
 	docker push twilio/twilio-ruby:${GITHUB_TAG}
 	docker push twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
 	docker push twilio/twilio-ruby:${CURRENT_TAG}
+
+cluster-test:
+	bundle exec rspec ./cluster_spec.rb

data/README.md

@@ -24,6 +24,11 @@ This library supports the following Ruby implementations:
 * Ruby 2.7
 * Ruby 3.0
 * Ruby 3.1
+* Ruby 3.2
+
+* JRuby 9.2
+* JRuby 9.3
+* JRuby 9.4
 
 ### Migrating from 4.x
 
@@ -34,13 +39,19 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.76.0'
+gem 'twilio-ruby', '~> 6.0.0-rc.2'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.76.0
+gem install twilio-ruby -v 6.0.0-rc.2
+```
+
+To install `twilio-ruby` release candidate via [Rubygems][rubygems] simply gem install:
+
+```bash
+gem install twilio-ruby -v 6.0.0-rc.2
 ```
 
 To build and install the development branch yourself from the latest source:

data/UPGRADE.md

@@ -3,6 +3,13 @@
 _After `5.0.0` all `MINOR` and `MAJOR` version bumps will have upgrade notes
 posted here._
 
+[2023-03-23] 5.3.x to 6.0.0-rc.x
+----------------------------
+Twilio Ruby Helper Library’s rc version 6.0.0-rc.x is now available. We ensured that you can upgrade to Ruby helper Library 6.0.0-rc version without any breaking changes.
+Behind the scenes Ruby RC Helper is now auto-generated via OpenAPI with this release. This enables us to rapidly add new features and enhance consistency across versions and languages.
+
+To learn more about the Ruby Helper Library, check out [our docs](https://www.twilio.com/docs/libraries/ruby).
+
 [2017-09-29] 5.x.x to 5.3.x
 ---------------------------
 

data/cluster_spec.rb

@@ -0,0 +1,77 @@
+require 'rspec/matchers'
+require 'twilio-ruby'
+
+# rubocop:disable Metrics/BlockLength
+describe 'Cluster Test' do
+  before(:each) do
+    @account_sid = ENV['TWILIO_ACCOUNT_SID']
+    @secret = ENV['TWILIO_API_SECRET']
+    @api_key = ENV['TWILIO_API_KEY']
+    @to_number = ENV['TWILIO_TO_NUMBER']
+    @from_number = ENV['TWILIO_FROM_NUMBER']
+    @client = Twilio::REST::Client.new @api_key, @secret, @account_sid
+  end
+
+  it 'can send a text' do
+    message = @client.messages.create(
+      to: @to_number,
+      from: @from_number,
+      body: 'Cluster test message from twilio-ruby'
+    )
+    expect(message).to_not eq(nil)
+    expect(message.body.include?('Cluster test message from twilio-ruby')).to eq(true)
+    expect(message.from).to eq(@from_number)
+    expect(message.to).to eq(@to_number)
+  end
+
+  it 'can list numbers' do
+    phone_numbers = @client.incoming_phone_numbers.list
+    expect(phone_numbers).to_not eq(nil)
+    expect(phone_numbers).to_not match_array([])
+  end
+
+  it 'list a number' do
+    phone_numbers = @client.incoming_phone_numbers.list(phone_number: @from_number)
+    expect(phone_numbers).to_not eq(nil)
+    expect(phone_numbers[0].phone_number).to eq(@from_number)
+  end
+
+  it 'allows special characters for friendly and identity name' do
+    service = @client.chat.v2.services.create(friendly_name: 'service|friendly&name')
+    expect(service).to_not eq(nil)
+
+    user = @client.chat.v2.services(service.sid).users.create(identity: 'user|identity&string')
+    expect(user).to_not eq(nil)
+
+    is_user_deleted = @client.chat.v2.services(service.sid).users(user.sid).delete
+    expect(is_user_deleted).to eq(true)
+
+    is_service_deleted = @client.chat.v2.services(service.sid).delete
+    expect(is_service_deleted).to eq(true)
+  end
+
+  it 'test list params' do
+    sink_configuration = { 'destination' => 'http://example.org/webhook', 'method' => 'post',
+                           'batch_events' => false }
+    types = [{ 'type' => 'com.twilio.messaging.message.delivered' },
+             { 'type' => 'com.twilio.messaging.message.sent' }]
+
+    sink = @client.events.v1.sinks.create(
+      description: 'test sink ruby',
+      sink_configuration: sink_configuration,
+      sink_type: 'webhook'
+    )
+    expect(sink).to_not eq(nil)
+
+    subscription = @client.events.v1.subscriptions.create(
+      description: 'test subscription ruby',
+      types: types,
+      sink_sid: sink.sid
+    )
+    expect(subscription).to_not eq(nil)
+
+    expect(@client.events.v1.subscriptions(subscription.sid).delete).to eq(true)
+    expect(@client.events.v1.sinks(sink.sid).delete).to eq(true)
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/lib/twilio-ruby/base/client_base.rb

@@ -0,0 +1,124 @@
+module Twilio
+  module REST
+    class ClientBase
+      # rubocop:disable Style/ClassVars
+      @@default_region = 'us1'
+      # rubocop:enable Style/ClassVars
+
+      attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge, :logger,
+                    :user_agent_extensions
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(username = nil, password = nil, account_sid = nil, region = nil, http_client = nil, logger = nil,
+                     user_agent_extensions = nil)
+        @username = username || Twilio.account_sid
+        @password = password || Twilio.auth_token
+        @region = region || Twilio.region
+        @edge = Twilio.edge
+        @account_sid = account_sid || @username
+        @auth_token = @password
+        @auth = [@username, @password]
+        @http_client = http_client || Twilio.http_client || Twilio::HTTP::Client.new
+        @logger = logger || Twilio.logger
+        @user_agent_extensions = user_agent_extensions || []
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # Makes a request to the Twilio API using the configured http client
+      # Authentication information is automatically added if none is provided
+      # rubocop:disable Lint/ShadowedArgument
+      def request(host, port, method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil) # rubocop:disable Metrics/MethodLength
+        auth ||= @auth
+        headers = generate_headers(method)
+        uri = build_uri(uri)
+
+        if @logger
+          @logger.debug('--BEGIN Twilio API Request--')
+          @logger.debug("Request Method: <#{method}>")
+
+          headers.each do |key, value|
+            @logger.debug("#{key}:#{value}") unless key.downcase == 'authorization'
+          end
+
+          url = URI(uri)
+          @logger.debug("Host:#{url.host}")
+          @logger.debug("Path:#{url.path}")
+          @logger.debug("Query:#{url.query}")
+          @logger.debug("Request Params:#{params}")
+        end
+
+        response = @http_client.request(
+          host,
+          port,
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+
+        if @logger
+          @logger.debug("Response Status Code:#{response.status_code}")
+          @logger.debug("Response Headers:#{response.headers}")
+          @logger.debug('--END TWILIO API REQUEST--')
+        end
+
+        response
+      end
+      # rubocop:enable Lint/ShadowedArgument
+
+      ##
+      # Build the final request uri
+      def build_uri(uri)
+        return uri if @region.nil? && @edge.nil?
+
+        parsed_url = URI(uri)
+        pieces = parsed_url.host.split('.')
+        product = pieces[0]
+        domain = pieces[-2, 2]
+        new_edge = @edge
+        new_region = @region
+
+        case pieces.length
+        when 4
+          new_region ||= pieces[1]
+        when 5
+          new_edge ||= pieces[1]
+          new_region ||= pieces[2]
+        end
+
+        new_region = @@default_region if !new_edge.nil? && new_region.nil?
+
+        parsed_url.host = [product, new_edge, new_region, domain].reject(&:nil?).join('.')
+        parsed_url.to_s
+      end
+
+      ##
+      # Validate the new SSL certificate for the Twilio API
+      def validate_ssl_certificate
+        response = request('api.twilio.com', '8443', 'GET', 'https://api.twilio.com:8443/.json')
+        return unless response.status_code < 200 || response.status_code >= 300
+
+        raise RestError.new 'Unexpected response from certificate endpoint', response
+      end
+
+      def generate_headers(method)
+        ruby_config = RbConfig::CONFIG
+        headers = {}
+        headers['User-Agent'] =
+          "twilio-ruby/#{Twilio::VERSION} (#{ruby_config['host_os']} #{ruby_config['host_cpu']}) Ruby/#{RUBY_VERSION}"
+        headers['Accept-Charset'] = 'utf-8'
+
+        user_agent_extensions.each { |extension| headers['User-Agent'] += " #{extension}" }
+
+        headers['Content-Type'] = 'application/x-www-form-urlencoded' if method == 'POST' && !headers['Content-Type']
+
+        headers['Accept'] = 'application/json' unless headers['Accept']
+        headers
+      end
+    end
+  end
+end

data/lib/twilio-ruby/framework/rest/error.rb

@@ -3,11 +3,6 @@
 module Twilio
   module REST
     class TwilioError < StandardError
-      # @deprecated all errors that have a body are now 'Twilio::RestError's
-      def body
-        warn "'Twilio::REST::TwilioError#body' has been deprecated. No 'TwilioError' objects are raised with a body."
-        nil
-      end
     end
 
     class RestError < TwilioError
@@ -23,13 +18,6 @@ module Twilio
         @response = response
       end
 
-      # @deprecated use #response instead
-      def body
-        warn 'This error used to be a "Twilio::REST::TwilioError" but is now a "Twilio::REST::RestError". ' \
-             'Please use #response instead of #body.'
-        @response
-      end
-
       def to_s
         message
       end