mux_ruby 1.4.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a82c3ff3d2f7a0856d87eeb12181161e46fd94b0
-  data.tar.gz: b0bc8878a363818ebf49889ccf57739a1b7d4bc1
+SHA256:
+  metadata.gz: 949908e8ddb5270a36db4c9df9991f878e91b8e95ad6a1260506b956861f7ec6
+  data.tar.gz: 368bcacc1322c6308fce401c068e74a5ae0bd3627e1eb2261db5d30bd53e0fa7
 SHA512:
-  metadata.gz: 4eb34200000fdb35dc50892d46ead7e99046cdacdd1639a88e209d398abf2b22302345a7fefc3e8524c0e09718ab48fbad3cfd84380e5ed67df1bfde85d1ade4
-  data.tar.gz: 481d66f9f17b8ba653ed30d2bb2b6ed2c8aa194563820e99c39063554afaa00621d9b0555f2ffe63d214a6dfecf09417831e564264e8995800fc6e82d5d5921a
+  metadata.gz: fde803ebf5c4db63c13522a8d4513282d74e1305725f122e87232be2d3126fdd1ff95c931f1e535c8d9d5de227d31924d7163a53cc51791294fb41c9afed78aa
+  data.tar.gz: 279bdcfeb349d5f4176e0e4408597644053052ef7a3cd85152a6443e50f9c7e6704e8e2dc5d7341814cd37e96b8f9cd8bf3be6fefca36989462eddaa28152f1b

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.4.0)
+    mux_ruby (1.8.1)
       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/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/DimensionValue.md

@@ -0,0 +1,9 @@
+# MuxRuby::DimensionValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**total_count** | **Integer** |  | [optional] 
+
+

data/docs/DimensionsApi.md

@@ -0,0 +1,118 @@
+# MuxRuby::DimensionsApi
+
+All URIs are relative to *https://api.mux.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
+[**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions
+
+
+# **list_dimension_values**
+> ListDimensionValuesResponse list_dimension_values(dimension_id, opts)
+
+Lists the values for a specific dimension
+
+Lists the values for a dimension along with a total count of related views.   Note: This API replaces the list-filter-values API call. 
+
+### 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::DimensionsApi.new
+dimension_id = 'abcd1234' # String | ID of the Dimension
+opts = {
+  limit: 25, # Integer | Number of items to include in the response
+  page: 1, # Integer | Offset by this many pages, of the size of `limit`
+  filters: ['filters_example'], # Array<String> | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).  Possible filter names are the same as returned by the List Filters endpoint. 
+  timeframe: ['timeframe_example'] # Array<String> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600    * duration string e.g. timeframe[]=24:hours or timeframe[]=7:days. 
+}
+
+begin
+  #Lists the values for a specific dimension
+  result = api_instance.list_dimension_values(dimension_id, opts)
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimension_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dimension_id** | **String**| ID of the Dimension | 
+ **limit** | **Integer**| Number of items to include in the response | [optional] [default to 25]
+ **page** | **Integer**| Offset by this many pages, of the size of &#x60;limit&#x60; | [optional] [default to 1]
+ **filters** | [**Array&lt;String&gt;**](String.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]&#x3D;operating_system:windows&amp;filters[]&#x3D;country:US).  Possible filter names are the same as returned by the List Filters endpoint.  | [optional] 
+ **timeframe** | [**Array&lt;String&gt;**](String.md)| Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). Accepted formats are...   * array of epoch timestamps e.g. timeframe[]&#x3D;1498867200&amp;timeframe[]&#x3D;1498953600    * duration string e.g. timeframe[]&#x3D;24:hours or timeframe[]&#x3D;7:days.  | [optional] 
+
+### Return type
+
+[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_dimensions**
+> ListDimensionsResponse list_dimensions
+
+List Dimensions
+
+List all available dimensions.  Note: This API replaces the list-filters API call. 
+
+### 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::DimensionsApi.new
+
+begin
+  #List Dimensions
+  result = api_instance.list_dimensions
+  p result
+rescue MuxRuby::ApiError => e
+  puts "Exception when calling DimensionsApi->list_dimensions: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDimensionsResponse**](ListDimensionsResponse.md)
+
+### Authorization
+
+[accessToken](../README.md#accessToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

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/FiltersApi.md

@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 Lists values for a specific filter
 
-Lists the values for a filter along with a total count of related views 
+Deprecated: The API has been replaced by the list-dimension-values API call.  Lists the values for a filter along with a total count of related views. 
 
 ### Example
 ```ruby
@@ -74,7 +74,7 @@ Name | Type | Description  | Notes
 
 List Filters
 
-Lists all the filters broken out into basic and advanced 
+Deprecated: The API has been replaced by the list-dimensions API call.  Lists all the filters broken out into basic and advanced. 
 
 ### Example
 ```ruby

data/docs/GetRealTimeBreakdownResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetRealTimeBreakdownResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<RealTimeBreakdownValue>**](RealTimeBreakdownValue.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/GetRealTimeHistogramTimeseriesResponse.md

@@ -0,0 +1,11 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) |  | [optional] 
+**data** | [**Array<RealTimeHistogramTimeseriesDatapoint>**](RealTimeHistogramTimeseriesDatapoint.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/GetRealTimeHistogramTimeseriesResponseMeta.md

@@ -0,0 +1,8 @@
+# MuxRuby::GetRealTimeHistogramTimeseriesResponseMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buckets** | [**Array<RealTimeHistogramTimeseriesBucket>**](RealTimeHistogramTimeseriesBucket.md) |  | [optional] 
+
+

data/docs/GetRealTimeTimeseriesResponse.md

@@ -0,0 +1,10 @@
+# MuxRuby::GetRealTimeTimeseriesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<RealTimeTimeseriesDatapoint>**](RealTimeTimeseriesDatapoint.md) |  | [optional] 
+**total_row_count** | **Integer** |  | [optional] 
+**timeframe** | **Array<Integer>** |  | [optional] 
+
+

data/docs/Incident.md

@@ -0,0 +1,28 @@
+# MuxRuby::Incident
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**threshold** | **Float** |  | [optional] 
+**status** | **String** |  | [optional] 
+**started_at** | **String** |  | [optional] 
+**severity** | **String** |  | [optional] 
+**sample_size_unit** | **String** |  | [optional] 
+**sample_size** | **Integer** |  | [optional] 
+**resolved_at** | **String** |  | [optional] 
+**notifications** | [**Array<IncidentNotification>**](IncidentNotification.md) |  | [optional] 
+**notification_rules** | [**Array<IncidentNotificationRule>**](IncidentNotificationRule.md) |  | [optional] 
+**measurement** | **String** |  | [optional] 
+**measured_value_on_close** | **Float** |  | [optional] 
+**measured_value** | **Float** |  | [optional] 
+**incident_key** | **String** |  | [optional] 
+**impact** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**error_description** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**breakdowns** | [**Array<IncidentBreakdown>**](IncidentBreakdown.md) |  | [optional] 
+**affected_views_per_hour_on_open** | **Integer** |  | [optional] 
+**affected_views_per_hour** | **Integer** |  | [optional] 
+**affected_views** | **Integer** |  | [optional] 
+
+