Author: vdichev
Date: Sat Feb 14 00:41:19 2009
New Revision: 744317
URL: http://svn.apache.org/viewvc?rev=744317&view=rev
Log:
Twitter-compatible REST API: support for timelines. Both XML and JSON are
supported. HTTP BASIC Auth is used.
Added:
incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala
(with props)
Modified:
incubator/esme/trunk/server/src/main/scala/bootstrap/liftweb/Boot.scala
Modified:
incubator/esme/trunk/server/src/main/scala/bootstrap/liftweb/Boot.scala
URL:
http://svn.apache.org/viewvc/incubator/esme/trunk/server/src/main/scala/bootstrap/liftweb/Boot.scala?rev=744317&r1=744316&r2=744317&view=diff
==============================================================================
--- incubator/esme/trunk/server/src/main/scala/bootstrap/liftweb/Boot.scala
(original)
+++ incubator/esme/trunk/server/src/main/scala/bootstrap/liftweb/Boot.scala Sat
Feb 14 00:41:19 2009
@@ -23,6 +23,7 @@
import net.liftweb.util._
import net.liftweb.http._
+import net.liftweb.http.auth._
import net.liftweb.sitemap._
import net.liftweb.sitemap.Loc._
import Helpers._
@@ -116,6 +117,15 @@
}
LiftRules.dispatch.prepend(RestAPI.dispatch)
+
+ LiftRules.httpAuthProtectedResource.prepend {
+ case (ParsePath(TwitterAPI.ApiPath :: _, _, _, _)) =>
Full(AuthRole("user"))
+ }
+
+ LiftRules.authentication = TwitterAPI.twitterAuth
+
+ LiftRules.statelessDispatchTable.append(TwitterXmlAPI.dispatch)
+ LiftRules.statelessDispatchTable.append(TwitterJsonAPI.dispatch)
LiftRules.early.append(makeUtf8)
Added:
incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala
URL:
http://svn.apache.org/viewvc/incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala?rev=744317&view=auto
==============================================================================
---
incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala
(added)
+++
incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala
Sat Feb 14 00:41:19 2009
@@ -0,0 +1,246 @@
+/**
+ * Copyright 2008-2009 WorldWide Conferencing, LLC
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+ * RestAPI.scala
+ *
+ * To change this template, choose Tools | Template Manager
+ * and open the template in the editor.
+ */
+
+package org.apache.esme.api
+
+import net.liftweb._
+import http._
+import auth._
+import js._
+import rest._
+import util._
+import mapper._
+import Helpers._
+
+import org.apache.esme._
+import model._
+import actor._
+
+import scala.xml.{NodeSeq, Text, Elem, XML}
+import scala.actors.Actor
+import Actor._
+
+import scala.collection.mutable.ListBuffer
+import java.util.logging._
+
+object TwitterAPI {
+ val ApiPath = "twitter"
+
+ def twitterAuth = HttpBasicAuthentication("esme") {
+ case (user: String, password: String, _) =>
+ !(for(auth <- AuthToken.find(By(AuthToken.uniqueId, password));
+ u <- auth.user.obj
+ if u.nickname == user || u.id == user) yield {
+ userRoles(AuthRole("user"))
+ }).isEmpty
+ }
+
+}
+
+abstract class TwitterAPI {
+ import TwitterAPI.ApiPath
+
+ val tf = new java.text.SimpleDateFormat("EEE MMM dd HH:mm:ss Z yyyy",
java.util.Locale.US)
+ val logger: Logger = Logger.getLogger("org.apache.esme.api")
+ val method: String
+ // TODO: twitter struct could be stronger typed
+ type TwitterResponse = Either[(String,List[Any]),Map[String,Any]]
+
+ def dispatch: LiftRules.DispatchPF
+ protected def dispatchMethod: PartialFunction[Req, () =>
Box[TwitterResponse]] = {
+ case Req(ApiPath :: "statuses" :: "public_timeline" :: Nil, this.method,
GetRequest) => publicTimeline
+ case req @ Req(ApiPath :: "statuses" :: "replies" :: Nil, this.method,
GetRequest) => () => replies(req)
+ case Req(ApiPath :: "direct_messages" :: Nil, this.method, GetRequest) =>
directMessages
+ case req @ Req(ApiPath :: "statuses" :: "friends_timeline" :: Nil,
this.method, GetRequest) => () => friendsTimeline(req)
+ case req @ Req(ApiPath :: "statuses" :: "user_timeline" :: Nil,
this.method, GetRequest) => () => userTimeline(req)
+ // case Req(ApiPath :: "statuses" :: "show" :: Nil, this.method,
GetRequest) => showStatus
+ // case Req(ApiPath :: "statuses" :: "update" :: Nil, this.method,
GetRequest) => () => update(S)
+
+ // case Req(ApiPath :: "statuses" :: "friends" :: Nil, this.method,
GetRequest) => friends
+ // case Req(ApiPath :: "statuses" :: "followers" :: Nil, this.method,
GetRequest) => followers
+ // case Req(ApiPath :: "users" :: "show" :: Nil, this.method, GetRequest)
=> showUser
+
+ // case Req(ApiPath :: "friendships" :: "create" :: Nil, this.method,
GetRequest) => createFriendship(S.param("user"))
+ // case Req(ApiPath :: "friendships" :: "destroy" :: Nil, this.method,
GetRequest) => destroyFriendship(S.param("user"))
+ // case Req(ApiPath :: "friendships" :: "exists" :: Nil, this.method,
GetRequest) => existsFriendship
+
+ case req @ Req(ApiPath :: "account" :: "verify_credentials" :: Nil,
this.method, GetRequest) => () => verifyCredentials(req)
+ // case Req(ApiPath :: "account" :: "end_session" :: Nil, this.method,
GetRequest) => endSession
+ // case Req(ApiPath :: "account" :: "rate_limit_status" :: Nil,
this.method, GetRequest) => rateLimitStatus
+ // case Req(ApiPath :: "update_profile" :: Nil, this.method, GetRequest)
=> updateProfile
+
+ }
+
+ def userAttributes(user: User) = {
+ Map("id" -> user.id,
+ "name" -> (user.firstName + " " + user.lastName),
+ "screen_name" -> user.nickname,
+ "location" -> user.timezone,
+ "profile_image_url" -> user.imageUrl,
+ "followers_count" -> user.followers.size,
+ "description" -> "N/A",
+ "url" -> "",
+ "protected" -> false
+ )
+ }
+
+ def msgAttributes(msg: Message) = {
+ Map("created_at" -> tf.format(new java.util.Date(msg.when.is)),
+ "id" -> msg.id.is,
+ "text" -> msg.getText.trim,
+ "source" -> msg.source,
+ "truncated" -> false,
+ "favorited" -> false,
+ "in_reply_to_status_id" -> None,
+ "in_reply_to_user_id" -> None,
+ "in_reply_to_screen_name" -> None,
+ )
+ }
+
+ def userData(user: User) = {
+ val lastMsg = Message.findAll(By(Message.author, user),
+ OrderBy(Message.id, Descending),
+ MaxRows(1))
+ userAttributes(user) +
+ (("status", lastMsg.map(msgAttributes _).firstOption.getOrElse("")))
+ }
+
+ def msgData(msg: Message) = {
+ val msgUser = User.find(msg.author).get
+ msgAttributes(msg) +
+ (("user", userAttributes(msgUser)))
+ }
+
+ def verifyCredentials(req: Req): Box[TwitterResponse] = {
+ calcUser(req) map { user => Right(Map("user" -> userData(user))) }
+ }
+
+ def friendsTimeline(req: Req): Box[TwitterResponse] = {
+ calcUser(req) map { user =>
+ val statusList =
+ for ((msg, why) <- Mailbox.mostRecentMessagesFor(user.id, 20))
+ yield { msgData(msg) }
+ Right(Map("statuses" -> ("status", statusList) ))
+ }
+ }
+
+ def userTimeline(req: Req): Box[TwitterResponse] = {
+ calcUser(req) map { user =>
+ val statusList =
+ Message.findAll(By(Message.author, user),
+ MaxRows(20),
+ OrderBy(Message.id, Descending)).
+ map(msgData _)
+ Right(Map("statuses" -> ("status", statusList) ))
+ }
+ }
+
+ def replies(req: Req): Box[TwitterResponse] = {
+ userTimeline(req)
+ }
+
+ def directMessages(): Box[TwitterResponse] = {
+ Full(Left("direct_messages" -> Nil))
+ }
+
+ def publicTimeline(): Box[TwitterResponse] = {
+ val statusList =
+ Message.findAll(OrderBy(Message.id, Descending),
+ MaxRows(20)).
+ map(msgData _)
+ Full(Right(Map("statuses" -> ("status", statusList) )))
+ }
+
+ private def calcUser(req: Req): Box[User] =
+ LiftRules.authentication match {
+ case basicAuth: HttpBasicAuthentication =>
+ basicAuth.credentials(req).flatMap(cred => User.findFromWeb(cred._1))
+ }
+
+}
+
+object TwitterXmlAPI extends TwitterAPI with XMLApiHelper {
+
+ override val method = "xml"
+
+ // TODO: construct typed objects instead of strings
+ def toXml(o:Any): String= { o match {
+ case m: Map[Any,Any] => m.foldRight{""} { (e: (_, _), str: String) =>
+ "<" + e._1.toString + ">" + toXml(e._2) + "</" + e._1.toString + ">" +
str }
+ case (label: String, list: List[Any]) => list.foldRight{""} { (e: Any,
str: String) =>
+ "<" + label + ">" + toXml(e) + "</" + label + ">" + str }
+ case None => ""
+ case a: Any => a.toString}
+ }
+
+ override def dispatch: LiftRules.DispatchPF = {
+ // modify the returned function to one which converts the result to XML
+ dispatchMethod.andThen(x =>
+ {() =>
Full(nodeSeqToResponse(XML.loadString(toXml(Either.merge(x().get))))) }
+ )
+ }
+
+ def createTag(in: NodeSeq) = in.first match {
+ case e: Elem => e
+ case _ => <error/>
+ }
+}
+
+object TwitterJsonAPI extends TwitterAPI {
+
+ override val method = "json"
+
+ override def dispatch: LiftRules.DispatchPF = {
+ // modify the returned function to one which converts the result to JSON
+ dispatchMethod.andThen(x =>
+ {() => Full(PlainTextResponse(jsonAttributes(Either.merge(x().get)),
+ ("Content-Type", "application/json") ::
Nil,
+ 200)) }
+ )
+ }
+
+ def jsonAttributes(o: Any): String = { o match {
+ case m: Map[String, Any] => toJson(m.values.next)
+ case o => toJson(o)}
+ }
+
+ // TODO: construct typed objects instead of strings
+ def toJson(o:Any): String= { o match {
+ case (label: String, list: List[Any]) =>
+ list map{ toJson } mkString("[", ",", "]")
+ case m: Map[Any,Any] =>
+ m map { e => '"' + e._1.toString + '"' + ": " + toJson(e._2) }
mkString("{", ",", "}")
+ case i: Int => i toString
+ case l: Long => l toString
+ case b: Boolean => b toString
+ case None => "null"
+ case a: Any => '"' + a.toString + '"'}
+ }
+
+}
+
Propchange:
incubator/esme/trunk/server/src/main/scala/org/apache/esme/api/TwitterAPI.scala
------------------------------------------------------------------------------
svn:executable = *
