Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 110 lines (76 sloc) 3.209 kb
7cba1cce »
2011-11-21 Prototype of CalendarList data structure
1 Note: **Click on `README.md` in the directory view to have working relative
2 links.**
d8549498 »
2011-11-17 Fix README
3
37fcd904 »
2011-11-17 Add simple documentation
4 Google APIs Client library for OCaml
5 ====================================
6
390609ba »
2011-12-07 README minor changes
7 **gapi-ocaml** is a simple, unofficial, OCaml client for Google Services. The
8 library supports ClientLogin, OAuth 1.0a, and OAuth 2.0 authentication.
9 Supported RESTful APIs:
37fcd904 »
2011-11-17 Add simple documentation
10
4b1ec251 »
2012-01-08 Update README
11 * Calendar APIs v3 (JSON based)
fad6b1b7 »
2011-12-08 Add Google+ data model test
12 * Google+ API v1
9cbf3d62 »
2011-12-09 Add tasks data model and tests
13 * Tasks API v1
4b1ec251 »
2012-01-08 Update README
14 * APIs Discovery Service v1
15 * URL Shortener API v1
16 * OAuth2 API v2
fad6b1b7 »
2011-12-08 Add Google+ data model test
17
18 Old versions:
1ff94b21 »
2011-12-10 Fix bullet points in README
19
fad6b1b7 »
2011-12-08 Add Google+ data model test
20 * Calendar Data API v2 (Atom based)
37fcd904 »
2011-11-17 Add simple documentation
21
48203bf4 »
2011-11-28 Update README
22 ### Features
23
24 * Monadic interface
2032d6df »
2012-01-14 Update documentation and authorization examples
25 * [Functional lenses](src/gapi/gapiLens.mli) to access data structures
4b1ec251 »
2012-01-08 Update README
26 * Service generator (experimental): a tool for generating client libraries for
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
27 APIs based on the Google API Discovery format
37fcd904 »
2011-11-17 Add simple documentation
28
29 Building gapi-ocaml
30 ------------------
31
32 ### Requirements
33
875c0905 »
2011-12-19 Update dependencies in README.md
34 This library was developed with the following dependencies ([Unofficial OCaml
35 packages for Debian](http://ocaml.debian.net/debian/ocaml-3.12.1/)):
37fcd904 »
2011-11-17 Add simple documentation
36
875c0905 »
2011-12-19 Update dependencies in README.md
37 * [OCaml][] = 3.12.1
38 * [Findlib][] = 1.2.7
39 * [Ocamlnet][] = 3.3.5
37fcd904 »
2011-11-17 Add simple documentation
40 * [Ocurl][] = 0.5.3
41 * [Cryptokit][] = 1.3.14
42 * [ExtLib][] = 1.5.1
43 * [json-wheel][] = 1.0.6
44 * [Xmlm][] = 1.0.2
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
45 * [pa_monad][] = 6.0 (syntax extension for Monads, optional)
46 * [OUnit][] = 1.1.0 (to build and run the tests, optional)
37fcd904 »
2011-11-17 Add simple documentation
47
48 [OCaml]: http://caml.inria.fr/ocaml/release.en.html
49 [Findlib]: http://projects.camlcity.org/projects/findlib.html/
50 [Ocamlnet]: http://projects.camlcity.org/projects/ocamlnet.html
51 [Ocurl]: http://sourceforge.net/projects/ocurl/
52 [Cryptokit]: http://forge.ocamlcore.org/projects/cryptokit/
53 [ExtLib]: http://code.google.com/p/ocaml-extlib/
54 [json-wheel]: http://martin.jambon.free.fr/json-wheel.html
55 [Xmlm]: http://erratique.ch/software/xmlm/doc/Xmlm
56 [pa_monad]: http://www.cas.mcmaster.ca/~carette/pa_monad/
57 [OUnit]: http://ounit.forge.ocamlcore.org/
58
2032d6df »
2012-01-14 Update documentation and authorization examples
59 ### Configuration and installation
37fcd904 »
2011-11-17 Add simple documentation
60
2032d6df »
2012-01-14 Update documentation and authorization examples
61 This project provides 2 libraries:
37fcd904 »
2011-11-17 Add simple documentation
62
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
63 * `gapi`: Google APIs client library
64 * `gdata`: Google Data Protocol client library
37fcd904 »
2011-11-17 Add simple documentation
65
2032d6df »
2012-01-14 Update documentation and authorization examples
66 and 1 executable:
37fcd904 »
2011-11-17 Add simple documentation
67
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
68 * `serviceGenerator`: Tool used to generate strongly typed client libraries for
2032d6df »
2012-01-14 Update documentation and authorization examples
69 Discovery-based services
37fcd904 »
2011-11-17 Add simple documentation
70
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
71 To build the libraries and the executable, run
37fcd904 »
2011-11-17 Add simple documentation
72
2032d6df »
2012-01-14 Update documentation and authorization examples
73 $ ocaml setup.ml -configure
74 $ ocaml setup.ml -build
ccefbc5f »
2012-01-14 Update README, setup.ml and clean tree
75
76 To install the libraries and the executable, run (as root, if your user
77 doesn't have enough privileges)
78
2032d6df »
2012-01-14 Update documentation and authorization examples
79 $ ocaml setup.ml -install
c1629e17 »
2011-12-07 Add instructions to generate documentation
80
2032d6df »
2012-01-14 Update documentation and authorization examples
81 To run the tests, execute
c1629e17 »
2011-12-07 Add instructions to generate documentation
82
2032d6df »
2012-01-14 Update documentation and authorization examples
83 $ ocaml setup.ml -test
84
85 See [tests README](src/test/README.md) for further details regarding the tests.
86
87 To generate the documentation, run
88
89 $ ocaml setup.ml -doc
90
91 Then you can browse the HTML documentation starting from
92 `gapi-ocaml.docdir/index.html`, but is not installed by default.
93
94 To uninstall anything that was previously installed, execute
95
96 $ ocaml setup.ml -uninstall
c1629e17 »
2011-12-07 Add instructions to generate documentation
97
37fcd904 »
2011-11-17 Add simple documentation
98 ### Usage
99
f741ddfe »
2011-11-17 README Wording
100 See [auth examples](src/examples/auth) for some examples of how to use
101 Google's authorization endpoints.
37fcd904 »
2011-11-17 Add simple documentation
102
f741ddfe »
2011-11-17 README Wording
103 See [monadic test](src/test/testMonadic.ml) for an example of how to use the
104 monadic interface.
37fcd904 »
2011-11-17 Add simple documentation
105
48203bf4 »
2011-11-28 Update README
106 See [calendar v3 test](src/test/testCalendarModelV3.ml) for an example of how
107 to use functional lenses to read and modify calendar data.
108
2032d6df »
2012-01-14 Update documentation and authorization examples
109 See [tools README](src/tools/README.md) for the instructions of how to run the
110 service generator utility.
111
Something went wrong with that request. Please try again.