factual-api: A driver for the Factual API

[ api, bsd3, library, web ] [ Propose Tags ]

This is a driver for the Factual API. It provides a type-safe, easy way to generate queries, setup OAuth authentication and send queries to the API.

[Skip to Readme]

Modules

[Index]

Downloads

factual-api-0.3.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

RudigerLippert

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	0.1.0, 0.1.1, 0.1.2, 0.2.0, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 0.4.0, 0.5.0, 0.5.1, 0.5.2, 0.6.0, 0.6.1
Dependencies	aeson (>=0.6.0.0), attoparsec (>=0.10.1.0), base (>=4 && <5), bytestring, containers, hoauth (>=0.3.0), HTTP, text (>=0.11.1.5), unordered-containers (>=0.1.4.6), vector (>=0.9.1) [details]
License	BSD-3-Clause
Copyright	(c) 2012 Rudiger Lippert
Author	Rudiger Lippert <rudy@factual.com>
Maintainer	Rudiger Lippert <rudy@factual.com>
Category	API, Web
Home page	https://github.com/rudyl313/factual-haskell-driver
Bug tracker	https://github.com/rudyl313/factual-haskell-driver/issues
Source repo	head: git clone git://github.com/rudyl313/factual-haskel-driver.git
Uploaded	by RudigerLippert at 2012-06-13T17:03:08Z
Distributions
Reverse Dependencies	1 direct, 0 indirect [details]
Downloads	10354 total (31 in the last 30 days)
Rating	(no votes yet) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs uploaded by user Build status unknown [no reports yet]

Readme for factual-api-0.3.1

[back to package description]

Introduction

This is a Haskell driver for Factual's public API.

Installation

Prerequisites

This driver targets ghc 7.4.1 and The Haskell Platform 2012.2.0.0. Please follow the installation instructions for your specific platform to install ghc and The Haskell Platform.

Installation from cabal

$ cabal install factual-api

Installation from git

$ git clone git@github.com:rudyl313/factual-haskell-driver.git
$ cabal install hoauth
$ cabal install aeson

Tests

Load the tests file into ghci to run the tests:

$ ghci test/Tests.hs

To run the integration tests you'll need an API key and secret, but you can always run the unit tests:

*Main> runUnitTests
Cases: 41  Tried: 41  Errors: 0  Failures: 0
Counts {cases = 41, tried = 41, errors = 0, failures = 0}
*Main> runIntegrationTests "mykey" "mysecret"
Cases: 10  Tried: 10  Errors: 0  Failures: 0
Counts {cases = 10, tried = 10, errors = 0, failures = 0}

Documentation

You can read library documentation by opening docs/index.html in your browser or by visiting the Hackage page.

Examples

See the examples directory for examples of each query type. To run an example go to the project root and execute these commands:

$ ghc -o example examples/ReadExample.hs --make
$ ./example mykey mysecret

In this example replace mykey with your key and mysecret with your secret. Note that compiling the source code generates .o and .hi files in the source directories.

Writes

Although there is code in the current version to support API writes, these features have not yet been implemented in the Factual API. Please refrain from attempting to use these features until they have been officially announced.