Changeset 86

Show
Ignore:
Timestamp:
09-02-11 12:02:54 (3 years ago)
Author:
kostas.karasavvas@…
Message:

v0.2.2 -- improved comments

Location:
myexperiment-rest
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • myexperiment-rest/lib/myexperiment-rest/myexperiment_rest.rb

    r74 r86  
    66 
    77  # 
    8   # Connects to myExperiment REST API and creates a workflow object. It initialises 
    9   # the following attributes that you can access: uri, workflow_id, workflow_version 
    10   # and workflow. 
     8  # Connects to myExperiment REST API and creates a +Workflow+ object. It initialises 
     9  # the following attributes that you can access: +uri+, +workflow_id+, +workflow_version+ 
     10  # and +workflow+. 
    1111  # 
    1212  class ReadWorkflow 
     
    3636 
    3737      # Get workflow resource information -- if version is empty it returns the current version 
    38       response = RestClient.get('http://www.myexperiment.org/workflow.xml', {:params => {'id' => "#{@workflow_id}", 'version' => "#{@workflow_version}",'elements' => 'title,description,components'} } ) 
     38      response = RestClient.get('http://www.myexperiment.org/workflow.xml', {:params => {'id' => "#{@workflow_id}",  
     39                                                                                         'version' => "#{@workflow_version}", 
     40                                                                                         'elements' => 'title,description,components'} } ) 
    3941 
    4042      @workflow = populate_workflow(response) 
    4143    end 
    4244 
     45 
    4346    private 
     47 
     48    # Acquire data from XML response and instantiate a +Workflow+ object 
    4449    def populate_workflow(response) 
    4550      doc = XML::Document.string(response) 
     
    5560 
    5661 
     62    # 
     63    # Populate +IOData+ objects for specified type: value +source+'+ is for inputs 
     64    # and +sink+ for outputs 
     65    # 
    5766    def get_IOData(doc, type) 
    5867      io_data = [] 
     
    8998 
    9099  # 
    91   # Contains all available information about a workflow: xml_uri, title, description, 
    92   # inputs and outputs. The xml_uri specifies the XML description on myExperiment and 
     100  # Contains all available information about a workflow: +xml_uri+, +title+, +description+, 
     101  # +inputs+ and +outputs+. The +xml_uri+ specifies the XML description on myExperiment and 
    93102  # not the XML of the workflow itself. 
    94103  # 
     
    110119  # 
    111120  # Contains all available information about an input or output: name, descriptions 
    112   # and examples. The last two are lists. Currently both inputs and outputs contain 
    113   # the same information. If that changes we can separate them. 
     121  # and examples. The last two are lists. 
     122  #-- 
     123  # Currently both inputs and outputs contain the same information. If that 
     124  # changes we can subclass this one. 
    114125  # 
    115126  class IOData 
  • myexperiment-rest/Rakefile

    r74 r86  
    1313spec = Gem::Specification.new do |s| 
    1414  s.name = 'myexperiment-rest' 
    15   s.version = '0.2.1' 
     15  s.version = '0.2.2' 
    1616  s.has_rdoc = true 
    1717  s.extra_rdoc_files = ['README', 'LICENSE']