Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 123 lines (88 sloc) 3.475 kb

Google APIs Client library for OCaml

gapi-ocaml is a simple, unofficial, OCaml client for Google Services. The library supports ClientLogin, OAuth 1.0a, and OAuth 2.0 authentication. Supported RESTful APIs:

  • Calendar APIs v3
  • Google+ API v1
  • Tasks API v1
  • APIs Discovery Service v1
  • URL Shortener API v1
  • OAuth2 API v2
  • Custom Search API v1
  • Google Analytics API v3
  • Page Speed Online API v1
  • Blogger API v2
  • Site Verification API v1
  • AdSense Management API v1.1
  • BigQuery API v2
  • Drive API v2

Google Data Protocol APIs (GData):

  • Google Documents List API v3 (supports Google Drive)

Features

  • Monadic interface
  • Functional lenses to access data structures
  • Service generator (experimental): a tool for generating client libraries for APIs based on the Google API Discovery format

Building gapi-ocaml

Requirements

You will need the following libraries:

This library was developed and tested on Ubuntu 12.04 LTS (64-bit).

Configuration and installation

This project provides 2 libraries:

  • gapi-ocaml: Google APIs client library
  • gapi-ocaml.gdata: Google Data Protocol client library

To build the libraries, run

$ ocaml setup.ml -configure
$ ocaml setup.ml -build

To install the libraries, run (as root, if your user doesn't have enough privileges)

$ ocaml setup.ml -install

To build and run the tests (you will need pa_monad_custom), execute

$ ocaml setup.ml -configure --enable-tests
$ ocaml setup.ml -build
$ ocaml setup.ml -test

See src/test/README.md for further details regarding the tests.

To build the examples:

$ ocaml setup.ml -configure --enable-examples
$ ocaml setup.ml -build

See examples/README.md for further details regarding the examples.

To generate the documentation, run

$ ocaml setup.ml -doc

Then you can browse the HTML documentation starting from gapi-ocaml.docdir/index.html, but is not installed by default.

To uninstall anything that was previously installed, execute

$ ocaml setup.ml -uninstall

Usage

See auth examples in examples/auth for some examples of how to use Google's authorization endpoints.

See examples directory to find code samples that show usage of some services.

See tools/serviceGenerator.ml for a complex example of how to use functional lenses within the state monad.

See tools/README.md for the instructions of how to build and run the service generator utility.

Something went wrong with that request. Please try again.