twilio-ruby 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ad998d6d974a18680aa4af67eac5060956bd089
-  data.tar.gz: 2c2907bdecbc092b9cdc5d3dc51f106bbb27092f
+  metadata.gz: 399f522ccd4b51d8383070a32079b1414e9b18df
+  data.tar.gz: aea3e095d94d500c80fdaf3c2c7f9d7cda910619
 SHA512:
-  metadata.gz: 8749bb3401a502e263e21733cc70591c86a4c6013b5aa193928be83f63921e65586cbd2b66ea06b92093091081bdca27870ada78100ca750726425cbfe4bd87c
-  data.tar.gz: 9ad4c8bc2ed44eb805f33d75f2ec9bb4ede33b5854a620d00b5b46377039ec100c3131b2585e7ea24cc41ba35d74db6ebb8ec002217e3c80b656b9226605cf19
+  metadata.gz: 1d09bebe465830e3d8bc71fa4f647885ea27814cd22a6b8a7b7522f0fc774102d6c37e4e44e012b777279700b5433dd48e36ff5fa097dfd558259d2f2abbb05f
+  data.tar.gz: 4b2ac197c38fda839f8836931a6986a80687a9212e75d6a74f875c20fbcc7509ff9e06ff424b08e44a7507e61b92791d30114e278e3066da8cee0c8b3f028082

data/.rubocop.yml

@@ -5,12 +5,20 @@ AllCops:
   Exclude:
     - 'lib/twilio-ruby/rest/**/*'
     - 'spec/integration/**/*'
+    - 'lib/twilio-ruby/version.rb'
 
 Metrics/LineLength:
   Max: 120
   Exclude:
     - 'spec/**/*'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 175
 

data/CHANGES.md

@@ -1,5 +1,27 @@
 twilio-ruby changelog
 =====================
+
+[2017-08-10] Version 5.1.1
+---------------------------
+**Library**
+- Don't override Faraday default param encoder. Thanks to @isaacseymour. PR #309
+- Fix incorrectly aliased `to_xml` on TwiML classes. Thanks to @philnash. PR #318
+- Only define `to_s` on BaseJWT instead of subclasses. Thanks to @philnash. PR #321
+- Silence deprecation messages in testing. Thanks to @philnash. PR #323
+
+**Api**
+- Add New wireless usage keys added
+- Add `auto_correct_address` param for Addresses create and update
+
+**Video**
+- Add `video_codec` enum and `video_codecs` parameter, which can be set to either `VP8` or `H264` during room creation.
+- Restrict recordings page size to 100
+
+**Chat**
+- Add ChatGrant to available access tokens.
+- Mark IpMessagingGrant as deprecated in favor of ChatGrant.
+
+
 [2017-07-27] Version 5.1.0
 ---------------------------
 This release adds Beta and Preview products to main artifact.

data/Makefile

@@ -1,4 +1,4 @@
-.PHONY: test lint-changed lint
+.PHONY: test lint-changed lint docs
 
 CHANGED_RUBY_FILES = $(shell git status --porcelain | grep ".rb" | awk -F ' ' '{print $2}' | tr '\n' ' ')
 
@@ -12,7 +12,7 @@ test: lint
 	bundle exec rake spec
 
 docs:
-	yard doc
+	yard doc --output-dir ./doc
 
 lint:
 	rubocop --cache true --parallel

data/README.md

@@ -6,18 +6,34 @@
 
 A module for using the Twilio REST API and generating valid [TwiML](http://www.twilio.com/docs/api/twiml/ "TwiML - Twilio Markup Language"). [Click here to read the full documentation.][documentation]
 
+## Recent Update
+
+As of release 5.1.0, Beta and Developer Preview products are now exposed via
+the main `twilio-java` artifact. Releases of the `alpha` branch have been
+discontinued.
+
+If you were using the `alpha` release line, you should be able to switch back
+to the normal release line without issue.
+
+If you were using the normal release line, you should now see several new
+product lines that were historically hidden from you due to their Beta or
+Developer Preview status. Such products are explicitly documented as
+Beta/Developer Preview both in the Twilio docs and console, as well as through
+in-line code documentation here in the library.
+
+
 ## Installation
 
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.1.0'
+gem 'twilio-ruby', '~> 5.1.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.1.0
+gem install twilio-ruby -v 5.1.1
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -120,8 +136,7 @@ section of the wiki.
 
 ## Getting Started With TwiML
 
-TwiML support is based on the [Builder][builder] library. You can construct a
-TwiML response like this:
+You can construct a TwiML response like this:
 
 ```ruby
 require 'twilio-ruby'
@@ -161,7 +176,6 @@ implementations:
 - Ruby 2.0.0
 
 [capability]: https://github.com/twilio/twilio-ruby/wiki/Capability
-[builder]: http://builder.rubyforge.org/
 [examples]: https://github.com/twilio/twilio-ruby/blob/master/examples
 [documentation]: http://twilio.github.io/twilio-ruby
 [wiki]: https://github.com/twilio/twilio-ruby/wiki

data/lib/twilio-ruby/http/http_client.rb

@@ -12,13 +12,11 @@ module Twilio
         @proxy_pass = proxy_pass
         @ssl_ca_file = ssl_ca_file
         @adapter = Faraday.default_adapter
-
-        # Set default params encoder
-        Faraday::Utils.default_params_encoder = Faraday::FlatParamsEncoder
       end
 
       def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
         @connection = Faraday.new(url: host + ':' + port.to_s, ssl: { verify: true }) do |f|
+          f.options.params_encoder = Faraday::FlatParamsEncoder
           f.request :url_encoded
           f.adapter @adapter
           f.headers = headers

data/lib/twilio-ruby/jwt/access_token.rb

@@ -50,10 +50,6 @@ module Twilio
         @grants.push(grant)
       end
 
-      def to_s
-        to_jwt
-      end
-
       protected
 
       def _generate_payload
@@ -81,6 +77,36 @@ module Twilio
         headers
       end
 
+      class ChatGrant
+        include AccessTokenGrant
+        attr_accessor :service_sid,
+                      :endpoint_id,
+                      :deployment_role_sid,
+                      :push_credential_sid
+
+        def _key
+          'chat'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload[:service_sid] = service_sid if service_sid
+
+          payload[:endpoint_id] = endpoint_id if endpoint_id
+
+          if deployment_role_sid
+            payload[:deployment_role_sid] = deployment_role_sid
+          end
+
+          if push_credential_sid
+            payload[:push_credential_sid] = push_credential_sid
+          end
+
+          payload
+        end
+      end
+
       class IpMessagingGrant
         include AccessTokenGrant
         attr_accessor :service_sid,
@@ -109,6 +135,11 @@ module Twilio
 
           payload
         end
+
+        class << self
+          extend Gem::Deprecate
+          deprecate :new, 'Chat.new', 2017, 7
+        end
       end
 
       class VoiceGrant

data/lib/twilio-ruby/jwt/client_capability.rb

@@ -12,8 +12,6 @@ module Twilio
                     :client_name,
                     :scopes
 
-      alias to_s to_jwt
-
       def initialize(account_sid, auth_token, scopes: [], nbf: nil, ttl: 3600, valid_until: nil)
         super(secret_key: auth_token, issuer: account_sid, nbf: nbf, ttl: ttl, valid_until: valid_until)
         @account_sid = account_sid

data/lib/twilio-ruby/jwt/jwt.rb

@@ -38,13 +38,14 @@ module Twilio
         payload[:nbf] = @nbf || Time.now.to_i
         payload[:exp] = @valid_until.nil? ? Time.now.to_i + @ttl : @valid_until
         payload[:sub] = @subject unless @subject.nil?
-        
+
         payload
       end
 
       def to_jwt
         ::JWT.encode payload, @secret_key, @algorithm, headers
       end
+      alias to_s to_jwt
     end
   end
 end

data/lib/twilio-ruby/jwt/task_router.rb

@@ -20,10 +20,6 @@ module Twilio
         @policies.push(policy)
       end
 
-      def to_s
-        to_jwt
-      end
-
       protected
 
       def _generate_payload

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

@@ -36,8 +36,9 @@ module Twilio
             # @param [String] iso_country The iso_country
             # @param [String] friendly_name The friendly_name
             # @param [Boolean] emergency_enabled The emergency_enabled
+            # @param [Boolean] auto_correct_address The auto_correct_address
             # @return [AddressInstance] Newly created AddressInstance
-            def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: :unset, emergency_enabled: :unset)
+            def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               data = Twilio::Values.of({
                   'CustomerName' => customer_name,
                   'Street' => street,
@@ -47,6 +48,7 @@ module Twilio
                   'IsoCountry' => iso_country,
                   'FriendlyName' => friendly_name,
                   'EmergencyEnabled' => emergency_enabled,
+                  'AutoCorrectAddress' => auto_correct_address,
               })
 
               payload = @version.create(
@@ -266,8 +268,9 @@ module Twilio
             # @param [String] region The region
             # @param [String] postal_code The postal_code
             # @param [Boolean] emergency_enabled The emergency_enabled
+            # @param [Boolean] auto_correct_address The auto_correct_address
             # @return [AddressInstance] Updated AddressInstance
-            def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset)
+            def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'CustomerName' => customer_name,
@@ -276,6 +279,7 @@ module Twilio
                   'Region' => region,
                   'PostalCode' => postal_code,
                   'EmergencyEnabled' => emergency_enabled,
+                  'AutoCorrectAddress' => auto_correct_address,
               })
 
               payload = @version.update(
@@ -475,8 +479,9 @@ module Twilio
             # @param [String] region The region
             # @param [String] postal_code The postal_code
             # @param [Boolean] emergency_enabled The emergency_enabled
+            # @param [Boolean] auto_correct_address The auto_correct_address
             # @return [AddressInstance] Updated AddressInstance
-            def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset)
+            def update(friendly_name: :unset, customer_name: :unset, street: :unset, city: :unset, region: :unset, postal_code: :unset, emergency_enabled: :unset, auto_correct_address: :unset)
               context.update(
                   friendly_name: friendly_name,
                   customer_name: customer_name,
@@ -485,6 +490,7 @@ module Twilio
                   region: region,
                   postal_code: postal_code,
                   emergency_enabled: emergency_enabled,
+                  auto_correct_address: auto_correct_address,
               )
             end
 

data/lib/twilio-ruby/rest/video/v1/room.rb

@@ -32,8 +32,9 @@ module Twilio
           # @param [String] max_participants The max_participants
           # @param [Boolean] record_participants_on_connect The
           #   record_participants_on_connect
+          # @param [room.VideoCodec] video_codecs The video_codecs
           # @return [RoomInstance] Newly created RoomInstance
-          def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset)
+          def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset)
             data = Twilio::Values.of({
                 'EnableTurn' => enable_turn,
                 'Type' => type,
@@ -42,6 +43,7 @@ module Twilio
                 'StatusCallbackMethod' => status_callback_method,
                 'MaxParticipants' => max_participants,
                 'RecordParticipantsOnConnect' => record_participants_on_connect,
+                'VideoCodecs' => video_codecs,
             })
 
             payload = @version.create(

data/lib/twilio-ruby/twiml/twiml.rb

@@ -11,8 +11,6 @@ module Twilio
       attr_accessor :name
       attr_accessor :indent
 
-      alias to_xml to_s
-
       def initialize(indent: false, **keyword_args)
         @name = self.class.name.split('::').last
         @indent = indent
@@ -37,6 +35,7 @@ module Twilio
         return ('<?xml version="1.0" encoding="UTF-8"?>' + xml) if xml_declaration
         xml
       end
+      alias to_xml to_s
 
       def xml
         # create XML element

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '5.1.0'
+    VERSION = '5.1.1'
 end

data/spec/jwt/access_token_spec.rb

@@ -42,18 +42,35 @@ describe Twilio::JWT::AccessToken do
       end
 
       it 'IpMessaging grant' do
-        ip_messaging_grant = Twilio::JWT::AccessToken::IpMessagingGrant.new
-        ip_messaging_grant.service_sid = 'SS123'
-        ip_messaging_grant.endpoint_id = 'EP123'
-        ip_messaging_grant.deployment_role_sid = 'DR123'
-        ip_messaging_grant.push_credential_sid = 'PC123'
-        @scat.add_grant(ip_messaging_grant)
+        Gem::Deprecate.skip_during do
+          ip_messaging_grant = Twilio::JWT::AccessToken::IpMessagingGrant.new
+          ip_messaging_grant.service_sid = 'SS123'
+          ip_messaging_grant.endpoint_id = 'EP123'
+          ip_messaging_grant.deployment_role_sid = 'DR123'
+          ip_messaging_grant.push_credential_sid = 'PC123'
+          @scat.add_grant(ip_messaging_grant)
+          payload, _ = JWT.decode @scat.to_s, 'secret'
+          expect(payload['grants'].count).to eq(1)
+          expect(payload['grants']['ip_messaging']['service_sid']).to eq('SS123')
+          expect(payload['grants']['ip_messaging']['endpoint_id']).to eq('EP123')
+          expect(payload['grants']['ip_messaging']['push_credential_sid']).to eq('PC123')
+          expect(payload['grants']['ip_messaging']['deployment_role_sid']).to eq('DR123')
+        end
+      end
+
+      it 'Chat grant' do
+        chat_grant = Twilio::JWT::AccessToken::ChatGrant.new
+        chat_grant.service_sid = 'SS123'
+        chat_grant.endpoint_id = 'EP123'
+        chat_grant.deployment_role_sid = 'DR123'
+        chat_grant.push_credential_sid = 'PC123'
+        @scat.add_grant(chat_grant)
         payload, _ = JWT.decode @scat.to_s, 'secret'
         expect(payload['grants'].count).to eq(1)
-        expect(payload['grants']['ip_messaging']['service_sid']).to eq('SS123')
-        expect(payload['grants']['ip_messaging']['endpoint_id']).to eq('EP123')
-        expect(payload['grants']['ip_messaging']['push_credential_sid']).to eq('PC123')
-        expect(payload['grants']['ip_messaging']['deployment_role_sid']).to eq('DR123')
+        expect(payload['grants']['chat']['service_sid']).to eq('SS123')
+        expect(payload['grants']['chat']['endpoint_id']).to eq('EP123')
+        expect(payload['grants']['chat']['push_credential_sid']).to eq('PC123')
+        expect(payload['grants']['chat']['deployment_role_sid']).to eq('DR123')
       end
 
       it 'Voice grant' do
@@ -83,12 +100,14 @@ describe Twilio::JWT::AccessToken do
       end
 
       it 'Conversations grant' do
-        conversation_grant = Twilio::JWT::AccessToken::ConversationsGrant.new
-        conversation_grant.configuration_profile_sid = 'VS123'
-        @scat.add_grant(conversation_grant)
-        payload, _ = JWT.decode @scat.to_s, 'secret'
-        expect(payload['grants'].count).to eq(1)
-        expect(payload['grants']['rtc']['configuration_profile_sid']).to eq('VS123')
+        Gem::Deprecate.skip_during do
+          conversation_grant = Twilio::JWT::AccessToken::ConversationsGrant.new
+          conversation_grant.configuration_profile_sid = 'VS123'
+          @scat.add_grant(conversation_grant)
+          payload, _ = JWT.decode @scat.to_s, 'secret'
+          expect(payload['grants'].count).to eq(1)
+          expect(payload['grants']['rtc']['configuration_profile_sid']).to eq('VS123')
+        end
       end
 
       it 'Room grant' do

data/spec/twiml/messaging_response_spec.rb

@@ -7,6 +7,11 @@ describe Twilio::TwiML::MessagingResponse do
       expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
     end
 
+    it 'should allow using to_xml instead of to_s' do
+      r = Twilio::TwiML::MessagingResponse.new
+      expect(r.to_xml).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
+    end
+
     it 'should allow populated response' do
       r = Twilio::TwiML::MessagingResponse.new
       r.message(body: 'Hello')

data/spec/twiml/voice_response_spec.rb

@@ -7,6 +7,11 @@ describe Twilio::TwiML::VoiceResponse do
       expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
     end
 
+    it 'should allow using to_xml instead of to_s' do
+      r = Twilio::TwiML::VoiceResponse.new
+      expect(r.to_xml).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
+    end
+
     it 'should allow populated response' do
       r = Twilio::TwiML::VoiceResponse.new
       r.hangup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Twilio API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -604,7 +604,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A simple library for communicating with the Twilio REST API, building TwiML,