wiktionary_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d197bdd3a4ca0783154ddee36287d5bf96b63693fc1ceb7e2161771fe5281559
+  data.tar.gz: 573bcc23d48203a941a4b8b5630409cb80271a97ec4b6d900dc6ae53d12553eb
+SHA512:
+  metadata.gz: 2d37db76704da2f422f6d6e518696e94bacd437fe06bf9d2e2a87d10b77507bbe05ef201bdd44e1d761ccc3722613ecaa9ab5409a1666ea44a6d5d145d627c78
+  data.tar.gz: d6c7ad9b8abdb654a4956e67d57588d9c86a7652d4d3b13a820dabc502e10b026baaafca265a481316e2765080880173ae10afdf44b0377e75249b110e3654e6

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,53 @@
+# Wiktionary API
+
+A ruby gem to interface with the [Wiktionary API](https://en.wiktionary.org/api/rest_v1/).
+
+## Installation
+
+```
+gem install wiktionary_api
+```
+
+## Usage
+
+```
+# Initialize the client
+client = WiktionaryAPI::Client.new
+
+# Look up a word
+results = client.lookup('hello')
+
+# Access the first result
+word = results.first
+
+# Get basic information
+puts word.part_of_speech        # => "Interjection"
+
+# Get all definitions
+word.definitions.each do |definition|
+  puts definition # => "A greeting (salutation) said when meeting someone or acknowledging someone’s arrival or presence."
+end
+
+# Get examples
+puts word.examples        # => ["Hello, everyone.", ...]
+
+# Works with multi-word phrases too
+results = client.lookup('give up')
+
+# Works with words with apostrophes
+results = client.lookup("I'll")
+```
+
+## 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/wiktionary_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/wiktionary_api/version.rb

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

data/lib/wiktionary_api/word.rb

@@ -0,0 +1,24 @@
+module WiktionaryAPI
+  class Word
+    attr_reader :part_of_speech, :language
+
+    def initialize(data)
+      @part_of_speech = data['partOfSpeech']
+      @language = data['language']
+      @definitions = data['definitions']
+    end
+
+    def definitions
+      @definitions.flat_map { |meaning| ::Nokogiri::HTML(meaning['definition']).text.strip }
+    end
+
+    def examples
+      @definitions.flat_map do |definition|
+        definition["examples"].map do |e|
+          ::Nokogiri::HTML(e).text.strip
+        end
+      end.compact
+    end
+
+  end
+end

data/lib/wiktionary_api.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+require 'json'
+require 'nokogiri'
+require 'uri'
+require 'cgi'
+require_relative 'wiktionary_api/version'
+require_relative 'wiktionary_api/word'
+
+module WiktionaryAPI
+  class Error < StandardError; end
+
+  class Client
+    BASE_URL = 'https://en.wiktionary.org/api/rest_v1/page/definition'.freeze
+
+    def self.lookup word, lang: :en
+      self.new.lookup word
+    end
+
+    def self.lookup! word, lang: :en
+      self.new.lookup! word
+    end
+
+    def lookup(word, lang: :en)
+      look_up_internal word, raise_error: false, lang: lang
+    end
+
+    def lookup!(word, lang: :en)
+      look_up_internal word, raise_error: true, lang: lang
+    end
+
+    private
+
+    def look_up_internal word, raise_error: false, lang: :en
+      encoded_word = CGI.escape(word.gsub(" ", "_"))
+      uri = URI("#{BASE_URL}/#{encoded_word}")
+      response = Net::HTTP.get_response(uri)
+
+      case response
+      when Net::HTTPSuccess
+        parse_response(response.body, lang: lang)
+      else
+        handle_error(response, raise_error)
+      end
+    end
+
+    def parse_response(body, lang:)
+      data = JSON.parse(body)
+
+      lang_data = data[lang.to_s]
+      lang_data.map { |word_data| Word.new(word_data) }
+    end
+
+    def handle_error(response, raise_error = false)
+      case response.code
+      when '404'
+        if raise_error
+          raise Error, "Word not found"
+        else
+          return nil
+        end
+      else
+        raise Error, "API request failed with status #{response.code}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: wiktionary_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben D'Angelo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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 Wiktionary API (https://en.wiktionary.org/api/rest_v1/)
+email:
+- ben@bendangelo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/wiktionary_api.rb
+- lib/wiktionary_api/version.rb
+- lib/wiktionary_api/word.rb
+homepage: https://codeberg.org/bendangelo/wiktionary_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://codeberg.org/bendangelo/wiktionary_api
+  source_code_uri: https://codeberg.org/bendangelo/wiktionary_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 Wiktionary API
+test_files: []