# Parliament::Opensearch
[parliament-opensearch](http://github.com/ukparliament/opensearch) is a gem created by the [Parliamentary Digital Service](https://www.parliament.uk/mps-lords-and-offices/offices/bicameral/parliamentary-digital-service/) to allow connections to and the processing of data from OpenSearch APIs.

> **NOTE:** This gem is in active development and is likely to change at short notice. It is not recommended that you use this in any production environment.

## Requirements
[parliament-opensearch](http://github.com/ukparliament/opensearch) requires the following:
* [Ruby](https://www.ruby-lang.org/en/)
* [Bundler](http://http://bundler.io/)
* [parliament-ruby](https://rubygems.org/gems/parliament-ruby)

## Installation

Add this line to your application's Gemfile:

This gem is currently not available on RubyGems. To use it in an application, install it directly from GitHub via your Gemfile
```bash
gem 'parliament-opensearch', git: 'https://github.com/ukparliament/parliament-opensearch.git', branch: 'master'
```

You will also need to include the parliament-ruby gem.  Add the following to your Gemfile:
```
gem 'parliament-ruby'
```
then run:
```
bundle install
```

## Usage

This gem's main function is fetching data from an OpenSearch API and parsing it.

> **Note:** Comprehensive class documentation can be found on [rubydocs](http://www.rubydoc.info/github/ukparliament/parliament-opensearch/master/file/README.md).


## Getting Started with Development
To clone the repository and set up the dependencies, run the following:
```bash
git clone https://github.com/ukparliament/parliament-opensearch.git
cd parliament-opensearch
bundle install
```

### Running the tests
We use [RSpec](http://rspec.info/) as our testing framework and tests can be run using:
```bash
bundle exec rake
```

## Contributing
If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.

1. Fork the repository
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Ensure your changes are tested using [Rspec](http://rspec.info/)
1. Create a new Pull Request