myexperiment-rest 0.2.8 → 0.3.0

data/doc/rdoc/README.html

@@ -66,13 +66,17 @@
         
           <li><a href="./MyExperimentREST.html">MyExperimentREST</a></li>
         
-          <li><a href="./MyExperimentREST/TavernaIOData.html">MyExperimentREST::TavernaIOData</a></li>
+          <li><a href="./MyExperimentREST/MyExperimentIOData.html">MyExperimentREST::MyExperimentIOData</a></li>
         
-          <li><a href="./MyExperimentREST/TavernaUser.html">MyExperimentREST::TavernaUser</a></li>
+          <li><a href="./MyExperimentREST/MyExperimentUser.html">MyExperimentREST::MyExperimentUser</a></li>
         
-          <li><a href="./MyExperimentREST/TavernaWorkflow.html">MyExperimentREST::TavernaWorkflow</a></li>
+          <li><a href="./MyExperimentREST/MyExperimentWorkflow.html">MyExperimentREST::MyExperimentWorkflow</a></li>
         
-          <li><a href="./MyExperimentREST/Workflows.html">MyExperimentREST::Workflows</a></li>
+          <li><a href="./MyExperimentREST/Urls.html">MyExperimentREST::Urls</a></li>
+        
+          <li><a href="./MyExperimentREST/User.html">MyExperimentREST::User</a></li>
+        
+          <li><a href="./MyExperimentREST/Workflow.html">MyExperimentREST::Workflow</a></li>
         
         </ul>
         <div id="no-class-search-results" style="display: none;">No matching classes.</div>
@@ -90,7 +94,7 @@
 <p>Konstantinos Karasavvas</p>
 </td></tr><tr><td class="rdoc-term"><p>Gem Version</p></td>
 <td>
-<p>0.2.8</p>
+<p>0.3.0</p>
 </td></tr><tr><td class="rdoc-term"><p>Contact</p></td>
 <td>
 <p><a href="mailto:kostas.karasavvas@nbic.nl">kostas.karasavvas@nbic.nl</a></p>
@@ -109,12 +113,13 @@ href="http://www.opensource.org/licenses/mit-license">www.opensource.org/license
 
 <h2>Features/Problems</h2>
 
-<p>Only a subset of myExperiment workflow data can be currently accessed.</p>
+<p>Only a subset of myExperiment workflow and user data can be currently
+accessed.</p>
 
 <h2>Usage</h2>
 
 <p>There is an example script inside the <tt>bin</tt> directory that
-demonstrates how you can use the library.</p>
+demonstrates how you can use the library: $ get_workflow_data.rb.</p>
 
 <h2>Installation</h2>
 

data/doc/rdoc/created.rid

@@ -1,6 +1,8 @@
-Mon, 19 Sep 2011 12:56:22 +0200
+Wed, 28 Sep 2011 12:45:52 +0200
 LICENSE	Tue, 26 Jul 2011 16:45:34 +0200
-README	Mon, 19 Sep 2011 11:02:31 +0200
-lib/myexperiment-rest.rb	Tue, 26 Jul 2011 16:45:34 +0200
-CHANGES	Mon, 19 Sep 2011 11:03:06 +0200
-lib/myexperiment-rest/myexperiment_rest.rb	Mon, 19 Sep 2011 12:56:14 +0200
+lib/myexperiment-rest/constants.rb	Wed, 28 Sep 2011 10:04:55 +0200
+README	Wed, 28 Sep 2011 12:41:40 +0200
+lib/myexperiment-rest/user.rb	Wed, 28 Sep 2011 12:11:32 +0200
+lib/myexperiment-rest.rb	Wed, 28 Sep 2011 12:07:50 +0200
+CHANGES	Wed, 28 Sep 2011 12:42:24 +0200
+lib/myexperiment-rest/workflow.rb	Wed, 28 Sep 2011 12:32:43 +0200

data/doc/rdoc/index.html

@@ -29,7 +29,7 @@
 <p>Konstantinos Karasavvas</p>
 </td></tr><tr><td class="rdoc-term"><p>Gem Version</p></td>
 <td>
-<p>0.2.8</p>
+<p>0.3.0</p>
 </td></tr><tr><td class="rdoc-term"><p>Contact</p></td>
 <td>
 <p><a href="mailto:kostas.karasavvas@nbic.nl">kostas.karasavvas@nbic.nl</a></p>
@@ -48,12 +48,13 @@ href="http://www.opensource.org/licenses/mit-license">www.opensource.org/license
 
 <h2>Features/Problems</h2>
 
-<p>Only a subset of myExperiment workflow data can be currently accessed.</p>
+<p>Only a subset of myExperiment workflow and user data can be currently
+accessed.</p>
 
 <h2>Usage</h2>
 
 <p>There is an example script inside the <tt>bin</tt> directory that
-demonstrates how you can use the library.</p>
+demonstrates how you can use the library: $ get_workflow_data.rb.</p>
 
 <h2>Installation</h2>
 
@@ -87,26 +88,44 @@ demonstrates how you can use the library.</p>
     
     <li class="module"><a href="MyExperimentREST.html">MyExperimentREST</a></li>
     
-    <li class="class"><a href="MyExperimentREST/TavernaIOData.html">MyExperimentREST::TavernaIOData</a></li>
+    <li class="class"><a href="MyExperimentREST/MyExperimentIOData.html">MyExperimentREST::MyExperimentIOData</a></li>
     
-    <li class="class"><a href="MyExperimentREST/TavernaUser.html">MyExperimentREST::TavernaUser</a></li>
+    <li class="class"><a href="MyExperimentREST/MyExperimentUser.html">MyExperimentREST::MyExperimentUser</a></li>
     
-    <li class="class"><a href="MyExperimentREST/TavernaWorkflow.html">MyExperimentREST::TavernaWorkflow</a></li>
+    <li class="class"><a href="MyExperimentREST/MyExperimentWorkflow.html">MyExperimentREST::MyExperimentWorkflow</a></li>
     
-    <li class="class"><a href="MyExperimentREST/Workflows.html">MyExperimentREST::Workflows</a></li>
+    <li class="module"><a href="MyExperimentREST/Urls.html">MyExperimentREST::Urls</a></li>
+    
+    <li class="class"><a href="MyExperimentREST/User.html">MyExperimentREST::User</a></li>
+    
+    <li class="class"><a href="MyExperimentREST/Workflow.html">MyExperimentREST::Workflow</a></li>
     
   </ul>
 
   <h2 id="methods">Methods</h2>
   <ul>
     
-      <li><a href="MyExperimentREST/TavernaIOData.html#method-c-new">::new &mdash; MyExperimentREST::TavernaIOData</a></li>
+      <li><a href="MyExperimentREST/User.html#method-c-from_id">::from_id &mdash; MyExperimentREST::User</a></li>
+    
+      <li><a href="MyExperimentREST/Workflow.html#method-c-from_id_and_version">::from_id_and_version &mdash; MyExperimentREST::Workflow</a></li>
+    
+      <li><a href="MyExperimentREST/User.html#method-c-from_uri">::from_uri &mdash; MyExperimentREST::User</a></li>
+    
+      <li><a href="MyExperimentREST/Workflow.html#method-c-from_uri">::from_uri &mdash; MyExperimentREST::Workflow</a></li>
+    
+      <li><a href="MyExperimentREST/MyExperimentIOData.html#method-c-from_xml">::from_xml &mdash; MyExperimentREST::MyExperimentIOData</a></li>
+    
+      <li><a href="MyExperimentREST.html#method-c-get_myexperiment_data">::get_myexperiment_data &mdash; MyExperimentREST</a></li>
+    
+      <li><a href="MyExperimentREST/MyExperimentUser.html#method-c-new">::new &mdash; MyExperimentREST::MyExperimentUser</a></li>
+    
+      <li><a href="MyExperimentREST/MyExperimentWorkflow.html#method-c-new">::new &mdash; MyExperimentREST::MyExperimentWorkflow</a></li>
     
-      <li><a href="MyExperimentREST/TavernaUser.html#method-c-new">::new &mdash; MyExperimentREST::TavernaUser</a></li>
+      <li><a href="MyExperimentREST/MyExperimentIOData.html#method-c-new">::new &mdash; MyExperimentREST::MyExperimentIOData</a></li>
     
-      <li><a href="MyExperimentREST/TavernaWorkflow.html#method-c-new">::new &mdash; MyExperimentREST::TavernaWorkflow</a></li>
+      <li><a href="MyExperimentREST/MyExperimentUser.html#method-c-parse">::parse &mdash; MyExperimentREST::MyExperimentUser</a></li>
     
-      <li><a href="MyExperimentREST/Workflows.html#method-i-read">#read &mdash; MyExperimentREST::Workflows</a></li>
+      <li><a href="MyExperimentREST/MyExperimentWorkflow.html#method-c-parse">::parse &mdash; MyExperimentREST::MyExperimentWorkflow</a></li>
     
   </ul>
 

data/doc/rdoc/lib/myexperiment-rest/constants_rb.html

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>File: constants.rb [myexperiment-rest Docs]</title>
+
+  <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+  <script src="../../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">Wed Sep 28 10:04:55 +0200 2011</dd>
+
+      
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+        
+        </ul>
+      </dd>
+      
+
+      
+    </dl>
+  </div>
+
+  <div id="documentation">
+    
+    <div class="description">
+      <h2>Description</h2>
+      
+    </div>
+    
+  </div>
+</body>
+</html>
+

data/doc/rdoc/lib/myexperiment-rest/{myexperiment_rest_rb.html → user_rb.html}

@@ -6,7 +6,7 @@
 <head>
   <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
 
-  <title>File: myexperiment_rest.rb [myexperiment-rest Docs]</title>
+  <title>File: user.rb [myexperiment-rest Docs]</title>
 
   <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
 
@@ -24,19 +24,13 @@
   <div id="metadata">
     <dl>
       <dt class="modified-date">Last Modified</dt>
-      <dd class="modified-date">Mon Sep 19 12:56:14 +0200 2011</dd>
+      <dd class="modified-date">Wed Sep 28 12:11:32 +0200 2011</dd>
 
       
       <dt class="requires">Requires</dt>
       <dd class="requires">
         <ul>
         
-          <li>rubygems</li>
-        
-          <li>rest_client</li>
-        
-          <li>open-uri</li>
-        
           <li>libxml</li>
         
         </ul>

data/doc/rdoc/lib/myexperiment-rest/workflow_rb.html

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>File: workflow.rb [myexperiment-rest Docs]</title>
+
+  <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+
+  <script src="../../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">Wed Sep 28 12:32:43 +0200 2011</dd>
+
+      
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+        
+          <li>libxml</li>
+        
+        </ul>
+      </dd>
+      
+
+      
+    </dl>
+  </div>
+
+  <div id="documentation">
+    
+    <div class="description">
+      <h2>Description</h2>
+      
+    </div>
+    
+  </div>
+</body>
+</html>
+

data/doc/rdoc/lib/myexperiment-rest_rb.html

@@ -24,14 +24,22 @@
   <div id="metadata">
     <dl>
       <dt class="modified-date">Last Modified</dt>
-      <dd class="modified-date">Tue Jul 26 16:45:34 +0200 2011</dd>
+      <dd class="modified-date">Wed Sep 28 12:07:50 +0200 2011</dd>
 
       
       <dt class="requires">Requires</dt>
       <dd class="requires">
         <ul>
         
-          <li>myexperiment-rest/myexperiment_rest.rb</li>
+          <li>rubygems</li>
+        
+          <li>rest_client</li>
+        
+          <li>myexperiment-rest/constants</li>
+        
+          <li>myexperiment-rest/workflow</li>
+        
+          <li>myexperiment-rest/user</li>
         
         </ul>
       </dd>

data/lib/myexperiment-rest.rb

@@ -1,5 +1,46 @@
-require 'myexperiment-rest/myexperiment_rest.rb'
+require 'rubygems'
+require 'rest_client'
+
+require 'myexperiment-rest/constants'
+require 'myexperiment-rest/workflow'
+require 'myexperiment-rest/user'
+
 
 module MyExperimentREST
 
+  
+  # Get information from myExperiment using the REST API. Resources supported currently
+  # are +WORKFLOW_URL+"+ and +USER_URL+.
+  def self.get_myexperiment_data(resource_url, params)
+    case resource_url
+
+    when Urls::WORKFLOW_URL
+      begin
+        # Get workflow resource information -- if version is empty it returns the current version
+        response = RestClient.get("#{Urls::MYEXPERIMENT_URL}/#{Urls::WORKFLOW_URL}",
+                                         {:params => {'id' => "#{params[:id]}",
+                                                      'version' => "#{params[:version]}",
+                                                      'elements' => 'title,description,content-uri,components,uploader'} } )
+        response
+      rescue Exception => e
+        raise "REST call to acquire workflow resource failed!\n" + e
+      end
+
+    when Urls::USER_URL
+      begin
+        # Get user resource information
+        response = RestClient.get("#{Urls::MYEXPERIMENT_URL}/#{Urls::USER_URL}",
+                                         {:params => {'id' => "#{params[:id]}" } } )
+        response
+      rescue Exception => e
+        raise "REST call to acquire user resource failed!\n" + e
+      end
+
+    else
+      raise "This is not a supported resource type!\n"
+    end
+
+  end
+
+
 end

data/lib/myexperiment-rest/constants.rb

@@ -0,0 +1,11 @@
+
+module MyExperimentREST
+
+  module Urls
+    # URL constants
+    MYEXPERIMENT_URL = "http://www.myexperiment.org"
+    WORKFLOW_URL = "workflow.xml"
+    USER_URL = "user.xml"
+  end
+
+end

data/lib/myexperiment-rest/user.rb

@@ -0,0 +1,83 @@
+require 'libxml'
+
+module MyExperimentREST
+
+  #
+  # Connects to myExperiment REST API and creates a _MyExperimentUser_ object.
+  #
+  class User
+
+    # Returns a _MyExperimentUser_ object given a URI of the user in the repository as a String.
+    def self.from_uri(uri)
+
+      user_id = ''
+
+      # Get user id - will match both user/74 and users.xml?id=74
+      uri_id = uri.match(/user.*[\/?](id=)?(\d+)/)
+      if uri_id != nil
+        user_id = uri_id[2]
+      else
+        raise "Could not match user id."
+      end
+
+      # Get user resource information
+      xml = MyExperimentREST.get_myexperiment_data(Urls::USER_URL, :id => user_id)
+
+      MyExperimentUser.parse(xml)
+    end
+
+
+    # Returns a _MyExperimentUser_ object given a myExperiment id for that user.
+    def self.from_id(user_id)
+
+      # Get user resource information
+      xml = MyExperimentREST.get_myexperiment_data(Urls::USER_URL, :id => user_id)
+
+      MyExperimentUser.parse(xml)
+    end
+
+  end  # class User
+
+
+
+  #
+  # Contains information about a user. All basic information is available but not
+  # some of the more advanced like all user's friends or workflow's.
+  #
+  class MyExperimentUser
+    attr_reader(:id, :created_at, :name, :description, :email, :avatar_uri, :city, :country, :website)
+
+    def initialize(attributes)
+      @id = attributes[:id]
+      @created_at = attributes[:created_at]
+      @name = attributes[:name]
+      @description = attributes[:description]
+      @email = attributes[:email]
+      @avatar_uri = attributes[:avatar_uri]
+      @city = attributes[:city]
+      @country = attributes[:country]
+      @website = attributes[:website]
+    end
+
+
+    # Acquire data from XML response and instantiate a _MyExperimentWorkflow_ object
+    def self.parse(xml)
+
+      doc = LibXML::XML::Document.string(xml)
+
+      new(:id => doc.find_first("/user/id").content,
+          :created_at => doc.find_first("/user/created-at").content,
+          :name => doc.find_first("/user/name").content,
+          :description => doc.find_first("/user/description").content,
+          :email => doc.find_first("/user/email").content,
+          :avatar_uri => doc.find_first("/user/avatar").attributes[:uri],
+          :city => doc.find_first("/user/city").content,
+          :country => doc.find_first("/user/country").content,
+          :website => doc.find_first("/user/website").content)
+
+    end
+
+  end  # class MyexperimentUser
+
+  
+end  # module MyExperimentREST