matterhorn_whymper 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjliZDhiZTllYjViZDZlMDRlNDBkMDk2Y2NjZDJlYjE2ODU3OTlmNA==
+    NDBjMjFkYWYxYzY0ZDNlYzkwZTZjYzBkNDc0NzU3NzU0ZWVkNDRhYw==
   data.tar.gz: !binary |-
-    ODkzN2MzZjJmYzc3YjJhMTc0M2UzZTg0ZWVmYTRmZGY5ZDJmNTYwMg==
+    Nzg0YjdjMzRiNjc4ZWU5NGE4N2Q3OGQwYjEwNjkxOTY3YmI4YzNhNQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDM4YzBhODU2MmU3YTdhNzFjM2Y2NDdjYzYyNjg4ZjAwZmZlNTllYTYwMTM3
-    YzNjM2FkOTdjNjFhZWNiOWRhOTdkZDJmYWUwNDNjZjc2ZDhmOTM5MzU2MDlm
-    MTA0ZTdhMDRmODBjMDYxNmU1MWQxYzVlZjQxYWYwMmQwNDhmNWY=
+    ZTgzYmJmNmFjOWY5YTkxYjYzMjM2YzE3ZWI1NTY2OWU1ZWI5YjQ4ZDQ0NjJk
+    YTg5NTRhMjBlZjAyMDkwZjA4YjliOGVlM2NkODQwZTBiODE3NTM5NWMwZGM4
+    OWFlMjJmZTAxZmFiZTRkMDc1NWJkZmYyYTFkMGViYWE0NDMzYzM=
   data.tar.gz: !binary |-
-    OGY2ZjhjYmQ4MDljZGQyYTEzMTAwMTdjY2Y4OWFiY2ZjOTBkMGIzYTg0OGJk
-    Mzg5MDg5NzI0NTA1MWUzNmRlNzBlZmMwYjQ0YThhZjUxNTJkNWJkMDM4NTMx
-    NWEzMDM4YWRhZmE3OTI5ZjZkMWNiYzdkMzliODEzNzdlZjA0ZTc=
+    M2NhMjZjYmYzN2VmZTk1NTc4ZDIyNTQyZWMyMzYzZmM0MDhkNWI1M2U5ZTYz
+    OGIzYmRkZWQxYmIzM2QwNWRjN2FjMTU4ZTY5OGVjNmQyY2IxMmUyZDg1ZDhi
+    Y2ZlNGY3ZmNmNzFjNzM3ZGM3OWE1YThjMjNiYmFhNDU3YTZkZGU=

data/lib/matterhorn/endpoint/event.rb

@@ -0,0 +1,45 @@
+# ================================================================== Matterhorn::Endpoint::Event ===
+
+# This endpoint is not a pure wrapper of the admin endpoint.
+# Create should be done over ingest endpoint
+# Update is implemented over the external API
+#
+class Matterhorn::Endpoint::Event < Matterhorn::Endpoint
+
+
+  # -------------------------------------------------------------------------- endpoint methodes ---
+
+  # ------------------------------------------------------------------------------------- create ---
+
+
+  # --------------------------------------------------------------------------------------- read ---
+
+  def read_media_package(media_package_id)
+    media_package_xml = nil
+    begin
+      split_response http_client.get(
+        "archive/archive/mediapackage/#{media_package_id}"
+      )
+      media_package_xml = response_body
+    rescue => ex
+      exception_handler('read_media_package', ex, {
+          404 => "The media package of event[#{media_package_id}] could not be found."
+        }
+      )
+    end
+    media_package_xml
+  end
+
+
+  # ------------------------------------------------------------------------------------- update ---
+
+
+  # ------------------------------------------------------------------------------------- delete ---
+
+
+  # ---------------------------------------------------------------------------- private section ---
+  private
+
+
+
+end # ---------------------------------------------------------- end Matterhorn::Endpoint::Event ---

data/lib/matterhorn/endpoint/ingest.rb

@@ -6,84 +6,84 @@ class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
   # -------------------------------------------------------------------------- endpoint methodes ---
 
   def addAttachment(file, flavor)
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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
       spit_response http_client.post(
         "ingest/addAttachment",
         { 'flavor' => flavor,
-          'mediaPackage' => @media_pkg_remote,
+          'mediaPackage' => @media_pkg_xml_remote,
           'BODY' => file
         }
       )
-      @media_pkg_remote = response_body
+      @media_pkg_xml_remote = response_body
     rescue => ex
       exception_handler('addAttachment', ex, {
-          400 => "Media package not valid! / media package:\n#{@media_pkg_remote}"
+          400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
         }
       )
       raise ex
     end
-    @media_pkg_remote
+    @media_pkg_xml_remote
   end
 
 
   def addCatalog(file, flavor)
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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_client.post(
         "ingest/addCatalog",
         { 'flavor' => flavor,
-          'mediaPackage' => @media_pkg_remote,
+          'mediaPackage' => @media_pkg_xml_remote,
           'BODY' => file
         }
       )
-      @media_pkg_remote = response_body
+      @media_pkg_xml_remote = response_body
     rescue => ex
       exception_handler('addCatalog', ex, {
-          400 => "Media package not valid! / media package:\n#{@media_pkg_remote}"
+          400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
         }
       )
       raise ex
     end
-    @media_pkg_remote
+    @media_pkg_xml_remote
   end
 
 
   def addDCCatalog(dublin_core)
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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_client.post(
         "ingest/addDCCatalog",
         { 'flavor' => 'dublincore/episode',
-          'mediaPackage' => @media_pkg_remote,
+          'mediaPackage' => @media_pkg_xml_remote,
           'dublinCore' => dublin_core
         }
       )
-      @media_pkg_remote = response_body
+      @media_pkg_xml_remote = response_body
     rescue => ex
       exception_handler('create', ex, {
-          400 => "Media package not valid! / media package:\n#{@media_pkg_remote}"
+          400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
         }
       )
       raise ex
     end
-    @media_pkg_remote
+    @media_pkg_xml_remote
   end
 
   HTTP_PROTOCOL_RE = /^https?:/
 
   def addTrack(file_or_url, flavor)
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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_client.post(
           "ingest/addTrack",
           { 'flavor' => flavor,
-            'mediaPackage' => @media_pkg_remote,
+            'mediaPackage' => @media_pkg_xml_remote,
             'url' => file_or_url
           }
         )
@@ -91,20 +91,20 @@ class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
         split_response http_client.post(
           "ingest/addTrack",
           { 'flavor' => flavor,
-            'mediaPackage' => @media_pkg_remote,
+            'mediaPackage' => @media_pkg_xml_remote,
             'BODY' => file_or_url
           }
         )
       end
-      @media_pkg_remote = response_body
+      @media_pkg_xml_remote = response_body
     rescue => ex
       exception_handler('addTrack', ex, {
-          400 => "Media package not valid! / media package:\n#{@media_pkg_remote}"
+          400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
         }
       )
       raise ex
     end
-    @media_pkg_remote
+    @media_pkg_xml_remote
   end
 
 
@@ -113,25 +113,29 @@ class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
   # then a local media description file 'manifest.xml' will be automaticaly saved in that folder.
   #
   def createMediaPackage(source_path = nil)
-    if @media_pkg_remote then raise(Matterhorn::Error, "A media package is allready created!"); end
-    @media_pkg_local = source_path ? Matterhorn::MediaPackage.new(source_path) : 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})
+                       else
+                         nil
+                       end
     begin
       split_response http_client.get(
         "ingest/createMediaPackage"
       )
-      @media_pkg_remote = response_body
+      @media_pkg_xml_remote = response_body
     rescue => ex
       exception_handler('createMediaPackage', ex, {})
       raise ex
     end
-    @media_pkg_remote
+    @media_pkg_xml_remote
   end
 
 
   def ingest(wdID = 'full', options = {})
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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_remote
+    options['mediaPackage'] = @media_pkg_xml_remote
     begin
       split_response http_client.post(
         "ingest/ingest/#{wdID}",
@@ -140,7 +144,7 @@ class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
       @workflow_inst = response_body
     rescue => ex
       exception_handler('create', ex, {
-          400 => "Media package not valid! / media package:\n#{@media_pkg_remote}"
+          400 => "Media package not valid! / media package:\n#{@media_pkg_xml_remote}"
         }
       )
       raise ex
@@ -149,14 +153,20 @@ class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
   end
 
 
+  def media_package_idenfifier
+    return nil unless @media_pkg_xml_remote
+    Matterhorn::MediaPackage.new(@media_pkg_xml_remote).identifier
+  end
+
+
   # ---------------------------------------------------------------------------- helper methodes ---
 
   def media_package(kind = 'local')
-    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    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_remote
-      Matterhorn::MediaPackage.new(@media_pkg_remote)
+    elsif @media_pkg_xml_remote
+      Matterhorn::MediaPackage.new(@media_pkg_xml_remote)
     else
       nil
     end

data/lib/matterhorn/endpoint.rb

@@ -82,7 +82,17 @@ class Matterhorn::Endpoint
     @response_code = response.code.to_i
     @response_body = response.body
   end
+
   
+  def build_query_str(options)
+    query_str = ''
+    options.each do |key, value|
+      query_str << (query_str.empty? ? '?' : '&')
+      query_str << "#{key.to_s}=#{value.to_s}"
+    end
+    URI.encode(query_str)
+  end
+
 
   def exception_handler(method, exception, code_error_msg_hash)
     res_code = 0

data/lib/matterhorn/media_package.rb

@@ -1,120 +1,137 @@
 require 'nokogiri'
 
 
-# =================================================================================== Matterhorn ===
+# ===================================================================== Matterhorn::MediaPackage ===
 
-module Matterhorn
+class Matterhorn::MediaPackage
+ 
+  # -------------------------------------------------------------------------- const definitions ---
 
+  XML_NS_MEDIAPACKAGE = "http://mediapackage.opencastproject.org"
+  
 
-  # =================================================================== Matterhorn::MediaPackage ===
-
-  class MediaPackage
-   
-    # ------------------------------------------------------------------------ const definitions ---
-
-    XML_NS_MEDIAPACKAGE = "http://mediapackage.opencastproject.org"
-    
+  # ----------------------------------------------------------------------------- initialization ---
 
-    # --------------------------------------------------------------------------- initialization ---
-  
-    def initialize(path, xml = nil)
-      @path = path + (path[-1] == '/' ? '' : '/')            # guarantee that path ends with a slash
-      if !xml.nil?
-        @document = Nokogiri::XML(xml)
-      else
-        @document = Nokogiri::XML::Builder.new do |xml|
-          xml.mediapackage('xmlns' => XML_NS_MEDIAPACKAGE) do
-            xml.media
-            xml.metadata
-            xml.attachments
-          end
+  def initialize(xml = nil, options = {})
+    if xml
+      @document = Nokogiri::XML::Builder.new do |xml|
+        xml.mediapackage('xmlns' => XML_NS_MEDIAPACKAGE) do
+          xml.media
+          xml.metadata
+          xml.attachments
         end
-        .doc
       end
+      .doc
+    else
+      @document = Nokogiri::XML(xml)
     end
-
-  
-    # --------------------------------------------------------------------------------- methodes ---
-
-    #  <attachments>
-    #    <attachment type="switchcastrecorder/metadata">
-    #      <tags/>
-    #      <url>metadata.plist</url>
-    #    </attachment>
-    #  </attachments>
-    #
-    def add_attachment(file, flavor)
-      Nokogiri::XML::Builder.with(@document.at('attachments')) do |xml|
-        xml.attachment(:type => flavor) {
-          xml.tags
-          xml.url file.sub(@path, '')
-        }
-      end
+    if (path = options[:path])
+      @path = path + (path[-1] == '/' ? '' : '/')            # guarantee that path ends with a slash
+    else
+      @path = nil
     end
+  end
 
 
-    # <metadata>
-    #   <catalog type="dublincore/episode">
-    #     <mimetype>text/xml</mimetype>
-    #     <tags/>
-    #     <url>dublincore.xml</url>
-    #   </catalog>
-    # </metadata>
-    #
-    def add_catalog(file, flavor, mimetype = 'text/xml')
-      Nokogiri::XML::Builder.with(@document.at('metadata')) do |xml|
-        xml.catalog(:type => flavor) {
-          xml.mimetype mimetype
-          xml.tags
-          xml.url file.sub(@path, '')
-        }
-      end
-    end
+  # ----------------------------------------------------------------------------------- methodes ---
 
+  def document
+    @document
+  end
 
-    def add_dc_catalog(dublin_core)
-      filename = 'dublincore.xml'
-      flavor   = 'dublincore/episode'
-      dc_doc   = Nokogiri::XML(dublin_core)
-      dc_file  = File.join(@path, filename)
-      File.open(dc_file, 'w') do |file|
-        file.write(dc_doc.to_xml)
-      end
-      add_catalog(dc_file, flavor)
+  
+  def to_xml
+    @document.to_xml
+  end
+
+
+  def inspect
+    to_xml.to_s
+  end
+
+
+  #  <attachments>
+  #    <attachment type="switchcastrecorder/metadata">
+  #      <tags/>
+  #      <url>metadata.plist</url>
+  #    </attachment>
+  #  </attachments>
+  #
+  def add_attachment(file, flavor)
+    Nokogiri::XML::Builder.with(@document.at('attachments')) do |xml|
+      xml.attachment(:type => flavor) {
+        xml.tags
+        xml.url file.sub(@path, '')
+      }
     end
-
-
-    # <media>
-    #   <track type="presenter/source+partial">
-    #     <tags/>
-    #     <url>source1/mux_2013_12-17T14_51_29_738.mov</url>
-    #   </track>
-    # </media>
-    #
-    def add_track(file, flavor)
-      Nokogiri::XML::Builder.with(@document.at('media')) do |xml|
-        xml.track(:type => flavor) {
-          xml.tags
-          xml.url file.sub(@path, '')
-        }
-      end
+  end
+
+
+  # <metadata>
+  #   <catalog type="dublincore/episode">
+  #     <mimetype>text/xml</mimetype>
+  #     <tags/>
+  #     <url>dublincore.xml</url>
+  #   </catalog>
+  # </metadata>
+  #
+  def add_catalog(file, flavor, mimetype = 'text/xml')
+    Nokogiri::XML::Builder.with(@document.at('metadata')) do |xml|
+      xml.catalog(:type => flavor) {
+        xml.mimetype mimetype
+        xml.tags
+        xml.url file.sub(@path, '')
+      }
     end
+  end
 
 
-    def save(path = @path)
-      manifest_file = File.join(path, 'manifest.xml')
-      File.open(manifest_file, 'w') do |file|
-        file.write(@document.to_xml)
-      end
+  def add_dc_catalog(dublin_core)
+    filename = 'dublincore.xml'
+    flavor   = 'dublincore/episode'
+    dc_doc   = Nokogiri::XML(dublin_core)
+    dc_file  = File.join(@path, filename)
+    File.open(dc_file, 'w') do |file|
+      file.write(dc_doc.to_xml)
+    end
+    add_catalog(dc_file, flavor)
+  end
+
+
+  # <media>
+  #   <track type="presenter/source+partial">
+  #     <tags/>
+  #     <url>source1/mux_2013_12-17T14_51_29_738.mov</url>
+  #   </track>
+  # </media>
+  #
+  def add_track(file, flavor)
+    Nokogiri::XML::Builder.with(@document.at('media')) do |xml|
+      xml.track(:type => flavor) {
+        xml.tags
+        xml.url file.sub(@path, '')
+      }
     end
+  end
 
 
-    def to_xml
-      @document.to_xml
-    end
+  # Returns the id attribute of mediapackage element.
+  # <mediapackage xmlns="http://mediapackage.opencastproject.org" id="1" duration="2704016" start="2014-04-23T12:35:00Z">
+  #
+  def identifier
+    @document.xpath('/xmlns:mediapackage/@id', {'xmlns' => XML_NS_MEDIAPACKAGE}).first.value
+  end
 
 
-  end # ----------------------------------------------------------- end Matterhorn::MediaPackage ---
+  def save(path = @path)
+    unless path
+      raise(Matterhorn::Error, "No path was set, where manifest file should be saved!")
+    end
+    manifest_file = File.join(path, 'manifest.xml')
+    File.open(manifest_file, 'w') do |file|
+      file.write(to_xml)
+    end
+  end
 
 
-end # --------------------------------------------------------------------------- end Matterhorn ---
+end # ------------------------------------------------------------- end Matterhorn::MediaPackage ---

data/lib/matterhorn_whymper/version.rb

@@ -5,7 +5,7 @@ module MatterhornWhymper
 
   # -------------------------------------------------------------------------- const definitions ---
 
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 
 
 end # -------------------------------------------------------------------- end MatterhornWhymper ---

data/lib/matterhorn_whymper.rb

@@ -8,6 +8,7 @@ require 'matterhorn_whymper/version'
 require 'matterhorn/acl'
 require 'matterhorn/dublin_core'
 require 'matterhorn/endpoint'
+require 'matterhorn/endpoint/event'
 require 'matterhorn/endpoint/ingest'
 require 'matterhorn/endpoint/series'
 require 'matterhorn/endpoint/workflow'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matterhorn_whymper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Fritschi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -140,6 +140,7 @@ files:
 - lib/matterhorn/acl.rb
 - lib/matterhorn/dublin_core.rb
 - lib/matterhorn/endpoint.rb
+- lib/matterhorn/endpoint/event.rb
 - lib/matterhorn/endpoint/ingest.rb
 - lib/matterhorn/endpoint/series.rb
 - lib/matterhorn/endpoint/workflow.rb