vidispine 1.5.5 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 787d02467c745b817b16e3c82b6b883e09dc28ce
-  data.tar.gz: 0df35672bacdb4945b455dc31d7a3363c091d6fb
+  metadata.gz: 42f586329307e5534298c0619169e8d2b2a5f78d
+  data.tar.gz: ecc3b8ba4c3472090ff6c45f48a263e624e95b9b
 SHA512:
-  metadata.gz: f281423491d31ca84a0583ea310fe786038fa8a2adc8e2aba3cf69744fa155e140014a00b76bd50af5e5e9c9fa134c4dd394683bb88254925d5f8650a26ae75e
-  data.tar.gz: 2b5d4a7827796d1a9cb7dbefdf8937de48dc6f3148407734dde6a81780fec95a2ecead0cb69a15fe486259fffefc92431fe4e6b213f059ebf703d336a27827b4
+  metadata.gz: f6dd1740b880a7730fe6786aa8cc30891b79a0cf641671f8a10f76472dae73c16fda520ba77df3aaf1eb68f9504b588ff76383288bb7800ffc3c4ce3921273ba
+  data.tar.gz: 4fe948a108b5ce5d23150bb2b2d3d5facaa8403066b4f5712b0b90f924d4231f1e7edc40b24ea8cc082b2f9e4f608a65b6a9e0c410a9a43e3134b821b203e271

data/lib/vidispine/api/client/http_client.rb

@@ -45,22 +45,21 @@ module Vidispine
 
           @default_query_data = args[:default_query_data] || { }
 
-          # @user_agent_default = "#{@hostname}:#{@username} Ruby SDK Version #{Vidispine::VERSION}"
-
           @username = args[:username] || DEFAULT_USERNAME
           @password = args[:password] || DEFAULT_PASSWORD
 
           @authorization_header_key = args.fetch(:authorization_header_key, 'Authorization')
           @authorization_header_value = args.fetch(:authorization_header_value, %(Basic #{["#{username}:#{password}"].pack('m').delete("\r\n")}))
 
-          content_type = args[:content_type_header] ||= DEFAULT_HEADER_CONTENT_TYPE
-          accepts = args[:accepts_header] ||= args[:accept_header] || DEFAULT_HEADER_ACCEPTS
+          user_agent = args.fetch(:user_agent, false)
+          content_type = args.fetch(:content_type_header, DEFAULT_HEADER_CONTENT_TYPE)
+          accept_header = args.fetch(:accept_header, args.fetch(:accepts_header, DEFAULT_HEADER_ACCEPTS))
 
-          @default_request_headers = {
-            'Content-Type' => content_type,
-            'Accept' => accepts,
-            authorization_header_key => authorization_header_value,
-          }
+          @default_request_headers = { }
+          @default_request_headers['Content-Type'] = content_type if content_type
+          @default_request_headers['Accept'] = accept_header if accept_header
+          @default_request_headers[@authorization_header_key] = @authorization_header_value if @authorization_header_key
+          @default_request_headers['User-Agent'] = user_agent if user_agent
 
           @log_request_body = args.fetch(:log_request_body, true)
           @log_response_body = args.fetch(:log_response_body, true)
@@ -93,6 +92,18 @@ module Vidispine
           http
         end
 
+        def user_agent=(value)
+          if (value)
+            default_request_headers['User-Agent'] = value
+          else
+            default_request_headers.delete('User-Agent')
+          end
+        end
+
+        def user_agent
+          default_request_headers['User-Agent']
+        end
+
         # Formats a HTTPRequest or HTTPResponse body for log output.
         # @param [HTTPRequest|HTTPResponse] obj
         # @return [String]
@@ -137,7 +148,7 @@ module Vidispine
             case response.content_type
             when 'application/json'
                response_body.empty? ? response_body : JSON.parse(response_body) # rescue response
-             else
+            else
                response_body
             end
           end

data/lib/vidispine/api/client.rb

@@ -1,5 +1,5 @@
 require 'logger'
-
+require 'vidispine/version'
 require 'vidispine/api/client/http_client'
 require 'vidispine/api/client/requests'
 
@@ -19,6 +19,7 @@ module Vidispine
         # APInoAuth Path
         @api_noauth_endpoint_prefix = args.fetch(:api_noauth_endpoint_prefix, 'APInoauth')
 
+        args.fetch(:user_agent, "Vidispine Ruby SDK v#{Vidispine::VERSION}")
         @http_client = HTTPClient.new(args)
         @logger = http_client.logger
       end

data/lib/vidispine/api/utilities.rb

@@ -41,14 +41,24 @@ module Vidispine
 
       # Tries to find a collection using either the collection id, name, or a file path with a collection name position.
       # For use in other methods that need to perform the same type of lookup
-      # @param [Hash] :collection
-      # @param [String] :collection_id
-      # @param [String] :collection_name
+      # @args [Hash]
+      # @option args [Hash] :collection
+      # @option args [String] :collection_id
+      # @option args [String] :collection_name
+      # @option args [Array] :collections (nil) If not nil then the each element will be run through
+      #   determine_collection and the array returned
+      # @option args [String] :file_path Used when :file_path_collection_name_position is set
+      # @option args [Integer] :file_path_collection_name_position Will split the file path and be used as the index
+      #   for the collection name location
+      #
       def determine_collection(args, options = { })
+        collections = args[:collections]
+        return collections.map { |v| determine_collection(v, options) } if collections.is_a?(Array)
+
         collection = args[:collection] || { }
 
         # 3 Get Collection
-        collection_id = args[:collection_id] || collection['id']
+        collection_id = args[:collection_id] || collection[:id] || collection['id']
         unless collection_id
           collection_name = args[:collection_name] || args[:name]
           unless collection_name
@@ -541,6 +551,7 @@ module Vidispine
       #
       # @param [Hash] options
       # @option options [Boolean] :add_item_to_collection
+      # @option options [Boolean] :wait_for_import_job (true)
       # @option options [Boolean] :wait_for_transcode_job (false)
       # @option options [Boolean] :skip_transcode_if_shape_with_tag_exists (true)
       # @option options [Boolean] :use_placeholder_import (true)
@@ -605,7 +616,9 @@ module Vidispine
 
         # Allow the file to be passed in
         file = args[:file]
-        unless file
+        if file
+          file_id = file['id']
+        else
           file_id = args[:file_id]
           file = { 'id' => file_id }
         end
@@ -617,6 +630,8 @@ module Vidispine
           raise "Error Getting Storage File. '#{storage_file_get_response.inspect}'" unless storage_file_get_response and storage_file_get_response['id']
           _response[:storage_file_get_response] = storage_file_get_response
 
+          file_found = true
+
           file = storage_file_get_response
         else
             storage_file_get_or_create_response = storage_file_get_or_create(storage_id, file_path_relative_to_storage_path, :extended_response => true)
@@ -627,27 +642,23 @@ module Vidispine
 
         if file
           _response[:item] = item = file['item']
-          file_found = true
         end
 
         _response[:file_already_existed] = file_found
         _response[:item_already_existed] = !!item
-        return _response if item
+        return _response if item # We already have an item so nothing to do
 
-        file_id = file['id']
+        file_id ||= file['id']
 
-        unless item
-          # 4.2 Create a Placeholder
-          logger.debug { 'Creating Placeholder.' }
-          #placeholder_args = args[:placeholder_args] ||= { :container => 1, :video => 1, :metadata_document => { :group => [ 'Film' ], :timespan => [ { :field => [ { :name => metadata_file_path_field_id, :value => [ { :value => vidispine_file_path } ] } ], :start => '-INF', :end => '+INF' } ] } }
-          #placeholder_args = args[:placeholder_args] ||= { :container => 1, :video => 1, :metadata_document => { :timespan => [ { :start => '-INF', :end => '+INF' }.merge(_metadata_as_fields) ] } }
-          #placeholder_args = args[:placeholder_args] ||= { :container => 1, :metadata_document => { :timespan => [ { :start => '-INF', :end => '+INF' }.merge(_metadata_as_fields) ] } }
-          placeholder_args = args[:placeholder_args] ||= { :container => 1, :metadata_document => metadata_document }
-          _response[:item] = item = import_placeholder(placeholder_args)
-        end
-        item_id = item['id']
-        shape = item['shape']
+        # 4.2 Create a Placeholder
+        logger.debug { 'Creating Placeholder.' }
+        #placeholder_args = args[:placeholder_args] ||= { :container => 1, :video => 1, :metadata_document => { :group => [ 'Film' ], :timespan => [ { :field => [ { :name => metadata_file_path_field_id, :value => [ { :value => vidispine_file_path } ] } ], :start => '-INF', :end => '+INF' } ] } }
+        #placeholder_args = args[:placeholder_args] ||= { :container => 1, :video => 1, :metadata_document => { :timespan => [ { :start => '-INF', :end => '+INF' }.merge(_metadata_as_fields) ] } }
+        #placeholder_args = args[:placeholder_args] ||= { :container => 1, :metadata_document => { :timespan => [ { :start => '-INF', :end => '+INF' }.merge(_metadata_as_fields) ] } }
+        placeholder_args = args[:placeholder_args] ||= { :container => 1, :metadata_document => metadata_document }
+        _response[:item] = item = import_placeholder(placeholder_args)
 
+        item_id = item['id']
         raise "Error Creating Placeholder: #{item.inspect}" unless item_id
 
         # Add any additional metadata (Vidispine will only take one group at a time)
@@ -657,18 +668,26 @@ module Vidispine
 
         if options[:add_item_to_collection]
           logger.debug { 'Determining Collection to Add the Item to.' }
-          collection = determine_collection(args, options)
-          _response[:collection] = collection
-          collection_id = collection['id']
+          collections = determine_collection(args, options)
+          if collections.is_a?(Array)
+            single_collection = false
+            _response[:collections] = collections
+          else
+            single_collection = true
+            _response[:collection] = collections
+            collections = [ collections ]
+          end
+          collection_object_add_responses = collections.map do |collection|
+            collection_id = collection['id']
+            logger.debug { 'Adding Item to Collection.' }
+            collection_object_add(:collection_id => collection_id, :object_id => item_id)
+          end
 
-          logger.debug { 'Adding Item to Collection.' }
-          collection_object_add_response = collection_object_add(:collection_id => collection_id, :object_id => item_id)
-          _response[:collection_object_add] = collection_object_add_response
+          _response[:collection_object_add] = single_collection ? collection_object_add_responses.first : collection_object_add_responses
         end
 
-        create_thumbnails = args.fetch(:create_thumbnails, true)
-        create_posters = args.fetch(:create_posters, 3)
 
+        shape = item['shape']
         unless shape
           import_args_in = args[:import_args]
 
@@ -697,15 +716,22 @@ module Vidispine
           end
           raise "Error Creating Item Shape Import Job. Response: #{item_shape_import_response.inspect}" unless job_id
 
-          job_monitor_response = wait_for_job_completion(:job_id => job_id) { |env|
-            logger.debug { "Waiting for Item Shape Import Job to Complete. Time Elapsed: #{Time.now - env[:time_started]} seconds" }
-          }
-          last_response = job_monitor_response[:last_response]
-          raise "Error Adding file As Original Shape. Response: #{last_response.inspect}" unless last_response['status'] == 'FINISHED'
 
           # 7. Generate the Transcode of the item
           transcode_tag = args.fetch(:transcode_tag, 'lowres')
-          if transcode_tag and !transcode_tag.empty? and transcode_tag.to_s.downcase != 'false'
+          should_transcode = transcode_tag and !transcode_tag.empty? and transcode_tag.to_s.downcase != 'false'
+
+          should_wait_for_import_job_completion = should_transcode || options.fetch(:wait_for_import_job, true)
+          if should_wait_for_import_job_completion
+            job_monitor_response = wait_for_job_completion(:job_id => job_id) { |env|
+              logger.debug { "Waiting for Item Shape Import Job to Complete. Time Elapsed: #{Time.now - env[:time_started]} seconds" }
+            }
+            last_response = job_monitor_response[:last_response]
+            _response[:item_shape_import_job_result] = last_response
+            raise "Error Importing File. Response: #{last_response.inspect}" unless last_response['status'] == 'FINISHED'
+          end
+
+          if should_transcode
             wait_for_transcode_job = options[:wait_for_transcode_job]
             skip_transcode_if_shape_with_tag_exists = options.fetch(:skip_transcode_if_shape_with_tag_exists, true)
             [*transcode_tag].each do |_transcode_tag|
@@ -726,6 +752,9 @@ module Vidispine
           end
 
           # 8. Generate the Thumbnails and Poster Frame
+          create_thumbnails = args.fetch(:create_thumbnails, true)
+          create_posters = args.fetch(:create_posters, 3)
+
           if (create_thumbnails or create_posters)
             logger.debug { 'Generating Thumbnails(s) and Poster Frame.' }
             args_out = { :item_id => item_id }

data/lib/vidispine/version.rb

@@ -1,3 +1,3 @@
 module Vidispine
-  VERSION = '1.5.5'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vidispine
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors:
 - John Whitson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler