the-free-dictionary 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9aff2d40d40a07e97b0696262cf690fa7c4bf1ea79e629f6f270b4d36d7a37a
+  data.tar.gz: caec3b23b39913fa49bb664897376bc727312401f13c446862e6b2f79accd0e4
+SHA512:
+  metadata.gz: cec7265c3859bfa80612f1a23e0fb9a6603bc55f11d77a61b70c0cc12aff96c14e067816ad445daacc7de7abcf1e72fad86a41a92446254fa1a98b0cb0536f42
+  data.tar.gz: 469167d55b50a3cb7d9a4667222e3335a75834575a6e118cf314d286a4851b12bdc9f4bade539f122f8787e41ee033990403cd8fb06970ddd8341d58a65643f5

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.3.0' ]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Check Rubocop compliance
+      run: bundle exec rubocop --format github
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1 @@
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--warnings

data/.rubocop.yml

@@ -0,0 +1,45 @@
+---
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - context
+    - describe
+    - task
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
+Layout/LineLength:
+  Max: 120
+
+Lint/MissingSuper:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    bigdecimal (3.1.8)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    hashdiff (1.1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (6.0.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.1)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.2)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.5.13

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anatoly Busygin
+
+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,56 @@
+# TheFreeDictionary
+
+TheFreeDictionary is a versatile Ruby library that fetches information about words from various languages. It retrieves the pronunciation link (audio) and the transcription for a given word from [The Free Dictionary website](https://www.thefreedictionary.com).
+
+## Features
+
+- Fetches audio pronunciation links
+- Retrieves phonetic transcription of words
+- Supports multiple languages including English, French, German, Italian, Russian, Spanish, and Chinese
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'the-free-dictionary'
+```
+
+And then execute:
+
+```shell
+$ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install the-free-dictionary
+```
+
+## Usage
+
+Here's a quick example to get you started:
+
+```ruby
+require 'the-free-dictionary'
+
+dictionary = TheFreeDictionary::English.new
+result = dictionary.find('glossary')
+
+puts "Sound URL: #{result[:sound]}"
+puts "Transcription: #{result[:transcription]}"
+```
+
+## Supported Languages
+
+TheFreeDictionary provides classes for different languages:
+- `TheFreeDictionary::English`
+- `TheFreeDictionary::Spanish`
+- `TheFreeDictionary::French`
+- `TheFreeDictionary::German`
+- `TheFreeDictionary::Italian`
+- `TheFreeDictionary::Russian`
+- `TheFreeDictionary::Chinese`
+
+Each class has a `find` method that takes a word as an argument and returns a hash with `:sound` and `:transcription`.

data/lib/the_free_dictionary/chinese.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class Chinese < Dictionary
+    def initialize
+      @language = 'zh'
+      @region = 'CN'
+    end
+  end
+end

data/lib/the_free_dictionary/dictionary.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module TheFreeDictionary
+  class Dictionary
+    attr_accessor :language, :region
+
+    def find(statement)
+      uri = build_uri(statement)
+      response = fetch(uri)
+      sound = build_sound_url(response)
+      transcription = fetch_transcription(response)
+
+      { sound:, transcription: }
+    end
+
+    private
+
+    def fetch(uri)
+      Net::HTTP.get_response(uri)
+    rescue Socket::ResolutionError
+      nil
+    end
+
+    def build_uri(statement)
+      URI(URI::DEFAULT_PARSER.escape("https://#{@language}.thefreedictionary.com/#{statement}"))
+    end
+
+    def build_sound_url(response)
+      sound_data = response.body.match(%r{#{@language}/#{@region}[^"]+})
+      if sound_data.nil?
+        ''
+      else
+        "https://img2.tfd.com/pron/mp3/#{sound_data[0]}.mp3"
+      end
+    end
+
+    def fetch_transcription(response)
+      regex = %r{<span[^>]*onclick="pron_key\(1\)"[^>]*class="pron"[^>]*>\s*\(?([^)]+)\)?\s*</span>}
+      transcription_data = response.body.match(regex)
+      if transcription_data.nil?
+        ''
+      else
+        decode_html_entities(transcription_data[1].force_encoding('UTF-8'))
+      end
+    end
+
+    def decode_html_entities(string)
+      string.gsub(/&#(\d+);/) { |_match| ::Regexp.last_match(1).to_i.chr(Encoding::UTF_8) }
+    end
+  end
+end

data/lib/the_free_dictionary/english.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class English < Dictionary
+    def initialize
+      @language = 'en'
+      @region = 'US'
+    end
+  end
+end

data/lib/the_free_dictionary/french.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class French < Dictionary
+    def initialize
+      @language = 'fr'
+      @region = 'EU'
+    end
+  end
+end

data/lib/the_free_dictionary/german.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class German < Dictionary
+    def initialize
+      @language = 'de'
+      @region = 'DE'
+    end
+  end
+end

data/lib/the_free_dictionary/italian.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class Italian < Dictionary
+    def initialize
+      @language = 'it'
+      @region = 'IT'
+    end
+  end
+end

data/lib/the_free_dictionary/russian.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class Russian < Dictionary
+    def initialize
+      @language = 'ru'
+      @region = 'RU'
+    end
+  end
+end

data/lib/the_free_dictionary/spanish.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TheFreeDictionary
+  class Spanish < Dictionary
+    def initialize
+      @language = 'es'
+      @region = /(EU|LA)/
+    end
+  end
+end

data/lib/the_free_dictionary.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'the_free_dictionary/dictionary'
+require_relative 'the_free_dictionary/english'
+require_relative 'the_free_dictionary/spanish'
+require_relative 'the_free_dictionary/french'
+require_relative 'the_free_dictionary/german'
+require_relative 'the_free_dictionary/italian'
+require_relative 'the_free_dictionary/chinese'
+require_relative 'the_free_dictionary/russian'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: the-free-dictionary
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anatoly Busygin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: anatolyb94@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/the_free_dictionary.rb
+- lib/the_free_dictionary/chinese.rb
+- lib/the_free_dictionary/dictionary.rb
+- lib/the_free_dictionary/english.rb
+- lib/the_free_dictionary/french.rb
+- lib/the_free_dictionary/german.rb
+- lib/the_free_dictionary/italian.rb
+- lib/the_free_dictionary/russian.rb
+- lib/the_free_dictionary/spanish.rb
+homepage: https://github.com/Suban05/the-free-dictionary
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.10
+signing_key: 
+specification_version: 4
+summary: TheFreeDictionary is a gem that fetches information about words from https://www.thefreedictionary.com/
+test_files: []