matterhorn_whymper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzFjMzFkMjcxNDYyMTZlZjM1NjVkMTBmMTUzNmJmNTI1N2ZiN2I1NA==
+    MzEwYzM5Nzg5YmFkZmU2MjNlZDZhMzQ5NDg3ZTRlNjc1MWU3YzdhZQ==
   data.tar.gz: !binary |-
-    MmFkNTAxNDM0M2ZiM2FlMzViNTczYjYzNjcxYzI4YTNjNDNjMjhkYQ==
+    ZDNhNmEyZTE5YWYzYTY0ZGQwOGNhNDY2YzMyYjEzNzc1NmFlYTU0ZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTc5ZGRlNGNkNGZlY2NhZGI4ZDY5YTgyNWFiMzUwYWQ2NmRmNzg4ZjA5ZTM0
-    MmU3MjY3YjNhYzI5ZjFmYWQ2NDIwOGE1ZjExNzY0NmI0ZmNkNGI0NTNkZWQz
-    NzVmZjQ3Njg4MGFhOThhNDQwMTc0NzI0NWQ1NWNhNzM4NWJjNTM=
+    NjUyZjBkMTI1MzI2YjI0YjBmOGE0Mjc3NjZmMDFjN2EzNzQxMGMwNWI2NGJj
+    MzJkYjkyZTBmMzY1NDliNjY0YWFiMmU0YTBjZWNhYzc5ZmM2ZTBlN2I4OWUy
+    MjMyOTk5YzZkODdjYmRjZGUxMjNhMDM5NTczN2JkOWE4MzhjNTM=
   data.tar.gz: !binary |-
-    NDEzZjUwZDMwZjhmZWY3NWI3YjQxODk4ZWViNzEyMDJkNjY4M2EyNmVkMzNi
-    YmYwMjVmMjVmNTY2ZGNlZTNhNzkzOWI3ZDM1YWZmNTE3YjQ5NWYzN2U0ODJk
-    ZmFjY2FhMDRhYjE3M2FmNTEwNDI0NTA5NmZmZGJmYmMzNjUxYTM=
+    YWU5ZTIzMGJlY2NjZDU0ODEyNTc3MWExMzlkYTg4YTNiZjA2NWE5NGRhNWU4
+    Y2E5MzRlZWVjMDQxZTM0M2UyYmQ2OTIwZmRjOGUyMDY3NWI3OTM2NzBiOTRm
+    YTYyZmZjYWE5ZTI2ZmRiYTBjNjlhYWU5YzQ1MjczNzFhY2ZmNzI=

data/lib/matterhorn/endpoint/ingest.rb

@@ -1,99 +1,155 @@
-class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
+# ================================================================= Matterhorn::Endpoint::Ingest ===
 
-  # --- attributes -------------------------------------------------------------
+class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
 
 
-  # --- end point methodes -----------------------------------------------------
+  # -------------------------------------------------------------------------- endpoint methodes ---
 
   def addAttachment(file, flavor)
-    if @media_pkg_remote.nil?
-      raise(Matterhorn::Error, "No media package is available!")
+    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    @media_pkg_local.add_attachment(file, flavor)    if @media_pkg_local
+    begin
+      @media_pkg_remote = http_client.post(
+        "ingest/addAttachment",
+        { 'flavor' => flavor,
+          'mediaPackage' => @media_pkg_remote,
+          'BODY' => file
+        }
+      ).body
+    rescue Matterhorn::HttpClientError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addAttachment | " +
+                                 "Media package not valid! / media package:\n#{@media_pkg_remote}" }
+      raise ex
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addAttachment | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
     end
-    @media_pkg_local.add_attachment(file, flavor)
-    @media_pkg_remote = http_client.post(
-      "ingest/addAttachment",
-      { 'flavor' => flavor,
-        'mediaPackage' => @media_pkg_remote,
-        'BODY' => file
-      }
-    ).body
+    @media_pkg_remote
   end
 
 
   def addCatalog(file, flavor)
-    if @media_pkg_remote.nil?
-      raise(Matterhorn::Error, "No media package is available!")
+    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    @media_pkg_local.add_catalog(file, flavor)    if @media_pkg_local
+    begin
+      @media_pkg_remote = http_client.post(
+        "ingest/addCatalog",
+        { 'flavor' => flavor,
+          'mediaPackage' => @media_pkg_remote,
+          'BODY' => file
+        }
+      ).body
+    rescue Matterhorn::HttpClientError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addCatalog | " +
+                                 "Media package not valid! / media package:\n#{@media_pkg_remote}" }
+      raise ex
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addCatalog | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
     end
-    @media_pkg_local.add_catalog(file, flavor)
-    @media_pkg_remote = http_client.post(
-      "ingest/addCatalog",
-      { 'flavor' => flavor,
-        'mediaPackage' => @media_pkg_remote,
-        'BODY' => file
-      }
-    ).body
+    @media_pkg_remote
   end
 
 
   def addDCCatalog(dublin_core)
-    if @media_pkg_remote.nil?
-      raise(Matterhorn::Error, "No media package is available!")
+    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    @media_pkg_local.add_dc_catalog(dublin_core)    if @media_pkg_local
+    begin
+      @media_pkg_remote = http_client.post(
+        "ingest/addDCCatalog",
+        { 'flavor' => 'dublincore/episode',
+          'mediaPackage' => @media_pkg_remote,
+          'dublinCore' => dublin_core
+        }
+      ).body
+    rescue Matterhorn::HttpClientError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addDCCatalog | " +
+                                 "Media package not valid! / media package:\n#{@media_pkg_remote}" }
+      raise ex
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addDCCatalog | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
     end
-    @media_pkg_local.add_dc_catalog(dublin_core)
-    @media_pkg_remote = http_client.post(
-      "ingest/addDCCatalog",
-      { 'flavor' => 'dublincore/episode',
-        'mediaPackage' => @media_pkg_remote,
-        'dublinCore' => dublin_core
-      }
-    ).body
+    @media_pkg_remote
   end
 
      
   def addTrack(file, flavor)
-    if @media_pkg_remote.nil?
-      raise(Matterhorn::Error, "No media package is available!")
+    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    @media_pkg_local.add_track(file, flavor)    if @media_pkg_local
+    begin
+      @media_pkg_remote = http_client.post(
+        "ingest/addTrack",
+        { 'flavor' => flavor,
+          'mediaPackage' => @media_pkg_remote,
+          'BODY' => file
+        }
+      ).body
+    rescue Matterhorn::HttpClientError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addTrack | " +
+                                 "Media package not valid! / media package:\n#{@media_pkg_remote}" }
+      raise ex
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::addTrack | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
     end
-    @media_pkg_local.add_track(file, flavor)
-    @media_pkg_remote = http_client.post(
-      "ingest/addTrack",
-      { 'flavor' => flavor,
-        'mediaPackage' => @media_pkg_remote,
-        'BODY' => file
-      }
-    ).body
+    @media_pkg_remote
   end
 
 
-  def createMediaPackage(path = '')
-    if !@media_pkg_remote.nil?
-      raise(Matterhorn::Error, "A media package is allready created!")
+  # 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.
+  #
+  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
+    begin
+      @media_pkg_remote = http_client.get(
+        "ingest/createMediaPackage"
+      ).body
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::createMediaPackage | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
     end
-    @media_pkg_local = Matterhorn::MediaPackage.new(path)
-    @media_pkg_remote = http_client.get(
-      "ingest/createMediaPackage"
-    ).body
+    @media_pkg_remote
   end
 
 
   def ingest(wdID = 'full', options = {})
-    if @media_pkg_remote.nil?
-      raise(Matterhorn::Error, "No media package is available!")
-    end
-    @media_pkg_local.save    if !@media_pkg_local.nil?
+    unless @media_pkg_remote then raise(Matterhorn::Error, "No media package is available!"); end
+    @media_pkg_local.save    if @media_pkg_local
     options['mediaPackage'] = @media_pkg_remote
-    @workflow_inst = http_client.post(
-      "ingest/ingest/#{wdID}",
-      options
-    ).body
+    begin
+      @workflow_inst = http_client.post(
+        "ingest/ingest/#{wdID}",
+        options
+      ).body
+    rescue Matterhorn::HttpClientError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::ingest | " +
+                                 "Media package not valid! / media package:\n#{@media_pkg_remote}" }
+      raise ex
+    rescue Matterhorn::HttpServerError => ex
+      MatterhornWhymper.logger.error { "#{self.class.name}::ingest | " +
+                                       "Internal server error on Matterhorn!" }
+      raise ex
+    end
     workflow_instance
   end
 
 
+  # ---------------------------------------------------------------------------- helper methodes ---
+
   def media_package(kind = 'local')
-    if kind == 'local' && !@media_pkg_local.nil?
+    unless @media_pkg_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.nil?
+    elsif @media_pkg_remote
       Matterhorn::MediaPackage.new(@media_pkg_remote)
     else
       nil
@@ -113,12 +169,8 @@ DUBLIN_CORE
 
 
   def workflow_instance
-    if !@workflow_inst.nil?
-      Matterhorn::WorkflowInstance.new(@workflow_inst)
-    else
-      nil
-    end
+    @workflow_inst ? Matterhorn::WorkflowInstance.new(@workflow_inst) : nil
   end
 
   
-end
+end # --------------------------------------------------------- end Matterhorn::Endpoint::Ingest ---

data/lib/matterhorn/endpoint/workflow.rb

@@ -1,67 +1,95 @@
-class Matterhorn::Endpoint::Workflow < Matterhorn::Endpoint
+# =============================================================== Matterhorn::Endpoint::Workflow ===
 
-  # --- attributes -------------------------------------------------------------
+class Matterhorn::Endpoint::Workflow < Matterhorn::Endpoint
 
 
-  # --- end point methodes -----------------------------------------------------
+  # -------------------------------------------------------------------------- endpoint methodes ---
 
   def instance(wi_id)
-    @workflow_inst = http_client.get(
-      "workflow/instance/#{wi_id}.xml"
-    ).body
-    workflow_instance
+    begin
+      wi = http_client.get(
+        "workflow/instance/#{wi_id}.xml"
+      ).body
+    rescue Matterhorn::HttpClientError, Matterhorn::HttpServerError => ex
+      if ex.code == 404
+        wi = nil
+        MatterhornWhymper.logger.warn { "#{self.class.name}::instance | " +
+                   "WorkflowInstance[#{wi_id}]: No workflow instance with that identifier exists." }
+      else
+        MatterhornWhymper.logger.error { "#{self.class.name}::instance | " +
+                                "WorkflowInstance[#{wi_id}]: Internal server error on Matterhorn!" }
+
+        raise ex
+      end
+    end
+    wi ? Matterhorn::WorkflowInstance.new(wi) : nil
   end
 
 
-  def remove(wi_id, options = {})
+  def remove(wi_id)
     begin
-      @workflow_inst = http_client.delete(
+      http_client.delete(
         "workflow/remove/#{wi_id}"
-      ).body
-    rescue Matterhorn::HttpClientError => ex
-      Rails.logger.warn { "Matterhorn::Workflow::remove | WorkflowInstance[wi_id] could not be stopped!\n" +
-                          "#{ex.class.name}: #{ex.to_s} / backtrace:\n#{ex.backtrace.join("\n")}" }
-      return nil
-    rescue => ex
-      raise ex
+      )
+      wi_removed = true
+    rescue Matterhorn::HttpClientError, Matterhorn::HttpServerError  => ex
+      if ex.code == 404
+        wi_removed = false
+        MatterhornWhymper.logger.warn { "#{self.class.name}::remove | " +
+                   "WorkflowInstance[#{wi_id}]: No workflow instance with that identifier exists." }
+      else
+        MatterhornWhymper.logger.error { "#{self.class.name}::remove | " +
+                                "WorkflowInstance[#{wi_id}]: Internal server error on Matterhorn!" }
+
+        raise ex
+      end
     end
+    wi_removed
   end
 
 
-  def resume(wi_id, options = {})
-    options['id'] = wi_id
-    @workflow_inst = http_client.post(
-      "workflow/resume",
-      options
-    ).body
-    workflow_instance
+  def resume(wi_id)
+    begin
+      wi = http_client.post(
+        "workflow/resume",
+        { 'id' => wi_id }
+      ).body
+    rescue Matterhorn::HttpClientError, Matterhorn::HttpServerError  => ex
+      if ex.code == 404
+        wi = nil
+        MatterhornWhymper.logger.warn { "#{self.class.name}::resume | " +
+         "WorkflowInstance[#{wi_id}]: No suspended workflow instance with that identifier exists." }
+      else
+        MatterhornWhymper.logger.error { "#{self.class.name}::resume | " +
+                                "WorkflowInstance[#{wi_id}]: Internal server error on Matterhorn!" }
+
+        raise ex
+      end
+    end
+    wi ? Matterhorn::WorkflowInstance.new(wi) : nil
   end
 
 
-  def stop(wi_id, options = {})
+  def stop(wi_id)
     begin
-      options['id'] = wi_id
-      @workflow_inst = http_client.post(
+      wi = http_client.post(
         "workflow/stop",
-        options
+        { 'id' => wi_id }
       ).body
-      workflow_instance
-    rescue Matterhorn::HttpClientError => ex
-      Rails.logger.warn { "Matterhorn::Workflow::stop | WorkflowInstance[wi_id] could not be stopped!\n" +
-                          "#{ex.class.name}: #{ex.to_s} / backtrace:\n#{ex.backtrace.join("\n")}" }
-      return nil
-    rescue => ex
-      raise ex
-    end
-  end
+    rescue Matterhorn::HttpClientError, Matterhorn::HttpServerError  => ex
+      if ex.code == 404
+        wi = nil
+        MatterhornWhymper.logger.warn { "#{self.class.name}::stop | " +
+           "WorkflowInstance[#{wi_id}]: No running workflow instance with that identifier exists." }
+      else
+        MatterhornWhymper.logger.error { "#{self.class.name}::stop | " +
+                                "WorkflowInstance[#{wi_id}]: Internal server error on Matterhorn!" }
 
-
-  def workflow_instance
-    if !@workflow_inst.nil?
-      Matterhorn::WorkflowInstance.new(@workflow_inst)
-    else
-      nil
+        raise ex
+      end
     end
+    wi ? Matterhorn::WorkflowInstance.new(wi) : nil
   end
+
   
-end
+end # ------------------------------------------------------- end Matterhorn::Endpoint::Workflow ---

data/lib/matterhorn/endpoint.rb

@@ -1,25 +1,37 @@
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
 
+
+  # ======================================================================= Matterhorn::Endpoint ===
+
   class Endpoint
 
-    # --- attributes -------------------------------------------------------------
+    # ------------------------------------------------------------------------------- attributes ---
   
     attr_reader :http_client
   
 
-    # --- initialization ---------------------------------------------------------
+    # --------------------------------------------------------------------------- initialization ---
   
     def self.open(endpoint)
       if endpoint.respond_to? 'to_s'
         endpoint = endpoint.to_s.capitalize
       else
-        #TODO: error handling
+        raise(Matterhorn::Error, "Matterhorn::Endpoint::open | " +
+                                 "#{endpoint.inspect} does not respond to 'to_s'")
       end
       endpoint = Object.const_get('Matterhorn').const_get('Endpoint').const_get(endpoint).new
-  
-      yield endpoint
-  
-      endpoint.close
+      if endpoint.nil? || !endpoint.kind_of?(Matterhorn::Endpoint)
+        raise(Matterhorn::Error, "Matterhorn::Endpoint::open | " +
+                                 "#{endpoint ? endpoint.class.name : 'nil'} is not a sub class " +
+                                 "of 'Matterhorn::Endpoint'!")
+      end 
+      begin
+        yield endpoint
+      ensure
+        endpoint.close
+      end
     end  
   
   
@@ -30,11 +42,14 @@ module Matterhorn
     end
   
   
+    # --------------------------------------------------------------------------------- methodes ---
+
     def close
       http_client.close
     end
 
 
-  end
+  end # --------------------------------------------------------------- end Matterhorn::Endpoint ---
+
 
-end
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn/error.rb

@@ -1,15 +1,34 @@
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
 
-# --- Matterhorn Exceptions ------------------------------------------------------------------------
 
-  class Matterhorn::Error < StandardError
+  # ====================================================================== several error classes ===
+
+  class Error < StandardError
   end
   
-  class Matterhorn::HttpClientError < Matterhorn::Error
+
+  class HttpGeneralError < Matterhorn::Error
+
+    attr_reader :code, :request, :response
+
+    def initialize(message, request, response)
+      @request = request
+      @response = response
+      @code = response.code.to_i
+      super(message)
+    end
+
   end
+
+
+  class HttpClientError < Matterhorn::HttpGeneralError
+  end
+
   
-  class Matterhorn::HttpServerError < Matterhorn::Error
+  class HttpServerError < Matterhorn::HttpGeneralError
   end
 
 
-end
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn/http_client.rb

@@ -1,15 +1,22 @@
 require 'net/http/post/multipart'
 require 'net/http/digest_auth'
 
+
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
   
+
+  # ===================================================================== Matterhorn::HttpClient ===
+
   class HttpClient
     
-    # --- attributes -------------------------------------------------------------
+    # ------------------------------------------------------------------------------- attributes ---
   
     attr_reader :base_uri, :host, :port, :ssl
   
-    # --- initialization ---------------------------------------------------------
+
+    # --------------------------------------------------------------------------- initialization ---
   
     def initialize(base_uri)
       @base_uri = URI.parse(base_uri)
@@ -18,11 +25,14 @@ module Matterhorn
       @ssl      = @port == 443 ? true : false
     end  
   
-    def close
-      @http_socket.finish    if !@http_socket.nil? && @http_socket.started?
+
+    # ---------------------------------------------------------------------------- http methodes ---
+  
+    def get(url)
+      request = Net::HTTP::Get.new(base_uri.request_uri + url)
+      execute_request(request)
     end
   
-    # --- http methodes ----------------------------------------------------------
   
     def post(url, params = {}, file = nil, filename = nil, mime_type = nil)
       if params.has_key?('BODY') || !file.nil?
@@ -34,21 +44,18 @@ module Matterhorn
     end
   
   
-    def get(url)
-      request = Net::HTTP::Get.new(base_uri.request_uri + url)
-      execute_request(request)
-    end
-  
-  
     def delete(url)
       request = Net::HTTP::Delete.new(base_uri.request_uri + url)
       execute_request(request)
     end
   
   
-    # ========================================================================== #
-    # === private section                                                    === #
-    # ========================================================================== #
+    def close
+      @http_socket.finish    if !@http_socket.nil? && @http_socket.started?
+    end
+  
+
+    # -------------------------------------------------------------------------- private section ---
     private
   
     def http_socket
@@ -62,7 +69,6 @@ module Matterhorn
     def singlepart_post(url, params)
       request = Net::HTTP::Post.new(base_uri.request_uri + url)
       request.set_form_data(params)
-      MatterhornWhymper.logger.debug { "Matterhorn::Client::singlepart_post: request = #{request.to_yaml}"}
       request
     end
   
@@ -79,9 +85,9 @@ module Matterhorn
         file = params['BODY']
         params['BODY'] = nil
       else
-        raise(Matterhorn::Error, "Matterhorn::Client::multipart_post: Neither BODY nor file exists!")
+        raise(Matterhorn::Error, "Matterhorn::HttpClient::multipart_post | " +
+                                 "Neither a BODY nor a file is present!")
       end
-      MatterhornWhymper.logger.debug { "Matterhorn::Client::multipart_post: file = #{file.inspect}"}
       if filename.nil?
         filename = File.basename(file.path)
       end
@@ -89,7 +95,6 @@ module Matterhorn
         mime_type = MIME::Types.type_for(File.basename(file.path)).first
       end
       params['BODY'] = UploadIO.new(file, mime_type, filename)
-      MatterhornWhymper.logger.debug { "Matterhorn::Client::multipart_post: params = #{params.to_yaml}"}
       Net::HTTP::Post::Multipart.new(base_uri.request_uri + url, params)
     end
   
@@ -111,46 +116,44 @@ module Matterhorn
       when 500..599
         handle_5xx_error(request, response)
       else
-        handle_unknown_error(request, response)
+        handle_general_error(request, response)
       end
       response
     end
   
   
     def handle_2xx_ok(request, response)
-      MatterhornWhymper.logger.info { "Matterhorn::Client::execute_request:\n" + log_message(request, response) }
+      msg = log_message('handle_2xx_ok', request, response)
+      MatterhornWhymper.logger.debug { msg }
     end
   
     def handle_4xx_error(request, response)
-      MatterhornWhymper.logger.error { "Matterhorn::Client::execute_request: Client Error:\n" + log_message(request, response) }
-      raise(Matterhorn::HttpClientError, log_message(request, response))
+      msg = log_message('handle_4xx_error', request, response)
+      MatterhornWhymper.logger.debug { msg }
+      raise(Matterhorn::HttpClientError, msg, request, response)
     end
   
     def handle_5xx_error(request, response)
-      MatterhornWhymper.logger.error { "Matterhorn::Client::execute_request: Server Error:\n" + log_message(request, response) }
-      raise(Matterhorn::HttpServerError, log_message(request, response))
+      msg = log_message('handle_5xx_error', request, response)
+      MatterhornWhymper.logger.debug { msg }
+      raise(Matterhorn::HttpServerError, msg, request, response)
     end
   
-    def handle_unknown_error(request, response)
-      MatterhornWhymper.logger.error { "Matterhorn::Client::execute_request: Server Error:\n" + log_message(request, response) }
-      raise(Matterhorn::Error, log_message(request, response))
+    def handle_general_error(request, response)
+      msg = log_message('handle_general_error', request, response)
+      MatterhornWhymper.logger.debug { msg }
+      raise(Matterhorn::HttpGeneralError, msg, request, response)
     end
   
   
-    def log_message(request, response)
-      "  request = #{log_request(request)}\n" +
-      "  response = #{log_response(response)}"
+    def log_message(method, request, response)
+      "#{self.class.name}::#{method} | code = #{response.code}\n" +
+      "  request  = #{request.method} #{request.path}\n" +
+      "  response = #{response.code} #{response.msg}, body:\n#{response.body}\n"
     end
   
-    def log_request(request)
-      "#{request.method} #{request.path}"
-    end
-  
-    def log_response(response)
-      "#{response.code} #{response.msg}, body:\n#{response.body}\n"
-    end
   
+  end # ------------------------------------------------------------- end Matterhorn::HttpClient ---
 
-  end
 
-end
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn/media_package.rb

@@ -1,34 +1,40 @@
 require 'nokogiri'
 
+
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
 
+
+  # =================================================================== Matterhorn::MediaPackage ===
+
   class MediaPackage
    
-    # --- const definitions ------------------------------------------------------
+    # ------------------------------------------------------------------------ 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
+      @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) {
+          xml.mediapackage('xmlns' => XML_NS_MEDIAPACKAGE) do
             xml.media
             xml.metadata
             xml.attachments
-          }
+          end
         end
         .doc
       end
-      MatterhornWhymper.logger.debug { "Matterhorn::MediaPackage::initialize | doc = #{to_xml}" }
     end
 
   
-    # --- methodes ---------------------------------------------------------------
+    # --------------------------------------------------------------------------------- methodes ---
 
     #  <attachments>
     #    <attachment type="switchcastrecorder/metadata">
@@ -36,6 +42,7 @@ module Matterhorn
     #      <url>metadata.plist</url>
     #    </attachment>
     #  </attachments>
+    #
     def add_attachment(file, flavor)
       Nokogiri::XML::Builder.with(@document.at('attachments')) do |xml|
         xml.attachment(:type => flavor) {
@@ -53,6 +60,7 @@ module Matterhorn
     #     <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) {
@@ -82,6 +90,7 @@ module Matterhorn
     #     <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) {
@@ -105,6 +114,7 @@ module Matterhorn
     end
 
 
-  end
+  end # ----------------------------------------------------------- end Matterhorn::MediaPackage ---
+
 
-end
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn/smil.rb

@@ -1,29 +1,30 @@
+require 'nokogiri'
+
+
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
 
-  class Smil
-  
-    # --- const definitions ------------------------------------------------------
   
-    # --- attributes -------------------------------------------------------------
+  # =========================================================================== Matterhorn::Smil ===
+
+  class Smil
+    
+
+    # ------------------------------------------------------------------------------- attributes --- 
+
     attr_reader :head, :body
   
-    # --- validations ------------------------------------------------------------
-  
-  
-    # --- callback declarations --------------------------------------------------
-  
-  
-    # --- relations --------------------------------------------------------------
   
-  
-    # --- initialization ---------------------------------------------------------
+    # --------------------------------------------------------------------------- initialization ---
   
     def initialize()
       @head = Smil::Head.new
       @body = Smil::Body.new
     end
   
-    # --- methodes ---------------------------------------------------------------
+
+    # --------------------------------------------------------------------------------- methodes ---
 
     def save(smil_file)
       File.open(smil_file, 'w') do |file|
@@ -35,52 +36,52 @@ module Matterhorn
 
 
     def to_xml
-      StringIO.open('', 'w') do |strio|
-        bx = Builder::XmlMarkup.new(:target=>strio, :indent=>2)
-        bx.instruct! :xml, :version=>'1.1', :encoding => 'UTF-8'
-        bx.smil(:xmlns => "http://www.w3.org/ns/SMIL") do
-          head.to_xml(bx)
-          body.to_xml(bx)
-        end
-        strio.string
+      doc = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |bx|
+      bx.smil('xmlns' => "http://www.w3.org/ns/SMIL") do
+        head.to_xml(bx)
+        body.to_xml(bx)
       end
+      doc.to_xml
     end
 
-  
-    # ========================================================================== #
-    # === protected section                                                  === #
-    # ========================================================================== #
-    protected
-  
-  
-    # ========================================================================== #
-    # === private section                                                    === #
-    # ========================================================================== #
-    private
-  
-  end
+
+  end # ------------------------------------------------------------------- end Matterhorn::Smil ---
 
 
 
+  # ===================================================================== Matterhorn::Smil::Head ===
+
   class Smil::Head
 
-    def to_xml(builder)
-      builder.head do
+    def to_xml(bx)
+      bx.head do
       end
     end
 
-  end
+
+  end # ------------------------------------------------------------- end Matterhorn::Smil::Head ---
+
 
 
+  # ===================================================================== Matterhorn::Smil::Body ===
 
   class Smil::Body
 
+
+    # ------------------------------------------------------------------------------- attributes ---
+
     attr_reader :par_list
 
+
+    # --------------------------------------------------------------------------- initialization ---
+
     def initialize()
       @par_list = Array.new
     end
 
+
+    # --------------------------------------------------------------------------------- methodes ---
+    
     def add_par()
       par = Smil::Par.new
       @par_list << par
@@ -96,16 +97,23 @@ module Matterhorn
       end
     end
 
-  end
+
+  end # ------------------------------------------------------------- end Matterhorn::Smil::Body ---
 
 
 
+  # ================================================================== Matterhorn::Smil::Element ===
+
   class Smil::Element
 
-    # --- attributes -------------------------------------------------------------
+
+    # ------------------------------------------------------------------------------- attributes ---
+
     attr_reader :start_point, :end_point, :rel_begin, :duration, :parent
 
-    # --- initialization ---------------------------------------------------------
+
+    # --------------------------------------------------------------------------- initialization ---
+
     def initialize(parent = nil)
       @start_point = nil
       @end_point   = nil
@@ -114,7 +122,8 @@ module Matterhorn
       @parent      = parent
     end
 
-    # --- methodes ---------------------------------------------------------------
+
+    # --------------------------------------------------------------------------------- methodes ---
     
     def attr_list
       attr_list = Hash.new
@@ -127,10 +136,8 @@ module Matterhorn
       attr_list
     end
 
-
-    # ========================================================================== #
-    # === protected section                                                  === #
-    # ========================================================================== #
+    
+    # ------------------------------------------------------------------------ protected section ---
     protected
 
     def start_point=(new_start_point)
@@ -145,6 +152,7 @@ module Matterhorn
       @start_point = new_start_point
     end
 
+
     def end_point=(new_end_point)
       if new_end_point.kind_of? String
         # end_point is an absolut time position and must be in the format 2013-12-02T14:12:42.364
@@ -157,6 +165,7 @@ module Matterhorn
       @end_point = new_end_point
     end
 
+
     def rel_begin=(new_rel_begin)
       if new_rel_begin.kind_of? Fixnum
         new_rel_begin = new_rel_begin / 1000.0
@@ -168,6 +177,7 @@ module Matterhorn
       @rel_begin = new_rel_begin
     end
 
+
     def duration=(new_duration)
       if new_duration.kind_of? Fixnum
         # duration is in ms
@@ -182,6 +192,7 @@ module Matterhorn
       @duration = new_duration
     end
 
+
     def update(sub_elem)
       if !sub_elem.start_point.nil? && (start_point.nil? || start_point > sub_elem.start_point)
         @start_point = sub_elem.start_point
@@ -203,21 +214,30 @@ module Matterhorn
       propagate(self)        if parent.nil?
     end
 
+
     def propagate(parent_elem)
     end
 
-  end
+
+  end # ---------------------------------------------------------- end Matterhorn::Smil::Element ---
 
 
 
+  # ====================================================================== Matterhorn::Smil::Par ===
+
   class Smil::Par < Smil::Element
 
+
+    # --------------------------------------------------------------------------- initialization ---
+
     def initialize()
       super
       @seq_list = Array.new
     end
 
 
+    # --------------------------------------------------------------------------------- methodes ---
+    
     def add_seq
       seq = Smil::Seq.new(self)
       @seq_list << seq
@@ -240,23 +260,33 @@ module Matterhorn
       end
     end
 
-  end
+
+  end # -------------------------------------------------------------- end Matterhorn::Smil::Par ---
+
 
 
+  # ====================================================================== Matterhorn::Smil::Seq ===
 
   class Smil::Seq < Smil::Element
 
+
+    # --------------------------------------------------------------------------- initialization ---
+
     def initialize(parent)
       super(parent)
       @track_list = Array.new
     end
 
+
+    # --------------------------------------------------------------------------------- methodes ---
+    
     def attr_list
       attrib_list = super
       attrib_list.delete(:begin)
       attrib_list
     end
 
+
     def add_track(kind, file, start_point, duration)
       track = Smil::Track.new(self, kind, file, start_point, duration)
       @track_list << track
@@ -264,6 +294,7 @@ module Matterhorn
       track
     end
 
+
     def propagate(parent_elem)
       @rel_begin = start_point - parent_elem.start_point
       @track_list.each do |track|
@@ -272,6 +303,7 @@ module Matterhorn
       end
     end
 
+
     def to_xml(bx)
       bx.seq(attr_list) do
         @track_list.each do |track|
@@ -280,11 +312,18 @@ module Matterhorn
       end
     end
 
-  end
+
+  end # -------------------------------------------------------------- end Matterhorn::Smil::Seq ---
 
   
+
+  # ====================================================================================== Track ===
+
   class Smil::Track < Smil::Element
 
+
+    # --------------------------------------------------------------------------- initialization ---
+
     def initialize(parent, kind, file, start_point, duration)
       super(parent)
       @kind = kind
@@ -293,18 +332,24 @@ module Matterhorn
       self.duration = duration
     end
 
+
+    # --------------------------------------------------------------------------------- methodes ---
+    
     def propagate(parent_elem)
       @rel_begin = start_point - parent_elem.start_point
     end
 
+
     def to_xml(bx)
       attributes = attr_list
       if !@src.nil?
         attributes[:src] = @src.to_s
       end
-      bx.tag!(@kind, attributes)
+      bx.tag_(@kind, attributes)
     end
 
-  end
 
-end
+  end # ------------------------------------------------------------ end Matterhorn::Smil::Track ---
+
+
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn/workflow_instance.rb

@@ -1,59 +1,51 @@
 require 'nokogiri'
 
+
+# =================================================================================== Matterhorn ===
+
 module Matterhorn
 
+
+  # =============================================================== Matterhorn::WorkflowInstance ===
+
   class WorkflowInstance
 
+
+    # ------------------------------------------------------------------------ const definitions ---
+
     XML_NS_WORKFLOW = "http://workflow.opencastproject.org"
+
   
-    # --- const definitions ------------------------------------------------------
-  
-    # --- attributes -------------------------------------------------------------
-  
-    # --- validations ------------------------------------------------------------
-  
-    # --- callback declarations --------------------------------------------------
-  
-  
-    # --- relations --------------------------------------------------------------
-  
-  
-    # --- initialization ---------------------------------------------------------
+    # --------------------------------------------------------------------------- initialization ---
   
     def initialize(xml)
       @document = Nokogiri::XML(xml)
     end
+
   
-    # --- methodes ---------------------------------------------------------------
+    # --------------------------------------------------------------------------------- methodes ---
 
     def id
       @document.xpath('/nsw:workflow/@id', {"nsw" => XML_NS_WORKFLOW}).first.value
     end
 
+
     def state
       @document.xpath('/nsw:workflow/@state', {"nsw" => XML_NS_WORKFLOW}).first.value
     end
 
+
     def template
       @document.xpath('/nsw:workflow/nsw:template', {"nsw" => XML_NS_WORKFLOW}).first.content       
     end
 
+
     def to_xml
       @document.to_xml
     end
 
   
-    # ========================================================================== #
-    # === protected section                                                  === #
-    # ========================================================================== #
-    protected
-  
-  
-    # ========================================================================== #
-    # === private section                                                    === #
-    # ========================================================================== #
-    private
-  
-  end
+  end # ------------------------------------------------------- end Matterhorn::WorkflowInstance ---
+
 
-end
+end # --------------------------------------------------------------------------- end Matterhorn ---

data/lib/matterhorn_whymper/version.rb

@@ -1,3 +1,11 @@
+# ============================================================================ MatterhornWhymper ===
+
 module MatterhornWhymper
-  VERSION = "0.0.2"
-end
+
+
+  # -------------------------------------------------------------------------- const definitions ---
+
+  VERSION = "0.0.3"
+
+
+end # -------------------------------------------------------------------- end MatterhornWhymper ---

data/lib/matterhorn_whymper.rb

@@ -7,17 +7,24 @@ require 'matterhorn/media_package'
 require 'matterhorn/error'
 
 
+# ============================================================================ MatterhornWhymper ===
+
 module MatterhornWhymper
 
-  def self.info
-    "Ruby wrapper against the Matterhorn Endpoint API. Version #{MatterhornWhymper::VERSION}"
-  end
- 
- 
+
+  # --------------------------------------------------------------------------------- attributes --- 
+
   class << self
     attr_accessor :configuration, :logger
   end
  
+
+  # ----------------------------------------------------------------------------------- methodes ---
+
+  def self.info
+    "Ruby wrapper against the Matterhorn Endpoint API. Version #{MatterhornWhymper::VERSION}"
+  end
+ 
  
   def self.configure
     self.configuration ||= Configuration.new
@@ -32,16 +39,23 @@ module MatterhornWhymper
  
 
 
+  # =========================================================== MatterhornWhymper::Configuration ===
+
   class Configuration
 
+    # ------------------------------------------------------------------------------- attributes --- 
+
     attr_accessor :system_account_user, :system_account_password, :system_domain, :system_protocol
 
+
+    # --------------------------------------------------------------------------------- methodes ---
+
     def uri
       "#{system_protocol}://#{system_account_user}:#{system_account_password}@#{system_domain}"
     end
 
 
-  end
+  end # --------------------------------------------------- end MatterhornWhymper::Configuration ---
 
 
-end
+end # -------------------------------------------------------------------- end MatterhornWhymper ---

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matterhorn_whymper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Fritschi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post