Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/malandrina/word_reference
A Ruby wrapper for the WordReference API
https://github.com/malandrina/word_reference
Last synced: 3 months ago
JSON representation
A Ruby wrapper for the WordReference API
- Host: GitHub
- URL: https://github.com/malandrina/word_reference
- Owner: malandrina
- License: mit
- Created: 2012-11-08T22:12:57.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-10-22T17:24:37.000Z (about 10 years ago)
- Last Synced: 2024-07-17T14:17:38.357Z (4 months ago)
- Language: Ruby
- Size: 146 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordReference
Authors: [malandrina](https://github.com/malandrina), [sandbochs](https://github.com/sandbochs)
A Ruby wrapper for the [WordReference.com](http://www.wordreference.com) Dictionary API
Documentation for the API can be found here: http://www.wordreference.com/docs/api.aspx
## TODO
- Handle exceptions
- Handle errors from WordReference.com API
- Add interface for thesaurus API
- Install Travis CI
## Installation
Add this line to your application's Gemfile:
gem 'word_reference'
And then execute:
$ bundle
Or install it yourself as:
$ gem install word_reference
## Usage
Include WordReference module
```ruby
include WordReference
```
In order to query the WordReference.com API, you will need an API key. You can get one here: http://www.wordreference.com/docs/APIregistration.aspx
Configure your API key
```ruby
WordReference.configure do |config|
config.api_key = YOUR_API_KEY
end
```
Create a new dictionary
A dictionary is referenced by a four-letter code comprising the original language and target language. Note that the WordReference.com API currently supports translations to or from English. If the dictionary does not exist (ex. 'czzh'), the API will return an error message. A list of two-letter language codes is provided below.
```ruby
french_dictionary = Dictionary.new('enfr')
```
- Arabic: ar
- Chinese: zh
- Czech: cz
- English: en
- French: fr
- Greek: gr
- Italian: it
- Japanese: ja
- Korean: ko
- Polish: pl
- Portuguese: pt
- Romanian: ro
- Spanish: es
- Turkish: tr
Change dictionary
```ruby
french_dictionary.change_language('iten')
# Or create another dictionary
italian_dictionary = Dictionary.new('iten')
```
Query API with term
Query terms which include special characters should be converted to UTF-8 Base 16. ("más" => "m%C3%A1s")
[UTF Converter](http://macchiato.com/unicode/convert.html)
```ruby
# Returns a Query object
query = italian_dictionary.query('chiave')
```
Get query results
```ruby
# Returns an array of translations
query.results
```
When #query is called on a dictionary, a collection of translation objects is returned.
Get original search term
```ruby
translation = query.results.first
translation.search_term => {"term"=>"chiave", "POS"=>"nf", "sense"=>"strumento per aprire", "usage"=>"letterale"}
translation.search_term['term'] => 'chiave'
translation.search_term['POS'] => 'nf' # 'POS' stands for 'Particle of Speech'
translation.search_term['sense'] => 'strumento per aprire'
translation.search_term['usage'] => 'letterale'
```
Get translations
```ruby
translation = query.results.first
first = translation.results.first
first => {"term"=>"key", "POS"=>"n", "sense"=>""}
first['term'] => 'key'
first['POS'] => 'n' # noun
first['sense'] => '' # no sense
first['usage'] => nil
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request