EMBL-EBI Web Services

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== net/http ======

For REST services using HTTP GET and/or POST the Ruby module net/http can be used to access the service. 

===== HTTP GET =====

For services available through a HTTP GET request, for example [[:services:dbfetch_rest|WSDbfetch (REST)]]: 
<code ruby>
# Load libraries
require 'net/http'
require 'uri'

# Base URL for service
baseUrl = 'http://www.ebi.ac.uk/Tools/webservices/rest/dbfetch'

# Defaults
dbName = 'uniprot'
entryId = 'wap_rat'
format = nil

# Split URL into components
baseUri = URI.parse(baseUrl)

# Create a HTTP connection
httpConn = Net::HTTP.new(baseUri.host, baseUri.port)

# Build the path for the resource
reqPath = baseUri.path + '/' + dbName + '/' + entryId
if format != nil
  reqPath += '/' + format
end

# Get the entry
resp, data = httpConn.get(reqPath)

# Print the result
puts data
</code>

===== HTTP POST =====

For services which require the use of a HTTP POST request, for example WSWUBlast (see [[.:rest|REST tutorial]]): 
<code ruby>
# Tool name
toolName = 'wublast'
# Query sequence
seq = ">Q8E5Q5_STRA3
MKLSKRYRFWQKVIKALGVLALIATLVLVVYLYKLGILNDSNELKDLVHKYEFWGPMIFI
VAQIVQIVFPVIPGGVTTVAGFLIFGPTLGFIYNYIGIIIGSVILFWLVKFYGRKFVLLF
MDQKTFDKYESKLETSGYEKFFIFCMASPISPADIMVMITGLSNMSIKRFVTIIMITKPI
SIIGYSYLWIYGGDILKNFLN"
# Structure containing parameters
params = {
          'tool' => toolName,
          'srchType' => 'interactive',
          'sequence' => seq,
          'program' => 'blastp',
          'database' => 'swissprot',
          'email' => 'your@email'
}

# Build the path for the resource
submitUrl = baseUrl + '/submit'
# Submit the job
resp, jobId = Net::HTTP.post_form(URI(submitUrl), params)
# Print the job identifier
puts jobId
</code>

===== Examples =====

  * [[:services:dbfetch|WSDbfetch]]: [[http://www.ebi.ac.uk/Tools/webservices/downloads/ruby/examples/dbfetch_net_http.rb|dbfetch_net_http.rb]]
  * [[:services:wublast|WSWUBlast]]: [[http://www.ebi.ac.uk/Tools/webservices/downloads/ruby/examples/wublast_net_http.rb|wublast_net_http.rb]]

===== Sample Clients =====

Most REST Web Services at [[http://www.ebi.ac.uk/|EMBL-EBI]] have sample clients which provide command-line access to the service and example code. For Ruby some of the clients are based on net/http, for example:

^ Service ^ Sample client ^
| [[:services:pfa:iprscan_rest|InterProScan (REST)]] | ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/ruby/net_http/iprscan_net_http.rb|iprscan_net_http.rb]]'' |
| [[:services:sss:NCBI BLAST (REST)]] | ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/ruby/net_http/ncbiblast_net_http.rb|ncbiblast_net_http.rb]]'' |
| [[:services:dbfetch_rest|WSDbfetch (REST)]] | ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/ruby/net_http/dbfetch_net_http.rb|dbfetch_net_http.rb]]'' |
EMBL-EBI Web Services

EMBL-EBI

Services

Research

Training

Industry

About us
