mux_ruby 3.3.0 → 3.5.0

data/lib/mux_ruby/models/update_referrer_domain_restriction_request.rb

@@ -14,196 +14,91 @@ require 'date'
 require 'time'
 
 module MuxRuby
-  class UpdateReferrerDomainRestrictionRequest
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::UpdateReferrerDomainRestrictionRequest` initialize method"
+  module UpdateReferrerDomainRestrictionRequest
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ReferrerDomainRestriction'
+        ]
       end
 
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::UpdateReferrerDomainRestrictionRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are defacto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
         end
-      end
 
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = MuxRuby.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        openapi_one_of.include?(:AnyType) ? data : nil
       end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
 
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = MuxRuby.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise unless (data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model && model.valid?
+            end
+          end
         end
 
-        hash[param] = _to_hash(value)
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
       end
-      hash
     end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end

data/lib/mux_ruby/models/video_view.rb

@@ -515,6 +515,109 @@ module MuxRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'view_total_upscaling',
+        :'preroll_ad_asset_hostname',
+        :'player_source_domain',
+        :'region',
+        :'viewer_user_agent',
+        :'preroll_requested',
+        :'page_type',
+        :'startup_score',
+        :'view_seek_duration',
+        :'country_name',
+        :'player_source_height',
+        :'longitude',
+        :'buffering_count',
+        :'video_duration',
+        :'player_source_type',
+        :'city',
+        :'platform_description',
+        :'video_startup_preroll_request_time',
+        :'viewer_device_name',
+        :'video_series',
+        :'viewer_application_name',
+        :'view_total_content_playback_time',
+        :'cdn',
+        :'player_instance_id',
+        :'video_language',
+        :'player_source_width',
+        :'player_error_message',
+        :'player_mux_plugin_version',
+        :'playback_score',
+        :'page_url',
+        :'metro',
+        :'view_max_request_latency',
+        :'requests_for_first_preroll',
+        :'view_total_downscaling',
+        :'latitude',
+        :'player_source_host_name',
+        :'mux_embed_version',
+        :'player_language',
+        :'page_load_time',
+        :'viewer_device_category',
+        :'video_startup_preroll_load_time',
+        :'player_version',
+        :'watch_time',
+        :'player_source_stream_type',
+        :'preroll_ad_tag_hostname',
+        :'viewer_device_manufacturer',
+        :'rebuffering_score',
+        :'experiment_name',
+        :'viewer_os_version',
+        :'buffering_duration',
+        :'player_view_count',
+        :'player_software',
+        :'player_load_time',
+        :'platform_summary',
+        :'video_encoding_variant',
+        :'player_width',
+        :'view_seek_count',
+        :'viewer_experience_score',
+        :'view_error_id',
+        :'video_variant_name',
+        :'preroll_played',
+        :'viewer_application_engine',
+        :'viewer_os_architecture',
+        :'player_error_code',
+        :'buffering_rate',
+        :'player_name',
+        :'view_average_request_throughput',
+        :'video_producer',
+        :'error_type_id',
+        :'video_id',
+        :'continent_code',
+        :'video_content_type',
+        :'viewer_os_family',
+        :'player_poster',
+        :'view_average_request_latency',
+        :'video_variant_id',
+        :'player_source_duration',
+        :'player_source_url',
+        :'video_title',
+        :'rebuffer_percentage',
+        :'time_to_first_frame',
+        :'viewer_user_id',
+        :'video_stream_type',
+        :'player_startup_time',
+        :'viewer_application_version',
+        :'view_max_downscale_percentage',
+        :'view_max_upscale_percentage',
+        :'country_code',
+        :'isp',
+        :'player_height',
+        :'asn',
+        :'asn_name',
+        :'quality_score',
+        :'player_software_version',
+        :'player_mux_plugin_name',
+        :'sub_property_id',
+        :'player_remote_played',
+        :'view_max_playhead_position',
+        :'view_playing_time',
+        :'view_session_id',
+        :'viewer_connection_type',
+        :'viewer_device_model',
+        :'weighted_average_bitrate'
       ])
     end
 

data/lib/mux_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.0.1
 =end
 
 module MuxRuby
-  VERSION = '3.3.0'
+  VERSION = '3.5.0'
 end

data/lib/mux_ruby.rb

@@ -27,12 +27,19 @@ require 'mux_ruby/models/asset_response'
 require 'mux_ruby/models/asset_static_renditions'
 require 'mux_ruby/models/asset_static_renditions_files'
 require 'mux_ruby/models/breakdown_value'
+require 'mux_ruby/models/broadcast'
+require 'mux_ruby/models/broadcast_layout'
+require 'mux_ruby/models/broadcast_resolution'
+require 'mux_ruby/models/broadcast_response'
+require 'mux_ruby/models/broadcast_status'
 require 'mux_ruby/models/create_asset_request'
+require 'mux_ruby/models/create_broadcast_request'
 require 'mux_ruby/models/create_live_stream_request'
 require 'mux_ruby/models/create_playback_id_request'
 require 'mux_ruby/models/create_playback_id_response'
 require 'mux_ruby/models/create_playback_restriction_request'
 require 'mux_ruby/models/create_simulcast_target_request'
+require 'mux_ruby/models/create_space_request'
 require 'mux_ruby/models/create_track_request'
 require 'mux_ruby/models/create_track_response'
 require 'mux_ruby/models/create_upload_request'
@@ -81,11 +88,13 @@ require 'mux_ruby/models/list_filters_response_data'
 require 'mux_ruby/models/list_incidents_response'
 require 'mux_ruby/models/list_insights_response'
 require 'mux_ruby/models/list_live_streams_response'
+require 'mux_ruby/models/list_playback_restrictions_response'
 require 'mux_ruby/models/list_real_time_dimensions_response'
 require 'mux_ruby/models/list_real_time_dimensions_response_data'
 require 'mux_ruby/models/list_real_time_metrics_response'
 require 'mux_ruby/models/list_related_incidents_response'
 require 'mux_ruby/models/list_signing_keys_response'
+require 'mux_ruby/models/list_spaces_response'
 require 'mux_ruby/models/list_uploads_response'
 require 'mux_ruby/models/list_video_view_exports_response'
 require 'mux_ruby/models/list_video_views_response'
@@ -112,6 +121,12 @@ require 'mux_ruby/models/signing_key'
 require 'mux_ruby/models/signing_key_response'
 require 'mux_ruby/models/simulcast_target'
 require 'mux_ruby/models/simulcast_target_response'
+require 'mux_ruby/models/space'
+require 'mux_ruby/models/space_response'
+require 'mux_ruby/models/space_status'
+require 'mux_ruby/models/space_type'
+require 'mux_ruby/models/start_space_broadcast_response'
+require 'mux_ruby/models/stop_space_broadcast_response'
 require 'mux_ruby/models/track'
 require 'mux_ruby/models/update_asset_mp4_support_request'
 require 'mux_ruby/models/update_asset_master_access_request'
@@ -140,6 +155,7 @@ require 'mux_ruby/api/metrics_api'
 require 'mux_ruby/api/playback_id_api'
 require 'mux_ruby/api/playback_restrictions_api'
 require 'mux_ruby/api/real_time_api'
+require 'mux_ruby/api/spaces_api'
 require 'mux_ruby/api/url_signing_keys_api'
 require 'mux_ruby/api/video_views_api'
 

data/spec/api/spaces_api_spec.rb

@@ -0,0 +1,149 @@
+=begin
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MuxRuby::SpacesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SpacesApi' do
+  before do
+    # run before each test
+    @api_instance = MuxRuby::SpacesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpacesApi' do
+    it 'should create an instance of SpacesApi' do
+      expect(@api_instance).to be_instance_of(MuxRuby::SpacesApi)
+    end
+  end
+
+  # unit tests for create_space
+  # Create a space
+  # Create a new space. Spaces are used to build [real-time video applications.](https://mux.com/real-time-video)
+  # @param create_space_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SpaceResponse]
+  describe 'create_space test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_space_broadcast
+  # Create a space broadcast
+  # Creates a new broadcast. Broadcasts are used to create composited versions of your space, which can be broadcast to live streams.  **Note:** By default only a single broadcast destination can be specified. Contact Mux support if you need more.
+  # @param space_id The space ID.
+  # @param create_broadcast_request 
+  # @param [Hash] opts the optional parameters
+  # @return [BroadcastResponse]
+  describe 'create_space_broadcast test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_space
+  # Delete a space
+  # Deletes a space. Spaces can only be deleted when `idle`.
+  # @param space_id The space ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_space test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_space_broadcast
+  # Delete a space broadcast
+  # Deletes a single broadcast of a specific space. Broadcasts can only be deleted when `idle`.
+  # @param space_id The space ID.
+  # @param broadcast_id The broadcast ID.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_space_broadcast test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_space
+  # Retrieve a space
+  # Retrieves the details of a space that has previously been created. Supply the unique space ID that was returned from your create space request, and Mux will return the information about the corresponding space. The same information is returned when creating a space.
+  # @param space_id The space ID.
+  # @param [Hash] opts the optional parameters
+  # @return [SpaceResponse]
+  describe 'get_space test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_space_broadcast
+  # Retrieve space broadcast
+  # Retrieves the details of a broadcast of a specific space.
+  # @param space_id The space ID.
+  # @param broadcast_id The broadcast ID.
+  # @param [Hash] opts the optional parameters
+  # @return [BroadcastResponse]
+  describe 'get_space_broadcast test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_spaces
+  # List spaces
+  # List all spaces in the current enviroment.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of items to include in the response
+  # @option opts [Integer] :page Offset by this many pages, of the size of `limit`
+  # @return [ListSpacesResponse]
+  describe 'list_spaces test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for start_space_broadcast
+  # Start a space broadcast
+  # Starts broadcasting a space to the associated destination.
+  # @param space_id The space ID.
+  # @param broadcast_id The broadcast ID.
+  # @param [Hash] opts the optional parameters
+  # @return [StartSpaceBroadcastResponse]
+  describe 'start_space_broadcast test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for stop_space_broadcast
+  # Stop a space broadcast
+  # Stops broadcasting a space, causing the destination live stream to become idle. This API also automatically calls `complete` on the destination live stream. Broadcasts are also automatically stopped when a space becomes idle.
+  # @param space_id The space ID.
+  # @param broadcast_id The broadcast ID.
+  # @param [Hash] opts the optional parameters
+  # @return [StopSpaceBroadcastResponse]
+  describe 'stop_space_broadcast test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/broadcast_layout_spec.rb

@@ -0,0 +1,28 @@
+=begin
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MuxRuby::BroadcastLayout
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MuxRuby::BroadcastLayout do
+  let(:instance) { MuxRuby::BroadcastLayout.new }
+
+  describe 'test an instance of BroadcastLayout' do
+    it 'should create an instance of BroadcastLayout' do
+      expect(instance).to be_instance_of(MuxRuby::BroadcastLayout)
+    end
+  end
+end

data/spec/models/broadcast_resolution_spec.rb

@@ -0,0 +1,28 @@
+=begin
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MuxRuby::BroadcastResolution
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MuxRuby::BroadcastResolution do
+  let(:instance) { MuxRuby::BroadcastResolution.new }
+
+  describe 'test an instance of BroadcastResolution' do
+    it 'should create an instance of BroadcastResolution' do
+      expect(instance).to be_instance_of(MuxRuby::BroadcastResolution)
+    end
+  end
+end

data/spec/models/broadcast_response_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#Mux API
+
+#Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.
+
+The version of the OpenAPI document: v1
+Contact: devex@mux.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MuxRuby::BroadcastResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MuxRuby::BroadcastResponse do
+  let(:instance) { MuxRuby::BroadcastResponse.new }
+
+  describe 'test an instance of BroadcastResponse' do
+    it 'should create an instance of BroadcastResponse' do
+      expect(instance).to be_instance_of(MuxRuby::BroadcastResponse)
+    end
+  end
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end