Accessing the Heroku REST API via Dispatch

Now that I have an extremely simple Heroku app up and running (see my previous post) and don’t know what to do with it, the logical next step for me was to check out Heroku’s REST API. :)

Ok, so first, let’s look up the REST API documentation…

… but wait, such an abstruse beast does not exist! – Instead, we get the Ruby sources of the Heroku REST client. That’s fine with me, except that I don’t speak Ruby so well. But never mind, this looks easy enough.

Let’s check out what to use as REST client API in Scala: Restlet, Jersey or something? – Nooo! Let’s use Dispatch. Dispatch wins the coolness competition hands down, if you ask me. You’ll see below, I hope.

Of course, I’ll use sbt for building my little project. We add the following two dependencies and are done with it:

libraryDependencies ++= Seq(
  "net.databinder" %% "dispatch-http" % "0.8.5",
  "net.databinder" %% "dispatch-lift-json" % "0.8.5")

Now let’s import all the good stuff:

import dispatch._
import liftjson.Js._

import net.liftweb.json._
import JsonParser._

I’m going to prepare a few helpers next, and then we’re ready to rumble:

implicit val formats = DefaultFormats

val http = new Http
private val user = "*my-heroku-user*"
private val password = "*my-heroku-password*"

val herokuApi = :/("", 443).as(user, password)
val herokuHeaders = Map(
    "Accept" -> "application/json", 
    "X-Heroku-Api-Version" -> "2")

Next, we can login, for example. This will return our api key, mostly (I don’t know yet what it’s good for though, seeing all the basic authentication that’s going on in the Ruby client).

def login = {
  http(resource(herokuApi / "login")
    < < Map("username" -> user, "password" -> password) 
    ># (_.extract[User]) )

def resource(request: Request) = <: < herokuHeaders

(The "< <" and "<: <" above should really be "<<" and "<:<", don't ask me why WordPress puts in a space each time I save this post)

Wait, what's User? I have to define that before the above will work. It's just a simple case class which will be filled by Lift-JSON. And when I'm already at it, I'll define the case class for the next request here, too:

case class User(
    email: String, 
    api_key: String, 
    verified_at: Option[String])

case class HerokuApp(
    id: Int,
    name: String, 
    stack: Option[String], 
    requested_stack: Option[String],
    slug_size: Int, 
    repo_size: Int,
    dynos: Int,
    workers: Int,      
    created_at: String,
    create_status: String,
    repo_migrate_status: String)

Now I can call login and will receive something like this:

This is fun!

Let's use the above HerokuApp case class to request our current Heroku apps:

def apps = http(resource(herokuApi / "apps") 
    ># (_.children map (_.extract[HerokuApp])))

Uhm... - yup, that's all there is to it. This returns a convenient list of apps I have running on Heroku:
List(HerokuApp(*my-id*,*my-app-name*,Some(cedar),None,*large-number-1*,*large-number-2*,0,0,2011/10/10 11:52:03 -0700,complete,complete))

This is great, isn't it? - I at least had no idea that it would turn out to be so very easy to connect to Heroku from Scala.

I still don't know what to put up on Heroku, though...

Posted in Scala by jmhofer at October 11th, 2011.
Tags: , , , ,

6 Responses to “Accessing the Heroku REST API via Dispatch”

  1. […] Scala.I still don't know what to put up on Heroku, though… Tweet This Post  Eclipse Read the full post on Planet Eclipse… Share […]

  2. Bananeweizen says:


    please make only Eclipse related stuff available in the PlanetEclipse syndication feed.

    Thanks, Michael

    • jmhofer says:


      I’m sorry, but I don’t know how to do that.

      Could you perhaps provide me a link to some kind of tutorial for this? I haven’t found anything that tells me how to tell PlanetEclipse what it should take from my blog and what it shouldn’t.

    • jmhofer says:

      Actually, I have found out that the “Eclipse-only” feed is available via the tag:

      I’ve also added a category for Eclipse, so that would be another possibility.

      I’ll post the tag-based feed to the Planet Eclipse admins, maybe they’ll update to reduce the noise for you (sorry about that).

  3. James Ward says:

    This is great! Thanks for sharing this. Have you seen:

    They have a bunch of the Heroku REST APIs already implemented in Scala / Dispatch.


Leave a Reply