Class: Matterhorn::Endpoint::Ingest

Inherits:
Matterhorn::Endpoint show all
Defined in:
lib/matterhorn/endpoint/ingest.rb

Overview

Matterhorn::Endpoint::Ingest ===

Constant Summary collapse

HTTP_PROTOCOL_RE = 
/^https?:/

Instance Attribute Summary

Attributes inherited from Matterhorn::Endpoint

#response_body, #response_code

Instance Method Summary collapse

Methods inherited from Matterhorn::Endpoint

#close, create, #error_code, #error_msg, #error_occurred?, #initialize, open

Constructor Details

This class inherits a constructor from Matterhorn::Endpoint

Instance Method Details

#addAttachment(file, flavor) ⇒ Object

————————————————————————– endpoint methodes —



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 8

def addAttachment(file, flavor)
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  @media_pkg_local.add_attachment(file, flavor)    if @media_pkg_local
  begin
    split_response http_endpoint_client.post(
      "ingest/addAttachment",
      { 'flavor' => flavor,
        'mediaPackage' => @media_pkg_xml_remote,
        'BODY' => file
      }
    )
    @media_pkg_xml_remote = response_body
  rescue => ex
    exception_handler('addAttachment', ex, {
        400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
      }
    )
    raise ex
  end
  @media_pkg_xml_remote
end

#addCatalog(file, flavor) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 31

def addCatalog(file, flavor)
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  @media_pkg_local.add_catalog(file, flavor)    if @media_pkg_local
  begin
    split_response http_endpoint_client.post(
      "ingest/addCatalog",
      { 'flavor' => flavor,
        'mediaPackage' => @media_pkg_xml_remote,
        'BODY' => file
      }
    )
    @media_pkg_xml_remote = response_body
  rescue => ex
    exception_handler('addCatalog', ex, {
        400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
      }
    )
    raise ex
  end
  @media_pkg_xml_remote
end

#addDCCatalog(dublin_core) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 54

def addDCCatalog(dublin_core)
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  @media_pkg_local.add_dc_catalog(dublin_core)    if @media_pkg_local
  begin
    split_response http_endpoint_client.post(
      "ingest/addDCCatalog",
      { 'flavor' => 'dublincore/episode',
        'mediaPackage' => @media_pkg_xml_remote,
        'dublinCore' => dublin_core
      }
    )
    @media_pkg_xml_remote = response_body
  rescue => ex
    exception_handler('addDCCatalog', ex, {
        400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
      }
    )
    raise ex
  end
  @media_pkg_xml_remote
end

#addTrack(file_or_url, flavor) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 78

def addTrack(file_or_url, flavor)
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  @media_pkg_local.add_track(file_or_url, flavor) if @media_pkg_local
  begin
    if HTTP_PROTOCOL_RE =~ file_or_url
      split_response http_endpoint_client.post(
        "ingest/addTrack",
        { 'flavor' => flavor,
          'mediaPackage' => @media_pkg_xml_remote,
          'url' => file_or_url
        }
      )
    else
      split_response http_endpoint_client.post(
        "ingest/addTrack",
        { 'flavor' => flavor,
          'mediaPackage' => @media_pkg_xml_remote,
          'BODY' => file_or_url
        }
      )
    end
    @media_pkg_xml_remote = response_body
  rescue => ex
    exception_handler('addTrack', ex, {
        400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
      }
    )
    raise ex
  end
  @media_pkg_xml_remote
end

#createMediaPackage(source_path = nil, prefix = nil) ⇒ Object

Create a media package on the matterhorn server. If the source_path to the source folder of uploaded items for that media package is given, then a local media description file ‘manifest.xml’ will be automaticaly saved in that folder.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 115

def createMediaPackage(source_path = nil, prefix = nil)
  if @media_pkg_xml_remote then raise(Matterhorn::Error, "A media package is allready created!"); end
  @media_pkg_local = if source_path
                       Matterhorn::MediaPackage.new(nil, {:path     => source_path,
                                                          :prefix => prefix})
                     else
                       nil
                     end
  begin
    split_response http_endpoint_client.get(
      "ingest/createMediaPackage"
    )
    @media_pkg_xml_remote = response_body
  rescue => ex
    exception_handler('createMediaPackage', ex, {})
    raise ex
  end
  @media_pkg_xml_remote
end

#ingest(wdID = 'full', options = {}) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 136

def ingest(wdID = 'full', options = {})
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  @media_pkg_local.save    if @media_pkg_local
  options['mediaPackage'] = @media_pkg_xml_remote
  begin
    split_response http_endpoint_client.post(
      "ingest/ingest/#{wdID}",
      options
    )
    @workflow_inst = response_body
  rescue => ex
    exception_handler('ingest', ex, {
        400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
      }
    )
    raise ex
  end
  workflow_instance
end

#media_package(kind = 'local') ⇒ Object

—————————————————————————- helper methodes —



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 165

def media_package(kind = 'local')
  unless @media_pkg_xml_remote then raise(Matterhorn::Error, "No media package is available!"); end
  if kind == 'local' && @media_pkg_local
    return @media_pkg_local
  elsif @media_pkg_xml_remote
    Matterhorn::MediaPackage.new(@media_pkg_xml_remote)
  else
    nil
  end
end

#media_package_identifier ⇒ Object 



157
158
159
160
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 157

def media_package_identifier
  return nil unless @media_pkg_xml_remote
  Matterhorn::MediaPackage.new(@media_pkg_xml_remote).identifier
end

#setTitle(title) ⇒ Object 



177
178
179
180
181
182
183
184
185
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 177

def setTitle(title)
  dublin_core = <<DUBLIN_CORE
<?xml version="1.0" encoding="UTF-8"?>
<dublincore xmlns="http://www.opencastproject.org/xsd/1.0/dublincore/" xmlns:dcterms="http://purl.org/dc/terms/">
<dcterms:title>#{title.encode(:xml => :text)}</dcterms:title>
</dublincore>
DUBLIN_CORE
  addDCCatalog(dublin_core)
end

#workflow_instance ⇒ Object 



188
189
190
 
# File 'lib/matterhorn/endpoint/ingest.rb', line 188

def workflow_instance
  @workflow_inst ? Matterhorn::WorkflowInstance.new(@workflow_inst) : nil
end