RubyGems - wsc_sdk - Versions diffs - 1.3.1 - Mend

wsc_sdk 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (265) hide show

checksums.yaml +7 -0
data/.circleci/config.yml +146 -0
data/.circleci/docker/build/Dockerfile +3 -0
data/.circleci/helpers/add_preamble.rb +29 -0
data/.circleci/helpers/build_docs.sh +5 -0
data/.circleci/helpers/build_gem.sh +5 -0
data/.circleci/helpers/debundle-context.sh +14 -0
data/.circleci/helpers/finalize_release.sh +24 -0
data/.circleci/helpers/publish_docs.sh +10 -0
data/.circleci/helpers/release_gem.sh +8 -0
data/.circleci/helpers/setup.sh +11 -0
data/.circleci/helpers/setup_aws.sh +13 -0
data/.circleci/helpers/setup_gem.sh +2 -0
data/.circleci/helpers/setup_git.sh +27 -0
data/.circleci/helpers/setup_rubygems.sh +15 -0
data/.circleci/helpers/test_integration.sh +12 -0
data/.circleci/helpers/test_unit.sh +6 -0
data/.circleci/jobs/publish-production.sh +17 -0
data/.circleci/jobs/publish-staging.sh +17 -0
data/.circleci/jobs/release-production.sh +21 -0
data/.circleci/jobs/test-integration.sh +9 -0
data/.circleci/jobs/test-unit.sh +9 -0
data/.circleci/tag_repo.rb +46 -0
data/.gitignore +28 -0
data/.rspec +2 -0
data/.yard/config +2 -0
data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
data/.yard/template/default/layout/html/footer.erb +0 -0
data/.yard/template/default/layout/html/headers.erb +10 -0
data/.yard/template/default/layout/html/layout.erb +45 -0
data/.yard/template/default/layout/html/setup.rb +24 -0
data/.yardopts +1 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +6 -0
data/Gemfile.lock +99 -0
data/LICENSE.txt +28 -0
data/README.md +397 -0
data/Rakefile +2 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/doc/Hash.html +291 -0
data/doc/WscSdk.html +570 -0
data/doc/WscSdk/ApiResponse.html +242 -0
data/doc/WscSdk/Attributes.html +128 -0
data/doc/WscSdk/Attributes/Mode.html +191 -0
data/doc/WscSdk/Attributes/Type.html +389 -0
data/doc/WscSdk/Client.html +2677 -0
data/doc/WscSdk/Configuration.html +595 -0
data/doc/WscSdk/Endpoint.html +2974 -0
data/doc/WscSdk/Endpoints.html +141 -0
data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
data/doc/WscSdk/Endpoints/Outputs.html +180 -0
data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
data/doc/WscSdk/Enum.html +225 -0
data/doc/WscSdk/Enums.html +321 -0
data/doc/WscSdk/Enums/BillingMode.html +188 -0
data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
data/doc/WscSdk/Enums/BufferSize.html +301 -0
data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
data/doc/WscSdk/Enums/CustomProvider.html +252 -0
data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
data/doc/WscSdk/Enums/DeliveryType.html +188 -0
data/doc/WscSdk/Enums/Encoder.html +460 -0
data/doc/WscSdk/Enums/Errors.html +555 -0
data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
data/doc/WscSdk/Enums/ImagePosition.html +220 -0
data/doc/WscSdk/Enums/ModelMode.html +175 -0
data/doc/WscSdk/Enums/ModelType.html +373 -0
data/doc/WscSdk/Enums/PlayerType.html +188 -0
data/doc/WscSdk/Enums/Protocol.html +204 -0
data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
data/doc/WscSdk/Enums/TranscoderType.html +188 -0
data/doc/WscSdk/Enums/UserRegion.html +383 -0
data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
data/doc/WscSdk/Errors.html +683 -0
data/doc/WscSdk/Loggable.html +346 -0
data/doc/WscSdk/Model.html +3316 -0
data/doc/WscSdk/ModelList.html +442 -0
data/doc/WscSdk/ModelTemplate.html +267 -0
data/doc/WscSdk/Models.html +141 -0
data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
data/doc/WscSdk/Models/Error.html +351 -0
data/doc/WscSdk/Models/LiveStream.html +601 -0
data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
data/doc/WscSdk/Models/LiveStreamState.html +200 -0
data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
data/doc/WscSdk/Models/Output.html +294 -0
data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
data/doc/WscSdk/Models/StreamTarget.html +273 -0
data/doc/WscSdk/Models/Transcoder.html +793 -0
data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
data/doc/WscSdk/Models/TranscoderState.html +196 -0
data/doc/WscSdk/Models/TranscoderStats.html +196 -0
data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
data/doc/WscSdk/Pagination.html +1277 -0
data/doc/WscSdk/Schema.html +861 -0
data/doc/WscSdk/SchemaAttribute.html +2400 -0
data/doc/WscSdk/Templates.html +141 -0
data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
data/doc/WscSdk/Templates/LiveStream.html +1432 -0
data/doc/WscSdk/Templates/Output.html +829 -0
data/doc/WscSdk/Templates/Transcoder.html +699 -0
data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
data/doc/_index.html +705 -0
data/doc/class_list.html +51 -0
data/doc/css/bootstrap.css +5 -0
data/doc/css/common.css +1 -0
data/doc/css/custom.css +151 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.README.html +570 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/images/wsc-ruby-1800x400.png +0 -0
data/doc/index.html +570 -0
data/doc/js/app.js +292 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +1731 -0
data/doc/top-level-namespace.html +182 -0
data/examples/client.rb +40 -0
data/examples/helpers.rb +100 -0
data/examples/live_streams/create.rb +39 -0
data/examples/live_streams/delete.rb +32 -0
data/examples/live_streams/find.rb +22 -0
data/examples/live_streams/flood.rb +126 -0
data/examples/live_streams/list.rb +24 -0
data/examples/live_streams/regenerate_connection_code.rb +29 -0
data/examples/live_streams/reset.rb +32 -0
data/examples/live_streams/reset_and_wait.rb +51 -0
data/examples/live_streams/start.rb +33 -0
data/examples/live_streams/start_and_wait.rb +51 -0
data/examples/live_streams/state.rb +33 -0
data/examples/live_streams/stats.rb +43 -0
data/examples/live_streams/stop.rb +33 -0
data/examples/live_streams/stop_and_wait.rb +51 -0
data/examples/live_streams/thumbnail_url.rb +46 -0
data/examples/live_streams/update.rb +43 -0
data/examples/live_streams/workflow.rb +165 -0
data/examples/output_stream_targets/create.rb +56 -0
data/examples/output_stream_targets/delete.rb +45 -0
data/examples/output_stream_targets/find.rb +37 -0
data/examples/output_stream_targets/list.rb +36 -0
data/examples/output_stream_targets/update.rb +56 -0
data/examples/outputs/create.rb +49 -0
data/examples/outputs/delete.rb +39 -0
data/examples/outputs/find.rb +31 -0
data/examples/outputs/list.rb +29 -0
data/examples/outputs/update.rb +50 -0
data/examples/stream_targets/custom/create.rb +42 -0
data/examples/stream_targets/custom/delete.rb +31 -0
data/examples/stream_targets/custom/find.rb +23 -0
data/examples/stream_targets/custom/list.rb +24 -0
data/examples/stream_targets/custom/update.rb +43 -0
data/examples/stream_targets/list.rb +24 -0
data/examples/stream_targets/ull/create.rb +41 -0
data/examples/stream_targets/ull/delete.rb +31 -0
data/examples/stream_targets/ull/find.rb +23 -0
data/examples/stream_targets/ull/list.rb +24 -0
data/examples/stream_targets/ull/update.rb +43 -0
data/examples/stream_targets/wowza/create.rb +42 -0
data/examples/stream_targets/wowza/delete.rb +31 -0
data/examples/stream_targets/wowza/find.rb +23 -0
data/examples/stream_targets/wowza/list.rb +23 -0
data/examples/stream_targets/wowza/update.rb +43 -0
data/examples/transcoders/create.rb +39 -0
data/examples/transcoders/delete.rb +31 -0
data/examples/transcoders/find.rb +23 -0
data/examples/transcoders/list.rb +24 -0
data/examples/transcoders/reset.rb +32 -0
data/examples/transcoders/reset_and_wait.rb +48 -0
data/examples/transcoders/start.rb +33 -0
data/examples/transcoders/start_and_wait.rb +50 -0
data/examples/transcoders/state.rb +33 -0
data/examples/transcoders/stats.rb +43 -0
data/examples/transcoders/stop.rb +33 -0
data/examples/transcoders/stop_and_wait.rb +50 -0
data/examples/transcoders/thumbnail_url.rb +46 -0
data/examples/transcoders/update.rb +43 -0
data/images/wsc-ruby-1800x400.png +0 -0
data/lib/wsc_sdk.rb +81 -0
data/lib/wsc_sdk/client.rb +417 -0
data/lib/wsc_sdk/configuration.rb +21 -0
data/lib/wsc_sdk/constants.rb +29 -0
data/lib/wsc_sdk/endpoint.rb +492 -0
data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
data/lib/wsc_sdk/enums.rb +31 -0
data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
data/lib/wsc_sdk/enums/encoder.rb +71 -0
data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
data/lib/wsc_sdk/enums/image_position.rb +26 -0
data/lib/wsc_sdk/enums/player_type.rb +20 -0
data/lib/wsc_sdk/enums/protocol.rb +23 -0
data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
data/lib/wsc_sdk/errors.rb +115 -0
data/lib/wsc_sdk/model.rb +515 -0
data/lib/wsc_sdk/model_list.rb +42 -0
data/lib/wsc_sdk/model_template.rb +27 -0
data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
data/lib/wsc_sdk/models/error.rb +53 -0
data/lib/wsc_sdk/models/live_stream.rb +130 -0
data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
data/lib/wsc_sdk/models/output.rb +61 -0
data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
data/lib/wsc_sdk/models/stream_target.rb +29 -0
data/lib/wsc_sdk/models/transcoder.rb +135 -0
data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
data/lib/wsc_sdk/modules/api_response.rb +24 -0
data/lib/wsc_sdk/modules/loggable.rb +44 -0
data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
data/lib/wsc_sdk/pagination.rb +89 -0
data/lib/wsc_sdk/schema.rb +140 -0
data/lib/wsc_sdk/schema_attribute.rb +349 -0
data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
data/lib/wsc_sdk/templates/live_stream.rb +234 -0
data/lib/wsc_sdk/templates/output.rb +133 -0
data/lib/wsc_sdk/templates/transcoder.rb +97 -0
data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
data/lib/wsc_sdk/version.rb +7 -0
data/wsc_sdk.gemspec +48 -0
metadata +460 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,182 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Wowza Streaming Cloud - SDK Code Documentation</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/custom.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="wowza-wrapper">
+      <header>
+        <div class="logo">
+          <a href="https://www.wowza.com">
+            <img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
+          </a>
+          <h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
+          <div class="clearfix"></div>
+        </div>
+        <div class="links">
+          <a href="https://www.wowza.com/">Wowza Home</a>
+          <a href="https://www.wowza.com/docs">Docs & APIS</a>
+          <a href="https://www.wowza.com/community/index.html">Forums</a>
+          <a href="https://www.wowza.com/support">Support</a>
+        </div>
+        <div class="clearfix"></div>
+      </header>
+      <div id="content">
+        <div class="nav_wrap">
+          <iframe id="nav" src="class_list.html?1"></iframe>
+          <div id="resizer"></div>
+        </div>
+        <div id="main" tabindex="-1">
+          <div id="header">
+            <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+            <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+            <div class="clear"></div>
+          </div>
+          <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="WscSdk.html" title="WscSdk (module)">WscSdk</a></span>
+</p>
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+    <dl class="constants">
+        <dt id="WSC_SDK_ROOT_PATH-constant" class="">WSC_SDK_ROOT_PATH =
+          <div class="docstring">
+  <div class="discussion">
+<p>The root path of the SDK code base.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span style="color:#036;font-weight:bold">File</span>.expand_path(<span style="color:#036;font-weight:bold">File</span>.join(<span style="color:#036;font-weight:bold">File</span>.dirname(<span style="color:#069">__FILE__</span>), <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">..</span><span style="color:#710">&quot;</span></span>))</pre></dd>
+        <dt id="WSC_SDK_LIB_PATH-constant" class="">WSC_SDK_LIB_PATH =
+          <div class="docstring">
+  <div class="discussion">
+<p>The ./lib path of the SDK code base</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span style="color:#036;font-weight:bold">File</span>.join(<span style="color:#036;font-weight:bold">WSC_SDK_ROOT_PATH</span>, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">lib</span><span style="color:#710">&quot;</span></span>)</pre></dd>
+        <dt id="WSC_SDK_PATH-constant" class="">WSC_SDK_PATH =
+          <div class="docstring">
+  <div class="discussion">
+<p>The ./lib/wsc_sdk path of the SDK code base</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+        </dt>
+        <dd><pre class="code"><span style="color:#036;font-weight:bold">File</span>.join(<span style="color:#036;font-weight:bold">WSC_SDK_LIB_PATH</span>, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">wsc_sdk</span><span style="color:#710">&quot;</span></span>)</pre></dd>
+    </dl>
+</div>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/examples/client.rb ADDED

@@ -0,0 +1,40 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+# Establish a client with your API authentication information
+#
+# This uses environment variables to set the API key and access key.  This
+# approach is recommended to add a layer of protection against exposing your
+# API keys.
+#
+raise "WSC_API_KEY environment variable is not set" unless ENV.has_key?('WSC_API_KEY')
+raise "WSC_API_ACCESS_KEY environment variable is not set" unless ENV.has_key?('WSC_API_ACCESS_KEY')
+# Logging is disabled by default, but you can turn on it on by uncommenting the
+# logger.level line below.
+logger = Logger.new(STDOUT)
+# logger.level = Logger::Severity::UNKNOWN # Disable logging output
+# logger.level = Logger::Severity::WARN # Enable logging output
+logger.level = Logger::Severity::DEBUG # Enable logging output
+WscSdk.configure do |config|
+  config.api_key      = ENV['WSC_API_KEY']
+  config.access_key   = ENV['WSC_API_ACCESS_KEY']
+  config.logger       = logger
+  # This value is set to Production, but you can change it to
+  # WscSdk::SANDBOX_HOSTNAME if you want to test your code before incurring
+  # charges on your account.
+  #
+  # NOTE: You will need to update your keys if you switch between the Production
+  # and Sandbox hostnames.
+  #
+  config.hostname     = WscSdk::PRODUCTION_HOSTNAME
+end
+$client     = WscSdk::Client.new
+logger.debug("Client Info:")
+$client.info.each do |k, v|
+  logger.debug(" |> #{k.to_s.ljust(20)}: #{v}")
+end

data/examples/helpers.rb ADDED

@@ -0,0 +1,100 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+# Generate usage output
+def output_usage(filename, *args)
+  puts
+  puts "usage: bundle exec ruby #{filename} #{args.map{ |a| a.to_s}.join(" ")}"
+  puts
+  exit 1
+end
+def ask_for_argument(arg, default=nil, arg_width=20)
+  message = "Enter argument value | #{arg.ljust(arg_width)} : "
+  message += "[#{default}] " unless default.nil?
+  print ">> #{message}"
+  response = STDIN.gets.chomp.strip
+  response = default if response.nil? or (response.length == 0)
+  return response
+end
+# Ask for user input on any args not passed into the example script.
+#
+def ask_for_arguments(filename, args={})
+  responses     = []
+  arg_index     = 0
+  max_arg_width = args.keys.map{ |k| k.to_s.length }.max
+  puts ""
+  args.each do |arg, default|
+    value = ARGV[arg_index]
+    arg_index += 1
+    if value.nil? or (value.length == 0)
+      response = ask_for_argument(arg.to_s, default, max_arg_width)
+    else
+      response = value
+    end
+    response = response.to_s
+    output_usage(filename, args.keys) if response.length == 0
+    responses << response
+  end
+  responses
+end
+# Exits the example, unless the result is a success
+def handle_api_error(result, message)
+  return if result.success?
+  output_model_attributes(result, "The API Generated an error: #{message}")
+  exit 1
+end
+# Outputs the attribute values of a model
+#
+# NOTE: This approach directly accesses the attributes for a model.  This is
+# okay for reading data out of a model, but data assignment should be done using
+# the getter (model.attribute) and setter (model.attribute=value) methods that
+# are built into the model.  Otherwise you will be bypassing the structures
+# necessary to validate the data, which may generate unwanted outcomes.
+#
+def output_model_attributes(model, title="Model Attributes")
+  puts ""
+  puts title
+  puts ""
+  max_attribute_width = model.attributes.keys.map{ |a| a.to_s.length }.max
+  model.attributes.each do |attribute, value|
+    puts " |>  #{attribute.to_s.ljust(max_attribute_width)} : #{value}"
+  end
+  puts ""
+end
+# Outputs a list of models.
+#
+def output_model_list(list, title="Model List", include_pagination=false, attribute=:to_s)
+  puts ""
+  puts title
+  puts ""
+  list.each do |id, model|
+    puts " |> #{id.to_s.ljust(10)} : #{model.send(attribute)}"
+  end
+  if include_pagination
+    # Output pagination information
+    #
+    puts ""
+    puts "Showing records #{list.pagination.page_first_index+1} - #{list.pagination.page_last_index+1} of #{list.pagination.total_records}"
+    puts "Currently on page #{list.pagination.page} of #{list.pagination.total_pages}"
+    puts ""
+    puts " |> Is first page  : #{list.pagination.first_page?}"
+    puts " |> First page #   : #{list.pagination.first_page}"
+    puts " |> Next page      : #{list.pagination.next_page}"
+    puts " |> Previous page  : #{list.pagination.previous_page}"
+    puts " |> Is last page   : #{list.pagination.last_page?}"
+    puts " |> Last page #    : #{list.pagination.last_page}"
+    puts ""
+  end
+end

data/examples/live_streams/create.rb ADDED

@@ -0,0 +1,39 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+require "wsc_sdk"
+require_relative "../client"  # Include our client configuration
+require_relative "../helpers" # Include some helpers to make the code more direct
+# Ensure the args passed in are present.
+arguments         = ask_for_arguments(__FILE__, live_stream_name: nil, source_url: nil)
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+# Build a RTMP/pull live_stream using a predefined template
+name              = arguments[0]
+source_url        = arguments[1]
+live_stream_data  = WscSdk::Templates::LiveStream.rtmp_pull(name, 1920, 1080, source_url)
+# Build the live_stream object
+live_stream       = live_streams.build(live_stream_data)
+# If the live_stream is invalid, output the messages and exit
+unless (live_stream.valid?)
+  puts "Live Stream is invalid:"
+  live_stream.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+# Get the result of saving the object to the API
+saved             = live_stream.save
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error creating the live stream") unless saved.success?
+# Defined in the helpers.rb file.
+output_model_attributes(live_stream, "Live Stream: #{live_stream.name}")

data/examples/live_streams/delete.rb ADDED

@@ -0,0 +1,32 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+# Ensure the args passed in are present, if not ask for them.
+arguments         = ask_for_arguments(__FILE__, live_stream_id: nil)
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+# Get the result of deleting the object from the API
+deleted = live_stream.delete
+# Handle an API error (in the helpers.rb file)
+handle_api_error(deleted, "There was an error deleting the live stream") unless deleted.success?
+# If we've successfully deleted the live_stream then output the details.
+# Note that the data for the output still exists locally in the SDK, however the
+# ID has been removed since it no longer references a valid record in the API.
+# Defined in the helpers.rb file.
+output_model_attributes(live_stream, "Live Stream: #{live_stream.name}")

data/examples/live_streams/find.rb ADDED

@@ -0,0 +1,22 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+# Ensure the args passed in are present
+arguments         = ask_for_arguments(__FILE__, live_stream_id: nil)
+# Extract some data into convenience variables
+live_streams      = $client.live_streams
+live_stream_id    = arguments[0]
+# Request the live_stream object
+live_stream       = live_streams.find(live_stream_id)
+# Handle an API error (in the helpers.rb file)
+handle_api_error(live_stream, "There was an error finding the live stream") unless live_stream.success?
+# Defined in the helpers.rb file.
+output_model_attributes(live_stream, "Live Stream: #{live_stream.name}")

data/examples/live_streams/flood.rb ADDED

@@ -0,0 +1,126 @@
+####> This code and all components © 2015 – 2019 Wowza Media Systems, LLC. All rights reserved.
+####> This code is licensed pursuant to the BSD 3-Clause License.
+require "wsc_sdk"
+require_relative "../client"  # Get our client
+require_relative "../helpers" # Include some helpers to make the code more direct
+# Ensure the args passed in are present, if not ask for them.
+arguments       = ask_for_arguments(__FILE__, { pagination_page: 1, pagination_per_page: 25 })
+# Extract some data into convenience variables
+page            = arguments[0]   # First argument is the page number (default: 1)
+per_page        = arguments[1]   # Second argument is the items per page (default: 25, max: 1000)
+mutex = Mutex.new
+live_stream_thread = Thread.new {
+  list = nil
+  mutex.synchronize {
+    models          = $client.live_streams
+    # Request the list of live_streams using pagination
+    list            = models.list(pagination: { page: page.to_i, per_page: per_page.to_i })
+    # Handle an API error (in the helpers.rb file)
+    handle_api_error(list, "There was an error retrieving the list of live streams") unless list.success?
+  }
+  start         = Time.now.to_f
+  last_request  = nil
+  request_num   = 1
+  list.each do |id, model|
+    model = nil
+    mutex.synchronize {
+      model         = $client.live_streams.find(id)
+      # Handle an API error (in the helpers.rb file)
+      handle_api_error(model, "There was an error retrieving the live stream") unless model.success?
+    }
+    elapsed       = Time.now.to_f - start
+    duration      = Time.now.to_f - (last_request || Time.now.to_f)
+    last_request  = $client.last_request_time
+    puts "Requested #{model.class.name.split("::").last}: #{id} | Name: #{model.name} | ##{request_num} | Duration: #{duration} | Elapsed: #{elapsed}"
+    request_num += 1
+  end
+}
+live_stream_state_thread = Thread.new {
+  begin
+    list = nil
+    mutex.synchronize {
+      models          = $client.live_streams
+      # Request the list of live_streams using pagination
+      list            = models.list(pagination: { page: page.to_i, per_page: per_page.to_i })
+      # Handle an API error (in the helpers.rb file)
+      handle_api_error(list, "There was an error retrieving the list of live streams") unless list.success?
+    }
+    puts "State!!!!"
+    start         = Time.now.to_f
+    last_request  = nil
+    request_num   = 1
+    list.each do |id, model|
+      puts "ID: #{id}"
+      model = nil
+      mutex.synchronize {
+        begin
+          model         = model.state
+        rescue Exception => e
+          puts "Live Stream State Error: #{exception.message} | #{exception.backtrace[0..8].join("\n")}"
+        end
+        # Handle an API error (in the helpers.rb file)
+        handle_api_error(model, "There was an error retrieving the live stream state") unless model.success?
+      }
+      elapsed       = Time.now.to_f - start
+      duration      = Time.now.to_f - (last_request || Time.now.to_f)
+      last_request  = $client.last_request_time
+      puts "Requested #{model.class.name.split("::").last}: #{id} | STate: #{model.state} | ##{request_num} | Duration: #{duration} | Elapsed: #{elapsed}"
+      request_num += 1
+    end
+  rescue Exception => e
+    puts "Live Stream State Error: #{exception.message} | #{exception.backtrace[0..8].join("\n")}"
+  end
+}
+stream_target_thread = Thread.new {
+  list = nil
+  mutex.synchronize {
+    models          = $client.stream_targets.wowza
+    # Request the list of live_streams using pagination
+    list            = models.list(pagination: { page: page.to_i, per_page: per_page.to_i })
+    # Handle an API error (in the helpers.rb file)
+    handle_api_error(list, "There was an error retrieving the list of live streams") unless list.success?
+  }
+  start         = Time.now.to_f
+  last_request  = nil
+  request_num   = 1
+  list.each do |id, model|
+    model = nil
+    mutex.synchronize {
+      model         = $client.stream_targets.wowza.find(id)
+      # Handle an API error (in the helpers.rb file)
+      handle_api_error(model, "There was an error retrieving the wowza stream target") unless model.success?
+    }
+    elapsed       = Time.now.to_f - start
+    duration      = Time.now.to_f - (last_request || Time.now.to_f)
+    last_request  = Time.now.to_f
+    puts "Requested #{model.class.name.split("::").last}: #{id} | Name: #{model.name} | ##{request_num} | Duration: #{duration} | Elapsed: #{elapsed}"
+    request_num += 1
+  end
+}
+live_stream_thread.join
+live_stream_state_thread.join
+stream_target_thread.join