Class: Vidispine::API::Client::Requests::StorageFileGet

Inherits:
BaseRequest
  • Object
show all
Defined in:
lib/vidispine/api/client/requests/storage_file_get.rb

Overview

Exposes two functions

1. Get status of file in storage
  @see http://apidoc.vidispine.com/4.2.3/ref/storage/file.html#get-status-of-file-in-storage

2. Get direct download access to file in storage
  @see http://apidoc.vidispine.com/4.2.3/ref/storage/file.html#get-direct-download-access-to-file-in-storage

Constant Summary collapse

HTTP_PATH = 
'/storage/#{path_arguments[:storage_id]}/file/#{path_arguments[:file_id]}'
PARAMETERS = 
[
  # Path Parameters
  { :name => :storage_id, :required => true, :send_in => :path },
  { :name => :file_id, :required => true, :send_in => :path },

  # Matrix Parameters
  { :name => :includeItem, :send_in => :matrix },
  { :name => :path, :send_in => :matrix },
  { :name => :uri, :send_in => :matrix },


  # Query Parameters
  :methodType
]

Constants inherited from BaseRequest

BaseRequest::DEFAULT_PARAMETER_SEND_IN_VALUE, BaseRequest::HTTP_BASE_PATH, BaseRequest::HTTP_METHOD, BaseRequest::HTTP_SUCCESS_CODE

Instance Attribute Summary

Attributes inherited from BaseRequest

#arguments, #body, #client, #default_parameter_send_in_value, #initial_arguments, #missing_required_arguments, #options, #parameters, #path, #processed_parameters, #query

Instance Method Summary collapse

Methods inherited from BaseRequest

#after_initialize, #base_path, #before_process_parameters, #body_arguments, #eval_http_path?, #http_method, #http_path, #http_success_code, #initialize, #matrix, #matrix_arguments, normalize_argument_hash_keys, normalize_parameter_name, #path_arguments, #path_only, process_parameter, #process_parameters, process_parameters, #query_arguments, #reset_attributes, #success?, #uri_request_path

Constructor Details

This class inherits a constructor from Vidispine::API::Client::Requests::BaseRequest

Instance Method Details

#after_process_parameters ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'lib/vidispine/api/client/requests/storage_file_get.rb', line 28

def after_process_parameters
  # URI Needs to be escaped twice, so we do it once here and then again when the query is built
  # @see http://apidoc.vidispine.com/4.2.6/storage/uri.html#api-calls
  _uri = arguments[:uri]
  arguments[:uri] = CGI.escape(_uri).gsub('+', '%20') if _uri

  _path  =arguments[:path]
  arguments[:path] = CGI.escape(_path).gsub('+', '%20') if _path
end