Class: Mediaflux::AssetMetadataRequest

Inherits:
Request
  • Object
show all
Defined in:
app/models/mediaflux/asset_metadata_request.rb

Overview

Get metadata about an asset in mediaflux

Examples:

metadata_request = Mediaflux::AssetMetadataRequest.new(
session_token: current_user.mediaflux_session, id: mediaflux_id).metadata

Instance Attribute Summary collapse

Attributes inherited from Request

#session_token

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Request

build_post_request, default_xml_namespace, default_xml_namespace_uri, #error?, find_or_create_http_client, format_date_for_mediaflux, request_path, #resolve, #resolved?, #response_body, #response_error, #response_xml, uri, #xml_payload, #xtoshell_xml

Constructor Details

#initialize(session_token:, id:) ⇒ AssetMetadataRequest

Constructor

Parameters:

  • session_token (String) —

    the API token for the authenticated session

  • id (Integer) —

    Id of the Asset to return the metadata for



13
14
15
16
 
# File 'app/models/mediaflux/asset_metadata_request.rb', line 13

def initialize(session_token:, id:)
  super(session_token: session_token)
  @id = id
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



8
9
10
 
# File 'app/models/mediaflux/asset_metadata_request.rb', line 8

def id
  @id
end

Class Method Details

.service ⇒ String

Specifies the Mediaflux service to use when getting asset metadata

Returns:

  • (String) 


20
21
22
 
# File 'app/models/mediaflux/asset_metadata_request.rb', line 20

def self.service
  "asset.get"
end

Instance Method Details

#metadata ⇒ Object

parse the returned XML into a hash about the asset that can be utilized



25
26
27
28
29
30
31
32
33
 
# File 'app/models/mediaflux/asset_metadata_request.rb', line 25

def metadata
  xml = response_xml
  asset = xml.xpath("/response/reply/result/asset")
  metadata = parse(asset)

  parse_file_count(asset, metadata)
  parse_quota(asset.xpath("./collection/quota"), metadata)
  metadata
end