module KalturaFu
  module Entry
    ##
    # The flavor module mixes in instance methods for a class that includes the Entry module.  This 
    # module primarily provides means to operate on the original upload to Kaltura.  It also contains
    # a very important method for checking the overall status of a specific entry.  
    #
    # @author Patrick Robertson
    ##
    module Flavor
      ##
      # Checks each flavor under a Kaltura entry for readiness.  It is possible under v3 of the Kaltura API
      # to receive a 'ready' status for the entry while flavors are still encoding.  Attempting to view the entry
      # with a player will result in a 'Media is converting' error screen.  This prevents that occurance.
      # 
      # @param [String] video_id Kaltura entry_id of the video.
      #
      # @return [Number] Kaltura::Constants::FlavorAssetStatus.  2 is ready.
      ##
      def check_status(entry_id)
        KalturaFu.check_for_client_session

        entry_status = get_status(entry_id)
        if entry_status == Kaltura::Constants::Entry::Status::READY
         flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
         error_count = 0
         not_ready_count = 0
         ready_count = 0
         flavor_array.each do |flavor|
           case flavor.status
             when Kaltura::Constants::FlavorAssetStatus::READY ||  Kaltura::Constants::FlavorAssetStatus::DELETED || Kaltura::Constants::FlavorAssetStatus::NOT_APPLICABLE
               ready_count +=1
             when Kaltura::Constants::FlavorAssetStatus::ERROR
               error_count +=1
             when Kaltura::Constants::FlavorAssetStatus::QUEUED || Kaltura::Constants::FlavorAssetStatus::CONVERTING
               not_ready_count +=1
           end
         end
         #puts "errors: #{error_count} ready:#{ready_count} not_ready:#{not_ready_count} total:#{video_array.size} \n"
         if error_count > 0
           Kaltura::Constants::FlavorAssetStatus::ERROR
         elsif not_ready_count > 0
           Kaltura::Constants::FlavorAssetStatus::CONVERTING
         else
           Kaltura::Constants::FlavorAssetStatus::READY
         end
        else
         entry_status
        end
      end
    
      ##
      # Returns the flavor ID of the original file uploaded to Kaltura.
      #
      # @param [String] video_id Kaltura entry_id of the video.
      #
      # @return [String] flavor_id
      ##
      def original_flavor(entry_id)
       KalturaFu.check_for_client_session

       flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
       ret_flavor = nil

       flavor_array.each do |flavor|
         if flavor.is_original
           ret_flavor = flavor.id.to_s
           break
         end
       end
       ret_flavor
      end

      ##
      # Returns the file extension of the original file uploaded to Kaltura for a given entry
      #
      # @param [String] video_id Kaltura entry_id of the video.
      #
      # @return [String] file extension
      ##
      def original_file_extension(entry_id)
        KalturaFu.check_for_client_session

        flavor_array = KalturaFu.client.flavor_asset_service.get_by_entry_id(entry_id)
        source_extension = nil
        flavor_array.each do |flavor|
          if flavor.is_original
            source_extension = flavor.file_ext
            break
          end
        end
        source_extension
      end

      ##
      # Returns a download URL suitable to be used for iTunes one-click syndication.  serveFlavor is not documented in KalturaAPI v3
      # nor is the ?novar=0 paramter.  
      # 
      # @param [String] video_id Kaltura entry_id of the video
      #
      # @return [String] URL that works with RSS/iTunes syndication.  Normal flavor serving is flakey with syndication.
      ##
      def original_download_url(video_id)
        KalturaFu.check_for_client_session
        
        service_url = KalturaFu.config[:service_url] || "http://www.kaltura.com"
        partner_id = KalturaFu.config[:partner_id]
        subpartner_id = (partner_id.to_i * 100).to_s
        flavor = original_flavor(video_id)
        extension = original_file_extension(video_id)
        
        "#{service_url}/p/#{partner_id}/sp/#{subpartner_id}/serveFlavor/flavorId/#{flavor}/name/#{flavor}.#{extension}?novar=0"
      end
             
    end #Flavor
  end #Entry
end #KalturaFu