twilio-ruby 3.12.3 → 3.13.0

data/docs/usage/sip.rst

@@ -27,9 +27,9 @@ under sip.twilio.com.
     @client = Twilio::REST::Client.new account_sid, auth_token
 
     @domain = @client.sip.domains.create(
-        {:friendly_name => "The Office Domain",
-         :voice_url => "http://example.com/voice",
-         :domain_name => "dunder-mifflin-scranton.sip.twilio.com",}
+      friendly_name: "The Office Domain",
+      voice_url: "http://example.com/voice"
+      domain_name: "dunder-mifflin-scranton.sip.twilio.com"
     )
     puts @domain.sid
 
@@ -51,7 +51,7 @@ to individual ip addresses. To do this, you'll first need to create an
     @client = Twilio::REST::Client.new account_sid, auth_token
 
     @ip_acl = @client.sip.ip_access_control_lists.create(
-        {:friendly_name => "The Office IpAccessControlList",}
+      friendly_name: "The Office IpAccessControlList"
     )
     puts @ip_acl.sid
 
@@ -71,10 +71,10 @@ Now it's time to add an :class:`IpAddress` to your new :class:`IpAccessControlLi
     @client = Twilio::REST::Client.new account_sid, auth_token
 
     @ip_address = @client.sip.ip_access_control_lists.get(
-        "AL456",  # IpAccessControlList sid
+      "AL456",  # IpAccessControlList sid
     ).ip_addresses.create(
-        {:friendly_name => "Dwights's Computer",
-         :ip_address => "192.168.1.42",}
+      friendly_name: "Dwights's Computer",
+      ip_address: "192.168.1.42"
     )
     puts @ip_address.sid
 
@@ -97,7 +97,8 @@ associate them. To do this, create an :class:`IpAccessControlListMapping`.
     @ip_acl_mapping = @client.sip.domains.get(
         "SD456",  # SIP Domain sid
     ).ip_access_control_list_mappings.create(
-        {:ip_access_control_list_sid => "AL789"})
+      ip_access_control_list_sid: "AL789"
+    )
 
     puts @ip_acl_mapping.sid
 

data/docs/usage/twiml.rst

@@ -35,7 +35,7 @@ All attributes are keyword arguments.
     require 'twilio-ruby'
 
     Twilio::TwiML::Response.new do |r|
-        r.Play "https://api.twilio.com/cowbell.mp3", :loop => 5
+        r.Play "https://api.twilio.com/cowbell.mp3", loop: 5
     end.text
 
 .. code-block:: xml
@@ -53,7 +53,7 @@ Any example of nesting nouns in verbs
 
     Twilio::TwiML::Response.new do |r|
         r.Say "hello"
-        r.Gather :finishOnKey => 4 do |g|
+        r.Gather finishOnKey: => 4 do |g|
             g.Say "world"
         end
     end.text

data/examples/examples.rb

@@ -8,7 +8,7 @@
 ################ ACCOUNTS ################
 
 # shortcut to grab your account object (account_sid is inferred from the client's auth credentials)
-@account = @client.account 
+@account = @client.account
 
 # list your (sub)accounts
 @client.accounts.list
@@ -19,12 +19,16 @@
 puts @account.friendly_name
 
 # update an account's friendly name
-@client.accounts.get(@account_sid).update(:friendly_name => 'A Fabulous Friendly Name')
+@client.accounts.get(@account_sid).update(friendly_name: 'A Fabulous Friendly Name')
 
 ################ CALLS ################
 
 # print a list of calls (all parameters optional)
-@account.calls.list({:page => 0, :page_size => 1000, :start_time => '2010-09-01'}).each do |call|
+@account.calls.list(
+  page: 0,
+  page_size: 1000,
+  start_time: '2010-09-01'
+).each do |call|
   puts call.sid
 end
 
@@ -34,18 +38,23 @@ end
 end
 
 # make a new outgoing call. returns a call object just like calls.get
-@call = @account.calls.create({:from => '+14159341234', :to => '+18004567890', :url => 'http://example.com/call-handler'})
+@call = @account.calls.create(
+  from: '+14159341234',
+  to: '+18004567890',
+  url: 'http://example.com/call-handler'
+)
 
 # cancel the call if not already in progress
-@account.calls.get(@call.sid).update({:status => 'canceled'})
+@account.calls.get(@call.sid).update(status: 'canceled')
 # or equivalently
-@call.update({:status => 'canceled'})
+@call.update(status: 'canceled')
 # or simply
 @call.cancel
 
 # redirect and then terminate a call
-@account.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662').update({:url => 'http://example.com/call-redirect'})
-@account.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662').update({:status => 'completed'})
+@call = @account.calls.get('CA386025c9bf5d6052a1d1ea42b4d16662')
+@call.update(url: 'http://example.com/call-redirect')
+@call.update(status: 'completed')
 # or, use the aliases...
 @call.redirect_to('http://example.com/call-redirect')
 @call.hangup
@@ -53,7 +62,7 @@ end
 ################ SMS MESSAGES ################
 
 # print a list of messages
-@account.messages.list({:date_sent => '2010-09-01'}).each do |message|
+@account.messages.list(date_sent: '2010-09-01').each do |message|
   puts message.body
 end
 
@@ -61,10 +70,18 @@ end
 puts @account.messages.get('SMXXXXXXXX').body
 
 # send an sms
-@account.messages.create(:from => '+14159341234', :to => '+16105557069', :body => 'Hey there!')
+@account.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  body: 'Hey there!'
+)
 
 # send an mms
-@account.messages.create(:from => '+14159341234', :to => '+16105557069', :media_urls => 'http://example.com/media.png')
+@account.messages.create(
+  from: '+14159341234',
+  to: '+16105557069',
+  media_urls: 'http://example.com/media.png'
+)
 
 ################ PHONE NUMBERS ################
 
@@ -72,22 +89,28 @@ puts @account.messages.get('SMXXXXXXXX').body
 @account.available_phone_numbers.list
 
 # print some available numbers
-@numbers = @account.available_phone_numbers.get('US').local.list({:contains => 'AWESOME'})
-@numbers.each {|num| puts num.phone_number}
+@numbers = @account.available_phone_numbers.get('US').local.list(
+  contains: 'AWESOME'
+)
+@numbers.each { |num| puts num.phone_number }
 
 # buy the first one
-@account.incoming_phone_numbers.create(:phone_number => @numbers[0].phone_number)
+@account.incoming_phone_numbers.create(phone_number: @numbers[0].phone_number)
 
 # update an existing phone number's voice url
-@account.incoming_phone_numbers.get('PNdba508c5616a7f5e141789f44f022cc3').update({:voice_url => 'http://example.com/voice'})
+number = @account.incoming_phone_numbers.get('PNdba508c5616a7f5e141789f44f022cc3')
+number.update(voice_url: 'http://example.com/voice')
 
 # decommission an existing phone number
-numbers = @account.incoming_phone_numbers.list(:friendly_name => 'A Fabulous Friendly Name') 
+numbers = @account.incoming_phone_numbers.list(
+  friendly_name: 'A Fabulous Friendly Name'
+)
 numbers[0].delete
 ################ CONFERENCES  ################
 
 # get a particular conference's participants object and stash it
-@participants = @account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39').participants
+conference = @account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39')
+@participants = conference.participants
 
 # list participants
 @participants.list.each do |p|
@@ -95,17 +118,18 @@ numbers[0].delete
 end
 
 # update a conference participant
-@participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').update({:muted => 'true'})
+@participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').update(muted: 'true')
 # or an easier way
 @participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').mute
 
 # and, since we're lazy loading, this would only incur one http request
-@account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39').participants.get('CA386025c9bf5d6052a1d1ea42b4d16662').update({:muted => 'true'})
+@account.conferences.get('CFbbe46ff1274e283f7e3ac1df0072ab39').participants
+  .get('CA386025c9bf5d6052a1d1ea42b4d16662').update(muted: 'true')
 
 ################ QUEUES ###################
 
 # create a new queue
-@queue = @account.queues.create(:friendly_name => 'MyQueue', :max_size => 50)
+@queue = @account.queues.create(friendly_name: 'MyQueue', max_size: 50)
 
 # get a list of queues for this account
 @queues = @account.queues.list

data/lib/rack/twilio_webhook_authentication.rb

@@ -33,7 +33,11 @@ module Rack
       if validator.validate(original_url, params, signature)
         @app.call(env)
       else
-        [403, {'Content-Type' => 'text/plain'}, ["Twilio Request Validation Failed."]]
+        [
+          403,
+          {'Content-Type' => 'text/plain'},
+          ["Twilio Request Validation Failed."]
+        ]
       end
     end
   end

data/lib/twilio-ruby/rest/calls.rb

@@ -7,7 +7,7 @@ module Twilio
       end
 
       def make(from, to, url)
-        create :from => from, :to => to, :url => url
+        create from: from, to: to, url: url
       end
     end
 
@@ -18,15 +18,15 @@ module Twilio
       end
 
       def redirect_to(url)
-        update :url => url
+        update url: url
       end
 
       def cancel
-        update :status => 'canceled'
+        update status: 'canceled'
       end
 
       def hangup
-        update :status => 'completed'
+        update status: 'completed'
       end
     end
   end

data/lib/twilio-ruby/rest/client.rb

@@ -63,21 +63,23 @@ module Twilio
       HTTP_HEADERS = {
         'Accept' => 'application/json',
         'Accept-Charset' => 'utf-8',
-        'User-Agent' => "twilio-ruby/#{Twilio::VERSION} (#{engine}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})",
+        'User-Agent' => "twilio-ruby/#{Twilio::VERSION}" \
+                        " (#{engine}/#{RUBY_PLATFORM}" \
+                        " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
       }
 
       DEFAULTS = {
-        :host => 'api.twilio.com',
-        :port => 443,
-        :use_ssl => true,
-        :ssl_verify_peer => true,
-        :ssl_ca_file => File.dirname(__FILE__) + '/../../../conf/cacert.pem',
-        :timeout => 30,
-        :proxy_addr => nil,
-        :proxy_port => nil,
-        :proxy_user => nil,
-        :proxy_pass => nil,
-        :retry_limit => 1,
+        host: 'api.twilio.com',
+        port: 443,
+        use_ssl: true,
+        ssl_verify_peer: true,
+        ssl_ca_file: File.dirname(__FILE__) + '/../../../conf/cacert.pem',
+        timeout: 30,
+        proxy_addr: nil,
+        proxy_port: nil,
+        proxy_user: nil,
+        proxy_pass: nil,
+        retry_limit: 1
       }
 
       attr_reader :account_sid, :account, :accounts, :last_request,
@@ -91,36 +93,36 @@ module Twilio
       # hash of connection configuration options. the following keys are
       # supported:
       #
-      # === <tt>:host => 'api.twilio.com'</tt>
+      # === <tt>host: 'api.twilio.com'</tt>
       #
       # The domain to which you'd like the client to make HTTP requests. Useful
       # for testing. Defaults to 'api.twilio.com'.
       #
-      # === <tt>:port => 443</tt>
+      # === <tt>port: 443</tt>
       #
       # The port on which to connect to the above domain. Defaults to 443 and
       # should be left that way except in testing environments.
       #
-      # === <tt>:use_ssl => true</tt>
+      # === <tt>use_ssl: true</tt>
       #
       # Declare whether ssl should be used for connections to the above domain.
       # Defaults to true and should be left alone except when testing.
       #
-      # === <tt>:ssl_verify_peer => true</tt>
+      # === <tt>ssl_verify_peer: true</tt>
       #
       # Declare whether to verify the host's ssl cert when setting up the
       # connection to the above domain. Defaults to true, but can be turned off
       # to avoid ssl certificate verification failures in environments without
       # the necessary ca certificates.
       #
-      # === <tt>:ssl_ca_file => '/path/to/ca/file'</tt>
+      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
       #
       # Specify the path to the certificate authority bundle you'd like to use
       # to verify Twilio's SSL certificate on each request. If not specified, a
       # certificate bundle extraced from Firefox is packaged with the gem and
       # used by default.
       #
-      # === <tt>:timeout => 30</tt>
+      # === <tt>timeout: 30</tt>
       #
       # Set the time in seconds to wait before timing out the HTTP request.
       # Defaults to 30 seconds. If you aren't fetching giant pages of call or
@@ -128,24 +130,24 @@ module Twilio
       # lower. In paricular if you are sending SMS you can set this to 1 second
       # or less and swallow the exception if you don't care about the response.
       #
-      # === <tt>:proxy_addr => 'proxy.host.domain'</tt>
+      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
       #
       # The domain of a proxy through which you'd like the client to make HTTP
       # requests. Defaults to nil.
       #
-      # === <tt>:proxy_port => 3128</tt>
+      # === <tt>proxy_port: 3128</tt>
       #
       # The port on which to connect to the above proxy. Defaults to nil.
       #
-      # === <tt>:proxy_user => 'username'</tt>
+      # === <tt>proxy_user: 'username'</tt>
       #
       # The user name to use for authentication with the proxy. Defaults to nil.
       #
-      # === <tt>:proxy_pass => 'password'</tt>
+      # === <tt>proxy_pass: 'password'</tt>
       #
       # The password to use for authentication with the proxy. Defaults to nil.
       #
-      # === <tt>:retry_limit => 1</tt>
+      # === <tt>retry_limit: 1</tt>
       #
       # The number of times to retry a request that has failed before throwing
       # an exception. Defaults to one.

data/lib/twilio-ruby/rest/conferences/participants.rb

@@ -10,11 +10,11 @@ module Twilio
 
     class Participant < InstanceResource
       def mute
-        update :muted => 'true'
+        update muted: 'true'
       end
 
       def unmute
-        update :muted => 'false'
+        update muted: 'false'
       end
 
       alias :kick :delete

data/lib/twilio-ruby/rest/incoming_phone_numbers.rb

@@ -8,7 +8,7 @@ module Twilio
       end
 
       def buy(phone_number)
-        create :phone_number => phone_number
+        create phone_number: phone_number
       end
     end
 

data/lib/twilio-ruby/rest/instance_resource.rb

@@ -32,7 +32,7 @@ module Twilio
       # to handle the update. For example, to update the +VoiceUrl+ of a Twilio
       # Application you could write:
       #
-      #   @app.update :voice_url => 'http://my.other.app.com/handle_voice'
+      #   @app.update voice_url: 'http://my.other.app.com/handle_voice'
       #
       # After returning, the object will contain the most recent state of the
       # instance resource, including the newly updated properties.
@@ -77,23 +77,27 @@ module Twilio
         hash.each do |p,v|
           property = detwilify p
           unless ['client', 'updated'].include? property
-            eigenclass.send :define_method, property.to_sym, &lambda {v}
+            eigenclass.send :define_method, property.to_sym, &lambda { v }
           end
         end
         @updated = !hash.keys.empty?
       end
 
       def resource(*resources)
-        custom_resource_names = {:sms => 'SMS', :sip => 'SIP'}
+        custom_resource_names = { sms: 'SMS', sip: 'SIP' }
         resources.each do |r|
           resource = twilify r
           relative_path = custom_resource_names.fetch(r, resource)
           path = "#{@path}/#{relative_path}"
-          enclosing_module = @submodule == nil ? (Twilio::REST) : (Twilio::REST.const_get(@submodule))
+          enclosing_module = if @submodule == nil
+            Twilio::REST
+          else
+            Twilio::REST.const_get(@submodule)
+          end
           resource_class = enclosing_module.const_get resource
           instance_variable_set("@#{r}", resource_class.new(path, @client))
         end
-        self.class.instance_eval {attr_reader *resources}
+        self.class.instance_eval { attr_reader *resources }
       end
 
     end

data/lib/twilio-ruby/rest/list_resource.rb

@@ -5,9 +5,9 @@ module Twilio
 
       def initialize(path, client)
         custom_names = {
-            'Media' => 'MediaInstance',
-            'IpAddresses' => 'IpAddress',
-            'Feedback' => 'FeedbackInstance',
+          'Media' => 'MediaInstance',
+          'IpAddresses' => 'IpAddress',
+          'Feedback' => 'FeedbackInstance'
         }
         @path, @client = path, client
         resource_name = self.class.name.split('::')[-1]
@@ -16,7 +16,11 @@ module Twilio
         # The next line grabs the enclosing module. Necessary for resources
         # contained in their own submodule like /SMS/Messages
         parent_module = self.class.to_s.split('::')[-2]
-        full_module_path = parent_module == 'REST' ? (Twilio::REST) : (Twilio::REST.const_get parent_module)
+        full_module_path = if parent_module == "REST"
+          Twilio::REST
+        else
+          Twilio::REST.const_get parent_module
+        end
 
         @instance_class = full_module_path.const_get instance_name
         @list_key, @instance_id_key = detwilify(resource_name), 'sid'
@@ -49,7 +53,7 @@ module Twilio
         client, list_class = @client, self.class
         resource_list.instance_eval do
           eigenclass = class << self; self; end
-          eigenclass.send :define_method, :total, &lambda {response['total']}
+          eigenclass.send :define_method, :total, &lambda { response['total'] }
           eigenclass.send :define_method, :next_page, &lambda {
             if response['next_page_uri']
               list_class.new(response['next_page_uri'], client).list({}, true)
@@ -70,7 +74,7 @@ module Twilio
       # +total+ attribute as well.
       def total
         raise "Can't get a resource total without a REST Client" unless @client
-        @client.get(@path, :page_size => 1)['total']
+        @client.get(@path, page_size: 1)['total']
       end
 
       ##
@@ -98,18 +102,22 @@ module Twilio
 
       def resource(*resources)
         custom_resource_names = {
-          :sms => 'SMS',
-          :sip => 'SIP',
+          sms: 'SMS',
+          sip: 'SIP'
         }
         resources.each do |r|
           resource = twilify r
           relative_path = custom_resource_names.fetch(r, resource)
           path = "#{@path}/#{relative_path}"
-          enclosing_module = @submodule == nil ? (Twilio::REST) : (Twilio::REST.const_get(@submodule))
+          enclosing_module = if @submodule == nil
+            Twilio::REST
+          else
+            Twilio::REST.const_get(@submodule)
+          end
           resource_class = enclosing_module.const_get resource
           instance_variable_set("@#{r}", resource_class.new(path, @client))
         end
-        self.class.instance_eval {attr_reader *resources}
+        self.class.instance_eval { attr_reader *resources }
       end
     end
   end