free_dictionary_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32c267cbbe88cdf72ef360bef124776f2374c5cdb812948f534792b31081cc2a
+  data.tar.gz: 57f87b53a62f638ff1d96996a5962609ac315f2bb7c11d57195c4239cdcb6710
+SHA512:
+  metadata.gz: bdcd6366d5b330dee4511ce2fd79a66c521edf503f0eb27cf1fff0e01d18114e59c24ffedba1dc87a861b3140116a58e5f425eccd820fd9ba95280e54053bd31
+  data.tar.gz: 06f95c0aec6f9adecc609fa1d23edc5baec1436010082db2b20f9c43f0c11bd45578344fac4e6e72068484a5b3c04d9221f58784f83743a99db9a2d6b96e9370

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ben D'Angelo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Free Dictionary API
+
+A ruby gem to interface with the [Free Dictionary API](https://github.com/meetDeveloper/freeDictionaryAPI).
+
+## 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](https://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](https://opensource.org/licenses/MIT).

data/lib/free_dictionary_api/version.rb

@@ -0,0 +1,3 @@
+module FreeDictionaryApi
+  VERSION = "0.1.0"
+end

data/lib/free_dictionary_api/word.rb

@@ -0,0 +1,33 @@
+module FreeDictionaryApi
+  class Word
+    attr_reader :word, :phonetic, :phonetics, :origin, :meanings
+
+    def initialize(data)
+      @word = data['word']
+      @phonetic = data['phonetic']
+      @phonetics = data['phonetics']
+      @origin = data['origin']
+      @meanings = data['meanings']
+    end
+
+    def definitions
+      meanings.flat_map { |meaning| meaning['definitions'] }
+    end
+
+    def parts_of_speech
+      meanings.map { |meaning| meaning['partOfSpeech'] }.uniq
+    end
+
+    def examples
+      definitions.map { |definition| definition['example'] }.compact
+    end
+
+    def synonyms
+      definitions.flat_map { |definition| definition['synonyms'] }.compact
+    end
+
+    def antonyms
+      definitions.flat_map { |definition| definition['antonyms'] }.compact
+    end
+  end
+end

data/lib/free_dictionary_api.rb

@@ -0,0 +1,43 @@
+require 'net/http'
+require 'json'
+require 'uri'
+require_relative 'free_dictionary_api/version'
+require_relative 'free_dictionary_api/word'
+
+module FreeDictionaryApi
+  class Error < StandardError; end
+
+  class Client
+    BASE_URL = 'https://api.dictionaryapi.dev/api/v2/entries/en'.freeze
+    PARSER = URI::Parser.new
+
+    def lookup(word)
+      encoded_word = PARSER.escape(word)
+      uri = URI("#{BASE_URL}/#{encoded_word}")
+      response = Net::HTTP.get_response(uri)
+
+      case response
+      when Net::HTTPSuccess
+        parse_response(response.body)
+      else
+        handle_error(response)
+      end
+    end
+
+    private
+
+    def parse_response(body)
+      data = JSON.parse(body)
+      data.map { |word_data| Word.new(word_data) }
+    end
+
+    def handle_error(response)
+      case response.code
+      when '404'
+        raise Error, "Word not found"
+      else
+        raise Error, "API request failed with status #{response.code}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: free_dictionary_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben D'Angelo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: A Ruby wrapper for the Free Dictionary API (https://dictionaryapi.dev/)
+email:
+- ben@bendangelo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/free_dictionary_api.rb
+- lib/free_dictionary_api/version.rb
+- lib/free_dictionary_api/word.rb
+homepage: https://codeberg.org/bendangelo/free_dictionary_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://codeberg.org/bendangelo/free_dictionary_api
+  source_code_uri: https://codeberg.org/bendangelo/free_dictionary_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: Ruby client for the Free Dictionary API
+test_files: []