mux_ruby 1.9.0 → 2.0.0.pre.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57380e4202d460cfdb8bde993e835818799ea3c1df4f52f3f513eec8d10552cc
-  data.tar.gz: 1acb2eeb73ab3c670ca81f6cf3095cc8b4681b20d458e235d969f5f103ef072e
+  metadata.gz: c28d49a2c666ce9ae287c24568e3ac96f76ce88fe2379da51685342f7ecdf0af
+  data.tar.gz: c41db82bdd105f37ff892b4225dbdefe9a8582e244b27598c3ce81d849cdf67d
 SHA512:
-  metadata.gz: 01bc513413c7663ef490a4e193755479e7b0e6739f9f1b7ddd621e8f1146a8ec9a219be4d8b78f2b7f259105b26f203b1da04d7835bc34b718fdef3e759988c2
-  data.tar.gz: 20adae366398998ae7861471860cb36579d2e6594620ebd6c8073d3872e326b070d33859e2244c2a0420cf5c71c8483358895cf0daf6013dcd5bf76c3c9df809
+  metadata.gz: cfd040f2a3ca7024191c8d915ae9f715d51ae4667e0b19d61f76208d06d093e6d9a97c5f488f1a0a0869a965d2c301edd97b12a92bef30b50e7c63c747ed6986
+  data.tar.gz: 28f825f2fb898231ca945877dd2d2fee242e6f8ada10fa36d8b16b48222cf493ce0a712dcedabb0c520d6a817176151043394e50770fd61814c2464167f95a5e

data/Gemfile

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

data/Gemfile.lock

@@ -1,41 +1,33 @@
 PATH
   remote: .
   specs:
-    mux_ruby (1.9.0)
-      json (~> 2.1, >= 2.1.0)
+    mux_ruby (2.0.0.pre.rc.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    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.17)
-      sys-uname
-    autotest-growl (0.2.16)
-    autotest-rails-pure (4.1.2)
+    ast (2.4.2)
     byebug (11.1.1)
     coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.12.2)
-    hashdiff (1.0.1)
-    json (2.3.0)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.1)
+    jaro_winkler (1.5.4)
     method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     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)
+    psych (4.0.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -49,33 +41,30 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    safe_yaml (1.0.5)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
     solid_assert (1.0.0)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    vcr (3.0.3)
-    webmock (1.24.6)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  autotest (~> 4.4, >= 4.4.6)
-  autotest-fsevent (~> 0.2, >= 0.2.12)
-  autotest-growl (~> 0.2, >= 0.2.16)
-  autotest-rails-pure (~> 4.1, >= 4.1.2)
   mux_ruby!
   pry-byebug
-  rake (~> 12.3.3)
+  rake (~> 13.0.1)
   rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
   solid_assert
-  vcr (~> 3.0, >= 3.0.1)
-  webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   2.2.13
+   2.2.18

data/README.md

@@ -2,6 +2,8 @@
 
 ![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
 
+MuxRuby - the Ruby gem for the Mux API
+
 # Mux Ruby
 
 Official Mux API wrapper for ruby projects, supporting both Mux Data and Mux Video.
@@ -12,27 +14,48 @@ Official Mux API wrapper for ruby projects, supporting both Mux Data and Mux Vid
 
 Not familiar with Mux? Check out https://mux.com/ for more information.
 
-## Requirements
-
-Ruby 1.9.
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-Use `bundle install` to install dependencies if you're developing locally.
+- API version: v1
+- Package version: 2.0.0-rc.1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
 
-### Adding to your Gemfile
+### Build a gem
 
-This gem can be sourced from [RubyGems](https://rubygems.org/gems/mux_ruby)
+To build the Ruby code into a gem:
 
-```
-gem 'mux_ruby'
+```shell
+gem build mux_ruby.gemspec
 ```
 
-### Clone and install locally
+Then either install the gem locally:
+
+```shell
+gem install ./mux_ruby-2.0.0-rc.1.gem
 ```
-git clone https://github.com/muxinc/mux-ruby.git && cd mux-ruby
-gem build mux_ruby.gemspec
-gem install mux_ruby.gem
+
+(for development, run `gem install --dev ./mux_ruby-2.0.0-rc.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'mux_ruby', '~> 2.0.0-rc.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'mux_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
 ```
 
 ## Getting Started
@@ -122,7 +145,7 @@ If you run into problems, [please raise a GitHub issue,](https://github.com/muxi
 
 ## Contributing
 
-Please do not submit PRs against this package. It is generated from our OpenAPI definitions - [Please open an issue instead!](https://github.com/muxinc/mux-ruby/issues)
+We now accept PRs against this package! Please make your modifications to the templates in `gen/templates`, not the code itself, or [please open an issue.](https://github.com/muxinc/mux-ruby/issues)
 
 ## License
 

data/docs/AbridgedVideoView.md

@@ -1,18 +1,38 @@
 # MuxRuby::AbridgedVideoView
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**viewer_os_family** | **String** |  | [optional] 
-**viewer_application_name** | **String** |  | [optional] 
-**video_title** | **String** |  | [optional] 
-**total_row_count** | **Integer** |  | [optional] 
-**player_error_message** | **String** |  | [optional] 
-**player_error_code** | **String** |  | [optional] 
-**error_type_id** | **Integer** |  | [optional] 
-**country_code** | **String** |  | [optional] 
-**view_start** | **String** |  | [optional] 
-**view_end** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **viewer_os_family** | **String** |  | [optional] |
+| **viewer_application_name** | **String** |  | [optional] |
+| **video_title** | **String** |  | [optional] |
+| **total_row_count** | **Integer** |  | [optional] |
+| **player_error_message** | **String** |  | [optional] |
+| **player_error_code** | **String** |  | [optional] |
+| **error_type_id** | **Integer** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+| **view_start** | **String** |  | [optional] |
+| **view_end** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AbridgedVideoView.new(
+  id: null,
+  viewer_os_family: null,
+  viewer_application_name: null,
+  video_title: null,
+  total_row_count: null,
+  player_error_message: null,
+  player_error_code: null,
+  error_type_id: null,
+  country_code: null,
+  view_start: null,
+  view_end: null
+)
+```
 

data/docs/Asset.md

@@ -1,31 +1,62 @@
 # MuxRuby::Asset
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | Unique identifier for the Asset. | [optional] 
-**created_at** | **String** | Time at which the object was created. Measured in seconds since the Unix epoch. | [optional] 
-**deleted_at** | **String** |  | [optional] 
-**status** | **String** | The status of the asset. | [optional] 
-**duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional] 
-**max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] 
-**max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.  | [optional] 
-**aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] 
-**playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) |  | [optional] 
-**tracks** | [**Array<Track>**](Track.md) |  | [optional] 
-**errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] 
-**per_title_encode** | **BOOLEAN** |  | [optional] 
-**is_live** | **BOOLEAN** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] 
-**passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] 
-**live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] 
-**master** | [**AssetMaster**](AssetMaster.md) |  | [optional] 
-**master_access** | **String** |  | [optional] [default to 'none']
-**mp4_support** | **String** |  | [optional] [default to 'none']
-**source_asset_id** | **String** | Asset Identifier of the video used as the source for creating the clip. | [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]
-**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** | Indicates this asset is a test asset if the value is `true`. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the Asset. Max 255 characters. | [optional] |
+| **created_at** | **String** | Time the Asset was created, defined as a Unix timestamp (seconds since epoch). | [optional] |
+| **status** | **String** | The status of the asset. | [optional] |
+| **duration** | **Float** | The duration of the asset in seconds (max duration for a single asset is 24 hours). | [optional] |
+| **max_stored_resolution** | **String** | The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. | [optional] |
+| **max_stored_frame_rate** | **Float** | The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.  | [optional] |
+| **aspect_ratio** | **String** | The aspect ratio of the asset in the form of `width:height`, for example `16:9`. | [optional] |
+| **playback_ids** | [**Array<PlaybackID>**](PlaybackID.md) | An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/video/play-your-videos) for more details. | [optional] |
+| **tracks** | [**Array<Track>**](Track.md) | The individual media tracks that make up an asset. | [optional] |
+| **errors** | [**AssetErrors**](AssetErrors.md) |  | [optional] |
+| **per_title_encode** | **Boolean** |  | [optional] |
+| **is_live** | **Boolean** | Whether the asset is created from a live stream and the live stream is currently `active` and not in `idle` state. | [optional] |
+| **passthrough** | **String** | Arbitrary metadata set for the asset. Max 255 characters. | [optional] |
+| **live_stream_id** | **String** | Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream. | [optional] |
+| **master** | [**AssetMaster**](AssetMaster.md) |  | [optional] |
+| **master_access** | **String** |  | [optional][default to 'none'] |
+| **mp4_support** | **String** |  | [optional][default to 'none'] |
+| **source_asset_id** | **String** | Asset Identifier of the video used as the source for creating the clip. | [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] |
+| **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** | True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::Asset.new(
+  id: null,
+  created_at: null,
+  status: null,
+  duration: null,
+  max_stored_resolution: null,
+  max_stored_frame_rate: null,
+  aspect_ratio: null,
+  playback_ids: null,
+  tracks: null,
+  errors: null,
+  per_title_encode: null,
+  is_live: null,
+  passthrough: null,
+  live_stream_id: null,
+  master: null,
+  master_access: null,
+  mp4_support: null,
+  source_asset_id: null,
+  normalize_audio: null,
+  static_renditions: null,
+  recording_times: null,
+  non_standard_input_reasons: null,
+  test: null
+)
+```
 

data/docs/AssetErrors.md

@@ -1,9 +1,20 @@
 # MuxRuby::AssetErrors
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **String** | The type of error that occurred for this asset. | [optional] 
-**messages** | **Array<String>** | Error messages with more details. | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of error that occurred for this asset. | [optional] |
+| **messages** | **Array<String>** | Error messages with more details. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AssetErrors.new(
+  type: null,
+  messages: null
+)
+```
 

data/docs/AssetMaster.md

@@ -1,9 +1,20 @@
 # MuxRuby::AssetMaster
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** |  | [optional] 
-**url** | **String** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **url** | **String** | The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours. | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AssetMaster.new(
+  status: null,
+  url: null
+)
+```
 

data/docs/AssetNonStandardInputReasons.md

@@ -1,16 +1,34 @@
 # 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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **video_codec** | **String** | The video codec used on the input file. For example, the input file encoded with `hevc` video codec is non-standard and the value of this parameter is `hevc`. | [optional] |
+| **audio_codec** | **String** | The audio codec used on the input file. Non-AAC audio codecs are non-standard. | [optional] |
+| **video_gop_size** | **String** | The video key frame Interval (also called as Group of Picture or GOP) of the input file is `high`. This parameter is present when the gop is greater than 10 seconds. | [optional] |
+| **video_frame_rate** | **String** | The video frame rate of the input file. Video with average frames per second (fps) less than 10 or greater than 120 is non-standard. A `-1` frame rate value indicates Mux could not determine the frame rate of the video track. | [optional] |
+| **video_resolution** | **String** | The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as `width` x `height` in pixels. | [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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AssetNonStandardInputReasons.new(
+  video_codec: null,
+  audio_codec: null,
+  video_gop_size: null,
+  video_frame_rate: null,
+  video_resolution: null,
+  pixel_aspect_ratio: null,
+  video_edit_list: null,
+  audio_edit_list: null,
+  unexpected_media_file_parameters: null
+)
+```
 

data/docs/AssetRecordingTimes.md

@@ -1,9 +1,20 @@
 # 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] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **started_at** | **Time** | 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] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::AssetRecordingTimes.new(
+  started_at: null,
+  duration: null
+)
+```