wsc_sdk 1.3.1

data/lib/wsc_sdk/models/transcoder_string_stat.rb

@@ -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.
+
+require 'wsc_sdk/model'
+
+module WscSdk
+  module Models
+
+    # A model to represent the Stats of a Transcoder in the Wowza Streaming
+    # Cloud API.
+    #
+    class TranscoderStringStat < WscSdk::Model
+
+      model_name_singular :transcoder
+      model_name_plural   :transcoders
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :value,                     :string, access: :read
+      attribute :status,                    :string, access: :read
+      attribute :text,                      :string, access: :read
+      attribute :units,                     :string, access: :read
+
+      # Convert the stat to a string
+      #
+      def to_s
+        str = "#{value.to_s}#{units}"
+        str += " | #{self.text}" if status != "normal"
+        str
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb

@@ -0,0 +1,29 @@
+####> 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/model'
+
+module WscSdk
+  module Models
+
+    # A model to represent the Thumbnail URL of a Transcoder in the Wowza Streaming
+    # Cloud API.
+    #
+    class TranscoderThumbnailUrl < WscSdk::Model
+
+      model_name_singular :transcoder
+      model_name_plural   :transcoders
+
+      #---------------------------------------------------------------------------
+      #  ___     _
+      # / __| __| |_  ___ _ __  __ _
+      # \__ \/ _| ' \/ -_) '  \/ _` |
+      # |___/\__|_||_\___|_|_|_\__,_|
+      #
+      #---------------------------------------------------------------------------
+
+      attribute :thumbnail_url,  :string, access: :read
+
+    end
+  end
+end

data/lib/wsc_sdk/models/ull_stream_target.rb

@@ -0,0 +1,54 @@
+####> 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/model'
+require 'wsc_sdk/models/stream_target'
+
+module WscSdk
+  module Models
+
+    # A model to represent a ULL Stream Target in the Wowza Streaming Cloud API.
+    #
+    class UllStreamTarget < WscSdk::Model
+
+      model_name_singular :stream_target_ull
+      model_name_plural   :stream_targets_ull
+
+      attribute :id,                          :string,    access: :read
+      attribute :name,                        :string,    required: true
+      attribute :source_delivery_method,      :string,    required: true,   access: :new_model_access
+      attribute :source_url,                  :string,    required: :source_url_required_if_pull
+      attribute :type,                        :string,    access: :read
+      attribute :provider,                    :string
+      attribute :enabled,                     :boolean
+      attribute :enable_hls,                  :boolean
+      attribute :state,                       :string
+      attribute :ingest_ip_whitelist,         :array
+      attribute :region_override,             :string
+      attribute :stream_name,                 :string,    access: :read
+      attribute :primary_url,                 :string,    access: :read
+      attribute :playback_urls,               :hash,      access: :read
+      attribute :connection_code,             :string,    access: :read
+      attribute :connection_code_expires_at,  :datetime,  access: :read
+      attribute :created_at,                  :datetime,  access: :read
+      attribute :updated_at,                  :datetime,  access: :read
+
+      # Determines the access level of the model based on whether it's a new
+      # model or not.
+      #
+      # @return [Symbol]
+      #     Returns :read_write if it's a new model, or :read if it's not.
+      #
+      def new_model_access
+        self.new_model? ? :read_write : :read
+      end
+
+      # Determines the requirement of the source_url field based on whether the
+      # target has a `pull` source delivery method.
+      #
+      def source_url_required_if_pull
+        self.source_delivery_method == WscSdk::Enums::DeliveryMethod::PULL
+      end
+    end
+  end
+end

data/lib/wsc_sdk/models/wowza_stream_target.rb

@@ -0,0 +1,60 @@
+####> 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/model'
+
+module WscSdk
+  module Models
+
+    # A model to represent a Wowza Stream Target in the Wowza Streaming Cloud API.
+    #
+    class WowzaStreamTarget < WscSdk::Model
+
+      model_name_singular :stream_target_wowza
+      model_name_plural   :stream_targets_wowza
+
+      attribute :id,                          :string,    access: :read
+      attribute :name,                        :string,    required: true
+      attribute :type,                        :string,    access: :read
+      attribute :provider,                    :string
+      attribute :location,                    :string,    access: :new_location_access
+      attribute :use_secure_ingest,           :boolean,   access: :new_model_access
+      attribute :use_cors,                    :boolean,   access: :new_model_access
+      attribute :stream_name,                 :string,    access: :read
+      attribute :secure_ingest_query_param,   :string,    access: :read
+      attribute :username,                    :string,    access: :read
+      attribute :password,                    :string,    access: :read
+      attribute :primary_url,                 :string,    access: :read
+      attribute :backup_url,                  :string,    access: :read
+      attribute :hds_playback_url,            :string,    access: :read
+      attribute :hls_playback_url,            :string,    access: :read
+      attribute :rtmp_playback_url,           :string,    access: :read
+      attribute :connection_code,             :string,    access: :read
+      attribute :connection_code_expires_at,  :datetime,  access: :read
+      attribute :created_at,                  :datetime,  access: :read
+      attribute :updated_at,                  :datetime,  access: :read
+
+      # Determines the access level of the model based on whether it's a new
+      # model or not.
+      #
+      # @return [Symbol]
+      #     Returns :read_write if it's a new model, or :read if it's not.
+      #
+      def new_model_access
+        self.new_model? ? :read_write : :read
+      end
+
+      # Location can only be set if its a new record and not an Akmai Cupertino
+      # provider.
+      #
+      # @return [Symbol]
+      #     Returns :read_write if it's a new model and not a Akamai Cupertino
+      #     provider, or :read otherwise.
+      #
+      def new_location_access
+        (self.new_model? and not self.provider.start_with?("akamai_cupertino")) ? :read_write : :read
+      end
+
+    end
+  end
+end

data/lib/wsc_sdk/modules/api_response.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.
+
+module WscSdk
+
+  # Module that adds common functionality for an API response object.
+  #
+  module ApiResponse
+
+    # Determine if the response was a result of a successful API call.
+    #
+    # @return [Boolean]
+    #   An indication of the success of the call.
+    #
+    def success?
+      if @success.nil?
+        @success = true
+      end
+
+      @success
+    end
+
+  end
+end

data/lib/wsc_sdk/modules/loggable.rb

@@ -0,0 +1,44 @@
+####> 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.
+
+module WscSdk
+
+  # A module that adds access to a logger.
+  #
+  # This will check to see if a Client object is available, and use its logger
+  # otherwise it checks for an endpoint and will use its logger, as a last ditch
+  # it will build a new plain old logger that logs to STDOUT.
+  #
+  # There is a logger attribute accessor, so you can overwrite the logger with
+  # your own.
+  #
+  module Loggable
+
+    # Returns an instance of a logger.
+    #
+    # @return [Logger]
+    #   The assigned logger.
+    #
+    def logger
+      if @logger.nil?
+        if self.respond_to?(:client)
+          @logger = self.client.logger
+        elsif self.respond_to?(:endpoint)
+          @logger = self.endpoint.logger
+        end
+
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      @logger
+    end
+
+    # Sets the instance of logger.
+    #
+    # @param _logger [Logger]
+    #   The logger instance to use for logging.
+    def logger= _logger
+      @logger = _logger
+    end
+  end
+end

data/lib/wsc_sdk/modules/transcoder_shared_methods.rb

@@ -0,0 +1,221 @@
+####> 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.
+
+module WscSdk
+
+  # Module for providing methods to handle state actions and transitions for a
+  # Transcoder or Live Stream model, since they have a lot of shared
+  # functionality.
+  #
+  module TranscoderSharedMethods
+
+    #---------------------------------------------------------------------------
+    #    _      _   _
+    #   /_\  __| |_(_)___ _ _  ___
+    #  / _ \/ _|  _| / _ \ ' \(_-<
+    # /_/ \_\__|\__|_\___/_||_/__/
+    #
+    #---------------------------------------------------------------------------
+
+
+    # Start the transcoder/live stream
+    #
+    # If a block is passed to the call, the SDK will start a state request
+    # loop that checks the state of the transcoder for a given period of time
+    # (timeout). Each iteration of the wait loop will call the block with the
+    # current state of the wait loop, and the current state of the
+    # transcoder
+    #
+    # The wait state will be one of 3 options: :waiting, :complete or :timeout
+    #
+    # The loop will exit when the transcoder state is "started" or the timeout
+    # limit is reached.
+    #
+    # @param options [Hash] A hash of options
+    #
+    # @option options [Integer] :timeout (30) The maximum wait for a `started` state response.
+    # @option options [Integer] :poll_interval (5) The wait time (in seconds) between state requests.  (Min: 1)
+    #
+    # @return [WscSdk::Model::TranscoderState] The transcoder state after the method execution has completed.
+    #
+    # @yield [wait_state, transcoder_state] Calls the block with  the states of the wait loop and the transcoder.
+    # @yieldparam wait_state [Symbol] The current state of the wait loop.  Will always be one of the following: :waiting, :complete, :cannot_change_state or :timeout
+    # @yieldparam transcoder_state [WscSdk::Model::TranscoderState] The current transcoder state data.
+    #
+    # @example Simple Start Request
+    #   state = transcoder.start
+    #
+    # @example Start and Wait for Started
+    #   transcoder.start do |wait_state, transcoder_state|
+    #     if wait_state == :waiting
+    #       puts "Waiting for the transcoder to start..."
+    #     if wait_state == :timeout
+    #       puts "The transcoder did not start in within the timeout period."
+    #     else
+    #       puts "Transcoder is #{state.state}.  The IP Address is #{state.ip_address}."
+    #     end
+    #   end
+    #
+    def start(options={}, &block)
+      current_state = self.endpoint.start(self.id)
+      return wait_for_state(:started, options, &block) if current_state.success? and block_given?
+      return current_state
+    end
+
+    # Stop the transcoder
+    #
+    # If a block is passed to the call, the SDK will start a state request
+    # loop that checks the state of the transcoder for a given period of time
+    # (timeout). Each iteration of the wait loop will call the block with the
+    # current state of the wait loop, and the current state of the
+    # transcoder
+    #
+    # The wait state will be one of 3 options: :waiting, :complete or :timeout
+    #
+    # The loop will exit when the transcoder state is "stopped" or the timeout
+    # limit is reached.
+    #
+    # @param options [Hash] A hash of options
+    #
+    # @option options [Integer] :timeout (30) The maximum wait for a `stopped` state response.
+    # @option options [Integer] :poll_interval (5) The wait time (in seconds) between state requests.  (Min: 1)
+    #
+    # @return [WscSdk::Model::TranscoderState] The transcoder state after the method execution has completed.
+    #
+    # @yield [wait_state, transcoder_state] Calls the block with the states of the wait loop and the transcoder.
+    # @yieldparam wait_state [Symbol] The current state of the wait loop.  Will always be one of the following: :waiting, :complete, :cannot_change_state or :timeout
+    # @yieldparam transcoder_state [WscSdk::Model::TranscoderState] The current transcoder state data.
+    #
+    # @example Simple Stop Request
+    #   state = transcoder.stop
+    #
+    # @example Stop and Wait for Stopped
+    #   transcoder.stop do |wait_state, transcoder_state|
+    #     if wait_state == :waiting
+    #       puts "Waiting for the transcoder to stop..."
+    #     if wait_state == :timeout
+    #       puts "The transcoder did not stop in within the timeout period."
+    #     else
+    #       puts "Transcoder is #{state.state}."
+    #     end
+    #   end
+    #
+    def stop(options={}, &block)
+      current_state = self.endpoint.stop(self.id)
+      return wait_for_state(:stopped, options, &block) if current_state.success? and block_given?
+      return current_state
+    end
+
+    # Reset the transcoder/live stream
+    #
+    # If a block is passed to the call, the SDK will start a state request
+    # loop that checks the state of the transcoder for a given period of time
+    # (timeout). Each iteration of the wait loop will call the block with the
+    # current state of the wait loop, and the current state of the
+    # transcoder
+    #
+    # The wait state will be one of 3 options: :waiting, :complete or :timeout
+    #
+    # The loop will exit when the transcoder state is "started" or the timeout
+    # limit is reached.
+    #
+    # @param options [Hash] A hash of options
+    #
+    # @option options [Integer] :timeout (30) The maximum wait for a `started` state response.
+    # @option options [Integer] :poll_interval (5) The wait time (in seconds) between state requests.  (Min: 1)
+    #
+    # @return [WscSdk::Model::TranscoderState] The transcoder state after the method execution has completed.
+    #
+    # @yield [wait_state, transcoder_state] Calls the block with  the states of the wait loop and the transcoder.
+    # @yieldparam wait_state [Symbol] The current state of the wait loop.  Will always be one of the following: :waiting, :complete, :cannot_change_state or :timeout
+    # @yieldparam transcoder_state [WscSdk::Model::TranscoderState] The current transcoder state data.
+    #
+    # @example Simple Reset Request
+    #   state = transcoder.reset
+    #
+    # @example Reset and Wait for Started
+    #   transcoder.reset do |wait_state, transcoder_state|
+    #     if wait_state == :waiting
+    #       puts "Waiting for the transcoder to start..."
+    #     if wait_state == :timeout
+    #       puts "The transcoder did not start in within the timeout period."
+    #     else
+    #       puts "Transcoder is #{state.state}.  The IP Address is #{state.ip_address}."
+    #     end
+    #   end
+    #
+    def reset(options={}, &block)
+      current_state = self.endpoint.reset(self.id)
+      return wait_for_state(:started, options, &block) if current_state.success? and block_given?
+      return current_state
+    end
+
+    # Return the current state of the transcoder/live stream.
+    #
+    # @return [WscSdk::Model::TranscoderState]
+    #
+    def state
+      return self.endpoint.state(self.id)
+    end
+
+
+    # Return the url of the current thumbnail for transcoder/live stream.
+    #
+    # @return [WscSdk::Model::TranscoderThumbnailUrl]
+    #
+    def thumbnail_url
+      return self.endpoint.thumbnail_url(self.id)
+    end
+
+    # Return the url of the current stats for the transcoder/live stream.
+    #
+    # @return [WscSdk::Model::TranscoderStats]
+    #
+    def stats
+      return self.endpoint.stats(self.id)
+    end
+
+    # Wait for a given state to be returned from the API.
+    #
+    # @param state [Symbol] The name of the state we are expecting to be returned.
+    # @param options [Hash] A hash of options
+    #
+    # @option options [Integer] :timeout (120) The maximum wait (in seconds) for a `started` state response.
+    # @option options [Integer] :poll_interval (5) The wait time (in seconds) between state requests.  (Min: 1)
+    #
+    # @return [Array<Symbol, WscSdk::Model::TranscoderState>] The `state` of the transcoder when the request is made or when the state request loop is complete.
+    #
+    # @yield [wait_state, state] Returns the state of the waiting loop and the state of the of the transcoder when the transcoder has started, or the timeout has been reached.
+    # @yieldparam result [Symbol] The result of waiting for the transcoder start.  Returns either the current state of the transcoder, or :timeout if the wait timout was reached.
+    # @yieldparam state [WscSdk::Model::TranscoderState] The last transcoder state data before the start wait cycle was completed.
+    #
+    private def wait_for_state(state, options={}, block=Proc.new)
+      state             = state.to_sym
+      first             = true
+      timeout           = options.fetch(:timeout, 120)
+      poll_interval     = [options.fetch(:poll_interval, 5).to_i, 1].max
+      start             = Time.now
+      elapsed           = 0
+      wait_state        = :waiting
+      current_state     = nil
+
+      while((elapsed < timeout) and (wait_state == :waiting))
+        sleep(poll_interval) unless first # Don't sleep on the first iteration.
+        first           = false
+        current_state   = self.state
+        elapsed         = Time.now - start
+        wait_state      = :timeout if elapsed >= timeout
+
+        if current_state.success?
+          wait_state    = :complete if current_state.state.to_sym == state.to_sym
+        else
+          wait_state    = :cannot_change_state
+        end
+        block.call(wait_state, current_state)
+      end
+      result ||= :timeout
+      return current_state
+    end
+
+  end
+end