Sha256: b6cebe1ecbe9093648e13772cc872dffeff3d197720f19f218d2fa6b7839fb0c

Contents?: true

Size: 1.26 KB

Versions: 1

Compression:

Stored size: 1.26 KB

Contents

# OpenAustralia [![Build Status](https://secure.travis-ci.org/henare/openaustralia-api.png?branch=master)](http://travis-ci.org/henare/openaustralia-api) [![Gem Version](https://badge.fury.io/rb/openaustralia.svg)](http://badge.fury.io/rb/openaustralia)

A Ruby wrapper for the [OpenAustralia API](http://www.openaustralia.org/api/).

## Requirements

* An account on openaustralia.org
* An API key obtained from http://openaustralia.org/api

## Installation

Add this line to your application's Gemfile:

    gem 'openaustralia'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install openaustralia

## Features/problems

* Wraps the current API calls
* So far no validation on validity of parameters or search terms

## Usage

    # spit out excerpts of what's been said
    # about the emissions trading scheme

    require 'openaustralia'

    api = OpenAustralia::Api.new 'YOUR-API-KEY-HERE'

    search = api.get_hansard :search => 'emissions trading'
    search.results.each do |result|
      puts result.body
    end

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
openaustralia-1.0.2 README.md