mux_ruby 1.9.0 → 2.0.0.pre.rc.1

data/docs/VideoViewEvent.md

@@ -1,11 +1,24 @@
 # MuxRuby::VideoViewEvent
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**viewer_time** | **Integer** |  | [optional] 
-**playback_time** | **Integer** |  | [optional] 
-**name** | **String** |  | [optional] 
-**event_time** | **Integer** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **viewer_time** | **Integer** |  | [optional] |
+| **playback_time** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **event_time** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::VideoViewEvent.new(
+  viewer_time: null,
+  playback_time: null,
+  name: null,
+  event_time: null
+)
+```
 

data/docs/VideoViewResponse.md

@@ -1,9 +1,20 @@
 # MuxRuby::VideoViewResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**VideoView**](.md) |  | [optional] 
-**timeframe** | **Array<Integer>** |  | [optional] 
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**VideoView**](.md) |  | [optional] |
+| **timeframe** | **Array<Integer>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mux_ruby'
+
+instance = MuxRuby::VideoViewResponse.new(
+  data: null,
+  timeframe: null
+)
+```
 

data/docs/VideoViewsApi.md

@@ -2,22 +2,24 @@
 
 All URIs are relative to *https://api.mux.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_video_view**](VideoViewsApi.md#get_video_view) | **GET** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View
-[**list_video_views**](VideoViewsApi.md#list_video_views) | **GET** /data/v1/video-views | List Video Views
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_video_view**](VideoViewsApi.md#get_video_view) | **GET** /data/v1/video-views/{VIDEO_VIEW_ID} | Get a Video View |
+| [**list_video_views**](VideoViewsApi.md#list_video_views) | **GET** /data/v1/video-views | List Video Views |
 
 
-# **get_video_view**
-> VideoViewResponse get_video_view(video_view_id)
+## get_video_view
+
+> <VideoViewResponse> get_video_view(video_view_id)
 
 Get a Video View
 
 Returns the details of a video view 
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -30,19 +32,37 @@ api_instance = MuxRuby::VideoViewsApi.new
 video_view_id = 'abcd1234' # String | ID of the Video View
 
 begin
-  #Get a Video View
+  # Get a Video View
   result = api_instance.get_video_view(video_view_id)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling VideoViewsApi->get_video_view: #{e}"
+  puts "Error when calling VideoViewsApi->get_video_view: #{e}"
+end
+```
+
+#### Using the get_video_view_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VideoViewResponse>, Integer, Hash)> get_video_view_with_http_info(video_view_id)
+
+```ruby
+begin
+  # Get a Video View
+  data, status_code, headers = api_instance.get_video_view_with_http_info(video_view_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VideoViewResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling VideoViewsApi->get_video_view_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **video_view_id** | **String**| ID of the Video View | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **video_view_id** | **String** | ID of the Video View |  |
 
 ### Return type
 
@@ -54,21 +74,22 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_video_views
 
-# **list_video_views**
-> ListVideoViewsResponse list_video_views(opts)
+> <ListVideoViewsResponse> list_video_views(opts)
 
 List Video Views
 
 Returns a list of video views 
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'mux_ruby'
 # setup authorization
 MuxRuby.configure do |config|
@@ -79,35 +100,53 @@ end
 
 api_instance = MuxRuby::VideoViewsApi.new
 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`
+  limit: 56, # Integer | Number of items to include in the response
+  page: 56, # Integer | Offset by this many pages, of the size of `limit`
   viewer_id: 'viewer_id_example', # String | Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.
   error_id: 56, # Integer | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error.
-  order_direction: 'order_direction_example', # String | Sort order.
-  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. 
+  order_direction: 'asc', # String | Sort order.
+  filters: ['inner_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: ['inner_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
-  #List Video Views
+  # List Video Views
   result = api_instance.list_video_views(opts)
   p result
 rescue MuxRuby::ApiError => e
-  puts "Exception when calling VideoViewsApi->list_video_views: #{e}"
+  puts "Error when calling VideoViewsApi->list_video_views: #{e}"
+end
+```
+
+#### Using the list_video_views_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListVideoViewsResponse>, Integer, Hash)> list_video_views_with_http_info(opts)
+
+```ruby
+begin
+  # List Video Views
+  data, status_code, headers = api_instance.list_video_views_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListVideoViewsResponse>
+rescue MuxRuby::ApiError => e
+  puts "Error when calling VideoViewsApi->list_video_views_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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]
- **viewer_id** | **String**| Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux. | [optional] 
- **error_id** | **Integer**| Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] 
- **order_direction** | **String**| Sort order. | [optional] 
- **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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **viewer_id** | **String** | Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux. | [optional] |
+| **error_id** | **Integer** | Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error. | [optional] |
+| **order_direction** | **String** | Sort order. | [optional] |
+| **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
 
@@ -119,8 +158,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/gen/.gitignore

@@ -0,0 +1,7 @@
+node_modules/
+tmp/
+
+*.log
+*.bak
+
+template-changes.diff

data/gen/Makefile

@@ -0,0 +1,31 @@
+# per-SDK stuff
+GENERATOR_TYPE=ruby
+
+###### helper variables ######
+# this is in case we want to go to Docker or something other than running yarn
+# for OAS in the future. also less typing.
+OAS_CLI=yarn run -s oas
+CONFIG_PATH=./generator-config.json
+OUTPUT_DIR=..
+TEMPLATE_DIR=./templates
+GENERATED_TEMPLATE_DIR=./tmp/oas-base-templates
+
+ensure:
+	yarn install
+
+clean:
+	rm -rf tmp
+
+clean-products:
+	rm -rf "${OUTPUT_DIR}/lib"
+	rm -rf "${OUTPUT_DIR}/docs"
+
+build: ensure clean-products
+	${OAS_CLI} generate -g "${GENERATOR_TYPE}" -c "${CONFIG_PATH}" -t "${TEMPLATE_DIR}" -o "${OUTPUT_DIR}" -i "${OAS_SPEC_PATH}"
+
+config-help: ensure
+	${OAS_CLI} config-help -g "${GENERATOR_TYPE}"
+
+template-diff: ensure
+	${OAS_CLI} author template -g "${GENERATOR_TYPE}" -o "${GENERATED_TEMPLATE_DIR}"
+	diff "${TEMPLATE_DIR}" "${GENERATED_TEMPLATE_DIR}" > ./tmp/template-changes.diff

data/gen/generator-config.json

@@ -0,0 +1,11 @@
+{
+  "!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/ruby.md",
+  "gemName": "mux_ruby",
+  "gemAuthor": "Mux",
+  "gemAuthorEmail": "devex@mux.com",
+  "gemDescription": "The Ruby client for Mux Data and Mux Video.",
+  "gemHomepage": "https://docs.mux.com",
+  "gemLicense": "MIT",
+  "moduleName": "MuxRuby",
+  "gemVersion": "2.0.0-rc.1"
+}

data/gen/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "5.0.1"
+  }
+}

data/gen/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "scripts": {
+        "oas": "openapi-generator-cli",
+        "current-version": "jq -r .gemVersion < ./generator-config.json",
+        "compute-next-version:patch": "semver $(yarn run --silent current-version) -i patch",
+        "compute-next-version:minor": "semver $(yarn run --silent current-version) -i minor",
+        "compute-next-version:major": "semver $(yarn run --silent current-version) -i major",
+        "bump-version:patch": "jq -r \".gemVersion = \\\"$(yarn run -s compute-next-version:patch)\\\"\" < ./generator-config.json > ./generator-config.tmp.json && cp ./generator-config.json ./generator-config.json.bak && mv ./generator-config.tmp.json ./generator-config.json",
+        "build": ""
+    },
+    "dependencies": {
+        "@openapitools/openapi-generator-cli": "2.2.2",
+        "node-jq": "1.12.0",
+        "semver": "7.3.4"
+    }
+}

data/gen/templates/Gemfile.mustache

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

data/gen/templates/README.mustache

@@ -0,0 +1,158 @@
+![Mux Ruby Banner](github-ruby-sdk.png)
+
+![](https://github.com/muxinc/mux-ruby/workflows/Integration%20Test/badge.svg)
+
+{{moduleName}} - the Ruby gem for the {{appName}}
+
+# Mux Ruby
+
+Official Mux API wrapper for ruby projects, supporting both Mux Data and Mux Video.
+
+[Mux Video](https://mux.com/video) is an API-first platform, powered by data and designed by video experts to make beautiful video possible for every development team.
+
+[Mux Data](https://mux.com/data) is a platform for monitoring your video streaming performance with just a few lines of code. Get in-depth quality of service analytics on web, mobile, and OTT devices.
+
+Not familiar with Mux? Check out https://mux.com/ for more information.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: {{appVersion}}
+- Package version: {{gemVersion}}
+{{^hideGenerationTimestamp}}
+- Build date: {{generatedDate}}
+{{/hideGenerationTimestamp}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build {{{gemName}}}.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
+```
+
+(for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.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 '{{{gemName}}}', '~> {{{gemVersion}}}'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://{{gitHost}}/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}, then add the following in the Gemfile:
+
+    gem '{{{gemName}}}', :git => 'https://{{gitHost}}/{{#gitUserId}}{{.}}{{/gitUserId}}{{^gitUserId}}YOUR_GIT_USERNAME{{/gitUserId}}/{{#gitRepoId}}{{.}}{{/gitRepoId}}{{^gitRepoId}}YOUR_GIT_REPO{{/gitRepoId}}.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+### Overview
+
+Mux Ruby is a code generated lightweight wrapper around the Mux REST API and reflects them accurately. This has a few consequences you should watch out for:
+
+1) For almost all API responses, the object you're looking for will be in the `data` field on the API response object, as in the example below. This is because we designed our APIs with similar concepts to the [JSON:API](https://jsonapi.org/) standard. This means we'll be able to return more metadata from our API calls (such as related entities) without the need to make breaking changes to our APIs. We've decided not to hide that in this library.
+
+2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.
+
+### Authentication
+To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)
+
+Its up to you to manage your token and secret. In our examples, we read them from `MUX_TOKEN_ID` and `MUX_TOKEN_SECRET` in your environment.
+
+### Example Usage
+Below is a quick example of using Mux Ruby to list the Video assets stored in your Mux account.
+
+Be sure to also checkout the [exmples directory](examples/):
+* [List Assets, Live Streams, Signing Keys, and Uploads.](examples/video/list-everything.rb)
+* [Create an Asset, wait for it to become availiable, and print its playback URL](examples/video/ingest.rb)
+* [Create a new Live Stream and retrieve its Stream key.](examples/video/create-live-stream.rb)
+
+There's also example usage of every API call (also used for testing):
+* [Video](examples/video/)
+  * [Assets](examples/video/exercise-assets.rb)
+  * [Live Streams](examples/video/exercise-live-streams.rb)
+  * [Signing Keys](examples/video/exercise-signing-keys.rb)
+  * [Uploads](examples/video/exercise-uploads.rb)
+* [Data](examples/data/)
+  * [Errors](examples/data/exercise-errors.rb)
+  * [Exports](examples/data/exercise-exports.rb)
+  * [Filters](examples/data/exercise-filters.rb)
+  * [Metrics](examples/data/exercise-metrics.rb)
+  * [Video Views](examples/data/exercise-video-views.rb)
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'mux_ruby'
+
+# Auth Setup
+openapi = MuxRuby.configure do |config|
+  config.username = ENV['MUX_TOKEN_ID']
+  config.password = ENV['MUX_TOKEN_SECRET']
+end
+
+# API Client Init
+assets_api = MuxRuby::AssetsApi.new
+
+# List Assets
+puts "Listing Assets in account:\n\n"
+
+assets = assets_api.list_assets()
+assets.data.each do | asset |
+  puts "Asset ID: #{asset.id}"
+  puts "Status: #{asset.status}"
+  puts "Duration: #{asset.duration.to_s}\n\n"
+end
+```
+
+## Exceptions & Error Handling
+
+All errors inherit from `ApiError`, you can catch it or you can catch one of the more specific Errors below.
+
+### NotFoundError
+
+`NotFoundError` is thrown when a resource is not found. This is useful when trying to get an entity by its ID, for example `get_asset("some-id-here")` in the AssetsApi.
+
+### UnauthorizedError
+
+`UnauthorizedError` is thrown when Mux cannot authenticate your request. [You should check you have configured your credentials correctly.](#authentication)
+
+### ServiceError
+
+`ServiceError` is thrown when Mux returns a HTTP 5XX Status Code. If you encounter this reproducibly, please get in touch with [support@mux.com](mailto:support@mux.com).
+
+## Documentation
+
+[Be sure to check out the documentation in the `docs` directory.](docs/)
+
+## Issues
+
+If you run into problems, [please raise a GitHub issue,](https://github.com/muxinc/mux-ruby/issues) filling in the issue template. We'll take a look as soon as possible.
+
+## Contributing
+
+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
+
+[MIT License.](LICENSE) Copyright 2019 Mux, Inc.