singlebrook/gnip-rule

# gnip-rule
This gem simplifies the effort to add/delete/list rules using the [Gnip Rules
API](http://support.gnip.com/apis/powertrack/api_reference.html). It handles HTTP
request/response and helps your rules conform to Gnip's restrictions.

## Installation
`gem install gnip-rule` or add the following to your `Gemfile`:

```ruby
gem 'gnip-rule'
```

## Usage

```ruby
require 'gnip-rule'

rules = GnipRule::Client.new(API_URL, USERNAME, PASSWORD)

# Add as a String, Rule, or Array of either
rules.add('foo')
rules.add('bar', 'tag')
rules.add(['foo', 'bar', 'baz'], 'tag')
rules.add(GnipRule::Rule.new('value', 'tag'))
rules.add([GnipRule::Rule.new('foo', 'bar'), GnipRule::Rule.new('baz', 'tag2')])

# Same with delete
rules.delete('baz', 'tag')
rules.delete(['foo', 'bar'])
rules.delete(GnipRule::Rule.new('value', 'tag'))

# Get all rules
rules_list = rules.list()
rules_list.each { |rule| rule.valid? }
jsonified = rules_list.map { |rule| rule.as_json `}
rules_tagged_foo = rules_list.select { |rule| rule.tag == 'foo' }
```

## Compatibility
See [.travis.yml](.travis.yml) for Ruby versions used in testing.

## Contributing
[![Build Status](https://secure.travis-ci.org/singlebrook/gnip-rule.png)](http://travis-ci.org/singlebrook/gnip-rule)
[![Code Climate](https://codeclimate.com/github/singlebrook/gnip-rule.png)](https://codeclimate.com/github/singlebrook/gnip-rule)
[![Coverage Status](https://coveralls.io/repos/singlebrook/gnip-rule/badge.png?branch=master)](https://coveralls.io/r/singlebrook/gnip-rule)

When submitting pull requests, please do the following to make it easier to incorporate
your changes:

* Include unit and/or functional specs that validate changes you're making.
* Rebase your changes onto the HEAD of my fork if you can do so cleanly.
* If submitting additional functionality, provide an example of how to use it.
* Please keep code style consistent with surrounding code.

### Testing
You can run all tests by simply running `bundle exec rake test` from your favorite shell.

## License
Licenced under the [MIT License](http://www.opensource.org/licenses/mit-license.php)

@eriwen and @singlebrook wrote this software. It is provided free of charge. If you find
it helpful, please endorse @eriwen on coderwall:
[![endorse](http://api.coderwall.com/eriwen/endorsecount.png)](http://coderwall.com/eriwen)
and check out [Singlebrook](http://singlebrook.com).