myexperiment-rest 0.2.7 → 0.2.8

data/lib/myexperiment-rest/myexperiment_rest.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'rest_client'
+require 'open-uri'
 require 'libxml'
 
 module MyExperimentREST
@@ -38,7 +39,7 @@ module MyExperimentREST
       # Get workflow resource information -- if version is empty it returns the current version
       response = RestClient.get('http://www.myexperiment.org/workflow.xml', {:params => {'id' => "#{workflow_id}", 
                                                                                          'version' => "#{workflow_version}",
-                                                                                         'elements' => 'title,description,content-uri,components'} } )
+                                                                                         'elements' => 'title,description,content-uri,components,uploader'} } )
 
       populate_workflow(response)
     end
@@ -47,6 +48,9 @@ module MyExperimentREST
     private
 
     # Acquire data from XML response and instantiate a _Taverna_Workflow_ object
+    #--
+    # TODO: refactor so that each (logical) workflow element is an object with
+    # its own read from_xml method...
     def populate_workflow(response)
       doc = XML::Document.string(response)
       wkf_xml_uri = doc.find_first("/workflow/content-uri").content
@@ -54,14 +58,15 @@ module MyExperimentREST
       wkf_descr = doc.find_first("/workflow/description").content
       wkf_inputs = get_IOData(doc, "source")
       wkf_outputs = get_IOData(doc, "sink")
+      wkf_user = get_user(doc.find_first("/workflow/uploader").attributes['uri'])
 
-      TavernaWorkflow.new(TavernaWorkflow::MY_EXPERIMENT, wkf_xml_uri, wkf_title, wkf_descr, wkf_inputs, wkf_outputs)
+      TavernaWorkflow.new(TavernaWorkflow::MY_EXPERIMENT, wkf_xml_uri, wkf_title, wkf_descr, wkf_inputs, wkf_outputs, wkf_user)
 
     end
 
 
     #
-    # Populate _Taverna_IOData_ objects for specified type: value +source+'+ is for inputs
+    # Populate _TavernaIOData_ objects for specified type: value +source+'+ is for inputs
     # and +sink+ for outputs
     #
     def get_IOData(doc, type)
@@ -94,14 +99,32 @@ module MyExperimentREST
     end
 
 
+    #
+    # Populate _TavernaUser_ object for specified user resource
+    #
+    def get_user(user_uri)
+      doc = XML::Document.file(user_uri)
+      user = TavernaUser.new(doc.find_first("/user/name").content,
+                             doc.find_first("/user/description").content,
+                             doc.find_first("/user/email").content,
+                             doc.find_first("/user/avatar").attributes['uri'],
+                             doc.find_first("/user/website").content,
+                             doc.find_first("/user/created-at").content)
+      user
+    end
+
+
+
   end
 
 
+
   #
-  # Contains all available information about a workflow: _input_type_, _xml_uri_, _title_, _description_,
-  # _inputs_ and _outputs_. The _xml_uri_ specifies the XML description on myExperiment and
-  # not the XML of the workflow itself. _input_type_ specifies the kind of input. Currently,
-  # either "myexperiment" (myExperiment's xml uri) or "t2flow" (filename)
+  # Contains all available information about a workflow: _input_type_, _xml_uri_,
+  # _title_, _description_,_inputs_, _outputs_ and _user_. The _xml_uri_ specifies
+  # the XML description on myExperiment and not the XML of the workflow itself.
+  # _input_type_ specifies the kind of input. Currently, either "myexperiment"
+  # (myExperiment's xml uri) or "t2flow" (filename)
   #
   class TavernaWorkflow
     
@@ -109,15 +132,16 @@ module MyExperimentREST
     MY_EXPERIMENT = 'myexperiment'
     T2_FLOW = 't2flow'
 
-    attr_reader(:input_type, :xml_uri, :title, :description, :inputs, :outputs)
+    attr_reader(:input_type, :xml_uri, :title, :description, :inputs, :outputs, :user)
 
-    def initialize(input_type, xml_uri, title, description, inputs, outputs)
+    def initialize(input_type, xml_uri, title, description, inputs, outputs, user)
       @input_type = input_type
       @xml_uri = xml_uri
       @title = title
       @description = description
       @inputs = inputs
       @outputs = outputs
+      @user = user
     end
 
   end
@@ -142,5 +166,25 @@ module MyExperimentREST
   end
 
 
+  #
+  # Contains all available information about an input or output: name, descriptions
+  # and examples. The last two are lists.
+  #
+  class TavernaUser
+    attr_reader(:name, :description, :email, :avatar, :website, :created_at)
+
+    def initialize(name, description, email, avatar, website, created_at)
+      @name = name
+      @description = description
+      @email = email
+      @avatar = avatar
+      @website = website
+      @created_at = created_at
+    end
+
+  end
+
+
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: myexperiment-rest
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Konstantinos Karasavvas
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-22 00:00:00 Z
+date: 2011-09-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 9
         segments: 
@@ -39,7 +39,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 5
         segments: 
@@ -67,54 +67,43 @@ files:
 - bin/get_workflow_data.rb
 - lib/myexperiment-rest.rb
 - lib/myexperiment-rest/myexperiment_rest.rb
-- doc/rdoc-style.css
-- doc/fr_file_index.html
-- doc/classes/TestReadWorkflow.html
-- doc/classes/TestReadWorkflow.src/M000002.html
-- doc/classes/TestReadWorkflow.src/M000001.html
-- doc/classes/TestReadWorkflow.src/M000003.html
-- doc/classes/TestReadWorkflow.src/M000004.html
-- doc/classes/MyExperimentREST.html
-- doc/classes/MyExperimentREST/TavernaWorkflow.src/M000006.html
-- doc/classes/MyExperimentREST/TavernaWorkflow.src/M000005.html
-- doc/classes/MyExperimentREST/ReadWorkflow.src/M000002.html
-- doc/classes/MyExperimentREST/ReadWorkflow.src/M000005.html
-- doc/classes/MyExperimentREST/TavernaIOData.src/M000006.html
-- doc/classes/MyExperimentREST/TavernaIOData.src/M000007.html
-- doc/classes/MyExperimentREST/Workflow.src/M000001.html
-- doc/classes/MyExperimentREST/IOData.src/M000003.html
-- doc/classes/MyExperimentREST/TavernaIOData.html
-- doc/classes/MyExperimentREST/Workflows.html
-- doc/classes/MyExperimentREST/TavernaWorkflow.html
-- doc/classes/MyExperimentREST/Workflow.html
-- doc/classes/MyExperimentREST/ReadWorkflow.html
-- doc/classes/MyExperimentREST/Workflows.src/M000004.html
-- doc/classes/MyExperimentREST/IOData.html
-- doc/fr_class_index.html
-- doc/index.html
-- doc/files/test/test_read_workflow_rb.html
-- doc/files/bin/get_workflow_data_rb.html
-- doc/files/README.html
-- doc/files/lib/myexperiment-rest/my_experiment_rest_rb.html
-- doc/files/lib/myexperiment-rest/myexperiment_rest_rb.html
-- doc/files/lib/myexperiment-rest_rb.html
-- doc/fr_method_index.html
-- doc/rdoc/rdoc-style.css
-- doc/rdoc/fr_file_index.html
-- doc/rdoc/classes/MyExperimentREST.html
-- doc/rdoc/classes/MyExperimentREST/TavernaIOData.html
-- doc/rdoc/classes/MyExperimentREST/Workflows.html
-- doc/rdoc/classes/MyExperimentREST/TavernaWorkflow.html
-- doc/rdoc/fr_class_index.html
+- doc/rdoc/rdoc.css
+- doc/rdoc/LICENSE.html
 - doc/rdoc/index.html
-- doc/rdoc/files/LICENSE.html
-- doc/rdoc/files/README.html
-- doc/rdoc/files/lib/myexperiment-rest/myexperiment_rest_rb.html
-- doc/rdoc/files/lib/myexperiment-rest_rb.html
-- doc/rdoc/files/CHANGES.html
-- doc/rdoc/fr_method_index.html
+- doc/rdoc/js/jquery.js
+- doc/rdoc/js/thickbox-compressed.js
+- doc/rdoc/js/darkfish.js
+- doc/rdoc/js/quicksearch.js
+- doc/rdoc/MyExperimentREST.html
+- doc/rdoc/README.html
+- doc/rdoc/lib/myexperiment-rest/myexperiment_rest_rb.html
+- doc/rdoc/lib/myexperiment-rest_rb.html
 - doc/rdoc/created.rid
-- doc/created.rid
+- doc/rdoc/CHANGES.html
+- doc/rdoc/images/find.png
+- doc/rdoc/images/bug.png
+- doc/rdoc/images/bullet_toggle_minus.png
+- doc/rdoc/images/wrench.png
+- doc/rdoc/images/bullet_black.png
+- doc/rdoc/images/macFFBgHack.png
+- doc/rdoc/images/page_white_text.png
+- doc/rdoc/images/ruby.png
+- doc/rdoc/images/bullet_toggle_plus.png
+- doc/rdoc/images/loadingAnimation.gif
+- doc/rdoc/images/brick.png
+- doc/rdoc/images/zoom.png
+- doc/rdoc/images/tag_green.png
+- doc/rdoc/images/page_green.png
+- doc/rdoc/images/brick_link.png
+- doc/rdoc/images/wrench_orange.png
+- doc/rdoc/images/date.png
+- doc/rdoc/images/page_white_width.png
+- doc/rdoc/images/package.png
+- doc/rdoc/images/plugin.png
+- doc/rdoc/MyExperimentREST/TavernaUser.html
+- doc/rdoc/MyExperimentREST/TavernaIOData.html
+- doc/rdoc/MyExperimentREST/Workflows.html
+- doc/rdoc/MyExperimentREST/TavernaWorkflow.html
 homepage: 
 licenses: []
 

data/doc/classes/MyExperimentREST.html

@@ -1,113 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: MyExperimentREST</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">MyExperimentREST</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/myexperiment-rest/myexperiment_rest_rb.html">
-                lib/myexperiment-rest/myexperiment_rest.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Class <a href="MyExperimentREST/TavernaIOData.html" class="link">MyExperimentREST::TavernaIOData</a><br />
-Class <a href="MyExperimentREST/TavernaWorkflow.html" class="link">MyExperimentREST::TavernaWorkflow</a><br />
-Class <a href="MyExperimentREST/Workflows.html" class="link">MyExperimentREST::Workflows</a><br />
-
-    </div>
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>

data/doc/classes/MyExperimentREST/IOData.html

@@ -1,169 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Class: MyExperimentREST::IOData</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">MyExperimentREST::IOData</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/myexperiment-rest/my_experiment_rest_rb.html">
-                lib/myexperiment-rest/my_experiment_rest.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-Contains all available information about an input or output: name,
-descriptions and examples. The last two are lists. Currently both inputs
-and outputs contain the same information. If that changes we can separate
-them.
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000003">new</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">descriptions</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">examples</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">name</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        </table>
-      </div>
-    </div>
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-
-        <div class="method-heading">
-          <a href="IOData.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('IOData.src/M000003.html');return false;">
-          <span class="method-name">new</span><span class="method-args">(name, descriptions, examples)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>