envoi-mam-agent 1.1.0

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

@@ -0,0 +1,286 @@
+require 'net/https'
+require 'faraday'
+
+require 'ubiquity/mediasilo/api/v3/utilities'
+require 'envoi/mam/agent/transfer_client/aspera'
+
+module Envoi
+
+  module Mam
+
+    class MediaSilo
+
+      attr_accessor :logger, :config, :api_client
+
+      class Agent < Envoi::Mam::Agent
+
+        DEFAULT_DOWNLOAD_DESTINATION_PATH = '.'
+
+        class CaseSensitiveHeaderKey < String
+          # def downcase; self end
+          def capitalize; self end
+        end
+
+        class File < ::File
+          def bytesize; size end
+        end
+
+        def initialize_api_client(args = { })
+          @api_client = args[:api_client] || begin
+            ms_config = config['mediasilo']
+            mediasilo_hostname = ms_config['hostname']
+            mediasilo_username = ms_config['username']
+            mediasilo_password = ms_config['password']
+            mediasilo_api_key = ms_config['api_key']
+
+            client_args = { }
+            client_args[:hostname] = mediasilo_hostname if mediasilo_hostname
+            client_args[:username] = mediasilo_username if mediasilo_username
+            client_args[:password] =  mediasilo_password if mediasilo_password
+            client_args[:api_key] = mediasilo_api_key if mediasilo_api_key
+            Ubiquity::MediaSilo::API::V3::Utilities.new(client_args)
+          end
+
+        end
+
+        def download(args = { })
+          transfer_type = args[:transfer_type]
+
+          file_path = args[:file_path]
+          project_id = args[:project_id]
+          folder_id = args[:folder_id]
+          asset_id = args[:asset_id]
+
+          mediasilo_path = args[:mediasilo_path]
+          project_name = args[:project_name]
+          folder_name = args[:folder_name]
+
+          if mediasilo_path || project_name || folder_name
+            check_path_result = api_client.check_path(mediasilo_path)
+            found = check_path_result[:existing]
+
+            project = found[:project] || { }
+            project_id = project['id']
+
+            folders = found[:folders]
+            folder_id = (folders.last || { })['id']
+
+            asset = found[:asset] || { }
+            asset_id = asset['id']
+          end
+
+          asset ||= asset_id
+
+          destination_file_path = args[:destination_path] || DEFAULT_DOWNLOAD_DESTINATION_PATH
+
+          case transfer_type
+          when :aspera; download_using_aspera(asset_id, destination_file_path, args)
+          else
+            do_upload_response = download_using_http(asset, destination_file_path, args)
+            asset_url = do_upload_response[:asset_url]
+          end
+
+        end
+
+        def download_using_aspera(asset_id, destination_file_path, args = { })
+          derivative_type = args[:asset_derivative_type]
+          derivative_type = derivative_type.downcase == 'source' ? 'source' : 'proxy'
+          ticket = api_client.aspera_file_download_ticket_create(:asset_id => asset_id, :target => derivative_type)
+          return false unless ticket.is_a?(Hash)
+
+          host = ticket['server']
+          username = ticket['username']
+          password = ticket['password']
+          token = ticket['token']
+
+          original_file_name = ticket['fileName']
+
+          file_path = ticket['path']
+          target_path = destination_file_path
+
+          FileUtils.mkdir_p(target_path) if target_path.end_with?('/') && !File.directory?(target_path)
+          if target_path.end_with?('/') || File.directory?(target_path)
+            target_path = File.join(target_path, original_file_name)
+          end
+
+          aspera_config = { }
+          aspera_config['host'] = host
+          aspera_config['username'] = username
+          aspera_config['password'] = password
+          aspera_config['token'] = token
+
+          client = Envoi::Mam::Agent::TransferClient::Aspera.new(agent: self)
+          client.download(aspera_config, file_path, target_path)
+        end
+
+        def download_using_http(asset, destination_file_path, args)
+          overwrite = args.fetch(:overwrite, false)
+          derivative_type = args[:asset_derivative_type]
+          api_client.asset_download_derivative(derivative_type, asset, destination_file_path, overwrite)
+        end
+
+
+        def upload(args = { })
+          file_path = args[:file_path]
+          raise "File not found: '#{file_path}'" unless File.exists?(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]
+          project_id = args[:project_id]
+          folder_id = args[:folder_id]
+          # asset_id = args[:asset_id]
+
+          mediasilo_path = args[:mediasilo_path]
+          project_name = args[:project_name]
+          folder_name = args[:folder_name]
+
+          if mediasilo_path || project_name || folder_name
+            mediasilo_path ||= File.join(project_name, folder_name)
+
+            check_path_result = api_client.check_path(mediasilo_path, false)
+            found = check_path_result[:existing]
+
+            project = found[:project] || { }
+            project_id = project['id']
+
+            folders = found[:folders]
+            folder_id = (folders.last || { })['id']
+          end
+
+          # # preserve_path = args.fetch(:preserve_path, vidispine_storage_true)
+          # preserve_path = args.fetch(:preserve_path, true)
+          #
+          # destination_path = args[: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?('/')
+
+          # upload file
+          case transfer_type
+          when :aspera; do_upload_response = upload_using_aspera(file_path, args)
+          else
+            do_upload_response = upload_using_http(file_path)
+            asset_url = do_upload_response[:asset_url]
+          end
+
+          return false unless do_upload_response[:success]
+
+          asset_create_args = {
+              'projectId' => project_id,
+              'folderId' => folder_id,
+              :source_url => asset_url
+          }
+          response = api_client.asset_create(asset_create_args)
+        end
+
+        def upload_using_aspera(file_path, args = { })
+          raise 'Upload using Aspera not yet Implemented.'
+
+          file_name = File.basename(file_path)
+
+          ticket =  api_client.aspera_file_upload_ticket_create(:file_name => file_name)
+
+          host = ticket['server']
+          username = ticket['username']
+          password = ticket['password']
+          token = ticket['token']
+          destination = ticket['destination']
+
+          target_path = destination
+
+          aspera_config = { }
+          aspera_config['host'] = host
+          aspera_config['username'] = username
+          aspera_config['password'] = password
+          aspera_config['token'] = token
+
+          client = AsperaTransferClient.new(agent: self)
+          client.upload(aspera_config, file_path, target_path)
+          { :success => true }
+        end
+
+        def upload_using_faraday(url, file_path, options = { })
+          headers = options[:headers]
+
+          uri = URI(url)
+          connection_url = "#{uri.scheme}://#{uri.host}:#{uri.port}"
+          conn = Faraday.new(connection_url, { headers: headers, ssl: { } }) do |f|
+            f.adapter :net_http
+          end
+          payload = Faraday::UploadIO.new(file_path, headers['Content-Type'])
+          response = conn.put do |req|
+            req.url  uri.path
+            req.body = payload
+            req.headers = headers
+          end
+        end
+
+        def upload_using_http(file_path)
+          file_name = File.basename(file_path)
+
+          res = api_client.asset_upload_ticket_create(:file_name => file_name)
+          uri_str = res['assetUrl']
+
+          uri = URI.parse(uri_str)
+
+          amz_date = res['amzDate']
+          amz_acl = res['amzAcl']
+          content_type = res['contentType']
+          authorization = res['authorization']
+
+          # file = FileToSend.open(file_path)
+          #
+          file = File.open(file_path)
+
+          headers = {
+              'x-amz-date' => amz_date,
+              'x-amz-acl' => amz_acl,
+              'Content-Type' => content_type,
+              'Authorization' => authorization,
+              'Content-Length' => file.size.to_s
+          }
+
+
+          response = upload_using_faraday(uri_str, file_path, { headers: headers })
+
+          unless response
+            req = Net::HTTP::Put.new(uri.request_uri)
+            req['x-amz-date'] = amz_date
+            req['x-amz-acl'] = amz_acl
+            req[CaseSensitiveHeaderKey.new('Content-Type')] = content_type
+            res[CaseSensitiveHeaderKey.new('Authorization')] = authorization
+            # req[CaseSensitiveHeaderKey.new('Transfer-Encoding')] = 'chunked'
+            req[CaseSensitiveHeaderKey.new('Content-Length')] = file.size
+
+            req.body_stream = file
+            # req.body = file
+
+            request = req
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = true
+            logger.debug { %(REQUEST: #{request.method} https://#{http.address}:#{http.port}#{request.path} HEADERS: #{request.to_hash.inspect} #{api_client.http_client.log_request_body and request.request_body_permitted? ? "BODY: #{api_client.http_client.format_body_for_log_output(request)}" : ''}) }
+
+            response = res = http.request(req)
+          end
+          logger.debug { %(RESPONSE: #{response.inspect})} #HEADERS: #{response.to_hash.inspect} #{api_client.http_client.log_response_body and response.respond_to?(:body) ? "BODY: #{api_client.http_client.format_body_for_log_output(response)}" : ''}) }
+          response_code = response.respond_to?(:status) ? response.status.to_s : response.code
+          { :success => response_code.start_with?('2'), asset_url: uri_str }
+        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