Popularity
0.5
Stable
Activity
0.0
Declining
0
4
1

Description

A simple ruby wrapper to use your self hosted Polr API

Monthly Downloads: 5
Programming language: Ruby
License: MIT License
Tags: Cloud     Third-party APIs     API Wrapper    
Latest version: v1.0.0

Polr alternatives and similar gems

Based on the "Third-party APIs" category

Do you think we are missing an alternative of Polr or a related project?

Add another 'Third-party APIs' Gem

README

Polr

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/polr. 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:

gem 'polr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install polr

Usage

TODO: Write usage instructions here

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/polr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

TODO :

  • Support HTTPS
  • Add tests on active Polr server with valid API KEY
  • Allow choice between JSON or Plain text

License

The gem is available as open source under the terms of the MIT License.


*Note that all licence references and agreements mentioned in the Polr README section above are relevant to that project's source code only.