Build Status

Ann-Ruby

Ruby client for ANN.

Installation

Add this line to your application's Gemfile:

gem "ann"

And then execute:

bundle install

Or install it yourself as:

gem install ann

Usage

# To start, create a client
ann = Ann::Client.new(url: "https://ann.example.com")

Development

To run the tests, run:

docker-compose run --rm ann-ruby rake spec

You can also run the following command for an interactive prompt that will allow you to experiment.

docker-compose run --rm ann-ruby bin/console

For added flexibility, you can use Bash.

docker-compose run --rm ann-ruby bash

Build

Add the gem repo to your configuration:

# keep @ AS IS
curl -u<USERNAME>:<PASSWORD> \
  https://na.artifactory.swg-devops.com/artifactory/api/gems/apset-ruby/api/v1/api_key.yaml \
  > ~/.gem/credentials

Build the gem:

gem build ann.gemspec

Install the gem locally: (optional)

gem install ann-*.gem

Push the gem:

gem push ann-*.gem
rm ann-*.gem

License

Please refer to LICENSE.

Authors