conversant 1.0.16

data/lib/conversant/v3/services/vms/partner/business.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class VMS
+        class Partner
+          # VMS Business analytics for partner-level business reporting
+          #
+          # Provides business-focused analytics methods that aggregate transcoding
+          # data for VOD (Video on Demand) billing and capacity planning.
+          #
+          # @since 1.0.16
+          class Business
+            # @return [Conversant::V3::Services::VMS::Partner::Analytics] the parent analytics instance
+            attr_reader :parent
+
+            # Initialize partner VMS business service
+            #
+            # @param parent [Conversant::V3::Services::VMS::Partner::Analytics] the parent analytics instance
+            def initialize(parent)
+              @parent = parent
+            end
+
+            # Fetches transcoding business analytics with codec breakdown
+            #
+            # Aggregates VOD transcoding data including transmuxing and transcoding
+            # across different resolutions (SD, HD, UHD) and codecs (H264, H265).
+            #
+            # @param args [Hash] Parameters for the query
+            # @option args [Time, String] :startTime start time for the report (defaults to beginning of current month)
+            # @option args [String, Integer] :type customer type filter (defaults to 2)
+            #
+            # @return [Hash] Transcoding business data with breakdown by codec and resolution. Hash contains:
+            #   - :vms_transcoding [Float] total transcoding duration
+            #   - :vms_transmuxing [Float] transmuxing duration
+            #   - :vms_transcoding_sd [Float] SD transcoding duration
+            #   - :vms_transcoding_hd [Float] HD transcoding duration
+            #   - :vms_transcoding_uhd [Float] UHD transcoding duration
+            #
+            # @example Get VOD transcoding business metrics
+            #   vms = Conversant::V3.vms(12345)
+            #   business = vms.partner.analytics.business
+            #   metrics = business.transcoding(startTime: Time.now.beginning_of_month)
+            #   puts "Total transcoding: #{metrics[:vms_transcoding]} minutes"
+            #   puts "SD: #{metrics[:vms_transcoding_sd]}, HD: #{metrics[:vms_transcoding_hd]}, UHD: #{metrics[:vms_transcoding_uhd]}"
+            #
+            # @since 1.0.16
+            def transcoding(**args)
+              transcoding = {
+                vms_transcoding: 0,
+                vms_transmuxing: 0,
+                vms_transcoding_sd: 0,
+                vms_transcoding_hd: 0,
+                vms_transcoding_uhd: 0
+              }
+
+              data = @parent.duration_of_vod(**args).first
+              return transcoding if data.nil?
+
+              name = data.keys.first
+
+              if data[name].present?
+                data[name].each do |item|
+                  transcoding[:vms_transmuxing] += item['transmux'].to_f
+                  transcoding[:vms_transcoding_sd] += item['h264SdTranscoding'].to_f + item['h265SdTranscoding'].to_f
+                  transcoding[:vms_transcoding_hd] += item['h264HdTranscoding'].to_f + item['h265HdTranscoding'].to_f
+                  transcoding[:vms_transcoding_uhd] += item['h264UhdTranscoding'].to_f + item['h265UhdTranscoding'].to_f
+                end
+              end
+
+              transcoding[:vms_transcoding] =
+                transcoding[:vms_transcoding_sd] + transcoding[:vms_transcoding_hd] + transcoding[:vms_transcoding_uhd]
+              transcoding
+            rescue StandardError => e
+              logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+              transcoding
+            end
+
+            private
+
+            def logger
+              @parent.send(:logger)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/vms/partner.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class VMS
+        # Partner service for VMS partner-level operations
+        #
+        # Provides access to partner-level analytics for Video Management System
+        # that aggregate data across multiple customer accounts.
+        #
+        # @example Access partner analytics
+        #   vms = Conversant::V3.vms(12345)
+        #
+        #   # Partner-level VMS analytics
+        #   transcoding = vms.partner.analytics.transcoding({
+        #     startTime: "2025-01-01T00:00:00Z",
+        #     endTime: "2025-01-31T23:59:59Z"
+        #   })
+        #
+        # @since 1.0.12
+        class Partner
+          # @return [VMS] the parent VMS service instance
+          attr_reader :parent
+
+          # Initialize partner service
+          #
+          # @param parent [VMS] the parent VMS service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get partner analytics service instance
+          #
+          # Provides partner-level analytics for VMS services including transcoding
+          # duration, volume, and processing metrics across multiple customers.
+          #
+          # @return [Analytics] VMS partner analytics service
+          # @since 1.0.12
+          def analytics
+            @analytics ||= Analytics.new(@parent)
+          end
+
+          private
+
+          def logger
+            @parent.send(:logger)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Load nested analytics class after Partner is defined
+require_relative 'partner/analytics'
+require_relative 'partner/business'

data/lib/conversant/v3/services/vms/transcoding.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Conversant
+  module V3
+    module Services
+      class VMS
+        # Video transcoding service for job and preset management
+        #
+        # Provides comprehensive job and preset management functionality for
+        # video transcoding operations including:
+        # - Transcoding job listing and filtering
+        # - Preset configuration management
+        # - Job status tracking
+        #
+        # @example Manage transcoding jobs
+        #   vms = Conversant::V3.vms(12345)
+        #
+        #   # Get recent transcoding jobs
+        #   jobs = vms.transcoding.jobs(page_size: 50, job_status: 2)
+        #
+        #   jobs.each do |job|
+        #     puts "Job #{job['id']}: #{job['file_name']} - #{job['status']}"
+        #   end
+        #
+        #   # Get available presets
+        #   presets = vms.transcoding.presets
+        #
+        # @since 1.0.0
+        class Transcoding
+          # @return [VMS] the parent VMS service instance
+          attr_reader :parent
+
+          # Initialize VOD transcoding service
+          #
+          # @param parent [VMS] the parent VMS service instance
+          def initialize(parent)
+            @parent = parent
+          end
+
+          # Get list of transcoding jobs
+          #
+          # Retrieves a paginated list of video transcoding jobs with filtering options.
+          # Returns detailed information about each job including status, file name,
+          # transcoding configurations, and timestamps.
+          #
+          # @param payload [Hash] query parameters for filtering and pagination
+          # @option payload [Integer] :page_number page number (default: 1)
+          # @option payload [Integer] :page_size number of results per page (default: 20)
+          # @option payload [Integer] :job_status filter by job status (-1 for all)
+          # @option payload [Integer] :source_type filter by source type (-1 for all)
+          # @option payload [Integer] :output_format filter by output format (-1 for all)
+          # @option payload [Integer] :protection_type filter by protection type (-1 for all)
+          # @option payload [String] :file_name filter by file name
+          # @option payload [String] :period time period filter (e.g., '0_30' for last 30 days)
+          # @option payload [Integer] :job_type job type filter (default: 1)
+          #
+          # @return [Array<Hash>] array of transcoding job records, or empty array on error
+          #
+          # @example Get recent transcoding jobs
+          #   jobs = vms.vod_transcoding.jobs(page_size: 50)
+          #   jobs.each { |job| puts "#{job['file_name']}: #{job['status']}" }
+          #
+          # @example Filter by status
+          #   active_jobs = vms.vod_transcoding.jobs(job_status: 2, page_size: 100)
+          #
+          # @since 1.0.0
+          def jobs(payload = {})
+            default_payload = {
+              sEcho: 1,
+              iColumns: 9,
+              sColumns: nil,
+              iDisplayStart: 0,
+              iDisplayLength: 20,
+              mDataProp_0: 'id',
+              mDataProp_1: 'file_name',
+              mDataProp_2: 'transcoding_configs',
+              mDataProp_3: 'created',
+              mDataProp_4: 'source_type',
+              mDataProp_5: 'ended',
+              mDataProp_6: 'transcoding_configs',
+              mDataProp_7: 'status',
+              mDataProp_8: 'id',
+              iSortingCols: '0',
+              bSortable_0: 'false',
+              bSortable_1: 'true',
+              bSortable_2: 'false',
+              bSortable_3: 'true',
+              bSortable_4: 'false',
+              bSortable_5: 'true',
+              bSortable_6: 'false',
+              bSortable_7: 'false',
+              bSortable_8: 'false',
+              page_number: 1,
+              page_size: 20,
+              sort_field: nil,
+              sort_type: nil,
+              job_status: -1,
+              source_type: -1,
+              output_format: -1,
+              protection_type: -1,
+              file_name: nil,
+              period: '0_30',
+              job_type: 1,
+              _: (Time.now.to_f * 1000).to_i
+            }
+
+            merged_payload = default_payload.merge(payload)
+            response = @parent.send(:call, 'GET', "/v2/jobs?#{merged_payload.to_query}")
+            return [] if response.nil?
+
+            JSON.parse(response)&.[]("list") || []
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+
+          # Get list of transcoding presets
+          #
+          # Retrieves a paginated list of transcoding preset configurations.
+          # Presets define encoding parameters such as resolution, bitrate,
+          # codec settings, and output formats.
+          #
+          # @param payload [Hash] query parameters for pagination
+          # @option payload [Integer] :page_number page number (default: 1)
+          # @option payload [Integer] :page_size number of results per page (default: 20)
+          #
+          # @return [Array<Hash>] array of transcoding preset configurations, or empty array on error
+          #
+          # @example Get available presets
+          #   presets = vms.vod_transcoding.presets
+          #   presets.each do |preset|
+          #     puts "#{preset['name']}: #{preset['description']}"
+          #   end
+          #
+          # @example Get first page with custom size
+          #   presets = vms.vod_transcoding.presets(page_number: 1, page_size: 50)
+          #
+          # @since 1.0.0
+          def presets(payload = {})
+            default_payload = {
+              sEcho: 1,
+              iColumns: 5,
+              sColumns: nil,
+              iDisplayStart: 0,
+              iDisplayLength: 20,
+              mDataProp_0: 'id',
+              mDataProp_1: 'name',
+              mDataProp_2: 'id',
+              mDataProp_3: 'description',
+              mDataProp_4: 'id',
+              iSortingCols: '0',
+              bSortable_0: 'false',
+              bSortable_1: 'false',
+              bSortable_2: 'false',
+              bSortable_3: 'false',
+              bSortable_4: 'false',
+              page_number: 1,
+              page_size: 20,
+              _: (Time.now.to_f * 1000).to_i
+            }
+
+            merged_payload = default_payload.merge(payload)
+            response = @parent.send(:call, 'GET', "/v2/osp/presets?#{merged_payload.to_query}")
+            return [] if response.nil?
+
+            JSON.parse(response)&.[]("list") || []
+          rescue StandardError => e
+            logger.error "#{@parent.send(:identifier)}.METHOD:#{__method__}.EXCEPTION:#{e.message}"
+            []
+          end
+
+          private
+
+          # Get logger instance from parent
+          #
+          # @return [Logger] logger instance
+          def logger
+            @parent.send(:logger)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conversant/v3/services/vms.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require_relative 'authorization'
+
+module Conversant
+  module V3
+    module Services
+      # Video Management System (VMS) service for video processing and management
+      #
+      # Provides comprehensive functionality for video operations including:
+      # - VOD (Video on Demand) transcoding management
+      # - Analytics for video metrics and usage
+      # - Business metrics for billing and reporting
+      #
+      # @example Basic usage
+      #   vms = Conversant::V3.vms(12345)
+      #
+      #   # Get transcoding jobs
+      #   jobs = vms.transcoding.jobs(page_number: 1)
+      #
+      #   # Get analytics
+      #   volume = vms.analytics.volume(startTime: '2025-01-01')
+      #
+      # @since 1.0.0
+      class VMS < ::Conversant::V3::Base
+        include Authorization
+
+        # Get transcoding service instance
+        #
+        # @return [Transcoding] transcoding service for job management
+        # @since 1.0.0
+        def transcoding
+          @transcoding ||= Transcoding.new(self)
+        end
+
+        # Get analytics service instance
+        #
+        # @return [Analytics] analytics service for video metrics
+        # @since 1.0.0
+        def analytics
+          @analytics ||= Analytics.new(self)
+        end
+
+        # Get business metrics service instance
+        #
+        # @return [Business] business service for billing metrics
+        # @since 1.0.0
+        def business
+          @business ||= Business.new(self)
+        end
+
+        # Get partner service instance
+        #
+        # Provides access to partner-level analytics for Video Management System
+        # that aggregate data across multiple customer accounts.
+        #
+        # @return [Partner] partner service for VMS analytics
+        # @since 1.0.12
+        #
+        # @example Access partner analytics
+        #   vms = Conversant::V3.vms(12345)
+        #   transcoding = vms.partner.analytics.transcoding(payload)
+        def partner
+          @partner ||= Partner.new(self)
+        end
+
+        # @deprecated Use {#partner} instead
+        # Get partner analytics service instance (deprecated)
+        #
+        # @return [VMS::Partner::Analytics] partner analytics for VMS reporting
+        # @since 1.0.8
+        # @deprecated Use `vms.partner.analytics` instead of `vms.partner_analytics`
+        def partner_analytics
+          @partner_analytics ||= Partner::Analytics.new(self)
+        end
+
+        protected
+
+        def call(method, uri, payload = nil)
+          url = "#{configuration.private_vms_endpoint}#{uri}"
+
+          headers = authorized_headers
+
+          # Check for JSESSIONID in Cookie header
+          if headers['Cookie'].nil? || !headers['Cookie'].include?('JSESSIONID=')
+            logger.error "#{identifier}.METHOD:call.NO_JSESSIONID"
+            raise AuthenticationError, 'Missing JSESSIONID for VMS'
+          end
+
+          code, response = request(method, url, payload, headers)
+
+          if code >= 400
+            logger.error "#{identifier}.METHOD:call.HTTP_ERROR:#{code}"
+            raise ApiError, "VMS API error: #{code}"
+          end
+
+          response.body
+        end
+
+        private
+
+        def fetch_new_session
+          sessions = authenticate
+          return nil unless sessions && sessions[:session] && sessions[:sso_gw_session2]
+
+          timestamp = (Time.now.to_f * 1000).to_i
+          reporting_url = "#{configuration.private_vms_endpoint}/reporting/vms/federation/business/usage"
+          reporting_url += "?customerId=#{customer_id}&type=#{type || 2}&t=#{timestamp}"
+
+          logger.debug "#{identifier}.METHOD:authorize.REQUESTING_JSESSIONID"
+
+          response = RestClient.get(
+            reporting_url,
+            {
+              authority: URI.parse(configuration.private_vms_endpoint).hostname,
+              referer: portal_endpoint,
+              user_agent: configuration.default_ua,
+              cookies: {
+                'SESSION': sessions[:session],
+                'SSO_GW_SESSION2': sessions[:sso_gw_session2]
+              },
+              timeout: 30,
+              open_timeout: 30
+            }
+          )
+
+          if response.cookies['JSESSIONID']
+            jsessionid = response.cookies['JSESSIONID']
+            redis.set(session_cache_key, jsessionid, ex: configuration.cache_ttl)
+            logger.debug "#{identifier}.METHOD:authorize.JSESSIONID_OBTAINED"
+            jsessionid
+          else
+            logger.error "#{identifier}.METHOD:authorize.NO_JSESSIONID_IN_RESPONSE"
+            nil
+          end
+        rescue RestClient::Unauthorized, RestClient::Forbidden => e
+          logger.error "#{identifier}.METHOD:authorize.AUTH_ERROR:#{e.message}"
+          nil
+        rescue StandardError => e
+          logger.error "#{identifier}.METHOD:authorize.ERROR:#{e.message}"
+          nil
+        end
+
+        protected
+
+        def service_endpoint
+          configuration.private_vms_endpoint
+        end
+
+        def session_cookie_name
+          'JSESSIONID'
+        end
+
+        def requires_session?
+          true
+        end
+      end
+    end
+  end
+end
+
+# Load nested service classes after VMS is defined
+require_relative 'vms/transcoding'
+require_relative 'vms/analytics'
+require_relative 'vms/business'
+require_relative 'vms/partner'

data/lib/conversant/v3.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'v3/http_client'
+require_relative 'v3/base'
+require_relative 'v3/mixins/authentication'
+require_relative 'v3/services/portal'
+require_relative 'v3/services/cdn'
+require_relative 'v3/services/lms'
+require_relative 'v3/services/vms'
+require_relative 'v3/services/oss'
+
+module Conversant
+  module V3
+    class << self
+      def portal(customer_id, type = 2)
+        Services::Portal.new(customer_id, type)
+      end
+
+      def cdn(customer_id, type = 2)
+        Services::CDN.new(customer_id, type)
+      end
+
+      def lms(customer_id, type = 2)
+        Services::LMS.new(customer_id, type)
+      end
+
+      def vms(customer_id, type = 2)
+        Services::VMS.new(customer_id, type)
+      end
+
+      def oss(customer_id, type = 2)
+        Services::OSS.new(customer_id, type)
+      end
+    end
+  end
+end

data/lib/conversant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Conversant
+  VERSION = '1.0.16'
+end

data/lib/conversant.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+require 'redis'
+require 'cgi'
+require 'logger'
+require 'uri'
+require 'ostruct'
+require 'date'
+require 'time'
+
+require_relative 'conversant/version'
+require_relative 'conversant/configuration'
+require_relative 'conversant/v3'
+
+# Conversant Ruby Gem
+#
+# A Ruby client library for interacting with Conversant/SwiftFederation CDN services.
+# Provides clean interfaces for Portal, CDN, and LMS APIs with V3 authentication support.
+#
+# @example Basic usage with zero configuration
+#   # If ENV variables are already set, just use it:
+#   portal = Conversant::V3.portal(customer_id)
+#   cdn = Conversant::V3.cdn(customer_id)
+#   lms = Conversant::V3.lms(customer_id)
+#
+# @example Manual configuration
+#   Conversant.configure do |config|
+#     config.private_cdn_endpoint = 'https://cdn.example.com'
+#     config.private_lms_endpoint = 'https://lms.example.com'
+#     config.redis = Redis.new(url: ENV['REDIS_URL'])
+#   end
+#
+# @see https://gitlab.vnetwork.dev/gems/conversant
+# @author Tho Nguyen
+module Conversant
+  # Base error class for all Conversant errors
+  class Error < StandardError; end
+
+  # Raised when authentication fails
+  class AuthenticationError < Error; end
+
+  # Raised when API calls fail
+  class ApiError < Error; end
+
+  class << self
+    # @return [Configuration] the global configuration object
+    attr_accessor :configuration
+  end
+
+  # Configure the Conversant gem
+  #
+  # @yield [config] Configuration object
+  # @yieldparam config [Configuration] the configuration object
+  # @return [Configuration] the configuration object
+  #
+  # @example
+  #   Conversant.configure do |config|
+  #     config.cache_ttl = 3600
+  #     config.debug_mode = true
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  # Auto-configure from environment variables
+  #
+  # Automatically loads configuration from ENV variables and validates.
+  # Uses existing CONVERSANT environment variables as defaults.
+  #
+  # @return [Configuration] the configured object
+  # @raise [Error] if required configuration is missing
+  #
+  # @example
+  #   Conversant.auto_configure!
+  def self.auto_configure!
+    self.configuration = Configuration.new
+
+    # Auto-detect and set Redis if available
+    if defined?($redis) && $redis
+      configuration.redis = $redis
+    elsif defined?(Redis) && ENV['REDIS_URL']
+      configuration.redis = Redis.new(url: ENV['REDIS_URL'])
+    elsif defined?(Redis)
+      configuration.redis = Redis.new
+    end
+
+    configuration.validate!
+    configuration
+  end
+
+  # Reset configuration to defaults
+  #
+  # @return [Configuration] new configuration object
+  def self.reset_configuration!
+    self.configuration = Configuration.new
+  end
+
+  # Check if gem is configured
+  #
+  # @return [Boolean] true if configured, false otherwise
+  def self.configured?
+    !configuration.nil?
+  end
+end