mux_ruby 1.3.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4b0deedd1384c8570bba28d6fbb40647a70f92f4
-  data.tar.gz: bba59bbf79426e17ba5e1eb30a53f227db79499e
+SHA256:
+  metadata.gz: ccbf90e37874b351e072e692180c58a354d436faddbb9f9d0f2c9a9d95868f4f
+  data.tar.gz: b8e1b2f842ec53b7447df8d4cb7ba51a4ec39ec83593edfcd83dc8e76289222e
 SHA512:
-  metadata.gz: 84c62cb5252f550f8b2e9542cb68eaa42c51c1ee1a3ad88f237f480ac63e664ba1345b663b5923e6e9dfc2beffabc07cb5b1535a16fbdbb67f06a9c652132f91
-  data.tar.gz: b0f0434546abde5a60e2970416670c40d12a5a10f3c128a28f57afcd76253ba2234dbc3aadda646ac55ddafa8c0ba86119cf6235f81d6b4a3df65d51e81dff88
+  metadata.gz: 7d4b97bfbe38e4fcbab508520383eec2d36c79551cc176a1ae4b4d2bb397e2d3e05dbab8d58da94de21c409fb2f2d66e95b4f6d16121c8673e182ecd2014f538
+  data.tar.gz: 0e7ac75c0ce0d429ae02710b35a1bc7ef3a5182ef1f138c8f2b435ac1b2a3fe70e259ed10c224a44865d06101adb7c4fd34cc262f60095f6b9391e60a7e9f8a6

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
   gem 'pry-byebug'
+  gem 'solid_assert'
 end

data/Gemfile.lock

@@ -1,58 +1,59 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.3.1)
+    mux_ruby (1.7.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.11.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    ZenTest (4.12.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.14)
+    autotest-fsevent (0.2.17)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    byebug (10.0.2)
+    byebug (11.1.1)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.9.25)
-    hashdiff (0.3.7)
-    json (2.1.0)
-    method_source (0.9.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    public_suffix (3.0.3)
-    rake (12.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    json (2.3.0)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.4)
-    sys-uname (1.0.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    solid_assert (1.0.0)
+    sys-uname (1.2.1)
       ffi (>= 1.0.0)
-    typhoeus (1.3.0)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
     vcr (3.0.3)
     webmock (1.24.6)
@@ -70,10 +71,11 @@ DEPENDENCIES
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   mux_ruby!
   pry-byebug
-  rake (~> 12.0.0)
+  rake (~> 12.3.3)
   rspec (~> 3.6, >= 3.6.0)
+  solid_assert
   vcr (~> 3.0, >= 3.0.1)
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -1,5 +1,7 @@
 ![Mux Ruby Banner](github-ruby-sdk.png)
 
+![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
+
 # Mux Ruby
 
 Official Mux API wrapper for ruby projects, supporting both Mux Data and Mux Video.
@@ -19,8 +21,11 @@ Use `bundle install` to install dependencies if you're developing locally.
 ## Installation
 
 ### Adding to your Gemfile
+
+This gem can be sourced from [RubyGems](https://rubygems.org/gems/mux_ruby)
+
 ```
-gem 'mux_ruby', :git => 'git://github.com/muxinc/mux-ruby.git'
+gem 'mux_ruby'
 ```
 
 ### Clone and install locally

data/docs/Asset.md

@@ -13,7 +13,6 @@ Name | Type | Description | Notes
 **aspect_ratio** | **String** |  | [optional] 
 **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
 **tracks** | [**Array<Track>**](Track.md) |  | [optional] 
-**demo** | **BOOLEAN** |  | [optional] 
 **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
 **is_live** | **BOOLEAN** |  | [optional] 
@@ -24,5 +23,8 @@ Name | Type | Description | Notes
 **mp4_support** | **String** |  | [optional] [default to 'none']
 **normalize_audio** | **BOOLEAN** |  | [optional] [default to false]
 **static_renditions** | [**AssetStaticRenditions**](AssetStaticRenditions.md) |  | [optional] 
+**recording_times** | [**Array<AssetRecordingTimes>**](AssetRecordingTimes.md) | An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream | [optional] 
+**non_standard_input_reasons** | [**AssetNonStandardInputReasons**](AssetNonStandardInputReasons.md) |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/AssetNonStandardInputReasons.md

@@ -0,0 +1,16 @@
+# MuxRuby::AssetNonStandardInputReasons
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**video_codec** | **String** | The video codec used on the input file | [optional] 
+**audio_codec** | **String** | The audio codec used on the input file | [optional] 
+**video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file | [optional] 
+**video_frame_rate** | **String** | The video frame rate of the input file | [optional] 
+**video_resolution** | **String** | The video resolution of the input file | [optional] 
+**pixel_aspect_ratio** | **String** | The video pixel aspect ratio of the input file | [optional] 
+**video_edit_list** | **String** | Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List | [optional] 
+**audio_edit_list** | **String** | Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List | [optional] 
+**unexpected_media_file_parameters** | **String** | A catch-all reason when the input file in created with non-standard encoding parameters | [optional] 
+
+

data/docs/AssetRecordingTimes.md

@@ -0,0 +1,9 @@
+# MuxRuby::AssetRecordingTimes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**started_at** | **DateTime** | The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format | [optional] 
+**duration** | **Float** | The duration of the live stream recorded. The time value is in seconds | [optional] 
+
+

data/docs/AssetsApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**get_asset_input_info**](AssetsApi.md#get_asset_input_info) | **GET** /video/v1/assets/{ASSET_ID}/input-info | Retrieve asset input info
 [**get_asset_playback_id**](AssetsApi.md#get_asset_playback_id) | **GET** /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID} | Retrieve a playback ID
 [**list_assets**](AssetsApi.md#list_assets) | **GET** /video/v1/assets | List assets
+[**update_asset_master_access**](AssetsApi.md#update_asset_master_access) | **PUT** /video/v1/assets/{ASSET_ID}/master-access | Update master access
 [**update_asset_mp4_support**](AssetsApi.md#update_asset_mp4_support) | **PUT** /video/v1/assets/{ASSET_ID}/mp4-support | Update MP4 support
 
 
@@ -524,6 +525,59 @@ Name | Type | Description  | Notes
 
 
 
+# **update_asset_master_access**
+> AssetResponse update_asset_master_access(asset_id, update_asset_master_access_request)
+
+Update master access
+
+Allows you add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to \"none\". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.
+
+### Example
+```ruby
+# load the gem
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::AssetsApi.new
+asset_id = 'asset_id_example' # String | The asset ID.
+update_asset_master_access_request = MuxRuby::UpdateAssetMasterAccessRequest.new # UpdateAssetMasterAccessRequest | 
+
+begin
+  #Update master access
+  result = api_instance.update_asset_master_access(asset_id, update_asset_master_access_request)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling AssetsApi->update_asset_master_access: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **asset_id** | **String**| The asset ID. | 
+ **update_asset_master_access_request** | [**UpdateAssetMasterAccessRequest**](UpdateAssetMasterAccessRequest.md)|  | 
+
+### Return type
+
+[**AssetResponse**](AssetResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_asset_mp4_support**
 > AssetResponse update_asset_mp4_support(asset_id, update_asset_mp4_support_request)
 

data/docs/CreateAssetRequest.md

@@ -5,11 +5,11 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input** | [**Array<InputSettings>**](InputSettings.md) |  | [optional] 
 **playback_policy** | [**Array<PlaybackPolicy>**](PlaybackPolicy.md) |  | [optional] 
-**demo** | **BOOLEAN** |  | [optional] 
 **per_title_encode** | **BOOLEAN** |  | [optional] 
 **passthrough** | **String** |  | [optional] 
 **mp4_support** | **String** |  | [optional] 
 **normalize_audio** | **BOOLEAN** | Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets. | [optional] [default to false]
 **master_access** | **String** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/CreateLiveStreamRequest.md

@@ -8,5 +8,7 @@ Name | Type | Description | Notes
 **reconnect_window** | **Float** | When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified. | [optional] 
 **passthrough** | **String** |  | [optional] 
 **reduced_latency** | **BOOLEAN** | Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/ | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
+**simulcast_targets** | [**Array<CreateSimulcastTargetRequest>**](CreateSimulcastTargetRequest.md) |  | [optional] 
 
 

data/docs/CreateUploadRequest.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **timeout** | **Integer** | Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked `timed_out` | [optional] [default to 3600]
 **cors_origin** | **String** | If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers. | [optional] 
 **new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/DisableLiveStreamResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::DisableLiveStreamResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) |  | [optional] 
+
+

data/docs/EnableLiveStreamResponse.md

@@ -0,0 +1,8 @@
+# MuxRuby::EnableLiveStreamResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Object**](.md) |  | [optional] 
+
+

data/docs/LiveStream.md

@@ -10,10 +10,11 @@ Name | Type | Description | Notes
 **recent_asset_ids** | **Array<String>** |  | [optional] 
 **status** | **String** |  | [optional] 
 **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
-**new_asset_settings** | [**Asset**](Asset.md) |  | [optional] 
+**new_asset_settings** | [**CreateAssetRequest**](CreateAssetRequest.md) |  | [optional] 
 **passthrough** | **String** |  | [optional] 
 **reconnect_window** | **Float** |  | [optional] 
 **reduced_latency** | **BOOLEAN** |  | [optional] 
 **simulcast_targets** | [**Array<SimulcastTarget>**](SimulcastTarget.md) |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/LiveStreamsApi.md

@@ -10,6 +10,8 @@ Method | HTTP request | Description
 [**delete_live_stream**](LiveStreamsApi.md#delete_live_stream) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID} | Delete a live stream
 [**delete_live_stream_playback_id**](LiveStreamsApi.md#delete_live_stream_playback_id) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID} | Delete a live stream playback ID
 [**delete_live_stream_simulcast_target**](LiveStreamsApi.md#delete_live_stream_simulcast_target) | **DELETE** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Delete a Live Stream Simulcast Target
+[**disable_live_stream**](LiveStreamsApi.md#disable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/disable | Disable a live stream
+[**enable_live_stream**](LiveStreamsApi.md#enable_live_stream) | **PUT** /video/v1/live-streams/{LIVE_STREAM_ID}/enable | Enable a live stream
 [**get_live_stream**](LiveStreamsApi.md#get_live_stream) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID} | Retrieve a live stream
 [**get_live_stream_simulcast_target**](LiveStreamsApi.md#get_live_stream_simulcast_target) | **GET** /video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID} | Retrieve a Live Stream Simulcast Target
 [**list_live_streams**](LiveStreamsApi.md#list_live_streams) | **GET** /video/v1/live-streams | List live streams
@@ -320,6 +322,108 @@ nil (empty response body)
 
 
 
+# **disable_live_stream**
+> DisableLiveStreamResponse disable_live_stream(live_stream_id)
+
+Disable a live stream
+
+Disables a live stream, making it reject incoming RTMP streams until re-enabled.
+
+### Example
+```ruby
+# load the gem
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Disable a live stream
+  result = api_instance.disable_live_stream(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->disable_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**DisableLiveStreamResponse**](DisableLiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **enable_live_stream**
+> EnableLiveStreamResponse enable_live_stream(live_stream_id)
+
+Enable a live stream
+
+Enables a live stream, allowing it to accept an incoming RTMP stream.
+
+### Example
+```ruby
+# load the gem
+require 'mux_ruby'
+# setup authorization
+MuxRuby.configure do |config|
+  # Configure HTTP basic authorization: accessToken
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MuxRuby::LiveStreamsApi.new
+live_stream_id = 'live_stream_id_example' # String | The live stream ID
+
+begin
+  #Enable a live stream
+  result = api_instance.enable_live_stream(live_stream_id)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling LiveStreamsApi->enable_live_stream: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **live_stream_id** | **String**| The live stream ID | 
+
+### Return type
+
+[**EnableLiveStreamResponse**](EnableLiveStreamResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_live_stream**
 > LiveStreamResponse get_live_stream(live_stream_id)
 

data/docs/UpdateAssetMasterAccessRequest.md

@@ -0,0 +1,8 @@
+# MuxRuby::UpdateAssetMasterAccessRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**master_access** | **String** | Add or remove access to the master version of the video. | [optional] 
+
+