overview.xml

<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="overview"
    xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>Spring Social TripIt Overview</title>

  <section id="overview-introduction">
    <title>Introduction</title>

    <para>
	    The Spring Social TripIt project is an extension to <ulink url="http://www.springframework.org/spring-social">Spring Social</ulink> that enables integration with TripIt.
	</para>

	<para>
		<ulink url="http://www.tripit.com">TripIt</ulink> is a social network that links together travelers. 
		By connecting with other travelers, you can keep in touch with contacts when your travel plans coincide. 
		Also, aside from its social aspects, TripIt is a rather useful service for managing one's travel information.
	</para>
	
	<para>
		Spring Social TripIt enables integration with TripIt with <classname>TripItConnectionFactory</classname>, a connection factory that can be plugged into Spring Social's service provider connection framework, and with an API binding to TripIt's REST API.
	</para>
  </section>

  <section id="overview-howtoget">
    <title>How to get</title>

    <para>
        The following Maven dependency will add Spring Social TripIt to your project:
	</para>

    <programlisting language="xml"><![CDATA[
<dependency>
  <groupId>org.springframework.social</groupId>
  <artifactId>spring-social-tripit</artifactId>
  <version>${org.springframework.social-tripit-version}</version>
</dependency>]]>
    </programlisting>

    <para>
	    As an extension to Spring Social, Spring Social TripIt depends on Spring Social. 
	    Spring Social's core module will be transitively resolved from the Spring Social TripIt dependency.
        If you'll be using Spring Social's web module, you'll need to add that dependency yourself:
	</para>

    <programlisting language="xml"><![CDATA[
<dependency>
  <groupId>org.springframework.social</groupId>
  <artifactId>spring-social-web</artifactId>
  <version>${org.springframework.social-version}</version>
</dependency>]]>
    </programlisting>

    <para>
	    Note that Spring Social TripIt may release on a different schedule than Spring Social.
	    Consequently, Spring Social's version may differ from that of Spring Social TripIt.
	</para>

	<para>
		Spring Social TripIt uses Spring Social's <classname>OAuth1Template</classname> to add OAuth 1.0a authorization headers to requests sent to TripIt.
		<classname>OAuth1Template</classname> uses the <ulink url="http://commons.apache.org/codec/">Commons Codec</ulink> library when calculating request signatures.
		Therefore, you'll also need Commons Codec in your project:
	</para>

    <programlisting language="xml"><![CDATA[
<dependency>
  <groupId>commons-codec</groupId>
  <artifactId>commons-codec</artifactId>
  <version>1.5</version>
</dependency>]]>
    </programlisting>

	<para>
		Consult <ulink url="http://static.springsource.org/spring-social/docs/1.0.x/reference/html/overview.html#overview-howtoget">Spring Social's reference documentation</ulink> for more information on Spring Social dependencies.
	</para>
  </section>

</chapter>