conversant 1.0.16

data/publish.sh

@@ -0,0 +1,107 @@
+#!/bin/bash
+
+# Conversant Gem Publishing Script
+# This script helps you publish the gem to RubyGems.org
+
+set -e  # Exit on error
+
+echo "========================================="
+echo "  Conversant Gem Publishing Process"
+echo "========================================="
+echo ""
+
+# Color codes for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# Step 1: Check if we're in the right directory
+if [ ! -f "conversant.gemspec" ]; then
+    echo -e "${RED}Error: conversant.gemspec not found. Please run this script from the gem root directory.${NC}"
+    exit 1
+fi
+
+echo -e "${GREEN}✓${NC} Found conversant.gemspec"
+
+# Step 2: Clean up previous builds
+echo -e "\n${YELLOW}Step 1: Cleaning previous builds...${NC}"
+rm -f *.gem
+echo -e "${GREEN}✓${NC} Cleaned previous gem files"
+
+# Step 3: Run tests (if available)
+echo -e "\n${YELLOW}Step 2: Running tests...${NC}"
+if [ -f "Rakefile" ] && grep -q "RSpec" "Rakefile" 2>/dev/null; then
+    bundle exec rake spec || {
+        echo -e "${RED}✗ Tests failed. Please fix tests before publishing.${NC}"
+        exit 1
+    }
+    echo -e "${GREEN}✓${NC} All tests passed"
+else
+    echo -e "${YELLOW}⚠${NC} No tests found, skipping..."
+fi
+
+# Step 4: Build the gem
+echo -e "\n${YELLOW}Step 3: Building the gem...${NC}"
+gem build conversant.gemspec || {
+    echo -e "${RED}✗ Gem build failed. Please fix the gemspec.${NC}"
+    exit 1
+}
+echo -e "${GREEN}✓${NC} Gem built successfully"
+
+# Step 5: Display gem info
+echo -e "\n${YELLOW}Step 4: Gem Information:${NC}"
+gem_file=$(ls *.gem | head -n 1)
+echo "  Gem file: $gem_file"
+gem specification $gem_file | grep -E "name:|version:|authors:|summary:" | sed 's/^/  /'
+
+# Step 6: Check RubyGems credentials
+echo -e "\n${YELLOW}Step 5: Checking RubyGems credentials...${NC}"
+if [ ! -f ~/.gem/credentials ]; then
+    echo -e "${YELLOW}⚠ No RubyGems credentials found.${NC}"
+    echo "  To set up credentials, run:"
+    echo "    gem signin"
+    echo "  Or:"
+    echo "    curl -u your_rubygems_username https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials"
+    echo "    chmod 0600 ~/.gem/credentials"
+    exit 1
+fi
+echo -e "${GREEN}✓${NC} RubyGems credentials found"
+
+# Step 7: Confirm before publishing
+echo -e "\n${YELLOW}Ready to publish $gem_file to RubyGems.org${NC}"
+echo -e "${YELLOW}This action cannot be undone. Are you sure? (y/N)${NC}"
+read -r response
+
+if [[ ! "$response" =~ ^[Yy]$ ]]; then
+    echo "Publishing cancelled."
+    exit 0
+fi
+
+# Step 8: Push to RubyGems
+echo -e "\n${YELLOW}Step 6: Publishing to RubyGems...${NC}"
+gem push $gem_file || {
+    echo -e "${RED}✗ Failed to push gem to RubyGems${NC}"
+    echo "  Common issues:"
+    echo "  - Gem name already taken"
+    echo "  - Invalid credentials"
+    echo "  - Network issues"
+    exit 1
+}
+
+echo -e "\n${GREEN}=========================================${NC}"
+echo -e "${GREEN}  🎉 Successfully published $gem_file!${NC}"
+echo -e "${GREEN}=========================================${NC}"
+echo ""
+echo "Your gem is now available at:"
+echo "  https://rubygems.org/gems/conversant"
+echo ""
+echo "Users can install it with:"
+echo "  gem install conversant"
+echo ""
+echo "Next steps:"
+echo "  1. Tag this release in git:"
+echo "     git tag -a v1.0.0 -m 'Release version 1.0.0'"
+echo "     git push origin v1.0.0"
+echo "  2. Create a GitHub release"
+echo "  3. Update documentation if needed"

data/sig/conversant/v3/services/authorization.rbs

@@ -0,0 +1,34 @@
+# Authorization module type signatures
+module Conversant
+  module V3
+    module Services
+      module Authorization
+        protected
+
+        def authorized_headers: () -> Hash[String, String]
+        def authorize: () -> String?
+
+        private
+
+        def fetch_session_cookie: () -> String?
+        def fetch_sso_session: () -> String?
+        def cached_session: () -> String?
+        def session_cache_key: () -> String
+        def sso_cache_key: () -> String
+        def build_headers_with_cookies: (String? session_cookie, String? sso_gw_session2) -> Hash[String, String]
+        def base_headers: () -> Hash[String, String]
+        def format_cookies: (String? session_cookie, String? sso_gw_session2) -> String?
+        def build_cookie_hash: (String? session_cookie, String? sso_gw_session2) -> Hash[String, String]
+        def log_missing_session: () -> void
+
+        # Service-specific methods that must be implemented
+        def service_endpoint: () -> String
+        def fetch_new_session: () -> String?
+
+        # Optional methods that services can override
+        def session_cookie_name: () -> String
+        def requires_session?: () -> bool
+      end
+    end
+  end
+end

data/sig/conversant/v3/services/cdn.rbs

@@ -0,0 +1,123 @@
+# CDN service type signatures for Conversant gem
+module Conversant
+  module V3
+    module Services
+      # CDN service inherits from Base class
+      class CDN < ::Conversant::V3::Base
+        # No need to re-declare attributes from Base
+        # attr_reader customer_id: Integer (inherited)
+        # attr_reader type: Integer (inherited)
+
+        # Constructor is inherited from Base
+        # def initialize: (Integer customer_id, ?Integer type) -> void
+
+        # Service instances
+        def analytics: () -> CDN::Analytics
+        def monitoring: () -> CDN::Monitoring
+        def audit: () -> CDN::Audit
+        def domain: () -> CDN::Domain
+        def business: () -> CDN::Business
+        def certificate: () -> CDN::Certificate
+
+        def requires_session?: -> bool
+
+        def session_cookie_name: -> String
+
+        private
+
+        def call: (String method, String path, Hash[Symbol, untyped]? payload) -> String?
+        def fetch_new_session: () -> String?
+        def service_endpoint: () -> String
+        def logger: () -> untyped
+        def configuration: () -> untyped
+        def redis: () -> untyped
+
+        # Nested service classes
+        class Analytics
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def bandwidths: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+          def volumes: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+          def viewers: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+          def request_per_second: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+          def http_codes: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+          def referrer_by_domain: (Hash[Symbol, untyped] payload) -> (Hash[Symbol, untyped] | Array[untyped])?
+          def popular_content_url_by_domain: (Hash[Symbol, untyped] payload) -> (Hash[Symbol, untyped] | Array[untyped])?
+          def origin_request: (Hash[Symbol, untyped] payload) -> Hash[Symbol, untyped]?
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        class Monitoring
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def spots: (Hash[Symbol, untyped] payload) -> (Hash[Symbol, untyped] | Array[untyped])?
+          def delivery_domain_list: () -> Array[Hash[String, untyped]]
+          def delivery_domain_detail: (Integer domain_id) -> Hash[String, untyped]?
+          def customer_details: () -> Hash[String, untyped]?
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        class Audit
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def list: (Hash[Symbol, untyped] payload) -> (Hash[Symbol, untyped] | Array[untyped])?
+          def delivery_domain_operations: (Hash[Symbol, untyped] payload) -> Array[Hash[String, untyped]]
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        class Domain
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def all: () -> Array[OpenStruct]
+          def find: (Integer | String domain_id) -> OpenStruct?
+          def find_by: (Hash[Symbol, untyped] params) -> OpenStruct?
+          def create: (Hash[Symbol, untyped] payload) -> Integer?
+          def total_current_disk_usage: () -> Integer
+
+          private
+
+          def redis: () -> untyped
+          def logger: () -> untyped
+        end
+
+        class Business
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def bandwidth: (Hash[Symbol, untyped] payload) -> Array[Hash[String, untyped]]
+          def bandwidth95th: (Hash[Symbol, Integer] params) -> Array[Hash[String, untyped]]
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        class Certificate
+          attr_reader parent: CDN
+
+          def initialize: (CDN parent) -> void
+          def all: (?Hash[Symbol, untyped] params) -> Array[Hash[String, untyped]]
+          def auto_certificate_info: (Integer | String certificate_id, String name) -> Hash[String, untyped]?
+          def deploy_auto_certificate: (Integer | String certificate_id, String name, Hash[Symbol, untyped] payload) -> bool
+
+          private
+
+          def logger: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/conversant/v3/services/lms.rbs

@@ -0,0 +1,80 @@
+# LMS service type signatures for Conversant gem
+module Conversant
+  module V3
+    module Services
+      # LMS (Live Media Streaming) service
+      class LMS < ::Conversant::V3::Base
+        # Job management for streaming
+        class Job
+          attr_reader parent: LMS
+
+          def initialize: (LMS parent) -> void
+          def where: (**untyped params) -> Array[Hash[String, untyped]]
+
+          private
+
+          def parse_status: (Integer | String | nil status) -> String
+          def parse_timestamp: (Integer | String | nil timestamp) -> DateTime?
+          def extract_encoder: (Hash[String | Symbol, untyped] item) -> String
+          def stream_extension: (String? type) -> String
+          def build_profile_url: (Hash[String | Symbol, untyped]? inbound, Hash[String | Symbol, untyped] item, Hash[String | Symbol, untyped]? stream) -> String?
+          def build_manifest_url: (Hash[String | Symbol, untyped]? inbound, Hash[String | Symbol, untyped] item, Array[Hash[Symbol, untyped]]? profiles) -> String?
+        end
+
+        # Domain management for LMS
+        class Domain
+          attr_reader parent: LMS
+
+          def initialize: (LMS parent) -> void
+          def all: (?Hash[Symbol, untyped] params) -> Hash[Symbol, untyped]?
+          def show: (Integer | String domain_id) -> Hash[String, untyped]?
+          def create: (Hash[Symbol, untyped] payload) -> bool
+          def update: (Hash[Symbol, untyped] payload) -> bool
+          def delete: (Integer | String domain_id) -> bool
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        # Dashboard metrics for LMS
+        class Dashboard
+          attr_reader parent: LMS
+
+          def initialize: (LMS parent) -> void
+          def live: () -> Hash[String, untyped]?
+          def vod: () -> Hash[String, untyped]?
+          def dvr: () -> Hash[String, untyped]?
+          def recent_jobs: () -> Array[Hash[Symbol, untyped]]
+
+          private
+
+          def parse_timestamp: (String? timestamp_text) -> Time?
+          def logger: () -> untyped
+        end
+
+        # Service accessors
+        def job: () -> Job
+        def domain: () -> Domain
+        def dashboard: () -> Dashboard
+
+        def partner_analytics: -> untyped
+
+        private
+
+        def fetch_new_session: () -> String?
+        def valid_sessions?: (Hash[Symbol, String]? sessions) -> bool
+        def request_jsessionid: (Hash[Symbol, String] sessions) -> untyped
+        def build_reporting_url: () -> String
+        def build_request_headers: (Hash[Symbol, String] sessions) -> Hash[String | Symbol, untyped]
+        def extract_and_cache_jsessionid: (untyped response) -> String?
+        def cache_jsessionid: (String jsessionid) -> void
+        def log_and_return_nil: (String message) -> nil
+
+        def service_endpoint: () -> String
+        def session_cookie_name: () -> String
+        def requires_session?: () -> bool
+      end
+    end
+  end
+end

data/sig/conversant/v3/services/portal.rbs

@@ -0,0 +1,22 @@
+# Portal service type signatures for Conversant gem
+module Conversant
+  module V3
+    module Services
+      # Portal service for appliance management
+      class Portal < ::Conversant::V3::Base
+        include Authorization
+
+        MASTER_APPLIANCE_REDIS_KEY: String
+
+        # Get appliances within date range
+        def appliances: (?String? gte, ?String? lte) -> Array[Hash[String, untyped]]
+
+        private
+
+        def fetch_new_session: () -> String
+        def service_endpoint: () -> String
+        def requires_session?: () -> bool
+      end
+    end
+  end
+end

data/sig/conversant/v3/services/vms.rbs

@@ -0,0 +1,64 @@
+# VMS service type signatures for Conversant gem
+module Conversant
+  module V3
+    module Services
+      # VMS (Video Management System) service
+      class VMS < ::Conversant::V3::Base
+        # VOD Transcoding management
+        class VodTranscoding
+          attr_reader parent: VMS
+
+          def initialize: (VMS parent) -> void
+          def list: (Hash[Symbol, untyped] params) -> Array[Hash[String, untyped]]
+          def status: (String | Integer job_id) -> Hash[String, untyped]?
+          def create: (Hash[Symbol, untyped] payload) -> Integer?
+          def presets: (?Hash[Symbol, untyped] payload) -> Array[Hash[String, untyped]]
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        # Analytics for VMS
+        class Analytics
+          attr_reader parent: VMS
+
+          def initialize: (VMS parent) -> void
+          def transcoding: (Hash[Symbol, untyped] payload) -> Array[untyped]
+          def volume: (Hash[Symbol, untyped] payload) -> Array[untyped]
+
+          private
+
+          def logger: () -> untyped
+        end
+
+        # Business metrics for VMS
+        class Business
+          attr_reader parent: VMS
+
+          def initialize: (VMS parent) -> void
+          def duration: (Hash[Symbol, untyped] payload) -> Array[Hash[String, untyped]]
+          def volume: (Hash[Symbol, untyped] payload) -> Array[Hash[String, untyped]]
+          def transcoding: (Hash[Symbol, untyped] payload) -> Hash[Symbol, Float]
+
+          private
+
+          def extract_month: (Hash[Symbol, untyped] payload) -> String
+          def logger: () -> untyped
+        end
+
+        # Service accessors
+        def vod_transcoding: () -> VodTranscoding
+        def analytics: () -> Analytics
+        def business: () -> Business
+
+        private
+
+        def fetch_new_session: () -> String?
+        def service_endpoint: () -> String
+        def session_cookie_name: () -> String
+        def requires_session?: () -> bool
+      end
+    end
+  end
+end

data/sig/conversant/v3.rbs

@@ -0,0 +1,85 @@
+# V3 module type signatures
+module Conversant
+  module V3
+    def self.portal: (Integer customer_id, ?Integer type) -> Services::Portal
+    def self.cdn: (Integer customer_id, ?Integer type) -> Services::CDN
+    def self.lms: (Integer customer_id, ?Integer type) -> Services::LMS
+    def self.vms: (Integer customer_id, ?Integer type) -> Services::VMS
+    def self.oss: (Integer customer_id, ?Integer type) -> Services::OSS
+
+    # Base class for all V3 services
+    class Base
+      include HttpClient
+
+      attr_reader customer_id: Integer
+      attr_reader type: Integer
+
+      def initialize: (Integer customer_id, ?Integer type) -> void
+
+      protected
+
+      def validate_configuration!: () -> void
+      def configuration: () -> Conversant::Configuration
+      def redis: () -> untyped
+      def portal_endpoint: () -> String
+      def sso_endpoint: () -> String
+      def identifier: () -> String
+      def logger: () -> untyped
+    end
+
+    # HTTP client module
+    module HttpClient
+      LOGIN_URL: String
+      PORTAL_SESSION_REDIS_KEY: String
+      SSO_GW_SESSION2_REDIS_KEY: String
+
+      def cookie_jar: () -> Hash[String, String]
+      def cookie_jar=: (Hash[String, String]? value) -> Hash[String, String]?
+      def debug_log: (String message) -> void
+      def sso_login: () -> Hash[Symbol, String]?
+      def authenticate: () -> Hash[Symbol, String]?
+      def request: (Symbol method, String url, untyped payload, Hash[String, String] headers) -> [Integer, untyped]
+
+      private
+
+      def http_get: (String url) -> Hash[Symbol, untyped]?
+      def http_post: (String url, String payload, Hash[String, String] extra_headers) -> Hash[Symbol, untyped]?
+      def add_cookies_to_headers: (Hash[String, String] headers) -> Hash[String, String]
+      def update_cookie_jar: (untyped response) -> void
+      def parse_cookie_to_jar: (String cookie_string) -> void
+      def extract_form_action: (String html_body) -> String?
+      def configuration: () -> Conversant::Configuration
+      def redis: () -> untyped
+    end
+
+    # Authentication mixin
+    module Mixins
+      module Authentication
+        def self.included: (untyped base) -> void
+
+        module ClassMethods
+          def use_conversant_auth!: () -> void
+        end
+
+        attr_reader customer_id: Integer
+        attr_reader type: Integer
+
+        def initialize_conversant_auth: (Integer customer_id, ?Integer type) -> void
+        def conversant_authenticate: () -> Hash[Symbol, String]?
+        def portal_authorized_headers: () -> Hash[String, String]
+        def cdn_authorized_headers: () -> Hash[String, String]
+        def lms_authorized_headers: () -> Hash[String, String]
+        def vms_authorized_headers: () -> Hash[String, String]
+
+        private
+
+        def portal_service: () -> Services::Portal
+        def cdn_service: () -> Services::CDN
+        def lms_service: () -> Services::LMS
+        def vms_service: () -> Services::VMS
+        def configuration: () -> Conversant::Configuration
+        def redis: () -> untyped
+      end
+    end
+  end
+end

data/sig/conversant.rbs

@@ -0,0 +1,37 @@
+# Main Conversant module type signatures
+module Conversant
+  VERSION: String
+
+  def self.configuration: () -> Configuration
+  def self.configure: () { (Configuration) -> void } -> void
+
+  class Configuration
+    attr_accessor portal_endpoint: String
+    attr_accessor private_cdn_endpoint: String
+    attr_accessor private_lms_endpoint: String
+    attr_accessor private_vms_endpoint: String
+    attr_accessor private_oss_endpoint: String
+    attr_accessor redis: untyped
+    attr_accessor default_ua: String
+    attr_accessor default_content_type: String
+    attr_accessor cache_ttl: Integer
+    attr_accessor enable_logging: bool
+    attr_accessor log_level: Symbol
+
+    def initialize: () -> void
+  end
+
+  class Error < StandardError
+  end
+
+  class AuthenticationError < Error
+  end
+
+  module V3
+    def self.cdn: (Integer customer_id, ?Integer type) -> Services::CDN
+    def self.lms: (Integer customer_id, ?Integer type) -> Services::LMS
+    def self.vms: (Integer customer_id, ?Integer type) -> Services::VMS
+    def self.portal: (Integer customer_id, ?Integer type) -> Services::Portal
+    def self.oss: (Integer customer_id, ?Integer type) -> Services::OSS
+  end
+end