wsc_sdk 1.3.1

data/examples/stream_targets/ull/list.rb

@@ -0,0 +1,24 @@
+####> 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__, pagination_page: 1, pagination_per_page: 25)
+
+# Extract some data into convenience variables
+stream_targets_ull      = $client.stream_targets.ull
+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)
+
+# Request the list of stream_targets_wowza using pagination
+list                    = stream_targets_ull.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 the Wowza stream targets") unless list.success?
+
+# Output the list of stream_targets_wowza
+# Defined in helpers.rb
+output_model_list(list, "Ull Stream Targets: #{list.keys.length}", true, :name)

data/examples/stream_targets/ull/update.rb

@@ -0,0 +1,43 @@
+####> 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__, ull_stream_target_id: nil, new_stream_target_name: nil)
+
+# Extract some data into convenience variables
+ull_stream_targets      = $client.stream_targets.ull
+ull_stream_target_id    = arguments[0]
+name                    = arguments[1]
+
+# Request the ull_stream_target object
+ull_stream_target       = ull_stream_targets.find(ull_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(ull_stream_target, "There was an error finding the ull stream target") unless ull_stream_target.success?
+
+# Update the ull_stream_target
+ull_stream_target.name  = name
+
+# If the ull_stream_target is invalid, output the messages and exit
+unless (ull_stream_target.valid?)
+  puts "Ull Stream Target is invalid:"
+
+  ull_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved                   = ull_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error saving the ull stream target") unless saved.success?
+
+# Output the ull_stream_target details
+# Defined in helpers.rb
+output_model_attributes(ull_stream_target, "Ull Stream Target: #{ull_stream_target.name}")

data/examples/stream_targets/wowza/create.rb

@@ -0,0 +1,42 @@
+####> 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__, stream_target_name: nil, use_secure_ingest: false, use_cors: false)
+
+# Extract some data into convenience variables
+wowza_stream_targets      = $client.stream_targets.wowza
+
+# Build a RTMP/pull wowza_stream_target using a predefined template, and modify a
+# few values
+name                      = arguments[0]
+secure_ingest             = arguments[1].to_s.downcase.start_with?("t","y","1")
+cors                      = arguments[2].to_s.downcase.start_with?("t","y","1")
+wowza_stream_target_data  = WscSdk::Templates::WowzaStreamTarget.akamai_cupertino(name, secure_ingest, cors)
+
+# Build the wowza_stream_target object
+wowza_stream_target       = wowza_stream_targets.build(wowza_stream_target_data)
+
+# If the wowza_stream_target is invalid, output the messages and exit
+unless (wowza_stream_target.valid?)
+  puts "Wowza Stream Target is invalid:"
+
+  wowza_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved                     = wowza_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error creating the wowza stream target") unless saved.success?
+
+# Output the wowza stream target
+# Defined in helpers.rb
+output_model_attributes(wowza_stream_target, "Wowza Stream Target: #{wowza_stream_target.name}")

data/examples/stream_targets/wowza/delete.rb

@@ -0,0 +1,31 @@
+####> 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__, wowza_stream_target_id: nil)
+
+# Extract some data into convenience variables
+wowza_stream_targets      = $client.stream_targets.wowza
+wowza_stream_target_id    = arguments[0]
+
+# Request the wowza_stream_target object
+wowza_stream_target       = wowza_stream_targets.find(wowza_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(wowza_stream_target, "There was an error finding the wowza stream target") unless wowza_stream_target.success?
+
+# Get the result of deleting the object from the API
+deleted                   = wowza_stream_target.delete
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(deleted, "There was an error deleting the wowza stream target") unless deleted.success?
+
+# If we've successfully deleted the wowza_stream_target, 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 helpers.rb
+output_model_attributes(wowza_stream_target, "Wowza Stream Target: #{wowza_stream_target.name}")

data/examples/stream_targets/wowza/find.rb

@@ -0,0 +1,23 @@
+####> 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__, wowza_stream_target_id: nil)
+
+# Extract some data into convenience variables
+wowza_stream_targets    = $client.stream_targets.wowza
+wowza_stream_target_id  = arguments[0]
+
+# Request the transcoder object
+wowza_stream_target     = wowza_stream_targets.find(wowza_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(wowza_stream_target, "There was an error finding the Wowza stream target") unless wowza_stream_target.success?
+
+# Output the wowza stream target
+# Defined in helpers.rb
+output_model_attributes(wowza_stream_target, "Wowza Stream Target: #{wowza_stream_target.name}")

data/examples/stream_targets/wowza/list.rb

@@ -0,0 +1,23 @@
+####> 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__, pagination_page: 1, pagination_per_page: 25)
+
+# Extract some data into convenience variables
+stream_targets_wowza    = $client.stream_targets.wowza
+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)
+
+# Request the list of stream_targets_wowza using pagination
+list                    = stream_targets_wowza.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 the Wowza stream targets") unless list.success?
+
+# Output the list of stream_targets_wowza
+output_model_list(list, "Wowza Stream Targets: #{list.keys.length}", true, :name)

data/examples/stream_targets/wowza/update.rb

@@ -0,0 +1,43 @@
+####> 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__, wowza_stream_target_id: nil, new_stream_target_name: nil)
+
+# Extract some data into convenience variables
+wowza_stream_targets      = $client.stream_targets.wowza
+wowza_stream_target_id    = arguments[0]
+name                      = arguments[1]
+
+# Request the wowza_stream_target object
+wowza_stream_target       = wowza_stream_targets.find(wowza_stream_target_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(wowza_stream_target, "There was an error finding the wowza stream target") unless wowza_stream_target.success?
+
+# Update the wowza_stream_target
+wowza_stream_target.name  = name
+
+# If the wowza_stream_target is invalid, output the messages and exit
+unless (wowza_stream_target.valid?)
+  puts "Wowza Stream Target is invalid:"
+
+  wowza_stream_target.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved                     = wowza_stream_target.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error saving the wowza stream target") unless saved.success?
+
+# Output the wowza_stream_target details
+# Defined in helpers.rb
+output_model_attributes(wowza_stream_target, "Wowza Stream Target: #{wowza_stream_target.name}")

data/examples/transcoders/create.rb

@@ -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
+
+arguments         = ask_for_arguments(__FILE__, transcoder_name: nil, source_url: nil)
+
+# Extract some data into convenience variables
+transcoders     = $client.transcoders
+name            = arguments[0]
+source_url      = arguments[1]
+
+# Build a RTMP/pull transcoder using a predefined template.
+transcoder_data = WscSdk::Templates::Transcoder.rtmp_pull(name, source_url)
+
+# Build the transcoder object
+transcoder      = transcoders.build(transcoder_data)
+
+# If the transcoder is invalid, output the messages and exit
+unless (transcoder.valid?)
+  puts "Transcoder is invalid:"
+
+  transcoder.errors.each do |field, message|
+    puts " - #{field}: #{message}"
+  end
+  exit
+end
+
+# Get the result of saving the object to the API
+saved = transcoder.save
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(saved, "There was an error creating the transcoder") unless saved.success?
+
+# Output the transcoder details
+# Defined in helpers.rb
+output_model_attributes(transcoder, "Transcoder: #{transcoder.name}")

data/examples/transcoders/delete.rb

@@ -0,0 +1,31 @@
+####> 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__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of deleting the object from the API
+deleted           = transcoder.delete
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(deleted, "There was an error deleting the transcoder") unless deleted.success?
+
+# If we've successfully deleted the transcoder 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 helpers.rb
+output_model_attributes(transcoder, "Transcoder: #{transcoder.name}")

data/examples/transcoders/find.rb

@@ -0,0 +1,23 @@
+####> 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__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Output transcoder details
+# Defined in helpers.rb
+output_model_attributes(transcoder, "Transcoder: #{transcoder.name}")

data/examples/transcoders/list.rb

@@ -0,0 +1,24 @@
+####> 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__, pagination_page: 1, pagination_per_page: 25)
+
+# Extract some data into convenience variables
+transcoders             = $client.transcoders
+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)
+
+# Request the list of transcoders using pagination
+list                    = transcoders.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 transcoders") unless list.success?
+
+# Output the list of transcoders
+# Define in helpers.rb
+output_model_list(list, "Transcoders: #{list.keys.length}", true, :name)

data/examples/transcoders/reset.rb

@@ -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
+arguments         = ask_for_arguments(__FILE__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of resetting the transcoder
+#
+# NOTE: You can also reset and wait for the transcoder state to transition to
+# a reset state.  See the `reset_and_wait` example.
+state             = transcoder.reset
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error resetting the transcoder") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Transcoder State:")

data/examples/transcoders/reset_and_wait.rb

@@ -0,0 +1,48 @@
+####> 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__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of resetting the transcoder.  We add a code block, which
+# instructs the SDK to enter a wait loop and periodically polls the API
+# for the transcoder state until either the `started` state is returned or
+# the timeout period is reached.
+state             = transcoder.reset do |wait_state, transcoder_state|
+  # This code will execute each time the state of the transcoder is polled
+  # during the wait loop. You can check the wait_state to determine what the
+  # outcomes of each request are.
+
+  if wait_state == :waiting
+    # We're still waiting for the started state to be returned
+    puts "Waiting..."
+  elsif wait_state == :complete
+    # We've successfully reset the transcoder, so output the completed state
+    # Defined in helpers.rb
+    output_model_attributes(transcoder_state, "Completed Transcoder State:")
+  elsif wait_state == :timeout
+    # A timeout occurs if the reset state isn't reached within the timeout
+    # limit, which defaults to 30 seconds.
+
+    puts "TIMEOUT: Could not reset the transcoder within the timeout period."
+  end
+end
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error starting the transcoder") unless state.success?
+
+output_model_attributes(state, "Final Transcoder State:")

data/examples/transcoders/start.rb

@@ -0,0 +1,33 @@
+####> 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__, transcoder_id: nil)
+
+# Extract some data into convenience variables
+transcoders       = $client.transcoders
+transcoder_id     = arguments[0]
+
+# Request the transcoder object
+transcoder        = transcoders.find(transcoder_id)
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(transcoder, "There was an error finding the transcoder") unless transcoder.success?
+
+# Get the result of starting the transcoder
+#
+# NOTE: You can also start and wait for the transcoder state to transition to
+# a started state.  See the `start_and_wait` example.
+#
+state             = transcoder.start
+
+# Handle an API error (in the helpers.rb file)
+handle_api_error(state, "There was an error starting the transcoder") unless state.success?
+
+# Output the transcoder state
+# Defined in helpers.rb
+output_model_attributes(state, "Transcoder State:")