twilio-ruby 5.10.5 → 5.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7002623d1c11cda3d127cb2ef84cb57a80505f8
-  data.tar.gz: 3b5a00a000a072b22d6d771533c2c7181611e9b1
+  metadata.gz: 5d8915509528831b439fb45ef8cb25d10790bebe
+  data.tar.gz: 54eb53c3d93bf543d7458ddc163fa504f9cc2f5a
 SHA512:
-  metadata.gz: 684ad0135b1149ee74dc4926e9d1a9c2ecb47e1e33e7f2b56630cf3b7984e138e678f1d0f95c5bf505205b3ca0ccf966cb736a2b1b6529fff73d26b03bf741de
-  data.tar.gz: 40f1c9e5ce371ca3656d8d714aff33929f28db4f8531e8877fa12fb085835599df69df2f49234268b8bd4b1277058d5f6048ff6004d086894ba47bf5334262c2
+  metadata.gz: 7657be54da4eaa33d4e81ccc580d1499e73dcc20e1bb27b5b01d367553aeb97f20e8b8c2cb0e6043209749b80ada1c15aea9cba8c3c71cf1052f939aca288d36
+  data.tar.gz: 54af734a54bd1118bbeacd9d19cfe2ef407bf9897b127053a13a22f444e73cfd7e4a1d9217ab3c51333a9d4c2fddd0843b9f8f30b9a47a889fb3b2dc0022b369

data/.travis.yml

@@ -12,6 +12,9 @@ rvm:
   - 2.0.0
   - jruby-9.1.9.0
 
+services:
+  - docker
+
 matrix:
   fast_finish: true
 
@@ -19,3 +22,10 @@ before_install:
   # Bundler on Travis may be too out of date
   # Update bundler to a recent version.
   - gem install bundler
+deploy:
+  provider: script
+  script: make docker-build && make docker-push
+  skip_cleanup: true
+  on:
+    tags: true
+    rvm: "2.4.0"

data/CHANGES.md

@@ -1,6 +1,16 @@
 twilio-ruby changelog
 =====================
 
+[2018-07-05] Version 5.10.6
+----------------------------
+**Library**
+- PR #413: Add Dockerfile and related changes to build the Docker image. Thanks to @jonatasbaldin!
+
+**Api**
+- Release `Call Recording Controls` feature support in helper libraries
+- Add Voice Insights sub-category keys to usage records
+
+
 [2018-06-21] Version 5.10.5
 ----------------------------
 **Library**

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.4.0
+
+RUN mkdir /twilio
+WORKDIR /twilio
+
+COPY . .
+
+RUN bundle install 
+RUN bundle exec rake install

data/Makefile

@@ -27,3 +27,14 @@ authors:
 
 gem:
 	bundle exec rake build | sed -e 's/.*pkg/pkg/g' | sed -e "s/\.$$//g" | xargs gem push
+
+API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
+docker-build:
+	docker build -t twilio/twilio-ruby .
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:${TRAVIS_TAG}
+	docker tag twilio/twilio-ruby twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}
+
+docker-push:
+	echo "${DOCKER_PASSWORD}" | docker login -u "${DOCKER_USERNAME}" --password-stdin
+	docker push twilio/twilio-ruby:${TRAVIS_TAG}
+	docker push twilio/twilio-ruby:apidefs-${API_DEFINITIONS_SHA}

data/README.md

@@ -27,13 +27,13 @@ in-line code documentation here in the library.
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 5.10.5'
+gem 'twilio-ruby', '~> 5.10.6'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 5.10.5
+gem install twilio-ruby -v 5.10.6
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -50,6 +50,9 @@ make install
 ## Documentation
 [Here][documentation]
 
+## Docker Image
+The `Dockerfile` present in this repository and its respective `twilio/twilio-ruby` Docker image are currently used by Twilio for testing purposes only.
+
 ## Feedback
 During the Release Candidate period of this library, please leave all feedback and issues in the [Github Issues][issues] for `twilio-ruby`.
 

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

@@ -207,8 +207,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this
-      #   resource.
+      # @param [String] sid A unique 34-character string that identifies this resource.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionInstance] if sid was passed.
       # @return [Twilio::REST::Api::V2010::AccountContext::TranscriptionList]
       def transcriptions(sid=:unset)

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

@@ -16,8 +16,11 @@ module Twilio
               ##
               # Initialize the RecordingList
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid The call_sid
+              # @param [String] account_sid The unique ID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
+              #   recording.
+              # @param [String] call_sid A unique identifier for the call associated with the
+              #   recording. This will always refer to the parent leg of a two leg call.
               # @return [RecordingList] RecordingList
               def initialize(version, account_sid: nil, call_sid: nil)
                 super(version)
@@ -27,13 +30,53 @@ module Twilio
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings.json"
               end
 
+              ##
+              # Retrieve a single page of RecordingInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] recording_status_callback_event The
+              #   recording_status_callback_event
+              # @param [String] recording_status_callback The recording_status_callback
+              # @param [String] recording_status_callback_method The
+              #   recording_status_callback_method
+              # @param [String] trim Possible values `trim-silence` or `do-not-trim`.
+              #   `trim-silence` will trim the silence from the beginning and end of the
+              #   recording. `do-not-trim` will not trim the silence. Defaults to `do-not-trim`
+              # @param [String] recording_channels The recording_channels
+              # @param [Boolean] play_beep Possible values : true or false.  true will play a
+              #   double beep before the recording is paused or stopped or a single beep after the
+              #   recording is resumed. Defaults to false
+              # @return [RecordingInstance] Newly created RecordingInstance
+              def create(recording_status_callback_event: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, trim: :unset, recording_channels: :unset, play_beep: :unset)
+                data = Twilio::Values.of({
+                    'RecordingStatusCallbackEvent' => Twilio.serialize_list(recording_status_callback_event) { |e| e },
+                    'RecordingStatusCallback' => recording_status_callback,
+                    'RecordingStatusCallbackMethod' => recording_status_callback_method,
+                    'Trim' => trim,
+                    'RecordingChannels' => recording_channels,
+                    'PlayBeep' => play_beep,
+                })
+
+                payload = @version.create(
+                    'POST',
+                    @uri,
+                    data: data
+                )
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                )
+              end
+
               ##
               # Lists RecordingInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Time] date_created_before The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before Filter by date created
+              # @param [Time] date_created Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,9 +98,9 @@ module Twilio
               # Streams RecordingInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Time] date_created_before The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before Filter by date created
+              # @param [Time] date_created Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -95,9 +138,9 @@ module Twilio
               ##
               # Retrieve a single page of RecordingInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] date_created_before The date_created
-              # @param [Time] date_created The date_created
-              # @param [Time] date_created_after The date_created
+              # @param [Time] date_created_before Filter by date created
+              # @param [Time] date_created Filter by date created
+              # @param [Time] date_created_after Filter by date created
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -178,8 +221,8 @@ module Twilio
               # Initialize the RecordingContext
               # @param [Version] version Version that contains the resource
               # @param [String] account_sid The account_sid
-              # @param [String] call_sid The call_sid
-              # @param [String] sid The sid
+              # @param [String] call_sid The call Sid that uniquely identifies this resource
+              # @param [String] sid The recording Sid that uniquely identifies this resource
               # @return [RecordingContext] RecordingContext
               def initialize(version, account_sid, call_sid, sid)
                 super(version)
@@ -189,6 +232,29 @@ module Twilio
                 @uri = "/Accounts/#{@solution[:account_sid]}/Calls/#{@solution[:call_sid]}/Recordings/#{@solution[:sid]}.json"
               end
 
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The status to change the recording to. 
+              #   Possible values : stopped, paused, in-progress
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil)
+                data = Twilio::Values.of({'Status' => status, })
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                RecordingInstance.new(
+                    @version,
+                    payload,
+                    account_sid: @solution[:account_sid],
+                    call_sid: @solution[:call_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
               ##
               # Fetch a RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance
@@ -230,9 +296,12 @@ module Twilio
               # Initialize the RecordingInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] account_sid The account_sid
-              # @param [String] call_sid The call_sid
-              # @param [String] sid The sid
+              # @param [String] account_sid The unique ID of the
+              #   [Account](https://www.twilio.com/docs/api/rest/account) responsible for this
+              #   recording.
+              # @param [String] call_sid A unique identifier for the call associated with the
+              #   recording. This will always refer to the parent leg of a two leg call.
+              # @param [String] sid The recording Sid that uniquely identifies this resource
               # @return [RecordingInstance] RecordingInstance
               def initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil)
                 super(version)
@@ -245,6 +314,7 @@ module Twilio
                     'conference_sid' => payload['conference_sid'],
                     'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
                     'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
+                    'start_time' => Twilio.deserialize_rfc2822(payload['start_time']),
                     'duration' => payload['duration'],
                     'sid' => payload['sid'],
                     'price' => payload['price'].to_f,
@@ -279,101 +349,116 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique sid that identifies this account
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The api_version
+              # @return [String] The version of the API in use during the recording.
               def api_version
                 @properties['api_version']
               end
 
               ##
-              # @return [String] The call_sid
+              # @return [String] The unique id for the call leg that corresponds to the recording.
               def call_sid
                 @properties['call_sid']
               end
 
               ##
-              # @return [String] The conference_sid
+              # @return [String] The unique id for the conference associated with the recording, if a conference recording.
               def conference_sid
                 @properties['conference_sid']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The duration
+              # @return [Time] The start time of the recording, given in RFC 2822 format.
+              def start_time
+                @properties['start_time']
+              end
+
+              ##
+              # @return [String] The length of the recording, in seconds.
               def duration
                 @properties['duration']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this recording
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The price
+              # @return [String] The one-time cost of creating this recording.
               def price
                 @properties['price']
               end
 
               ##
-              # @return [String] The uri
+              # @return [String] The URI for this resource
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [Hash] The encryption_details
+              # @return [Hash] Details for how to decrypt the recording.
               def encryption_details
                 @properties['encryption_details']
               end
 
               ##
-              # @return [String] The price_unit
+              # @return [String] The currency used in the Price property.
               def price_unit
                 @properties['price_unit']
               end
 
               ##
-              # @return [recording.Status] The status
+              # @return [recording.Status] The status of the recording.
               def status
                 @properties['status']
               end
 
               ##
-              # @return [String] The channels
+              # @return [String] The number of channels in the final recording file as an integer.
               def channels
                 @properties['channels']
               end
 
               ##
-              # @return [recording.Source] The source
+              # @return [recording.Source] The way in which this recording was created.
               def source
                 @properties['source']
               end
 
               ##
-              # @return [String] The error_code
+              # @return [String] More information about the recording failure, if Status is failed.
               def error_code
                 @properties['error_code']
               end
 
+              ##
+              # Update the RecordingInstance
+              # @param [recording.Status] status The status to change the recording to. 
+              #   Possible values : stopped, paused, in-progress
+              # @return [RecordingInstance] Updated RecordingInstance
+              def update(status: nil)
+                context.update(status: status, )
+              end
+
               ##
               # Fetch a RecordingInstance
               # @return [RecordingInstance] Fetched RecordingInstance

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

@@ -220,6 +220,7 @@ module Twilio
 
               # Dependents
               @participants = nil
+              @recordings = nil
             end
 
             ##
@@ -294,6 +295,28 @@ module Twilio
               @participants
             end
 
+            ##
+            # Access the recordings
+            # @return [RecordingList]
+            # @return [RecordingContext] if sid was passed.
+            def recordings(sid=:unset)
+              raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+              if sid != :unset
+                return RecordingContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
+              end
+
+              unless @recordings
+                @recordings = RecordingList.new(
+                    @version,
+                    account_sid: @solution[:account_sid],
+                    conference_sid: @solution[:sid],
+                )
+              end
+
+              @recordings
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -432,6 +455,13 @@ module Twilio
               context.participants
             end
 
+            ##
+            # Access the recordings
+            # @return [recordings] recordings
+            def recordings
+              context.recordings
+            end
+
             ##
             # Provide a user friendly representation
             def to_s