twilio-ruby 6.0.0.pre.rc.3 → 6.0.1

data/advanced-examples/custom-http-client.md

@@ -0,0 +1,170 @@
+# Custom HTTP Clients for the Twilio Ruby Helper Library
+
+If you are working with the Twilio Ruby Helper Library, and you need to be able to modify the HTTP requests that the library makes to the Twilio servers, you’re in the right place. The most common need to alter the HTTP request is to connect and authenticate with an enterprise’s proxy server. We’ll provide sample code that you can drop right into your app to handle this use case.
+
+Connect and authenticate with a proxy server
+To connect and provide credentials to a proxy server that may be between your app and Twilio, you need a way to modify the HTTP requests that the Twilio helper library makes on your behalf to invoke the Twilio REST API.
+
+The Twilio Ruby helper library uses the [Faraday](https://rubygems.org/gems/faraday) gem under the hood to make the HTTP requests. The following example shows a typical request, without a custom `http_client`:
+
+```rb
+@client = Twilio::REST::Client.new(account_sid, auth_token)
+
+message = @client.messages
+  .create(
+    to: "+15558675310",
+    body: "Hey there!",
+    from: "+15017122661",
+  )
+```
+
+Out of the box, the helper library is creating a default `Twilio::Http::Client` for you, using the Twilio credentials you provide. However, you can create your own `Twilio::Http::Client`, and pass it to any Twilio REST API resource action you want.
+
+Here’s an example of sending an SMS message with a custom client:
+
+```rb
+# Download the helper library from https://www.twilio.com/docs/ruby/install
+require "rubygems"
+require "twilio-ruby"
+require "dotenv/load"
+
+# Custom HTTP Client
+require_relative "MyRequestClass"
+
+# Your Account Sid and Auth Token from twilio.com/console
+account_sid = ENV["ACCOUNT_SID"]
+auth_token = ENV["AUTH_TOKEN"]
+proxy_address = ENV["PROXY_ADDRESS"]
+proxy_protocol = ENV["PROXY_PROTOCOL"]
+proxy_port = ENV["PROXY_PORT"]
+
+my_request_client = MyRequestClass.new(proxy_protocol, proxy_address, proxy_port)
+
+@client = Twilio::REST::Client.new(account_sid, auth_token,
+                                   nil, nil, my_request_client)
+
+message = @client.messages
+  .create(
+    to: "+593978613041",
+    body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?",
+    from: "+13212855389",
+  )
+
+puts "Message SID: #{message.sid}"
+```
+
+## Create your custom TwilioRestClient
+
+When you take a closer look at the constructor for `Twilio::Http::Client`, you see that this class provides it to the Twilio helper library to make the necessary HTTP requests.
+
+## Call Twilio through the proxy server
+
+Now that we understand how all the components fit together, we can create our own `http_client` that can connect through a proxy server. To make this reusable, here’s a class that you can use to create this `http_client` whenever you need one.
+
+```rb
+class MyRequestClass
+  attr_accessor :adapter
+  attr_reader :timeout, :last_response, :last_request
+
+  def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, timeout: nil)
+    @proxy_prot = proxy_prot
+    @proxy_addr = proxy_addr
+    @proxy_port = proxy_port
+    @timeout = timeout
+    @adapter = Faraday.default_adapter
+  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])
+      if @proxy_addr
+        f.proxy = "#{@proxy_prot}://#{@proxy_addr}:#{@proxy_port}"
+      end
+      f.options.open_timeout = request.timeout || @timeout
+      f.options.timeout = request.timeout || @timeout
+    end
+
+    @last_request = request
+    @last_response = nil
+    response = @connection.send(request.method.downcase.to_sym,
+                                request.url,
+                                request.method == "GET" ? request.params : request.data)
+
+    if response.body && !response.body.empty?
+      object = response.body
+    elsif response.status == 400
+      object = { message: "Bad request", code: 400 }.to_json
+    end
+
+    twilio_response = Twilio::Response.new(response.status, object, headers: response.headers)
+    @last_response = twilio_response
+
+    twilio_response
+  end
+
+  def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+    request = Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
+    _request(request)
+  end
+end
+```
+
+In this example, we are using some environment variables loaded at the program startup to retrieve various configuration settings:
+
+- Your Twilio Account Sid and Auth Token ([found here, in the Twilio console](https://console.twilio.com))
+- A proxy address in the form of `http://127.0.0.1:8888`
+
+These settings are located in a file like `.env` like so:
+
+```env
+ACCOUNT_SID=ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+AUTH_TOKEN= your_auth_token
+
+HTTPS_PROXY=https://127.0.0.1:8888
+HTTP_PROXY=http://127.0.0.1:8888
+```
+
+Here’s the full console program that sends a text message and shows how it all can work together. It loads the `.env` file.
+
+```rb
+# Download the helper library from https://www.twilio.com/docs/ruby/install
+require "rubygems"
+require "twilio-ruby"
+require "dotenv/load"
+
+# Custom HTTP Client
+require_relative "MyRequestClass"
+
+# Your Account Sid and Auth Token from twilio.com/console
+account_sid = ENV["ACCOUNT_SID"]
+auth_token = ENV["AUTH_TOKEN"]
+proxy_address = ENV["PROXY_ADDRESS"]
+proxy_protocol = ENV["PROXY_PROTOCOL"]
+proxy_port = ENV["PROXY_PORT"]
+
+my_request_client = MyRequestClass.new(proxy_protocol, proxy_address, proxy_port)
+
+@client = Twilio::REST::Client.new(account_sid, auth_token,
+                                   nil, nil, my_request_client)
+
+message = @client.messages
+  .create(
+    to: "+593978613041",
+    body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?",
+    from: "+13212855389",
+  )
+
+puts "Message SID: #{message.sid}"
+```
+
+## What else can this technique be used for?
+
+Now that you know how to inject your own `http_client` into the Twilio API request pipeline, you could use this technique to add custom HTTP headers and authorization to the requests (perhaps as required by an upstream proxy server).
+
+You could also implement your own `http_client` to mock the Twilio API responses so your unit and integration tests can run quickly without the need to make a connection to Twilio. In fact, there’s already an example online showing [how to do exactly that with Node.js and Prism](https://www.twilio.com/docs/openapi/mock-api-generation-with-twilio-openapi-spec).
+
+We can’t wait to see what you build!

data/lib/twilio-ruby/rest/api/v2010/account/address.rb

@@ -285,13 +285,8 @@ module Twilio
                     def dependent_phone_numbers
                       unless @dependent_phone_numbers
                         @dependent_phone_numbers = DependentPhoneNumberList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                address_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  address_sid: @solution[:sid], )
                       end
-
                       @dependent_phone_numbers
                     end
 

data/lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country.rb

@@ -170,13 +170,8 @@ module Twilio
                     def voip
                       unless @voip
                         @voip = VoipList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @voip
                     end
                     ##
@@ -186,13 +181,8 @@ module Twilio
                     def national
                       unless @national
                         @national = NationalList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @national
                     end
                     ##
@@ -202,13 +192,8 @@ module Twilio
                     def mobile
                       unless @mobile
                         @mobile = MobileList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @mobile
                     end
                     ##
@@ -218,13 +203,8 @@ module Twilio
                     def machine_to_machine
                       unless @machine_to_machine
                         @machine_to_machine = MachineToMachineList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @machine_to_machine
                     end
                     ##
@@ -234,13 +214,8 @@ module Twilio
                     def toll_free
                       unless @toll_free
                         @toll_free = TollFreeList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @toll_free
                     end
                     ##
@@ -250,13 +225,8 @@ module Twilio
                     def shared_cost
                       unless @shared_cost
                         @shared_cost = SharedCostList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @shared_cost
                     end
                     ##
@@ -266,13 +236,8 @@ module Twilio
                     def local
                       unless @local
                         @local = LocalList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                available_phone_number_country_country_code: @solution[:country_code]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  country_code: @solution[:country_code], )
                       end
-
                       @local
                     end
 

data/lib/twilio-ruby/rest/api/v2010/account/call.rb

@@ -431,13 +431,8 @@ module Twilio
                     def events
                       unless @events
                         @events = EventList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                       end
-
                       @events
                     end
                     ##
@@ -447,13 +442,8 @@ module Twilio
                     def user_defined_messages
                       unless @user_defined_messages
                         @user_defined_messages = UserDefinedMessageList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                       end
-
                       @user_defined_messages
                     end
                     ##
@@ -470,11 +460,7 @@ module Twilio
 
                         unless @siprec
                             @siprec = SiprecList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @siprec
@@ -493,11 +479,7 @@ module Twilio
 
                         unless @user_defined_message_subscriptions
                             @user_defined_message_subscriptions = UserDefinedMessageSubscriptionList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @user_defined_message_subscriptions
@@ -516,11 +498,7 @@ module Twilio
 
                         unless @payments
                             @payments = PaymentList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @payments
@@ -539,11 +517,7 @@ module Twilio
 
                         unless @recordings
                             @recordings = RecordingList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @recordings
@@ -562,11 +536,7 @@ module Twilio
 
                         unless @notifications
                             @notifications = NotificationList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @notifications
@@ -596,11 +566,7 @@ module Twilio
 
                         unless @streams
                             @streams = StreamList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                call_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  call_sid: @solution[:sid], )
                         end
 
                      @streams

data/lib/twilio-ruby/rest/api/v2010/account/conference.rb

@@ -255,11 +255,7 @@ module Twilio
 
                         unless @recordings
                             @recordings = RecordingList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                conference_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  conference_sid: @solution[:sid], )
                         end
 
                      @recordings
@@ -278,11 +274,7 @@ module Twilio
 
                         unless @participants
                             @participants = ParticipantList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                conference_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  conference_sid: @solution[:sid], )
                         end
 
                      @participants

data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/assigned_add_on.rb

@@ -205,12 +205,7 @@ module Twilio
 
                         unless @extensions
                             @extensions = AssignedAddOnExtensionList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                resource_sid: @solution[:resource_sid],
-                                assigned_add_on_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  resource_sid: @solution[:resource_sid],  assigned_add_on_sid: @solution[:sid], )
                         end
 
                      @extensions

data/lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number.rb

@@ -407,11 +407,7 @@ module Twilio
 
                         unless @assigned_add_ons
                             @assigned_add_ons = AssignedAddOnList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                incoming_phone_number_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  resource_sid: @solution[:sid], )
                         end
 
                      @assigned_add_ons

data/lib/twilio-ruby/rest/api/v2010/account/message.rb

@@ -315,13 +315,8 @@ module Twilio
                     def feedback
                       unless @feedback
                         @feedback = FeedbackList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                message_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  message_sid: @solution[:sid], )
                       end
-
                       @feedback
                     end
                     ##
@@ -338,11 +333,7 @@ module Twilio
 
                         unless @media
                             @media = MediaList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                message_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  message_sid: @solution[:sid], )
                         end
 
                      @media

data/lib/twilio-ruby/rest/api/v2010/account/queue.rb

@@ -226,11 +226,7 @@ module Twilio
 
                         unless @members
                             @members = MemberList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                queue_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  queue_sid: @solution[:sid], )
                         end
 
                      @members

data/lib/twilio-ruby/rest/api/v2010/account/recording/add_on_result.rb

@@ -182,12 +182,7 @@ module Twilio
 
                         unless @payloads
                             @payloads = PayloadList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                reference_sid: @solution[:reference_sid],
-                                add_on_result_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  reference_sid: @solution[:reference_sid],  add_on_result_sid: @solution[:sid], )
                         end
 
                      @payloads

data/lib/twilio-ruby/rest/api/v2010/account/recording.rb

@@ -228,11 +228,7 @@ module Twilio
 
                         unless @add_on_results
                             @add_on_results = AddOnResultList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                recording_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  reference_sid: @solution[:sid], )
                         end
 
                      @add_on_results
@@ -251,11 +247,7 @@ module Twilio
 
                         unless @transcriptions
                             @transcriptions = TranscriptionList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                recording_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  recording_sid: @solution[:sid], )
                         end
 
                      @transcriptions

data/lib/twilio-ruby/rest/api/v2010/account/sip/credential_list.rb

@@ -221,11 +221,7 @@ module Twilio
 
                         unless @credentials
                             @credentials = CredentialList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                credential_list_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  credential_list_sid: @solution[:sid], )
                         end
 
                      @credentials

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

@@ -288,13 +288,8 @@ module Twilio
                     def auth
                       unless @auth
                         @auth = AuthTypesList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                domain_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  domain_sid: @solution[:sid], )
                       end
-
                       @auth
                     end
                     ##
@@ -311,11 +306,7 @@ module Twilio
 
                         unless @ip_access_control_list_mappings
                             @ip_access_control_list_mappings = IpAccessControlListMappingList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                domain_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  domain_sid: @solution[:sid], )
                         end
 
                      @ip_access_control_list_mappings
@@ -334,11 +325,7 @@ module Twilio
 
                         unless @credential_list_mappings
                             @credential_list_mappings = CredentialListMappingList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                domain_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  domain_sid: @solution[:sid], )
                         end
 
                      @credential_list_mappings

data/lib/twilio-ruby/rest/api/v2010/account/sip/ip_access_control_list.rb

@@ -221,11 +221,7 @@ module Twilio
 
                         unless @ip_addresses
                             @ip_addresses = IpAddressList.new(
-                                @version,
-                                account_sid: @solution[:account_sid],
-                                ip_access_control_list_sid: @solution[:sid]
-                                
-                                )
+                                @version, account_sid: @solution[:account_sid],  ip_access_control_list_sid: @solution[:sid], )
                         end
 
                      @ip_addresses