Rapleaf Address Book API in Perl

dannymo2 (Dan Scudder) — Fri, 14 Mar 2008 14:39:58 GMT

Retrieve e-mail contacts from several services using the Rapleaf Address Book API.

It accesses the Rapleaf API Web server and executes a request to retrieve the contact list of a given user of either Gmail, Yahoo, Hotmail and AOL.

Returns an associative array with the contacts names and e-mail addresses, as well the HTTP response status and any errors.



package Rapleaf;

use strict;



use LWP::UserAgent;

use HTTP::Request;

use XML::Simple;



sub getData {

	my ($email, $pass, $api_key, $url) = @_;

	my $post_data = "login=$email&password=$pass";



	$url ||= 'http://api.rapleaf.com/v2/abook';

	my $agent = LWP::UserAgent->new();

	my $request = HTTP::Request->new(POST => $url);

	$request->content($post_data);

	$request->header( 'Authorization' => $api_key );

	my $response;

	$response = $agent->request($request);

	my %result; 

	if($response->code == 200) {

		my $xml = new XML::Simple;

		%result = %{$xml->XMLin($response->content)};



		# if a single contact if found, XMLin returns a result set of a different format, therefore we need to manually format it

		if ($result{'contact'}->{'name'}) {

			$result{'contact'}->{$result{'contact'}->{'name'}} 

				= {'email'=>$result{'contact'}->{'email'}};

			delete $result{'contact'}->{'name'};

			delete $result{'contact'}->{'email'};

		} 

	} elsif ($response->code == 400) {

		$result{'error'} = 'The request did not contain all required parameters: '.$response;

	} elsif ($response->code == 401) {

		$result{'error'} = 'API key was not provided or is invalid.';

	} elsif ($response->code == 420) {

		$result{'error'} = 'Login failed.';

	} elsif ($response->code == 500) {

		$result{'error'} = 'There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com.';

	} elsif ($response->code == 520) {

		$result{'error'} = 'There was an error while reading the contacts from the address book.';

	}

	

	$result{'status'} = $response->code;

	return \%result;

}



1;

Rapleaf Address Book API in PHP

dannymo2 (Dan Scudder) — Thu, 06 Mar 2008 20:55:55 GMT

// The Rapleaf Address Book API allows you to access names and addresses of a person's webmail contact list (Gmail, AOL, Hotmail, and Yahoo). You can use this API to send friend invites on a social network, etc.



/*

 * Helper class for the Rapleaf Address Book API

 * 		(http://www.rapleaf.com/apidoc/v2/abook)

 * Gets the XML response from the Rapleaf server and parses it into a PHP object.

 *

 * Usage: 

 * 	1. $abook = new RapleafAbook(api_key[,url]) to initialize

 *  2. $result = $abook->getData(email, password) to query the API for a contact list

 *  See the function definitions for details.

 *  

 * 03/01/2008

 *

 */

 

class RapleafAbook {

	var $url;

	var $api_key;

	var $status; 



	function RapleafAbook($api_key, $url = 'http://api.rapleaf.com/v2/abook') {

		$this->api_key = $api_key;

		$this->url = $url;

		$this->status = '';

	}



	function getData($email, $pass) {

		# assemble post_data string

		$post_data = "login=$email&password=$pass";

		$response = $this->sendPostRequest($this->url, $post_data);

    

		# the return structure

		$result = array(

			'status'   => '',  # HTTP status code returned by the server

			'error'    => '',  # error message if there are any

			'contacts' => array(),  # contact list if request succeeded

		);

		

		$result['status'] = $this->status;

		if ($this->status == '200') { #OK

			$result['contacts'] = $this->xmlToObj($response);

		} elseif ($this->status == '400') {

			$result['error'] = 'The request did not contain all required parameters: '.$response;

		} elseif ($this->status == '401') {

			$result['error'] = 'API key was not provided or is invalid.';

		} elseif ($this->status == '420') {

			$result['error'] = 'Login failed.';

		} elseif ($this->status == '500') {

			$result['error'] = 'There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com.';

		} elseif ($this->status == '520') {

			$result['error'] = 'There was an error while reading the contacts from the address book.';

		}

		return $result;

	}



	# Parse the xml response text into an associative array

	function xmlToObj($str) {

		$xml = simplexml_load_string($str);

		$result = array();

		foreach ($xml->contact as $contact) {

			$result[] = array('name' => (string) $contact['name'], 'email' => (string) $contact['email']);

		}

		return $result;

	}

	

	# Returns the xml response on success, sets the error message on failure

	function sendPostRequest($url, $post_data) {

		$ch = curl_init();

		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

		curl_setopt($ch, CURLOPT_TIMEOUT, 20);

		curl_setopt($ch, CURLOPT_URL, $url);

		curl_setopt($ch, CURLOPT_POST, 1);

		curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);

		curl_setopt($ch, CURLOPT_HTTPHEADER, 

			array("Authorization: ".$this->api_key, "Content-Type: application/x-www-form-urlencoded")

		);

		

		$data = curl_exec($ch);

		$this->status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

		curl_close($ch);

		return $data;

	}

}

?>

DZone Snippets: Dannymo2's Code Snippets

Rapleaf Address Book API in Perl

Rapleaf Address Book API in PHP