cantemo-portal-agent 1.0.9

data/lib/envoi/mam/vdms/agent.rb

@@ -0,0 +1,183 @@
+require 'envoi/mam/agent/transfer_client/aspera'
+require 'envoi/mam/agent/transfer_client/s3'
+
+require 'ubiquity/vdms/uplynk/api/client'
+
+module Envoi
+
+  module Mam
+
+    class Vdms
+
+      class Agent < Envoi::Mam::Agent
+
+        DEFAULT_FORMAT_NAME = 'ORIGINAL'
+        DEFAULT_DESTINATION_PATH = '.'
+
+        def after_initialize
+          @default_format_name = initial_args[:default_format_name] || DEFAULT_FORMAT_NAME
+        end
+
+        def iconik_config
+          config['vdms']
+        end
+
+        def initialize_api_client(args = { })
+          @api_client = args[:api_client] || begin
+            http_host_address = iconik_config['http_host_address']
+            application_id = iconik_config['application_id']
+            token = iconik_config['token']
+            client_args = { }
+            client_args[:http_host_address] = http_host_address if http_host_address && !http_host_address.empty?
+            client_args[:application_id] = application_id if application_id && !application_id.empty?
+            client_args[:token] = token if token && !token.empty?
+            Ubiquity::Iconik::API::Utilities.new(client_args)
+          end
+        end
+
+        def download(args = { })
+
+          asset_id = args[:asset_id]
+          file_id = args[:file_id]
+          if file_id && !file_id.empty?
+            asset_file = api_client.asset_file_get(asset_id: asset_id, file_id: file_id)
+          else
+            format_name = args[:format_name] || @default_format_name
+            format = api_client.asset_format_get_by_name(asset_id: asset_id, format_name: format_name.upcase)
+            format_id = format['id']
+
+            asset_files_get_response = api_client.asset_files_get(asset_id: asset_id, generate_signed_url: true)
+            asset_files = asset_files_get_response['objects']
+
+            asset_files_for_format = asset_files.find_all { |f| f['format_id'] == format_id }
+
+            asset_file = asset_files_for_format.first
+          end
+
+          # file = files.first
+          files = [ asset_file ] # just do the first file for now
+          files.each do |file|
+            begin
+              download_file(args, file)
+            rescue => e
+              logger.warn { "Exception: #{$!}. #{$@.first}" }
+            end
+          end
+          logger.info { 'DONE' }
+        end
+
+        def download_file(args, file)
+          logger.debug { "File: #{file}"}
+          transfer_type = args[:transfer_type] || ''
+
+          file_storage_id = file['storage_id']
+          file_directory_path = file['directory_path']
+          file_path = !file_directory_path || file_directory_path.empty? ? file['original_name'] : File.join(file_directory_path, file['original_name'])
+
+          file_storage_config = iconik_config['storages'][file_storage_id]
+
+          unless file_storage_config && !file_storage_config.empty?
+            raise Exception, "No configuration found for storage '#{file_storage_id}'"
+          end
+
+          logger.info { "Transferring File Path: '#{file_path}'" }
+          preserve_path = args.fetch(:preserve_path, file_storage_config.fetch('preserve_path', true))
+
+          destination_path = args[:destination_path] || file_storage_config['destination_path'] || DEFAULT_DESTINATION_PATH
+          relative_path = preserve_path ? file_directory_path : nil
+          relative_path = nil if relative_path == '.'
+
+          target_path = relative_path ? File.join(destination_path, relative_path) : destination_path
+          target_path = target_path[0..-1] if target_path.start_with?('/') && !destination_path.start_with?('/')
+
+          aspera_config = file_storage_config['aspera']
+          if (transfer_type.empty? || transfer_type == :aspera) && (aspera_config && !aspera_config.empty?)
+            client = Envoi::Mam::Agent::TransferClient::Aspera.new(agent: self)
+            return client.download(aspera_config, file_path, target_path)
+          end
+
+          s3_config = file_storage_config['s3']
+          if (transfer_type.empty? || transfer_type == :s3) && (s3_config && !s3_config.empty?)
+            target_path = File.expand_path(target_path) if target_path == '.'
+            target_path = File.join(target_path, File.basename(file_path))
+            client = Envoi::Mam::Agent::TransferClient::S3.new(agent: self)
+            return client.download(s3_config, file_path, target_path)
+          end
+
+          logger.warn { "No Supported TransferClient Configuration#{transfer_type && !transfer_type.empty? ? " for transfer type '#{transfer_type}' " : ''}Found in Storage Configuration." }
+        end
+
+        def upload(args = { })
+          file_path = args[:file_path]
+          if File.directory?(file_path)
+            file_paths = Dir.glob(File.join(file_path, '*.*'))
+            logger.debug { "File Paths: #{file_paths}"}
+            file_paths.map { |fp| upload(args.merge(file_path: fp))}
+            return file_paths
+          end
+          logger.debug { "Preparing to upload '#{file_path}'" }
+
+          transfer_type = args[:transfer_type] || ''
+          storage_id = args[:storage_id]
+          path_on_storage = nil
+          iconik_storage_config = iconik_config['storages'][storage_id]
+
+          unless iconik_storage_config && !iconik_storage_config.empty?
+            raise Exception, "No configuration found for storage '#{storage_id}'"
+          end
+
+          preserve_path = args.fetch(:preserve_path, iconik_storage_config.fetch('preserve_path', true))
+
+          destination_path = args[:destination_path] || iconik_storage_config['destination_path'] || '/'
+          relative_path = preserve_path ? File.dirname(file_path) : nil
+          relative_path = File.expand_path(relative_path) if relative_path == '.'
+
+          target_path = relative_path ? File.join(destination_path, relative_path) : destination_path
+          target_path = target_path[1..-1] if target_path.start_with?('/') && !destination_path.start_with?('/')
+
+          # abort("FP: #{file_path} TP: #{target_path}")
+
+          transfer_response = begin
+            aspera_config = iconik_storage_config['aspera']
+            if (transfer_type.empty? || transfer_type == :aspera) && (aspera_config && !aspera_config.empty?)
+              client = Envoi::Mam::Agent::TransferClient::Aspera.new(agent: self)
+              resp = client.upload(aspera_config, file_path, target_path)
+            end
+
+            s3_config = iconik_storage_config['s3']
+            if (!resp) && (transfer_type.empty? || transfer_type == :s3) && (s3_config && !s3_config.empty?)
+              _target_path = target_path
+              _target_path = '' if target_path == '.'
+              _target_path = File.join(_target_path, File.basename(file_path))
+              client = Envoi::Mam::Agent::TransferClient::S3.new(agent: self)
+              resp = client.upload(s3_config, file_path, _target_path)
+              path_on_storage = _target_path
+            end
+
+            resp
+          end
+
+          if transfer_response.nil?
+            logger.warn { "No supported TransferClient configuration#{transfer_type && !transfer_type.empty? ? " for transfer type '#{transfer_type}' " : ''}found in storage configuration." }
+            return false
+          end
+
+          unless transfer_response
+            logger.warn { ""}
+            return false
+          end
+
+          file_size = File.exist?(file_path) ? File.size?(file_path) : 1024
+          path_on_storage ||= File.join(target_path, File.basename(file_path))
+
+          api_client.asset_add_using_file_path(file_path: path_on_storage, storage_id: storage_id, file_size: file_size)
+        end
+
+
+      end
+
+    end
+
+  end
+
+end

data/lib/envoi/mam/vidispine/agent.rb

@@ -0,0 +1,214 @@
+require 'envoi/mam/agent/transfer_client/aspera'
+require 'envoi/mam/agent/transfer_client/s3'
+
+require 'vidispine/api/utilities'
+
+module Envoi
+
+  module Mam
+    
+    class Vidispine
+
+      class Agent < Envoi::Mam::Agent
+    
+        DEFAULT_SHAPE_TAG = 'original'
+        DEFAULT_ASPERA_ARGS = '-v -k3 --overwrite=diff -P 33001'
+        DEFAULT_DESTINATION_PATH = '.'
+    
+        attr_accessor :default_aspera_ascp_args,
+                      :default_aspera_ascp_path,
+                      :default_vidispine_shape_tag
+    
+        def after_initialize
+          args = initial_args
+          @default_aspera_ascp_path   = args[:default_aspera_ascp_path]
+          @default_aspera_args = args[:default_ascp_args] || DEFAULT_ASPERA_ARGS
+        end
+        
+        def dry_run?; @dry_run end
+    
+        def vidispine_config
+          config['vidispine'] || { }
+        end
+    
+        def initialize_api_client(args = { })
+          _vidispine_config = vidispine_config
+          @api_client = args[:vidispine_api_client] || begin
+    
+            vidispine_host = _vidispine_config['host']
+            vidispine_username = _vidispine_config['username']
+            vidispine_password = _vidispine_config['password']
+            client_args = { }
+            client_args[:http_host_address] = vidispine_host if vidispine_host
+            client_args[:username] = vidispine_username if vidispine_username
+            client_args[:password] =  vidispine_password if vidispine_password
+            ::Vidispine::API::Utilities.new(client_args)
+          end
+    
+          @default_vidispine_shape_tag = args[:default_shape_tag] || _vidispine_config['default_shape_tag'] || _vidispine_config['shape_tag'] || DEFAULT_SHAPE_TAG
+    
+        end
+    
+        def item_get_shape_by_tag(item_id, shape_tag)
+          item_shapes_get_response = api_client.item_shapes_get(:item_id => item_id, :tag => shape_tag)
+          shape_id = item_shapes_get_response['uri'].first
+        end
+
+        def download(args = { })
+
+          item_id = args[:item_id]
+          shape_id = args[:shape_id]
+          unless shape_id && !shape_id.empty?
+            shape_tag = args[:shape_tag] || default_vidispine_shape_tag
+            shape_id = item_get_shape_by_tag(item_id, shape_tag)
+          end
+
+          logger.info { "Getting file path for Item ID: #{item_id} Shape ID: #{shape_id}"}
+          item_shape_get_response = api_client.item_shape_get(:item_id => item_id, :shape_id => shape_id)
+
+          files = item_shape_get_response['containerComponent']['file']
+          logger.debug { "Files: #{files}"}
+
+          # file = files.first
+          files = [ files.first ] # just do the first file for now
+          files.each do |file|
+            begin
+              download_file(args, file)
+            rescue => e
+              logger.warn { "Exception: #{$!}" }
+            end
+          end
+          logger.info { 'DONE' }
+        end
+
+        def download_file(args, file)
+          logger.debug { "File: #{file}"}
+          transfer_type = args[:transfer_type]
+
+          file_storage_id = file['storage']
+          file_path = file['path']
+
+          file_storage_config = vidispine_config['storages'][file_storage_id]
+
+          unless file_storage_config && !file_storage_config.empty?
+            raise Exception, "No configuration found for storage '#{file_storage_id}'"
+          end
+
+          logger.info { "Transferring File Path: '#{file_path}'" }
+          preserve_path = args.fetch(:preserve_path, file_storage_config.fetch('preserve_path', true))
+
+          destination_path = args[:destination_path] || file_storage_config['destination_path'] || DEFAULT_DESTINATION_PATH
+          relative_path = preserve_path ? File.dirname(file_path) : nil
+          relative_path = nil if relative_path == '.'
+
+          target_path = relative_path ? File.join(destination_path, relative_path) : destination_path
+          target_path = target_path[0..-1] if target_path.start_with?('/') && !destination_path.start_with?('/')
+
+          aspera_config = file_storage_config['aspera']
+          if (transfer_type.empty? || transfer_type == :aspera) && (aspera_config && !aspera_config.empty?)
+            client = Envoi::Mam::Agent::TransferClient::Aspera.new(agent: self)
+            return client.download(aspera_config, file_path, target_path)
+            # download_using_aspera(aspera_config, file_path, target_path)
+          end
+
+          s3_config = file_storage_config['s3']
+          if (transfer_type.empty? || transfer_type == :s3) && (s3_config && !s3_config.empty?)
+            target_path = File.expand_path(target_path) if target_path == '.'
+            target_path = File.join(target_path, File.basename(file_path))
+            client = Envoi::Mam::Agent::TransferClient::S3.new(agent: self)
+            return client.download(s3_config, file_path, target_path)
+          end
+
+          logger.warn { "No Supported TransferClient Configuration#{transfer_type && !transfer_type.empty? ? " for transfer type '#{transfer_type}' " : ''}Found in Storage Configuration." }
+        end
+
+        def upload(args = { })
+          file_path = args[:file_path]
+          raise ArgumentError, "Path not found: '#{file_path}'" unless File.exists?(file_path)
+
+          if File.directory?(file_path)
+            # Non-recursive directory upload
+            file_paths = Dir.glob(File.join(file_path, '*.*'))
+            logger.debug { "File Paths: #{file_paths}"}
+            file_paths.map { |fp| upload(args.merge(file_path: fp))}
+            return file_paths
+          end
+          logger.debug { "Preparing to upload '#{file_path}'" }
+
+          transfer_type = args[:transfer_type] || ''
+          storage_id = args[:storage_id]
+          vidispine_storage_config = vidispine_config['storages'][storage_id]
+    
+          unless vidispine_storage_config && !vidispine_storage_config.empty?
+            raise "No configuration found for storage '#{storage_id}'"
+          end
+
+          should_import_file = args.fetch(:import_file, vidispine_storage_config.fetch('import', true))
+
+          should_preserve_path = args.fetch(:preserve_path, vidispine_storage_config.fetch('preserve_path', true))
+    
+          destination_path = args[:destination_path] || vidispine_storage_config['destination_path'] || '/'
+          relative_path = should_preserve_path ? File.dirname(file_path) : nil
+          relative_path = File.expand_path(relative_path) if relative_path == '.'
+    
+          target_path = relative_path ? File.join(destination_path, relative_path) : destination_path
+          target_path = target_path[0..-1] if target_path.start_with?('/') && !destination_path.start_with?('/')
+    
+    
+          # upload file
+    
+          transfer_response = begin
+            aspera_config = vidispine_storage_config['aspera']
+            if (transfer_type.empty? || transfer_type == :aspera) && (aspera_config && !aspera_config.empty?)
+              client = Envoi::Mam::Agent::TransferClient::Aspera.new(agent: self)
+              response = client.upload(aspera_config, file_path, target_path)
+            end
+    
+            s3_config = vidispine_storage_config['s3']
+            if !response && (transfer_type.empty? || transfer_type == :s3) && (s3_config && !s3_config.empty?)
+              _target_path = target_path
+              _target_path = File.expand_path(_target_path) if target_path == '.'
+              _target_path = File.join(_target_path, File.basename(file_path))
+              client = Envoi::Mam::Agent::TransferClient::S3.new(agent: self)
+              response = client.upload(s3_config, file_path, _target_path)
+            end
+    
+            response
+          end
+    
+          logger.warn { "No supported TransferClient configuration#{transfer_type && !transfer_type.empty? ? " for transfer type '#{transfer_type}' " : ''}found in storage configuration." } unless transfer_response != nil
+
+          _response = { transfer_response: transfer_response }
+
+          return _response unless should_import_file
+
+          item_id = args[:item_id]
+          shape_tag = args[:shape_tag] || default_vidispine_shape_tag
+
+          # attach file to item as shape
+          path_on_storage = File.join(target_path, File.basename(file_path))
+          file_create_response = api_client.storage_file_create storage_id: storage_id, path: path_on_storage, state: 'CLOSED'
+          file_id = file_create_response['id']
+
+          if item_id
+            item_shape_import_response = vs_api.item_shape_import item_id: item_id, tag: shape_tag, fileId: file_id
+          else
+            item_shape_import_response = vs_api.item_add_using_file_path storage_id: storage_id,
+                                                                         file_path: file_path,
+                                                                         file_id: file_id,
+                                                                         storage_path_map: { '/' => storage_id }
+          end
+          _response[:import_response] = item_shape_import_response
+
+          _response
+        end
+
+        # Agent
+      end
+    
+      # Vidispine
+    end
+    
+  end
+
+end

data/lib/envoi/mam/wiredrive/agent.rb

@@ -0,0 +1,117 @@
+module Envoi
+
+  module Mam
+
+    class Wiredrive
+
+      class Agent < Envoi::Mam::Agent
+
+        def after_initialize
+
+        end
+
+        def initialize_api_client(args = {})
+          @api_client = args[:api_client] || begin
+            client_args = {}
+            Ubiquity::Wiredrive::API::V3::Client.new(client_args)
+          end
+        end
+
+        def download(args = {})
+
+          presentation_invitation_token = args[:presentation_invitation_token]
+          if presentation_invitation_token
+            presentation_password = args[:presentation_password]
+            r                     = api_client.presentation_get_using_token(presentation_invitation_token, presentation_password)
+
+          end
+
+        end
+
+        # Downloads a file from a URI or file location and saves it to a local path
+        #
+        # @param [String] download_file_path The source path of the file being downloaded
+        # @param [String] destination_file_path The destination path for the file being downloaded
+        # @param [Boolean] overwrite Determines if the destination file will be overwritten if it is found to exist
+        #
+        # @return [Hash]
+        #   * :download_file_path [String] The source path of the file being downloaded
+        #   * :overwrite [Boolean] The value of the overwrite parameter when the method was called
+        #   * :file_downloaded [Boolean] Indicates if the file was downloaded, will be false if overwrite was true and the file existed
+        #   * :destination_file_existed [String|Boolean] The value will be 'unknown' if overwrite is true because the file exist check will not have been run inside of the method
+        #   * :destination_file_path [String] The destination path for the file being downloaded
+        def download_file(download_file_path, destination_file_path, overwrite = false)
+          logger.debug { "Downloading '#{download_file_path}' -> '#{destination_file_path}' Overwrite: #{overwrite}" }
+          file_existed = 'unknown'
+          if overwrite or not (file_existed = File.exists?(destination_file_path))
+            File.open(destination_file_path, 'wb') { |tf|
+              open(download_file_path) { |sf| tf.write sf.read }
+            }
+            file_downloaded = true
+          else
+            file_downloaded = false
+          end
+          { :download_file_path => download_file_path, :overwrite => overwrite, :file_downloaded => file_downloaded, :destination_file_existed => file_existed, :destination_file_path => destination_file_path }
+        end
+
+
+        def presentation_assets_download(args = {}, options = {})
+          assets           = args[:assets]
+          destination_path = args[:destination_path]
+          assets.each { |a| presentation_asset_download(a, destination_path, options) }
+        end
+
+        def presentation_asset_download(asset, destination_path, options = {})
+          destination_dir = destination_path
+          overwrite       = options.fetch(:overwrite, false)
+
+          media_elements = asset['media']
+          # media_elements.concat asset['thumbnails']
+          media_elements.each do |media|
+            url                   = media['downloadUrl'] || media['url']
+            uri                   = URI(url)
+            file_name             = CGI.unescape(File.basename(uri.path))
+            destination_file_path = File.join(destination_dir, file_name)
+            download_file(url, destination_file_path, overwrite)
+          end
+
+          thumbnails = asset['thumbnails']
+          thumbnails.each do |media|
+            url                   = media['downloadUrl'] || media['url']
+            uri                   = URI(url)
+            file_name             = CGI.unescape(File.basename(uri.path)) + "_thumbnail_#{media['category']}.#{media['extension']}"
+            destination_file_path = File.join(destination_dir, file_name)
+            download_file(url, destination_file_path, overwrite)
+          end
+
+        end
+
+        # @param [Object]  presentation_invitation_token
+        # @param [Object]  presentation_password
+        # @param [Object]  options
+        # @option options [Boolean] :preserve_auth_token Determines if the api clients auth token is reset to the
+        #                                                value it was before retrieving the presentation
+        # @return [Object]
+        def presentation_get_using_token(presentation_invitation_token, presentation_password = nil, options = {})
+          preserve_auth_token   = options.fetch(:preserve_auth_token, true)
+          auth_token            = api_client.presentation_authorize_get(token: presentation_invitation_token, password: presentation_password)
+          presentation_id       = api_client.response['presentation']['id']
+          original_auth_token   = api_client.auth_token
+          api_client.auth_token = auth_token
+          presentation          = api_client.presentation_get(:id => presentation_id)
+          api_client.auth_token = original_auth_token if preserve_auth_token
+          presentation
+        end
+
+
+        def upload(args = {})
+          raise 'Upload method is not implemented.'
+        end
+
+      end
+
+    end
+
+  end
+
+end