vidispine 1.4.0

data/lib/vidispine/api/client/requests/collection_access_add.rb

@@ -0,0 +1,30 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#add-a-new-entry-access-control-entry
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#add-access-control-entries-to-all-items
+  class CollectionAccessAdd < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/collection/#{path_arguments[:collection_id] ? "#{path_arguments[:collection_id]}/" : ""}access'
+
+    PARAMETERS = [
+        { :name => :collection_id, :send_in => :path },
+        { :name => :access_control_document, :required => true, :send_in => :body },
+        { :name => :allow_all_collections, :aliases => [ :all_collections ], :send_in => :none }
+    ]
+
+    def after_process_parameters
+      _collection_id = arguments[:collection_id]
+      unless (arguments[:allow_all_collections] == true) || (_collection_id && !_collection_id.empty?)
+        raise ArgumentError, 'Collection ID is required unless :allow_all_collections parameter is set to true.'
+      end
+    end
+
+    def body
+      body_arguments[:access_control_document]
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/collection_access_delete.rb

@@ -0,0 +1,26 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#delete--collection-(collection-id)-access-(access-id)
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#remove-all-access-control-entries-from-all-collections
+  class CollectionAccessDelete < BaseRequest
+
+    HTTP_METHOD = :delete
+    HTTP_PATH = '/collection/#{path_arguments[:collection_id] ? "#{path_arguments[:collection_id]}/" : ""}access/#{path_arguments[:access_id]}'
+
+    PARAMETERS = [
+      { :name => :collection_id, :send_in => :path },
+      { :name => :access_id, :send_in => :path, :required => true },
+      { :name => :allow_all_collections, :aliases => [ :all_collections ], :send_in => :none }
+    ]
+
+    def after_process_parameters
+      _collection_id = arguments[:collection_id]
+      unless (arguments[:allow_all_collections] == true) || (_collection_id && !_collection_id.empty?)
+        raise ArgumentError, 'Collection ID is required unless :allow_all_collections parameter is set to true.'
+      end
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/collection_metadata_set.rb

@@ -0,0 +1,24 @@
+module Vidispine::API::Client::Requests
+
+
+  # @see http://apidoc.vidispine.com/4.2/ref/collection.html#update-collection-metadata
+  class CollectionMetadataSet < BaseRequest
+
+    HTTP_METHOD = :put
+    HTTP_PATH = 'collection/#{path_arguments[:collection_id]}/metadata'
+
+    PARAMETERS = [
+      { :name => :collection_id, :aliases => [ :id ], :required => true, :send_in => :path },
+
+      { :name => :MetadataDocument, :aliases => [ :body ], :send_in => :body, :default_value => { } }
+    ]
+
+    def body
+      @body ||= body_arguments[:MetadataDocument]
+    end
+
+  end
+
+
+end
+

data/lib/vidispine/api/client/requests/import_placeholder.rb

@@ -0,0 +1,36 @@
+module Vidispine::API::Client::Requests
+
+  class ImportPlaceholder < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/import/placeholder'
+
+    PARAMETERS = [
+      { :name => :container },
+      { :name => :audio },
+      { :name => :video },
+      :type,
+      :frameDuration,
+      :notification,
+      :notificationData,
+      :priority,
+      :jobmetadata,
+      'no-transcode',
+      { :name => :MetadataDocument, :aliases => [ :metadata ], :default_value => { }, :send_in => :body },
+    ]
+
+    def body
+      @body ||= arguments[:MetadataDocument]
+    end
+
+    def body_as_xml
+      <<-XML
+<MetadataDocument xmlns="http://xml.vidispine.com/schema/vidispine">
+</MetadataDocument>
+      XML
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/import_placeholder_item.rb

@@ -0,0 +1,38 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/item/import.html#import-to-a-placeholder-item
+  class ImportPlaceholderItem < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/import/placeholder/#{path_arguments[:item_id]}/#{path_arguments[:item_type]}'
+
+    PARAMETERS = [
+      { :name => :item_id, :required => true, :send_in => :path },
+      { :name => :item_type, :required => true, :send_in => :path },
+      :uri,
+      :fileId,
+      :tag,
+      :original,
+      :createThumbnails,
+      :overrideFastStart,
+      :requireFastStart,
+      :fastStartLength,
+      :growing,
+      :notification,
+      :notificationDta,
+      :priority,
+      :jobmetadata,
+      :settings,
+      :index
+    ]
+
+    def after_process_parameters
+      # URI Needs to be escaped twice, so we do it once here and then again when the query is built
+      _uri = arguments[:uri]
+      arguments[:uri] = CGI.escape(_uri) if _uri
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/import_sidecar_file.rb

@@ -0,0 +1,28 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/item/import.html#import-a-sidecar-file
+  # @see http://vidispine.com/partner/vidiwiki/RestItemImport#Syntax:_Starting_a_sidecar_import_job
+  class ImportSidecarFile < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/import/sidecar/#{path_arguments[:item_id]}'
+
+    PARAMETERS = [
+      { :name => :item_id, :required => true, :send_in => :path },
+      :sidecar,
+      :notification,
+      :notificationDta,
+      :priority,
+      :jobmetadata,
+    ]
+
+    def after_process_parameters
+      # URI Needs to be escaped twice, so we do it once here and then again when the query is built
+      sidecar = arguments[:sidecar]
+      arguments[:sidecar] = CGI.escape(sidecar) if sidecar and sidecar.start_with?('file://')
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/import_using_uri.rb

@@ -0,0 +1,44 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/4.2/ref/item/import.html#import-using-a-uri
+  class ImportUsingURI < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/import'
+
+    PARAMETERS = [
+      { :name => :uri, :aliases => [ :url ], :required => true },
+      :tag,
+      :original,
+      :thumbnails,
+      :thumbnailService,
+      :createPosers,
+      :overrideFastStart,
+      :requireFastStart,
+      :fastStartLength,
+      :storageId,
+      :filename,
+      :growing,
+      :xmpfile,
+      :sidecar,
+      'no-transcode',
+      :notification,
+      :notificationData,
+      :priority,
+      :jobmetadata,
+      { :name => :MetadataDocument, :aliases => [ :metadata ], :default_value => { }, :send_in => :body },
+    ]
+
+    # def after_process_parameters
+    #   # URI Needs to be escaped twice, so we do it once here and then again when the query is built
+    #   _uri = arguments[:uri]
+    #   arguments[:uri] = CGI.escape(_uri) if _uri
+    # end
+
+    def body
+      @body ||= arguments[:MetadataDocument]
+    end
+
+  end
+
+end

data/lib/vidispine/api/client/requests/item_access_add.rb

@@ -0,0 +1,30 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#add-a-new-entry-access-control-entry
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#add-access-control-entries-to-all-items
+  class ItemAccessAdd < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/item/#{path_arguments[:item_id] ? "#{path_arguments[:item_id]}/" : ""}access'
+
+    PARAMETERS = [
+      { :name => :item_id, :send_in => :path },
+      { :name => :access_control_document, :required => true, :send_in => :body },
+      { :name => :allow_all_items, :aliases => [ :all_items ], :send_in => :none }
+    ]
+
+    def after_process_parameters
+      _item_id = arguments[:item_id]
+      unless (arguments[:allow_all_items] == true) || (_item_id && !_item_id.empty?)
+        raise ArgumentError, 'Item ID is required unless :allow_all_items parameter is set to true.'
+      end
+    end
+
+    def body
+      body_arguments[:access_control_document]
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/item_access_delete.rb

@@ -0,0 +1,26 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#delete--item-(item-id)-access-(access-id)
+  # @see http://apidoc.vidispine.com/latest/ref/access-control.html#remove-all-access-control-entries-from-all-items
+  class ItemAccessDelete < BaseRequest
+
+    HTTP_METHOD = :delete
+    HTTP_PATH = '/item/#{path_arguments[:item_id] ? "#{path_arguments[:item_id]}/" : ""}access/#{path_arguments[:access_id]}'
+
+    PARAMETERS = [
+      { :name => :item_id, :send_in => :path },
+      { :name => :access_id, :send_in => :path, :required => true },
+      { :name => :allow_all_items, :aliases => [ :all_items ], :send_in => :none }
+    ]
+
+    def after_process_parameters
+      _item_id = arguments[:item_id]
+      unless (arguments[:allow_all_items] == true) || (_item_id && !_item_id.empty?)
+        raise ArgumentError, 'Item ID is required unless :allow_all_items parameter is set to true.'
+      end
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/item_delete.rb

@@ -0,0 +1,17 @@
+module Vidispine::API::Client::Requests
+
+  class ItemDelete < BaseRequest
+
+    HTTP_METHOD = :delete
+    HTTP_PATH = '/item/#{path_arguments[:item_id]}'
+
+    PARAMETERS = [
+      { :name => :item_id, :aliases => [ :id ], :required => true, :send_in => :path },
+      :keepShapeTagMedia,
+      :keepShapeTagStorage,
+    ]
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/item_export.rb

@@ -0,0 +1,44 @@
+module Vidispine::API::Client::Requests
+
+  # @see http://apidoc.vidispine.com/latest/ref/item/export.html#item-export
+  class ItemExport < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/item/#{path_arguments[:item_id]}/export'
+    DEFAULT_PARAMETER_SEND_IN_VALUE = :query
+
+    PARAMETERS = [
+      { :name => :item_id, :send_in => :path },
+
+      :uri,
+      :locationName,
+      :tag,
+      :metadata,
+      :projection,
+      :start,
+      :end,
+      :notification,
+      :notificationData,
+      :priority,
+      :jobmetadata,
+      :useOriginalFilename,
+      :template,
+      :allowMissing,
+
+      { :name => :body, :send_in => :body }
+    ]
+
+    def body
+      @body ||= arguments[:body]
+    end
+
+    def body_as_xml
+      <<-XML
+<empty/>
+      XML
+    end
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/item_metadata_get.rb

@@ -0,0 +1,37 @@
+module Vidispine::API::Client::Requests
+
+
+  # @see http://apidoc.vidispine.com/4.2/ref/metadata/metadata.html#get--item-(id)-metadata
+  class ItemMetadataGet < BaseRequest
+
+    HTTP_METHOD = :get
+    HTTP_PATH = '/item/#{path_arguments[:item_id]}/metadata'
+
+    DEFAULT_PARAMETER_SEND_IN_VALUE = :matrix
+
+    PARAMETERS = [
+        { :name => :item_id, :aliases => [ :id ], :required => true, :send_in => :path },
+
+        :projection,
+        :interval,
+        :startc,
+        :field,
+        :group,
+        :track,
+        :language,
+        :conflict,
+        :samplerate,
+        :revision,
+        :terse,
+        :include,
+        :defaultValue,
+        :from,
+        :to,
+
+        { :name => :includeTransientMetadata, :send_in => :query },
+    ]
+
+  end
+
+end
+

data/lib/vidispine/api/client/requests/item_metadata_set.rb

@@ -0,0 +1,29 @@
+module Vidispine::API::Client::Requests
+
+
+  # @see http://apidoc.vidispine.com/4.2/ref/metadata/metadata.html#set--item-(id)-metadata
+  class ItemMetadataSet < BaseRequest
+
+    HTTP_METHOD = :put
+    HTTP_PATH = '/item/#{path_arguments[:item_id]}/metadata'
+
+    PARAMETERS = [
+      { :name => :item_id, :aliases => [ :id ], :required => true, :send_in => :path },
+
+      { :name => :projection, :send_in => :matrix },
+      { :name => 'output-project', :send_in => :matrix },
+
+      :revision,
+
+      { :name => :MetadataDocument, :send_in => :body, :default_value => { } }
+    ]
+
+    def body
+      @body ||= body_arguments[:MetadataDocument]
+    end
+
+  end
+
+
+end
+

data/lib/vidispine/api/client/requests/item_transcode.rb

@@ -0,0 +1,23 @@
+module Vidispine::API::Client::Requests
+
+  class ItemTranscode < BaseRequest
+
+    HTTP_METHOD = :post
+    HTTP_PATH = '/item/#{path_arguments[:item_id]}/transcode'
+
+    PARAMETERS = [
+      { :name => :item_id, :aliases => [ :id ], :send_in => :path, :required => true },
+
+      { :name => :tag, :required => true },
+      :createThumbnails,
+      :createPosters,
+      :notification,
+      :notificationData,
+      :priority,
+      :jobmetadata
+    ]
+
+  end
+
+end
+