google-translate-free 0.0.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61878476dbea93fa674c06ec15e5447c79d59534aac01e45767467dde0964186
-  data.tar.gz: 3d46fe34808ad0391f7ddd3d43357fdaacb023270ab3e72e4e32f2a46a6c361b
+  metadata.gz: 4cc72fe0c76488b83866129f10701348e32119ea42b3dfd42ec535682e1afbd9
+  data.tar.gz: 75f4ff9e1e54ad9dbae00937d05d622b9ea080484c23fdc2acf9aaa2e83c5675
 SHA512:
-  metadata.gz: 4b1d3d8c3af406f0b003dc47b9c723363051a149487608b1340b0ffffdcfd9aa7b2e024b96d0389c54b77a7ba079fb49a7da088b3a071f41e36223fd3414b4b7
-  data.tar.gz: c6576a7a50fa7d15f1a9e02b2a404584b638ff547aab17aafdc387e43b682df4324d9a85afc6c49986ad1d8ad3a67307e7050748e975ed72257698ba117fc4da
+  metadata.gz: 041a4b9dae5ec62be5d6de6d1d667058f59a1aff9045024cbe0d09246245c806a6b7ba27cc41976eb675064550e1b484f7015f942763b06c02bcc65e1f9dad8b
+  data.tar.gz: 65f41fd1f0b04f752cfd0c4986953f1ed679624ba697e264865e79990ede898c99c6db7476ed9ee0eda6a8863db1b1c2d5c7ef20ba699579e53df911f206101e

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/README.md

@@ -1 +1,97 @@
-# google-translate-free
+# Google Translate Free
+
+This repository is a robust translation service designed to help you with a variety of language-based features including direct translations, alternate translations, definitions, examples, transliterations, spelling suggestions, language detection, and highly relevant keyword suggestions.
+
+Let's read the [documents](https://api.datpmt.com) before using it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'google-translate-free', '~> 1.0'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install google-translate-free
+
+## Usage
+To translate
+```ruby
+Translate.translate('summer', :vi, :en)
+# => "mùa hè"
+```
+Without third params, Google Translate will auto-detect your source language.
+```ruby
+Translate.translate('summer', :vi)
+# => "mùa hè"
+```
+For definitions
+```ruby
+Translate.definitions('summer')
+# =>
+#[
+#  {
+#    :noun=>[
+#      ["The warmest season of the year, in the northern hemisphere from june to august and in the southern hemisphere from december to february.", "<b>summer</b> vacation.", nil],
+#      ["A horizontal bearing beam, especially one supporting joists or rafters.", nil, nil]
+#    ]
+#  },
+#  {
+#    :verb=>[
+#      ["Spend the summer in a particular place.", nil, nil]
+#    ]
+#  }
+#]
+```
+For examples
+```ruby
+Translate.examples('summer')
+# =>
+#[
+#  "The plant flowers in late <b>summer</b>.",
+#  "The golden <b>summer</b> of her life.",
+#  "A long hot <b>summer</b>.",
+#  "<b>summer</b> vacation."
+#]
+```
+For transliteration
+```ruby
+Translate.transliteration('summer')
+# => "ˈsəmər"
+```
+For spelling suggestions
+```ruby
+Translate.suggest('summmer')
+# => "summer"
+```
+For language detection
+```ruby
+Translate.detection('summer')
+# => ["en", 0.93254006]
+```
+For keyword suggestions
+```ruby
+Translate.see_more('summers')
+# => "summer"
+```
+
+## Contributors
+
+- [datpmt](https://github.com/datpmt)
+
+I welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b your-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin your-feature`).
+5.  Create a new pull request.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/{translate.rb → google-translate-free.rb}

@@ -22,6 +22,7 @@ module Translate
   end
 
   def self.definitions(keyword)
+    validate_keyword(keyword)
     # [ preposition: [desc ex sysnonyms] ]
     uri = URI(url(:md, keyword, :auto))
     result = net_get(uri)[12]
@@ -32,7 +33,7 @@ module Translate
       {
         "#{pre}": preposition[1].map do |arr|
           code = arr.last
-          [arr[0].capitalize, examples(keyword, code)&.first, synonyms(pre, keyword, code)]
+          [arr[0], examples(keyword, code)&.first, synonyms(pre, keyword, code)]
         end
       }
     end
@@ -53,6 +54,7 @@ module Translate
   end
 
   def self.examples(keyword, code = nil)
+    validate_keyword(keyword)
     uri = URI(url(:ex, keyword, :auto))
     result = net_get(uri)[13]
     return unless result
@@ -63,13 +65,13 @@ module Translate
                 result[0].map { |ex| ex[0] if ex.last == code }.compact
               end
     last_rs.map do |ex|
-      "#{ex.capitalize}."
+      "#{ex}."
     end
   end
 
-  def self.transliteration(string)
-    encode = encode_url(string)
-    uri = URI(url(:rm, encode, :auto))
+  def self.transliteration(keyword)
+    validate_keyword(keyword)
+    uri = URI(url(:rm, keyword, :auto))
     net_get(uri)&.dig(0, 0, 3)
   end
 
@@ -81,8 +83,8 @@ module Translate
 
   def self.see_more(keyword)
     # ex [kids -> kid, tables -> table]
-    encode = encode_url(keyword)
-    uri = URI(url(:rw, encode, :auto))
+    validate_keyword(keyword)
+    uri = URI(url(:rw, keyword, :auto))
     net_get(uri)&.dig(14, 0, 0) || keyword
   end
 
@@ -115,4 +117,8 @@ module Translate
   def self.validate_language_code(from_lang, to_lang)
     TranslateLib::Validation.validate_language_code(from_lang, to_lang)
   end
+
+  def self.validate_keyword(keyword)
+    TranslateLib::Validation.validate_keyword(keyword)
+  end
 end

data/lib/translate_lib/validation.rb

@@ -20,11 +20,19 @@ module TranslateLib
       raise_error!('Translate strings shorter than or equal to 5000 characters.') if string.length > 5000
     end
 
+    def self.validate_keyword(keyword)
+      raise_error!('keyword does not have a valid value.') unless single_word?(keyword)
+    end
+
     def self.validate_language_code(from_lang, to_lang)
       raise_error!('from_lang does not have a valid value.') unless ALLOW_LANGUAGE_CODE.include?(from_lang.to_s.downcase)
       raise_error!('to_lang does not have a valid value.') unless ALLOW_LANGUAGE_CODE.include?(to_lang.to_s.downcase)
     end
 
+    def self.single_word?(str)
+      !!(str =~ /^\p{L}+$/)
+    end
+
     def self.raise_error!(message)
       TranslateLib::Exception.raise_error!(message)
     end

metadata

@@ -1,25 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: google-translate-free
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '1.0'
 platform: ruby
 authors:
 - datpmt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies: []
-description: Google Translate Free
+description: Translation service designed to help you with a variety of language-based
+  features including direct translations, alternate translations, definitions, examples,
+  transliterations, spelling suggestions, language detection, and highly relevant
+  keyword suggestions.
 email: datpmt.2k@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.MD
+- CHANGELOG.md
 - LICENSE
 - README.md
-- lib/translate.rb
+- lib/google-translate-free.rb
 - lib/translate_lib/exception.rb
 - lib/translate_lib/validation.rb
 homepage: https://rubygems.org/gems/google-translate-free
@@ -46,5 +49,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Google Translate Free
+summary: Supports APIs related to Google Translate and more!
 test_files: []