0.0
No commit activity in last 3 years
No release in over 3 years
Acceleration provides a succinct, ActiveResource-style interface to a the IBM Watson Explorer Foundational Components Engine search platform instance's REST API. Acceleration is derived from Velocity, the original name for Engine.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.14.0
>= 0
>= 0
~> 0.3.0
>= 0

Runtime

 Project Readme

Acceleration

A succinct interface to the IBM Watson Explorer Foundational Components Engine REST API

by Colin Dean colindean@us.ibm.com

Introduction

Acceleration provides a succinct, ActiveResource-style interface to a IBM Watson Explorer Foundational Components (WEX-FC) Engine search platform instance's REST API.

The name comes from WEX-FC's pre-acquisition name, VivĂ­simo Velocity. Acceleration is derived from Velocity. Get it?

License

This library is property of IBM Corporation and licensed under the MIT license. See LICENSE.md for license terms.

(C) Copyright IBM Corporation. 2012-2016. AWSOM WAT056420161228.

Installation

gem install acceleration

Contributing

Please test all changes against Ruby 1.9.3+ and JRuby 1.7+. Proper testing infrastructure is more than welcome!

Getting started

Check out the source:

git clone git@github.com:Watson-Explorer/acceleration-ruby.git
cd acceleration

Install dependencies:

gem install bundler
bundle install

Generate documentation:

rake doc

Now you're clear for hacking. Open the docs with open doc/index.html to learn how to use it. The top-level class is actually Velocity.

Releasing

Acceleration uses semantic versioning. Once all work for a version is committed, increment the version number in lib/acceleration/version.rb and execute semver inc patch, or whatever else is appropriate for the release. Then, commit the changes to lib/acceleration/version.rb and .semver with git commit -a -m "version $(semver tag)" and then tag it with git tag $(semver tag).