free_dictionary_api

Free Dictionary API

A ruby gem to interface with the Free Dictionary API.

Installation

gem install free_dictionary_api

Usage

# Initialize the client
client = FreeDictionaryApi::Client.new

# Look up a word
results = client.lookup('hello')

# Access the first result
word = results.first

# Get basic information
puts word.word        # => "hello"
puts word.phonetic    # => "həˈləʊ"
puts word.origin      # => "early 19th century: variant of earlier hollo..."

# Get all definitions
word.definitions.each do |definition|
  puts definition['definition']
end

# Get parts of speech
puts word.parts_of_speech  # => ["exclamation", "noun", "verb"]

# Get examples
puts word.examples        # => ["hello there, Katie!", ...]

# Get synonyms and antonyms
puts word.synonyms
puts word.antonyms

# Works with multi-word phrases too
results = client.lookup('give up')

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Codeberg at https://codeberg.org/bendangelo/free_dictionary_api.

License

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