cambridge_dict 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c267c98cdc071799bc99ff46db6963e543bf79ba0a96ce1efb391d27fabcd40c
+  data.tar.gz: 3bfc706d541138132c78030a885a227eb3f66cb1405235b5c87022420f204b2c
+SHA512:
+  metadata.gz: 6f31eeb418116539c5d61b9487a0bfc1d98c0bfa310c986bf7a4ac99a213c46e98e4032a7bc45f0b85ae87cb82ff2ea043fbd7979c600ad94d2442dc84fbb3ba
+  data.tar.gz: defbccf32f337d0ddbefac15a85853e27e0487cf6f4d67f77cde947228bc50fe77bc2d0270d948a26b5fe0dd47b93e891d06d75bf433f0781f0d036d03c3aef8

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,72 @@
+# Cambridge Dict
+
+Look up words for cambridge via code or web server.
+
+## Installation
+
+```
+gem install cambridge_dict
+```
+
+## Client Usage
+
+```
+client = CambridgeDictionary::Client.new
+result = client.lookup("back", language: "en")
+
+=>
+{:word=>"back",                                                                                 
+ :pos=>["adverb", "noun", "verb", "adjective"],                                                                                                                                                 
+ :verbs=>                                                                                                                                                                                       
+  [{:id=>0, :type=>"Preposition", :text=>"back"},                                                                                                                                               
+   {:id=>1, :type=>"Singular", :text=>"back"},                                                  
+   {:id=>2, :type=>"Plural", :text=>"backs"},
+   {:id=>3, :type=>"Plain form", :text=>"back"},
+   {:id=>4, :type=>"Third-person singular", :text=>"backs"},                                    
+   {:id=>5, :type=>"Past tense", :text=>"backed"},
+   {:id=>6, :type=>"Past participle", :text=>"backed"},                                                                                                                                         
+   {:id=>7, :type=>"Present participle", :text=>"backing"}],                                                                                                                                    
+ :pronunciation=>                                                                                                                                                                               
+  [{:pos=>"adverb", :lang=>"us", :url=>"https://dictionary.cambridge.org/us/media/english/us_pron/b/bac/back_/back.mp3", :pron=>"/bæk/"}, 
+   {:pos=>"adverb", :lang=>"uk", :url=>"https://dictionary.cambridge.org/us/media/english/uk_pron/u/uka/ukazt/ukazt__024.mp3", :pron=>"/bæk/"},                                                 
+   {:pos=>"noun", :lang=>"us", :url=>"https://dictionary.cambridge.org/us/media/english/us_pron/b/bac/back_/back.mp3", :pron=>"/bæk/"},                                                         
+   {:pos=>"noun", :lang=>"uk", :url=>"https://dictionary.cambridge.org/us/media/english/uk_pron/u/uka/ukazt/ukazt__024.mp3", :pron=>"/bæk/"},                                                   
+   {:pos=>"verb", :lang=>"us", :url=>"https://dictionary.cambridge.org/us/media/english/us_pron/b/bac/back_/back.mp3", :pron=>"/bæk/"},                
+   ...
+:definition=>                                                                                                                                                                                  
+  [{:id=>0,                                                                                                                                                                                     
+    :pos=>"adverb",
+    :source=>"cald4-us",
+    :text=>"in, into, or toward a previous place or condition, or an earlier time: ",
+    :translation=>nil,                                                                                                                                                                          
+    :example=>        
+     [{:id=>0, :text=>"He looked back and saw they were following him.", :translation=>nil},                                                                                                    
+      {:id=>1, :text=>"When you take the scissors, remember to put them back.", :translation=>nil},
+      {:id=>2, :text=>"Looking at her old photographs brought back (= made her remember) a lot of memories.", :translation=>nil},
+      {:id=>3, :text=>"He left a note saying \"Gone out. Back soon.\"", :translation=>nil},
+      {:id=>4, :text=>"She went to Brazil for two years, but now she's back.", :translation=>nil},
+      {:id=>5, :text=>"I was woken by a thunderstorm, and I couldn't get back to sleep (= could not sleep again).", :translation=>nil},
+      {:id=>6, :text=>"The last time we saw Lowell was back (= at an earlier time) in January.", :translation=>nil},                                                     
+      {:id=>7, :text=>"This tradition dates back to the 16th century.", :translation=>nil}]},
+   {:id=>1,           
+    :pos=>"adverb",     
+    :source=>"cald4-us",                                                                        
+    :text=>"in return: ",
+    :translation=>nil,                                                                                             
+```
+
+## Webserver Setup
+
+```
+# config.ru
+require 'cambridge_dictionary'
+run CambridgeDictionary::API
+
+ruby config.ru
+```
+
+## 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.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config.ru

@@ -0,0 +1,2 @@
+require './lib/cambridge_dict'
+run CambridgeDictionary::API

data/lib/cambridge_dict/version.rb

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

data/lib/cambridge_dict.rb

@@ -0,0 +1,174 @@
+require 'nokogiri'
+require 'httparty'
+require 'sinatra'
+require 'sinatra/cors'
+require 'cambridge_dict/version'
+
+module CambridgeDict
+  class Client
+    def initialize
+      @base_url = "https://dictionary.cambridge.org"
+      @wiki_base = "https://simple.wiktionary.org/wiki"
+    end
+
+    def lookup(word, language: 'en')
+      nation, dict_lang = parse_language(language)
+      url = "#{@base_url}/#{nation}/dictionary/#{dict_lang}/#{word}"
+
+      response = HTTParty.get(url, {
+        headers: {"User-Agent" => "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.3"},
+      })
+      return nil unless response.success?
+
+      doc = Nokogiri::HTML(response.body)
+      wiki_verbs = fetch_verbs("#{@wiki_base}/#{word}")
+
+      {
+        word: extract_word(doc),
+        pos: extract_pos(doc),
+        verbs: wiki_verbs,
+        pronunciation: extract_pronunciation(doc),
+        definition: extract_definitions(doc)
+      }
+    end
+
+    private
+
+    def parse_language(lang)
+      case lang
+      when 'en'
+        ['us', 'english']
+      when 'uk'
+        ['uk', 'english']
+      when 'en-tw'
+        ['us', 'english-chinese-traditional']
+      when 'en-cn'
+        ['us', 'english-chinese-simplified']
+      else
+        ['us', 'english']
+      end
+    end
+
+    def fetch_verbs(url)
+      response = HTTParty.get(url)
+      return [] unless response.success?
+
+      doc = Nokogiri::HTML(response.body)
+      verbs = []
+
+      rows = doc.css('tr > td > p')
+
+      lines = rows.map {|i| i.children.collect {|c| c.text } }.flatten.map(&:strip).reject(&:empty?)
+
+      lines.each_slice(2) do |type, text|
+        break if verbs.include?({type: type, text: text})
+        verbs << {id: verbs.length, type: type, text: text} if type && text
+      end
+
+      verbs
+    end
+
+    def extract_word(doc)
+      doc.at_css('.hw.dhw')&.text || ''
+    end
+
+    def extract_pos(doc)
+      doc.css('.pos.dpos').map(&:text).uniq
+    end
+
+    def extract_pronunciation(doc)
+      audio = []
+
+      doc.css('.pos-header.dpos-h').each do |header|
+        pos_node = header.at_css('.dpos-g')
+        next unless pos_node && !pos_node.children.empty?
+
+        pos = pos_node.children.first.text
+        header.css('.dpron-i').each do |node|
+          lang = node.at_css('span:first-child')&.text
+          source = node.at_css('source')
+          next unless source
+
+          url = @base_url + source['src']
+          pron = node.at_css('span:last-child')&.text
+
+          audio << {
+            pos: pos,
+            lang: lang,
+            url: url,
+            pron: pron
+          }
+        end
+      end
+
+      audio
+    end
+
+    def extract_definitions(doc)
+      definitions = []
+
+      doc.css('.def-block.ddef_block').each_with_index do |block, index|
+        entry = block.ancestors('.pr.entry-body__el').first
+        source_result = block.ancestors('.pr.dictionary')&.first
+
+        if source_result
+          source = source_result['data-id']
+        end
+
+        pos = entry&.at_css('.pos.dpos')&.text
+
+        definition = {
+          id: index,
+          pos: pos,
+          source: source || nil,
+          text: block.at_css('.def.ddef_d.db')&.text,
+          translation: block.at_css('.def-body.ddef_b > span.trans.dtrans')&.text,
+          example: extract_examples(block)
+        }
+
+        definitions << definition
+      end
+
+      definitions
+    end
+
+    def extract_examples(block)
+      examples = []
+
+      block.css('.def-body.ddef_b > .examp.dexamp').each_with_index do |example, index|
+        examples << {
+          id: index,
+          text: example.at_css('.eg.deg')&.text,
+          translation: example.at_css('.trans.dtrans')&.text
+        }
+      end
+
+      examples
+    end
+  end
+
+  class API < Sinatra::Base
+    register Sinatra::Cors
+
+    set :allow_origin, "*"
+    set :allow_methods, "GET,HEAD,POST"
+    set :allow_headers, "content-type,if-modified-since"
+    set :expose_headers, "location,link"
+
+    client = Client.new
+
+    get '/api/dictionary/:language/:entry' do
+      content_type :json
+
+      result = client.lookup(params[:entry], language: params[:language])
+
+      if result && !result[:word].empty?
+        status 200
+        result.to_json
+      else
+        status 404
+        {error: "word not found"}.to_json
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: cambridge_dict
+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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sinatra-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: A Ruby gem to interact with the Cambridge Dictionary website
+email: ben@bendangelo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.ru
+- lib/cambridge_dict.rb
+- lib/cambridge_dict/version.rb
+homepage: https://codeberg.org/bendangelo/cambridge_dict
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Cambridge Dictionary API wrapper
+test_files: []