The factual-api package

[Tags: bsd3, library]

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]

Properties

Versions0.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
Change logNone available
Dependenciesaeson (>=0.6.0.0), attoparsec (>=0.10.1.0), base (==4.*), bytestring, containers, curl (>=1.3.7), dataenc (>=0.14.0.3), hoauth (>=0.3.5), HTTP, MissingH (>=1.0.0), text (>=0.11.1.5), unordered-containers (>=0.1.4.6), utf8-string (>=0.3.7), vector (>=0.9.1) [details]
LicenseBSD3
Copyright(c) 2012 Rudiger Lippert
AuthorRudiger Lippert <rudy@factual.com>
MaintainerRudiger Lippert <rudy@factual.com>
Stabilitystable
CategoryAPI, Web
Home pagehttps://github.com/rudyl313/factual-haskell-driver
Bug trackerhttps://github.com/rudyl313/factual-haskell-driver/issues
Source repositoryhead: git clone git://github.com/rudyl313/factual-haskel-driver.git
UploadedFri Oct 26 21:20:52 UTC 2012 by RudigerLippert
Downloads2026 total (95 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for factual-api-0.6.0

Introduction

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

Features

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.

You'll need a Factual account to use this driver. If you don't have one yet, it's free and easy to get one.

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
$ cabal install MissingH

Tests

To run the integration tests you'll need an to create a yaml file at ~/.factual/factual-auth.yaml to store your Factual credentials:

---
key: MYKEY
secret: MYSECRET

Load the tests file into ghci to run the tests:

$ ghci test/Tests.hs

Next you use the following functions to run the unit and integration tests respectively:

*Main> runUnitTests
Cases: 53  Tried: 53  Errors: 0  Failures: 0
Counts {cases = 53, tried = 53, errors = 0, failures = 0}
*Main> runIntegrationTests
Cases: 14  Tried: 14  Errors: 0  Failures: 0
Counts {cases = 14, tried = 14, errors = 0, failures = 0}

Documentation

You can read library documentation by visiting the Hackage page.

The github wiki also provides thorough documentation and examples for each feature.

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.