# Newznab::Api

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/newznab/api`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'newznab-api'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install newznab-api

Then set a environmental variables named `NEWZNAB_API_KEY` and `NEWZNAB_URI` to auto connect **(optional)**

    $ export NEWZNAB_URI=https://api.newznab.com
    $ export NEWZNAB_API_KEY=7e8896464895c1cde33759b8307f5cf8


## Usage

If you did not set the env variables `NEWZNAB_API_KEY` or `NEWZNAB_URI` then you need to set the class `api_key` and `uri` before using. If you did set the env variable you do not need to set this.

```ruby
Newznab::Api.new(uri: 'https://api.newznab.com', key: '7e8896464895c1cde33759b8307f5cf8')
```


Perform a search:

```ruby
resp = newznab.search(query: 'This Old House', limit: 50)
```




## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kalinon/newznab-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).