matterhorn_whymper 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzFjMzFkMjcxNDYyMTZlZjM1NjVkMTBmMTUzNmJmNTI1N2ZiN2I1NA==
+  data.tar.gz: !binary |-
+    MmFkNTAxNDM0M2ZiM2FlMzViNTczYjYzNjcxYzI4YTNjNDNjMjhkYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTc5ZGRlNGNkNGZlY2NhZGI4ZDY5YTgyNWFiMzUwYWQ2NmRmNzg4ZjA5ZTM0
+    MmU3MjY3YjNhYzI5ZjFmYWQ2NDIwOGE1ZjExNzY0NmI0ZmNkNGI0NTNkZWQz
+    NzVmZjQ3Njg4MGFhOThhNDQwMTc0NzI0NWQ1NWNhNzM4NWJjNTM=
+  data.tar.gz: !binary |-
+    NDEzZjUwZDMwZjhmZWY3NWI3YjQxODk4ZWViNzEyMDJkNjY4M2EyNmVkMzNi
+    YmYwMjVmMjVmNTY2ZGNlZTNhNzkzOWI3ZDM1YWZmNTE3YjQ5NWYzN2U0ODJk
+    ZmFjY2FhMDRhYjE3M2FmNTEwNDI0NTA5NmZmZGJmYmMzNjUxYTM=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/matterhorn.yml
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p484@matterhorn-endpoint_api"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.25.19 (stable)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 1 )) # display automatically
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matterhorn-endpoint_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SWITCH / Daniel Fritschi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Matterhorn Whymper
+
+Ruby wrapper against the Matterhorn Endpoint API
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'matterhorn_whymper'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install matterhorn_whymper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/switch-ch/matterhorn_whymper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/lib/matterhorn/endpoint.rb

@@ -0,0 +1,40 @@
+module Matterhorn
+
+  class Endpoint
+
+    # --- attributes -------------------------------------------------------------
+  
+    attr_reader :http_client
+  
+
+    # --- initialization ---------------------------------------------------------
+  
+    def self.open(endpoint)
+      if endpoint.respond_to? 'to_s'
+        endpoint = endpoint.to_s.capitalize
+      else
+        #TODO: error handling
+      end
+      endpoint = Object.const_get('Matterhorn').const_get('Endpoint').const_get(endpoint).new
+  
+      yield endpoint
+  
+      endpoint.close
+    end  
+  
+  
+    def initialize
+      @http_client = Matterhorn::HttpClient.new(
+        MatterhornWhymper.configuration.uri
+      )
+    end
+  
+  
+    def close
+      http_client.close
+    end
+
+
+  end
+
+end

data/lib/matterhorn/endpoint/ingest.rb

@@ -0,0 +1,124 @@
+class Matterhorn::Endpoint::Ingest < Matterhorn::Endpoint
+
+  # --- attributes -------------------------------------------------------------
+
+
+  # --- end point methodes -----------------------------------------------------
+
+  def addAttachment(file, flavor)
+    if @media_pkg_remote.nil?
+      raise(Matterhorn::Error, "No media package is available!")
+    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
+  end
+
+
+  def addCatalog(file, flavor)
+    if @media_pkg_remote.nil?
+      raise(Matterhorn::Error, "No media package is available!")
+    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
+  end
+
+
+  def addDCCatalog(dublin_core)
+    if @media_pkg_remote.nil?
+      raise(Matterhorn::Error, "No media package is available!")
+    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
+  end
+
+     
+  def addTrack(file, flavor)
+    if @media_pkg_remote.nil?
+      raise(Matterhorn::Error, "No media package is available!")
+    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
+  end
+
+
+  def createMediaPackage(path = '')
+    if !@media_pkg_remote.nil?
+      raise(Matterhorn::Error, "A media package is allready created!")
+    end
+    @media_pkg_local = Matterhorn::MediaPackage.new(path)
+    @media_pkg_remote = http_client.get(
+      "ingest/createMediaPackage"
+    ).body
+  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?
+    options['mediaPackage'] = @media_pkg_remote
+    @workflow_inst = http_client.post(
+      "ingest/ingest/#{wdID}",
+      options
+    ).body
+    workflow_instance
+  end
+
+
+  def media_package(kind = 'local')
+    if kind == 'local' && !@media_pkg_local.nil?
+      return @media_pkg_local
+    elsif !@media_pkg_remote.nil?
+      Matterhorn::MediaPackage.new(@media_pkg_remote)
+    else
+      nil
+    end
+  end
+
+
+  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}</dcterms:title>
+</dublincore>
+DUBLIN_CORE
+    addDCCatalog(dublin_core)
+  end
+
+
+  def workflow_instance
+    if !@workflow_inst.nil?
+      Matterhorn::WorkflowInstance.new(@workflow_inst)
+    else
+      nil
+    end
+  end
+
+  
+end

data/lib/matterhorn/endpoint/workflow.rb

@@ -0,0 +1,67 @@
+class Matterhorn::Endpoint::Workflow < Matterhorn::Endpoint
+
+  # --- attributes -------------------------------------------------------------
+
+
+  # --- end point methodes -----------------------------------------------------
+
+  def instance(wi_id)
+    @workflow_inst = http_client.get(
+      "workflow/instance/#{wi_id}.xml"
+    ).body
+    workflow_instance
+  end
+
+
+  def remove(wi_id, options = {})
+    begin
+      @workflow_inst = 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
+    end
+  end
+
+
+  def resume(wi_id, options = {})
+    options['id'] = wi_id
+    @workflow_inst = http_client.post(
+      "workflow/resume",
+      options
+    ).body
+    workflow_instance
+  end
+
+
+  def stop(wi_id, options = {})
+    begin
+      options['id'] = wi_id
+      @workflow_inst = http_client.post(
+        "workflow/stop",
+        options
+      ).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
+
+
+  def workflow_instance
+    if !@workflow_inst.nil?
+      Matterhorn::WorkflowInstance.new(@workflow_inst)
+    else
+      nil
+    end
+  end
+  
+end

data/lib/matterhorn/error.rb

@@ -0,0 +1,15 @@
+module Matterhorn
+
+# --- Matterhorn Exceptions ------------------------------------------------------------------------
+
+  class Matterhorn::Error < StandardError
+  end
+  
+  class Matterhorn::HttpClientError < Matterhorn::Error
+  end
+  
+  class Matterhorn::HttpServerError < Matterhorn::Error
+  end
+
+
+end

data/lib/matterhorn/http_client.rb

@@ -0,0 +1,156 @@
+require 'net/http/post/multipart'
+require 'net/http/digest_auth'
+
+module Matterhorn
+  
+  class HttpClient
+    
+    # --- attributes -------------------------------------------------------------
+  
+    attr_reader :base_uri, :host, :port, :ssl
+  
+    # --- initialization ---------------------------------------------------------
+  
+    def initialize(base_uri)
+      @base_uri = URI.parse(base_uri)
+      @host     = @base_uri.host
+      @port     = @base_uri.port
+      @ssl      = @port == 443 ? true : false
+    end  
+  
+    def close
+      @http_socket.finish    if !@http_socket.nil? && @http_socket.started?
+    end
+  
+    # --- http methodes ----------------------------------------------------------
+  
+    def post(url, params = {}, file = nil, filename = nil, mime_type = nil)
+      if params.has_key?('BODY') || !file.nil?
+        request = multipart_post(url, params, file, filename, mime_type)
+      else
+        request = singlepart_post(url, params)
+      end
+      execute_request(request)
+    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                                                    === #
+    # ========================================================================== #
+    private
+  
+    def http_socket
+      return @http_socket   if !@http_socket.nil? && @http_socket.started?
+      @http_socket = Net::HTTP.new(host, port)
+      @http_socket.use_ssl = ssl
+      @http_socket.start
+    end
+  
+  
+    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
+  
+  
+    def multipart_post(url, params, file, filename, mime_type)
+      if file.kind_of?(String)
+        file = File.new(file)
+      elsif file.kind_of?(File)
+        # noting to do
+      elsif params['BODY'].kind_of?(String)
+        file = File.new(params['BODY'])
+        params['BODY'] = nil
+      elsif params['BODY'].kind_of?(File)
+        file = params['BODY']
+        params['BODY'] = nil
+      else
+        raise(Matterhorn::Error, "Matterhorn::Client::multipart_post: Neither BODY nor file exists!")
+      end
+      MatterhornWhymper.logger.debug { "Matterhorn::Client::multipart_post: file = #{file.inspect}"}
+      if filename.nil?
+        filename = File.basename(file.path)
+      end
+      if mime_type.nil?
+        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
+  
+  
+    def execute_request(request)
+      head = Net::HTTP::Head.new(request.path)
+      head['X-REQUESTED-AUTH'] = 'Digest'
+      head['X-Opencast-Matterhorn-Authorization'] = 'true'
+      digest_result = http_socket.request(head)
+      digest_auth = Net::HTTP::DigestAuth.new
+      auth = digest_auth.auth_header(base_uri, digest_result['www-authenticate'], request.method)
+      request.add_field('Authorization', auth)
+      response = http_socket.request(request)
+      case response.code.to_i
+      when 200..299
+        handle_2xx_ok(request, response)
+      when 400..499
+        handle_4xx_error(request, response)
+      when 500..599
+        handle_5xx_error(request, response)
+      else
+        handle_unknown_error(request, response)
+      end
+      response
+    end
+  
+  
+    def handle_2xx_ok(request, response)
+      MatterhornWhymper.logger.info { "Matterhorn::Client::execute_request:\n" + log_message(request, response) }
+    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))
+    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))
+    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))
+    end
+  
+  
+    def log_message(request, response)
+      "  request = #{log_request(request)}\n" +
+      "  response = #{log_response(response)}"
+    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

data/lib/matterhorn/media_package.rb

@@ -0,0 +1,110 @@
+require 'nokogiri'
+
+module Matterhorn
+
+  class MediaPackage
+   
+    # --- const definitions ------------------------------------------------------
+    XML_NS_MEDIAPACKAGE = "http://mediapackage.opencastproject.org"
+    
+
+    # --- 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) {
+            xml.media
+            xml.metadata
+            xml.attachments
+          }
+        end
+        .doc
+      end
+      MatterhornWhymper.logger.debug { "Matterhorn::MediaPackage::initialize | doc = #{to_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
+    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 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 save(path = @path)
+      manifest_file = File.join(path, 'manifest.xml')
+      File.open(manifest_file, 'w') do |file|
+        file.write(@document.to_xml)
+      end
+    end
+
+
+    def to_xml
+      @document.to_xml
+    end
+
+
+  end
+
+end

data/lib/matterhorn/smil.rb

@@ -0,0 +1,310 @@
+module Matterhorn
+
+  class Smil
+  
+    # --- const definitions ------------------------------------------------------
+  
+    # --- attributes -------------------------------------------------------------
+    attr_reader :head, :body
+  
+    # --- validations ------------------------------------------------------------
+  
+  
+    # --- callback declarations --------------------------------------------------
+  
+  
+    # --- relations --------------------------------------------------------------
+  
+  
+    # --- initialization ---------------------------------------------------------
+  
+    def initialize()
+      @head = Smil::Head.new
+      @body = Smil::Body.new
+    end
+  
+    # --- methodes ---------------------------------------------------------------
+
+    def save(smil_file)
+      File.open(smil_file, 'w') do |file|
+        file.write(self.to_xml)
+      end
+      Rails.logger.debug { "Matterhorn::Smil::save | Smil description =\n#{self.to_xml}" }
+      true
+    end
+
+
+    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
+      end
+    end
+
+  
+    # ========================================================================== #
+    # === protected section                                                  === #
+    # ========================================================================== #
+    protected
+  
+  
+    # ========================================================================== #
+    # === private section                                                    === #
+    # ========================================================================== #
+    private
+  
+  end
+
+
+
+  class Smil::Head
+
+    def to_xml(builder)
+      builder.head do
+      end
+    end
+
+  end
+
+
+
+  class Smil::Body
+
+    attr_reader :par_list
+
+    def initialize()
+      @par_list = Array.new
+    end
+
+    def add_par()
+      par = Smil::Par.new
+      @par_list << par
+      par
+    end
+
+
+    def to_xml(bx)
+      bx.body do
+        @par_list.each do |par|
+          par.to_xml(bx)
+        end
+      end
+    end
+
+  end
+
+
+
+  class Smil::Element
+
+    # --- attributes -------------------------------------------------------------
+    attr_reader :start_point, :end_point, :rel_begin, :duration, :parent
+
+    # --- initialization ---------------------------------------------------------
+    def initialize(parent = nil)
+      @start_point = nil
+      @end_point   = nil
+      @rel_begin   = nil
+      @duration    = nil
+      @parent      = parent
+    end
+
+    # --- methodes ---------------------------------------------------------------
+    
+    def attr_list
+      attr_list = Hash.new
+      if !@rel_begin.nil?
+        attr_list[:begin] = "#{(@rel_begin * 1000).round.to_s}ms"
+      end
+      if !@duration.nil?
+        attr_list[:dur] = "#{(@duration * 1000).round.to_s}ms"
+      end
+      attr_list
+    end
+
+
+    # ========================================================================== #
+    # === protected section                                                  === #
+    # ========================================================================== #
+    protected
+
+    def start_point=(new_start_point)
+      if new_start_point.kind_of? String
+        # start_point is an absolut time position and must be in the format 2013-12-02T14:12:42.364
+        new_start_point = new_start_point.to_datetime.to_f
+      elsif new_start_point.respond_to?('to_f')
+        new_start_point = new_start_point.to_f
+      else
+        new_start_point = nil
+      end
+      @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
+        new_end_point = new_end_point.to_datetime.to_f
+      elsif new_end_point.respond_to?('to_f')
+        new_end_point = new_end_point.to_f
+      else
+        new_end_point = nil
+      end
+      @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
+      elsif new_rel_begin.respond_to?('to_f')
+        new_rel_begin = new_rel_begin.to_f
+      else
+        new_rel_begin = nil
+      end
+      @rel_begin = new_rel_begin
+    end
+
+    def duration=(new_duration)
+      if new_duration.kind_of? Fixnum
+        # duration is in ms
+        new_duration = new_duration / 1000
+      elsif duration.respond_to?('to_f')
+        # duration is in s
+        new_duration = new_duration.to_f
+      else
+        new_duration = nil
+      end
+      @end_point = start_point + new_duration   if !start_point.nil? && !new_duration.nil?
+      @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
+      else
+        # do not update start_point
+      end
+      
+      if !sub_elem.end_point.nil? && (end_point.nil? || end_point < sub_elem.end_point)
+        @end_point = sub_elem.end_point
+      else
+        # do not update start_point
+      end
+
+      if !start_point.nil? && !end_point.nil?
+        @duration = end_point - start_point
+      end
+      # update parent if any
+      parent.update(self)    if !parent.nil?
+      propagate(self)        if parent.nil?
+    end
+
+    def propagate(parent_elem)
+    end
+
+  end
+
+
+
+  class Smil::Par < Smil::Element
+
+    def initialize()
+      super
+      @seq_list = Array.new
+    end
+
+
+    def add_seq
+      seq = Smil::Seq.new(self)
+      @seq_list << seq
+      seq
+    end
+
+
+    def propagate(parent_elem)
+      @seq_list.each do |seq|
+        seq.propagate(self)
+      end
+    end
+
+
+    def to_xml(bx)
+      bx.par(attr_list) do
+        @seq_list.each do |seq|
+          seq.to_xml(bx)
+        end
+      end
+    end
+
+  end
+
+
+
+  class Smil::Seq < Smil::Element
+
+    def initialize(parent)
+      super(parent)
+      @track_list = Array.new
+    end
+
+    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
+      update(track)
+      track
+    end
+
+    def propagate(parent_elem)
+      @rel_begin = start_point - parent_elem.start_point
+      @track_list.each do |track|
+        # propagate with par element
+        track.propagate(parent_elem)
+      end
+    end
+
+    def to_xml(bx)
+      bx.seq(attr_list) do
+        @track_list.each do |track|
+          track.to_xml(bx)
+        end
+      end
+    end
+
+  end
+
+  
+  class Smil::Track < Smil::Element
+
+    def initialize(parent, kind, file, start_point, duration)
+      super(parent)
+      @kind = kind
+      @src = file
+      self.start_point = start_point
+      self.duration = duration
+    end
+
+    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)
+    end
+
+  end
+
+end

data/lib/matterhorn/workflow_instance.rb

@@ -0,0 +1,59 @@
+require 'nokogiri'
+
+module Matterhorn
+
+  class WorkflowInstance
+
+    XML_NS_WORKFLOW = "http://workflow.opencastproject.org"
+  
+    # --- const definitions ------------------------------------------------------
+  
+    # --- attributes -------------------------------------------------------------
+  
+    # --- validations ------------------------------------------------------------
+  
+    # --- callback declarations --------------------------------------------------
+  
+  
+    # --- relations --------------------------------------------------------------
+  
+  
+    # --- initialization ---------------------------------------------------------
+  
+    def initialize(xml)
+      @document = Nokogiri::XML(xml)
+    end
+  
+    # --- 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

data/lib/matterhorn_whymper.rb

@@ -0,0 +1,47 @@
+require 'matterhorn_whymper/version'
+require 'matterhorn/endpoint'
+require 'matterhorn/endpoint/ingest'
+require 'matterhorn/endpoint/workflow'
+require 'matterhorn/http_client'
+require 'matterhorn/media_package'
+require 'matterhorn/error'
+
+
+module MatterhornWhymper
+
+  def self.info
+    "Ruby wrapper against the Matterhorn Endpoint API. Version #{MatterhornWhymper::VERSION}"
+  end
+ 
+ 
+  class << self
+    attr_accessor :configuration, :logger
+  end
+ 
+ 
+  def self.configure
+    self.configuration ||= Configuration.new
+    if defined?(Rails)
+      self.logger = Rails.logger
+    else
+      require 'logger'
+      self.logger = Logger.new(STDOUT)
+    end
+    yield(configuration)    if block_given?
+  end
+ 
+
+
+  class Configuration
+
+    attr_accessor :system_account_user, :system_account_password, :system_domain, :system_protocol
+
+    def uri
+      "#{system_protocol}://#{system_account_user}:#{system_account_password}@#{system_domain}"
+    end
+
+
+  end
+
+
+end

data/lib/matterhorn_whymper/version.rb

@@ -0,0 +1,3 @@
+module MatterhornWhymper
+  VERSION = "0.0.2"
+end

data/matterhorn_whymper.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matterhorn_whymper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matterhorn_whymper"
+  spec.version       = MatterhornWhymper::VERSION
+  spec.authors       = ["Daniel Fritschi"]
+  spec.email         = ["daniel.fritschi@switch.ch"]
+  spec.summary       = %q{Ruby wrapper around the Matterhorn Endpoint API}
+  spec.description   = %q{This Ruby wrapper is designed to write some ruby scripts against the
+                          Matterhorn Endpoint API}
+  spec.homepage      = "https://github.com/switch-ch/matterhorn_whymper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "multipart-post", "~> 2.0"
+  spec.add_runtime_dependency "net-http-digest_auth", "~> 1.4"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+  
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/Matterhorn_whymper_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe MatterhornWhymper do
+
+  it "version must be defined" do
+    expect(MatterhornWhymper::VERSION).not_to be nil
+  end
+
+  it "#info" do
+    expect(MatterhornWhymper.info).to include MatterhornWhymper::VERSION
+  end
+
+end

data/spec/endpoints_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Matterhorn::Endpoint do
+
+  it "does ingest endpoint available" do
+    Matterhorn::Endpoint.open(:ingest) do |ingest_endpoint|
+      expect(ingest_endpoint).not_to be nil
+      expect(ingest_endpoint.class.name).to eq 'Matterhorn::Endpoint::Ingest'
+    end
+  end
+
+  it "does workflow endpoint available" do
+    Matterhorn::Endpoint.open(:workflow) do |workflow_endpoint|
+      expect(workflow_endpoint).not_to be nil
+      expect(workflow_endpoint.class.name).to eq 'Matterhorn::Endpoint::Workflow'
+    end
+  end
+
+end
+
+
+describe "Ingest Mediapackages" do
+  
+  it "creates a mediapackage" do
+    Matterhorn::Endpoint.open(:ingest) do |ingest_endpoint|
+      ingest_endpoint.createMediaPackage()
+      mp_local = ingest_endpoint.media_package
+      mp_remote = ingest_endpoint.media_package('remote')
+      expect(mp_local).not_to be nil
+      expect(mp_remote).not_to be nil
+    end
+  end
+  
+end

data/spec/matterhorn.yml.sample

@@ -0,0 +1,5 @@
+matterhorn:
+  system_account_user:     inser_system_user_name_here
+  system_account_password: insert_system_user_password_here
+  system_domain:           mh-admin.localdomain
+  system_protocol:         http

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'yaml'
+
+Bundler.setup
+
+require 'matterhorn_whymper' # and any other gems you need
+
+RSpec.configure do |config|
+  MatterhornWhymper.configure do |mh_config|
+    mh_yml = YAML::load_file( "./spec/matterhorn.yml" )
+    mh_config.system_account_user     = mh_yml['matterhorn']['system_account_user']
+    mh_config.system_account_password = mh_yml['matterhorn']['system_account_password']
+    mh_config.system_domain           = mh_yml['matterhorn']['system_domain']
+    mh_config.system_protocol         = mh_yml['matterhorn']['system_protocol']
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: matterhorn_whymper
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Daniel Fritschi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-digest_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: ! "This Ruby wrapper is designed to write some ruby scripts against the\n
+  \                         Matterhorn Endpoint API"
+email:
+- daniel.fritschi@switch.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matterhorn/endpoint.rb
+- lib/matterhorn/endpoint/ingest.rb
+- lib/matterhorn/endpoint/workflow.rb
+- lib/matterhorn/error.rb
+- lib/matterhorn/http_client.rb
+- lib/matterhorn/media_package.rb
+- lib/matterhorn/smil.rb
+- lib/matterhorn/workflow_instance.rb
+- lib/matterhorn_whymper.rb
+- lib/matterhorn_whymper/version.rb
+- matterhorn_whymper.gemspec
+- spec/Matterhorn_whymper_spec.rb
+- spec/endpoints_spec.rb
+- spec/matterhorn.yml.sample
+- spec/spec_helper.rb
+homepage: https://github.com/switch-ch/matterhorn_whymper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper around the Matterhorn Endpoint API
+test_files:
+- spec/Matterhorn_whymper_spec.rb
+- spec/endpoints_spec.rb
+- spec/matterhorn.yml.sample
+- spec/spec_helper.rb