Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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