Yahoo! Boss Search

Prev — Chapter 2. Yahoo!'s OAuth Authorization Model

Chapter 3. BOSS API Specification — Next

OAuth Coding Examples

The following sections provide quick start examples of using OAuth in various common coding languages. BOSS API is providing this information to help you get up and running quickly with your BOSS API implementations. These self-serve samples are provided for you to use have been contributed by the BOSS User Community.

Note

Please make sure to add your "ADD YOUR KEY HERE" and "ADD YOUR SECRET HERE" in the appropriate places in the code examples below.

Note

All code samples below are adapted from original contributions. Contributors are noted.

PHP Example

Sign up for OAuth application through http://developer.yahoo.com.
Download the PHP OAuth Library from http://oauth.net/code. This is where you can retrieve the required OAuth.php file displayed below.
Create a php script based on this example updating the $cc_key with your Consumer Key and the $cc_secret with your Consumer Secret:

Perl Example

use strict;
use lib 'extra_mods';
use lib 'extra_mods/5.8';
use JSON;
use Net::OAuth;
use LWP::UserAgent;
use Data::Dumper;

$Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0A;

my $expected_result_format = 'xml'; #xml or json

my %args;
$args{q} = "Yahoo!"; # This is the query we are searching for
$args{format} = $expected_result_format; 
$args{count} = 1; # number of results to be returned

my $buckets = "web"; # news,web,images (various BOSS services)

print get_response(\%args,$buckets);

sub get_response {
    my %args = %{(shift)};
    my $buckets = shift;

my $ua = LWP::UserAgent->new;

# PROVIDE YOUR KEY HERE
    my $cc_key = "";

# PROVIDE YOUR SECRET HERE
    my $cc_secret = "";

# Source Url
    my $url = "http://yboss.yahooapis.com/ysearch/$buckets";

# Create request
    my $request = Net::OAuth->request("request token")->new(
            consumer_key => $cc_key,  
            consumer_secret => $cc_secret, 
            request_url => $url, 
            request_method => 'GET', 
            signature_method => 'HMAC-SHA1',
            timestamp => time, 
            nonce => 'hsu94j3884jdopsl',
            callback => 'http://printer.example.com/request_token_ready',
            extra_params => \%args 
            );

# Sign request        
    $request->sign;

# Get message to the Service Provider
    my $res = $ua->get($request->to_url);

# If request is success, display content
        if ($res->is_success) {
            return $res->content;
        }
        else {
        # Print error and die
                        Dumper $res;
            die "Something went wrong";
        }
}

Perl*

Perl 5.8+

Location: http://www.perl.org/get.html

extra mods:

http://search.cpan.org/dist/Net-OAuth/

http://search.cpan.org/dist/LWP-Protocol-socks/

http://search.cpan.org/~makamaka/JSON-2.53/lib/JSON.pm

* Specific CPAN Modules are required. Please see the code for required modules.

Ruby Example

Example: example.rb

Ruby

oauth_util.rb

Location: https://gist.github.com/383159

License: https://gist.github.com/375593

C# Example

Example: boss_test.cs

Location: http://oauth.googlecode.com/svn/code/csharp/OAuthBase.cs

License: Unknown

Contributor: Bryan Meverovich

Java Example

Example: SignPostTest.java

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Logger;

import oauth.signpost.OAuthConsumer;
import oauth.signpost.basic.DefaultOAuthConsumer;

/**
 * Sample code to use Yahoo! Search BOSS
 * 
 * Please include the following libraries 
 * 1. Apache Log4j
 * 2. oAuth Signpost
 * 
 * @author xyz
 */
public class SignPostTest {

private static final Logger log = Logger.getLogger(SignPostTest.class);

protected static String yahooServer = "http://yboss.yahooapis.com/ysearch/";

// Please provide your consumer key here
private static String consumer_key = "";

// Please provide your consumer secret here
private static String consumer_secret = "";

/** The HTTP request object used for the connection */
private static StHttpRequest httpRequest = new StHttpRequest();

/** Encode Format */
private static final String ENCODE_FORMAT = "UTF-8";

/** Call Type */
private static final String callType = "web";

private static final int HTTP_STATUS_OK = 200;

/**
 * 
 * @return
 */
public int returnHttpData() 
throws UnsupportedEncodingException, 
Exception{

if(this.isConsumerKeyExists() && this.isConsumerSecretExists()) {

// Start with call Type
String params = callType;

// Add query
params = params.concat("?q=");

// Encode Query string before concatenating
params = params.concat(URLEncoder.encode(this.getSearchString(), "UTF-8"));

// Create final URL
String url = yahooServer + params;

// Create oAuth Consumer 
OAuthConsumer consumer = new DefaultOAuthConsumer(consumer_key, consumer_secret);

// Set the HTTP request correctly
httpRequest.setOAuthConsumer(consumer);

try {
log.info("sending get request to" + URLDecoder.decode(url, ENCODE_FORMAT));
int responseCode = httpRequest.sendGetRequest(url);

// Send the request
if(responseCode == HTTP_STATUS_OK) {
log.info("Response ");
} else {
log.error("Error in response due to status code = " + responseCode);
}
log.info(httpRequest.getResponseBody());

} catch(UnsupportedEncodingException e) {
log.error("Encoding/Decording error");
} catch (IOException e) {
log.error("Error with HTTP IO", e);
} catch (Exception e) {
log.error(httpRequest.getResponseBody(), e);
return 0;
}

} else {
log.error("Key/Secret does not exist");
}
return 1;
}

private String getSearchString() {
return "Yahoo";
}

private boolean isConsumerKeyExists() {
if(consumer_key.isEmpty()) {
log.error("Consumer Key is missing. Please provide the key");
return false;
}
return true;
}

private boolean isConsumerSecretExists() {
if(consumer_secret.isEmpty()) {
log.error("Consumer Secret is missing. Please provide the key");
return false;
}
return true;
}
/**
 * @param args
 */
public static void main(String[] args) {

BasicConfigurator.configure();

try {

SignPostTest signPostTest = new SignPostTest();

signPostTest.returnHttpData();

} catch (Exception e) {
log.info("Error", e);
}
}

}

Example: StHTTPRequest.java

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;

import org.apache.log4j.Logger;

import oauth.signpost.OAuthConsumer;
import oauth.signpost.exception.OAuthCommunicationException;
import oauth.signpost.exception.OAuthExpectationFailedException;
import oauth.signpost.exception.OAuthMessageSignerException;

/**
 * @author David Hardtke
 * @author xyz
 * Simple HTTP Request implementation
 */
public class StHttpRequest {

private static final Logger log = Logger.getLogger(StHttpRequest.class);

private String responseBody = "";
   
    private OAuthConsumer consumer = null;

/** Default Constructor */
    public StHttpRequest() { }
   
    public StHttpRequest(OAuthConsumer consumer) {
        this.consumer = consumer;
    }

public HttpURLConnection getConnection(String url) 
    throws IOException,
        OAuthMessageSignerException,
        OAuthExpectationFailedException, 
        OAuthCommunicationException
    {
     try {
             URL u = new URL(url);

HttpURLConnection uc = (HttpURLConnection) u.openConnection();
             
             if (consumer != null) {
                 try {
                     log.info("Signing the oAuth consumer");
                     consumer.sign(uc);
                     
                 } catch (OAuthMessageSignerException e) {
                     log.error("Error signing the consumer", e);
                     throw e;

} catch (OAuthExpectationFailedException e) {
                 log.error("Error signing the consumer", e);
                 throw e;
                 
                 } catch (OAuthCommunicationException e) {
                 log.error("Error signing the consumer", e);
                 throw e;
                 }
                 uc.connect();
             }
             return uc;
     } catch (IOException e) {
     log.error("Error signing the consumer", e);
     throw e;
     }
    }
    
    /**
     * Sends an HTTP GET request to a url
     *
     * @param url the url
     * @return - HTTP response code
     */
    public int sendGetRequest(String url) 
    throws IOException,
    OAuthMessageSignerException,
    OAuthExpectationFailedException, 
    OAuthCommunicationException {
    
    
        int responseCode = 500;
        try {
            HttpURLConnection uc = getConnection(url);
            
            responseCode = uc.getResponseCode();
            
            if(200 == responseCode || 401 == responseCode || 404 == responseCode){
                BufferedReader rd = new BufferedReader(new InputStreamReader(responseCode==200?uc.getInputStream():uc.getErrorStream()));
                StringBuffer sb = new StringBuffer();
                String line;
                while ((line = rd.readLine()) != null) {
                    sb.append(line);
                }
                rd.close();
                setResponseBody(sb.toString());
            }
         } catch (MalformedURLException ex) {
            throw new IOException( url + " is not valid");
        } catch (IOException ie) {
            throw new IOException("IO Exception " + ie.getMessage());
        }
        return responseCode;
    }

/**
     * Return the Response body
     * @return String
     */
    public String getResponseBody() {
        return responseBody;
    }

/**
     * Setter
     * @param responseBody
     */
    public void setResponseBody(String responseBody) {
        if (null != responseBody) {
            this.responseBody = responseBody;
        }
    }
   
    /**
     * Set the oAuth consumer
     * @param consumer
     */
    public void setOAuthConsumer(OAuthConsumer consumer) {
        this.consumer = consumer;
    }
}

Java

SignPost

Location: http://code.google.com/p/oauth-signpost/

License: http://www.apache.org/licenses/LICENSE-2.0

Contributor: David Hardtke

Apache Logger

Location: http://logging.apache.org/log4j/1.2/download.html

License: http://logging.apache.org/log4j/1.2/license.html

Node.JS Example

Example: Node.JS

Node.JS

Contributor: Heber Allred

Prev — Chapter 2. Yahoo!'s OAuth Authorization Model

Chapter 3. BOSS API Specification — Next

Yahoo! Developer Network

Yahoo! Boss Search

OAuth Coding Examples

Note

Note

PHP Example

Perl Example

Ruby Example

C# Example

Java Example

Node.JS Example

Table of Contents