Project

rubymuse

0.0
No commit activity in last 3 years
No release in over 3 years
Provides a lightweight Ruby wrapper for the Datamuse API. Datamuse query parameters are passed to the endpoint method as keyword arguments
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 10.0
~> 3.0
>= 0

Runtime

>= 0
 Project Readme

Rubymuse

Rubymuse is a tiny api wrapper for the Datamuse API.

Installation

Add this line to your application's Gemfile:

gem 'rubymuse'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rubymuse

Usage

To construct queries, pass query parameters as keyword arguments to Datamuse::words.

require('rubymuse')

# Find words with a meaning similar to the word 'programming'
Datamuse.words(ml: 'programming')

# Find words with a meaning similiar to the word 'programming' and related to the topic 'television'
Datamuse.words(ml: 'programming', topics: 'television') 

# Find words that rhyme with 'orange'
Datamuse.words(rel_rhy: 'orange')

# Find suggested words based on partial string 'prog'
Datamuse.sug(s: 'prog')

# Find suggested words in Spanish based on partial string 'prog'
Datamuse.sug(s: 'prog', v: 'es')

See Datamuse API for full documentation on Datamuse's query parameters and options.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mosegontar/rubymuse.

License

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