merriam_webster_plus 0.1.0

data/lib/merriam_webster_plus/entry_audio_merger.rb

@@ -0,0 +1,55 @@
+module MerriamWebsterPlus
+  class EntryAudioMerger
+    attr_reader :dst_entries, :src_entries
+
+    def initialize(dst_entries:, src_entries:)
+      @dst_entries = dst_entries
+      @src_entries = src_entries
+    end
+
+    def merged_entries
+      heteronym? ? entries_with_multi_audio : entries_with_single_audio
+    end
+
+    private
+
+    def heteronym?
+      audios.size > 1
+    end
+
+    def entries_with_multi_audio
+      return remove_ids(dst_entries) if dst_entries == src_entries
+
+      dst_entries.each do |dst_entry|
+        target_uuid = dst_entry[:target_uuid]
+        dst_entry[:audio] = src_entries_audio_index[target_uuid]
+      end
+      remove_ids(dst_entries)
+    end
+
+    def src_entries_audio_index
+      indexed_audio = {}
+      src_entries.each do |src_entry|
+        indexed_audio[src_entry[:uuid]] ||= src_entry[:audio]
+      end
+      indexed_audio
+    end
+
+    def entries_with_single_audio
+      dst_entries.map { |dst_entry| dst_entry[:audio] = src_audio }
+      remove_ids(dst_entries)
+    end
+
+    def src_audio
+      audios.first
+    end
+
+    def audios
+      src_entries.map { |entry| entry.slice(:audio)[:audio] }.compact.uniq
+    end
+
+    def remove_ids(entries)
+      entries.map { |entry| entry.except(:uuid, :target_uuid) }
+    end
+  end
+end

data/lib/merriam_webster_plus/populator.rb

@@ -0,0 +1,31 @@
+require "merriam_webster_plus/dictionary_plus"
+
+module MerriamWebsterPlus
+  class Populator
+    attr_reader :lookupper, :src_dir, :dst_dir
+
+    def initialize(lookupper:, src_dir:, dst_dir:)
+      @lookupper 			= lookupper
+      @src_dir 			= src_dir
+      @dst_dir 			= dst_dir
+    end
+
+    def populate
+      csv_out = CSV.open(dst_dir, "wb", write_headers: true, headers: src_headers)
+
+      CSV.foreach(src_dir, headers: true, header_converters: :symbol) do |src_row|
+        entry = lookupper.new(word: src_row[0]).primary_entry
+        entry ? (csv_out << entry.values) : (csv_out << src_row)
+      rescue StandardError
+        csv_out << src_row
+      end
+      csv_out.close
+    end
+
+    private
+
+    def src_headers
+      CSV.foreach(src_dir).first
+    end
+  end
+end

data/lib/merriam_webster_plus/primary_entry_finder.rb

@@ -0,0 +1,41 @@
+module MerriamWebsterPlus
+  class PrimaryEntryFinder
+    attr_reader :primary_src_entries, :secondary_src_entries, :tertiary_src_entries
+
+    def initialize(primary_src_entries:, secondary_src_entries:, tertiary_src_entries:)
+      @primary_src_entries = primary_src_entries
+      @secondary_src_entries = secondary_src_entries
+      @tertiary_src_entries = tertiary_src_entries
+    end
+
+    def primary_entry
+      first_complete_entry(primary_src_entries) ||
+        first_complete_entry(secondary_src_entries) ||
+        first_entry(tertiary_src_entries)
+    end
+
+    private
+
+    def first_complete_entry(entries)
+      entries.each do |entry|
+        entry[:senses]&.each do |sense_section|
+          sense = sense_section&.dig(1)
+          return singled_entry(entry: entry, sense: sense) if !sense[:example].nil? && !sense[:definition].nil?
+        end
+      end
+      nil
+    end
+
+    def first_entry(entries)
+      singled_entry(entry: entries.first, sense: entries&.dig(0, :senses, 0)&.dig(1))
+    end
+
+    def singled_entry(entry:, sense:)
+      { word: entry[:word],
+        class: entry[:class],
+        definition: sense&.dig(:definition),
+        example: sense&.dig(:example),
+        audio: entry[:audio] }
+    end
+  end
+end

data/lib/merriam_webster_plus/thesaurus_entries.rb

@@ -0,0 +1,13 @@
+require "merriam_webster_plus/client"
+require "merriam_webster_plus/thesaurus_entry"
+
+module MerriamWebsterPlus
+  class ThesaurusEntries < DictionaryEntries
+    private
+
+    def title_post_initialize
+      @api_entries 		= MerriamWebsterPlus::Client.new(word: word, title: :collegiate_thesaurus).api_entries
+      @entry_parser		= ThesaurusEntry
+    end
+  end
+end

data/lib/merriam_webster_plus/thesaurus_entry.rb

@@ -0,0 +1,12 @@
+require "merriam_webster_plus/dictionary_entry"
+require "merriam_webster_plus/thesaurus_sense"
+
+module MerriamWebsterPlus
+  class ThesaurusEntry < DictionaryEntry
+    private
+
+    def title_post_initialize
+      @sense_parser = ThesaurusSense
+    end
+  end
+end

data/lib/merriam_webster_plus/thesaurus_sense.rb

@@ -0,0 +1,47 @@
+module MerriamWebsterPlus
+  class ThesaurusSense < DictionarySense
+    def primary_sense
+      {
+        definition: definition,
+        synonyms: synonyms,
+        synonyms_and_near_synonyms: synonyms_and_near_synonyms,
+        related_words: related_words,
+        synonymous_phrases: synonymous_phrases,
+        near_antonyms: near_antonyms,
+        antonyms: antonyms,
+        antonyms_and_near_antonyms: antonyms_and_near_antonyms,
+        example: example_sentence
+      }.compact
+    end
+
+    private
+
+    def synonyms
+      sense&.dig(:syn_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def synonyms_and_near_synonyms
+      sense&.dig(:sim_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def related_words
+      sense&.dig(:rel_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def synonymous_phrases
+      sense&.dig(:phrase_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def near_antonyms
+      sense&.dig(:near_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def antonyms
+      sense&.dig(:ant_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+
+    def antonyms_and_near_antonyms
+      sense&.dig(:opp_list, 0)&.map { |word_obj| word_obj&.dig(:wd) }&.join(", ")
+    end
+  end
+end

data/lib/merriam_webster_plus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MerriamWebsterPlus
+  VERSION = "0.1.0"
+end

data/lib/merriam_webster_plus.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "merriam_webster_plus/dictionary_plus"
+require "merriam_webster_plus/version"
+
+module MerriamWebsterPlus
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/merriam_webster_plus.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "merriam_webster_plus/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "merriam_webster_plus"
+  spec.version       = MerriamWebsterPlus::VERSION
+  spec.authors       = ["Christopher J. Corona"]
+  spec.email         = ["CRiSToBaLZ@users.noreply.github.com"]
+
+  spec.summary       = "Easily get word definitions, synonyms/antonyms, usage examples, audio pronunciations, and more! Backed by Merriam-Webster API."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/CRiSToBaLZ/merriam_webster_plus"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.executables   = ["mwp"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 2.3"
+  spec.add_dependency "httparty"
+  spec.add_dependency "json"
+  spec.add_dependency "minitest"
+  spec.add_dependency "minitest-stub-const"
+  spec.add_dependency "rake"
+  spec.add_dependency "rubocop"
+  spec.add_dependency "vcr"
+  spec.add_dependency "webmock"
+end

data/test_out.csv

@@ -0,0 +1,11 @@
+word,part_of_speech,definition,example_sentence,audio
+Internet,noun,an electronic communications network that connects computer networks and organizational computer facilities around the world —used with the except when being used attributively,doing research on the Internet,https://media.merriam-webster.com/audio/prons/en/us/mp3/i/inter01s.mp3
+reversible,adjective,capable of being reversed or of reversing,a reversible chemical reaction,https://media.merriam-webster.com/audio/prons/en/us/mp3/r/revers05.mp3
+yearn,verb,"to long persistently, wistfully, or sadly",yearns to make a difference,https://media.merriam-webster.com/audio/prons/en/us/mp3/y/yearn001.mp3
+acre,noun,"any of various units of area; specifically : a unit in the U.S. and England equal to 43,560 square feet (4047 square meters)",acres of free publicity,https://media.merriam-webster.com/audio/prons/en/us/mp3/a/acre0001.mp3
+contrast,noun,the quality or state of being different,the contrast between the two approaches to the problem of overeating could not be greater,https://media.merriam-webster.com/audio/prons/en/us/mp3/c/contra64.mp3
+superior,adjective,having a feeling of superiority that shows itself in an overbearing attitude,that superior sportscaster lets it be known that he thinks all foreign baseball teams are second-rate,https://media.merriam-webster.com/audio/prons/en/us/mp3/s/superi14.mp3
+pardoned,verb,to cease to have feelings of anger or bitterness toward,he eventually pardoned his sister after she apologized,
+salmon,noun,a large anadromous salmonid fish (Salmo salar) of the North Atlantic noted as a game and food fish —called also Atlantic salmon,,https://media.merriam-webster.com/audio/prons/en/us/mp3/s/salmon01.mp3
+fungi,combining form,fungus,fungiform,
+Ferris wheel,noun,an amusement device consisting of a large upright power-driven wheel carrying seats that remain horizontal around its rim,,https://media.merriam-webster.com/audio/prons/en/us/mp3/f/ferris01.mp3

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: merriam_webster_plus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher J. Corona
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily get word definitions, synonyms/antonyms, usage examples, audio
+  pronunciations, and more! Backed by Merriam-Webster API.
+email:
+- CRiSToBaLZ@users.noreply.github.com
+executables:
+- mwp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".byebug_history"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/mwp
+- bin/setup
+- fixtures/.DS_Store
+- fixtures/vcr_cassettes/.DS_Store
+- fixtures/vcr_cassettes/empty_api_entries.yml
+- fixtures/vcr_cassettes/heteronym_entries.yml
+- fixtures/vcr_cassettes/invalid_api_entries.yml
+- fixtures/vcr_cassettes/invalid_dictionary_plus_lookup.yml
+- fixtures/vcr_cassettes/invalid_endpoint_api_entries.yml
+- fixtures/vcr_cassettes/main_entries_dictionary.yml
+- fixtures/vcr_cassettes/main_entries_thesaurus.yml
+- fixtures/vcr_cassettes/main_entry_dictionary.yml
+- fixtures/vcr_cassettes/main_entry_thesaurus.yml
+- fixtures/vcr_cassettes/non_heteronym_entries.yml
+- fixtures/vcr_cassettes/valid_api_entries.yml
+- fixtures/vcr_cassettes/valid_dictionary_plus_lookup.yml
+- fixtures/vcr_cassettes/word_medley_primary_entry_population.yml
+- fixtures/vcr_cassettes/word_not_in_dictionary_primary_entry.yml
+- fixtures/vcr_cassettes/word_not_in_thesaurus_primary_entry.yml
+- lib/.DS_Store
+- lib/merriam_webster_plus.rb
+- lib/merriam_webster_plus/.DS_Store
+- lib/merriam_webster_plus/client.rb
+- lib/merriam_webster_plus/dictionary_entries.rb
+- lib/merriam_webster_plus/dictionary_entry.rb
+- lib/merriam_webster_plus/dictionary_plus.rb
+- lib/merriam_webster_plus/dictionary_sense.rb
+- lib/merriam_webster_plus/entry_audio_merger.rb
+- lib/merriam_webster_plus/populator.rb
+- lib/merriam_webster_plus/primary_entry_finder.rb
+- lib/merriam_webster_plus/thesaurus_entries.rb
+- lib/merriam_webster_plus/thesaurus_entry.rb
+- lib/merriam_webster_plus/thesaurus_sense.rb
+- lib/merriam_webster_plus/version.rb
+- merriam_webster_plus.gemspec
+- test_out.csv
+homepage: https://github.com/CRiSToBaLZ/merriam_webster_plus
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.16
+signing_key:
+specification_version: 4
+summary: Easily get word definitions, synonyms/antonyms, usage examples, audio pronunciations,
+  and more! Backed by Merriam-Webster API.
+test_files: []