com.socrata.soda2.consumer.LowLevel.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soda-consumer-scala_2.9.1 Show documentation
soda-consumer-scala
The newest version!
package com.socrata.soda2.consumer

import java.net.URI

import com.rojoma.json.ast.JValue

import com.socrata.soda2.consumer.impl.QueryDisambiguator
import com.socrata.future.Future
import com.socrata.iteratee.CharIteratee
import com.socrata.soda2.{Resource, Soda2Metadata}

// Should this be moved to the soda2 package?  It's not a consumer-specific thing...

/** Very low-level access to a SODA2 server.  This encapsulates all HTTP actions so higher-level code
 * such as a [[com.socrata.soda2.consumer.Consumer]] object can deal purely with the data returned. */
trait LowLevel {
  /** Executes a GET query against a SODA2 server and feeds the character data returned into the given
   * [[com.socrata.iteratee.Iteratee]].
   *
   * @param resource The resource to retrieve.
   * @param parameters The values to feed into query.
   * @param iteratee A handler for the response. */
  def get[T](resource: Resource, parameters: Map[String, Seq[String]], iteratee: (URI, Soda2Metadata) => CharIteratee[T]): Future[T]

  /** Executes a GET query against a SODA2 server and feeds the character data returned into the given
   * [[com.socrata.iteratee.Iteratee]].
   *
   * @param resource The resource to retrieve.
   * @param parameters The values to feed into query.
   * @param iteratee A handler for the response. */
  def get[T](resource: Resource, parameters: Map[String, String], iteratee: (URI, Soda2Metadata) => CharIteratee[T])(implicit stupidErasure: QueryDisambiguator): Future[T] =
    get(resource, parameters.mapValues(Seq(_)), iteratee)

  /** Executes a POST query against a SODA2 server and feeds the character data returned into the given
   * [[com.socrata.iteratee.Iteratee]].
   *
   * @param resource The resource to which to send the JSON.
   * @param jvalue The JSON to serialize into the request.
   * @param iteratee A handler for the response. */
  def postJson[T](resource: Resource, jvalue: JValue, iteratee: (URI, Soda2Metadata) => CharIteratee[T]): Future[T]

  /** Executes a PUT query against a SODA2 server and feeds the character data returned into the given
   * [[com.socrata.iteratee.Iteratee]].
   *
   * @param resource The resource to which to send the JSON.
   * @param jvalue The JSON to serialize into the request.
   * @param iteratee A handler for the response. */
  def putJson[T](resource: Resource, jvalue: JValue, iteratee: (URI, Soda2Metadata) => CharIteratee[T]): Future[T]

  // All the remaining methods are actually SODA1 methods that we must support but
  // which do not map neatly into a simple operation-on-a-Resource.  Instead they
  // use the given Resources to construct URLs corresponding to legacy SODA1 endpoints
  // and manipulate them.

  def legacyMakeWorkingCopy[T](resource: Resource, copyRows: Boolean, iteratee: (URI, Soda2Metadata) => CharIteratee[T]): Future[T]
  def legacyPublish[T](workingCopy: Resource, iteratee: (URI, Soda2Metadata) => CharIteratee[T]): Future[T]
}