web_translate_it 2.5.2 → 2.6.0

data/lib/web_translate_it/term.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 module WebTranslateIt
-  class Term
+  class Term # rubocop:todo Metrics/ClassLength
     require 'net/https'
     require 'multi_json'
-    
+
     attr_accessor :id, :text, :description, :created_at, :updated_at, :translations, :new_record
-    
+
     # Initialize a new WebTranslateIt::Term
     #
     # Implementation Example:
@@ -19,18 +18,18 @@ module WebTranslateIt
     #   WebTranslateIt::Term.new({ "text" => "Hello", "translations" => [translation_es, translation_fr]})
     #
     # to instantiate a new Term with a Term Translations in Spanish and French.
-    
+
     def initialize(params = {})
       params.stringify_keys!
-      self.id           = params["id"] || nil
-      self.text         = params["text"] || nil
-      self.description  = params["description"] || nil
-      self.created_at   = params["created_at"] || nil
-      self.updated_at   = params["updated_at"] || nil
-      self.translations = params["translations"] || []
+      self.id           = params['id'] || nil
+      self.text         = params['text'] || nil
+      self.description  = params['description'] || nil
+      self.created_at   = params['created_at'] || nil
+      self.updated_at   = params['updated_at'] || nil
+      self.translations = params['translations'] || []
       self.new_record   = true
     end
-    
+
     # Fetch all terms
     #
     # Implementation Example:
@@ -40,27 +39,27 @@ module WebTranslateIt
     #   end
     #
     #  puts terms.inspect #=> An array of WebTranslateIt::Term objects
-    
-    def self.find_all(params = {})
+
+    def self.find_all(params = {}) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
       params.stringify_keys!
       url = "/api/projects/#{Connection.api_key}/terms.yaml"
-      url += '?' + HashUtil.to_params(params) unless params.empty?
+      url += "?#{HashUtil.to_params(params)}" unless params.empty?
 
       request = Net::HTTP::Get.new(url)
       WebTranslateIt::Util.add_fields(request)
       begin
         terms = []
-        while(request) do
+        while request
           response = Connection.http_connection.request(request)
           YAML.load(response.body).each do |term_response|
             term = WebTranslateIt::Term.new(term_response)
             term.new_record = false
             terms.push(term)
           end
-          if response["Link"] && response["Link"].include?("rel=\"next\"")
-            url = response["Link"].match(/<(.*)>; rel="next"/)[1]
+          if response['Link']&.include?('rel="next"')
+            url = response['Link'].match(/<(.*)>; rel="next"/)[1]
             request = Net::HTTP::Get.new(url)
             WebTranslateIt::Util.add_fields(request)
           else
@@ -69,7 +68,7 @@ module WebTranslateIt
         end
         return terms
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -79,7 +78,7 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Find a Term based on its ID
     # Returns a Term object or nil if not found.
     #
@@ -93,8 +92,8 @@ module WebTranslateIt
     #
     # to find and instantiate the Term which ID is `1234`.
     #
-    
-    def self.find(term_id)
+
+    def self.find(term_id) # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
       request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/terms/#{term_id}.yaml")
@@ -102,11 +101,12 @@ module WebTranslateIt
       begin
         response = Connection.http_connection.request(request)
         return nil if response.code.to_i == 404
+
         term = WebTranslateIt::Term.new(YAML.load(response.body))
         term.new_record = false
         return term
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -129,9 +129,9 @@ module WebTranslateIt
     #
 
     def save
-      self.new_record ? self.create : self.update
+      new_record ? create : update
     end
-    
+
     # Delete a Term on WebTranslateIt.com
     #
     # Implementation Example:
@@ -141,16 +141,16 @@ module WebTranslateIt
     #     term.delete
     #   end
     #
-    
-    def delete
+
+    def delete # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Delete.new("/api/projects/#{Connection.api_key}/terms/#{self.id}")
+      request = Net::HTTP::Delete.new("/api/projects/#{Connection.api_key}/terms/#{id}")
       WebTranslateIt::Util.add_fields(request)
       begin
         Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -160,7 +160,7 @@ module WebTranslateIt
       end
       success
     end
-    
+
     # Gets a Translation for a Term
     #
     # Implementation Example:
@@ -170,28 +170,29 @@ module WebTranslateIt
     #     puts term.translation_for("fr") #=> A TermTranslation object
     #   end
     #
-    
-    def translation_for(locale)
+
+    def translation_for(locale) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
       success = true
       tries ||= 3
-      translation = self.translations.detect{ |t| t.locale == locale }
+      translation = translations.detect { |t| t.locale == locale }
       return translation if translation
-      return nil if self.new_record
-      request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/terms/#{self.id}/locales/#{locale}/translations.yaml")
+      return nil if new_record
+
+      request = Net::HTTP::Get.new("/api/projects/#{Connection.api_key}/terms/#{id}/locales/#{locale}/translations.yaml")
       WebTranslateIt::Util.add_fields(request)
       begin
         response = Util.handle_response(Connection.http_connection.request(request), true, true)
         array = YAML.load(response)
         return nil if array.empty?
+
         translations = []
-        array.each do |translation|
-          term_translation = WebTranslateIt::TermTranslation.new(translation)
+        array.each do |trans|
+          term_translation = WebTranslateIt::TermTranslation.new(trans)
           translations.push(term_translation)
         end
         return translations
-        
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -204,22 +205,22 @@ module WebTranslateIt
 
     protected
 
-    def update
+    def update # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/terms/#{self.id}.yaml")
+      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/terms/#{id}.yaml")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json
+      request.body = to_json
 
-      self.translations.each do |translation|
-        translation.term_id = self.id
+      translations.each do |translation|
+        translation.term_id = id
         translation.save
       end
 
       begin
         Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -229,22 +230,21 @@ module WebTranslateIt
       end
       success
     end
-    
-    def create
+
+    def create # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
       request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/terms")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json(true)
+      request.body = to_json(true)
 
       begin
         response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
-        self.id = response["id"]
+        self.id = response['id']
         self.new_record = false
         return true
-        
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -254,17 +254,17 @@ module WebTranslateIt
       end
       success
     end
-    
-    def to_json(with_translations = false)
+
+    def to_json(with_translations = false) # rubocop:todo Metrics/MethodLength
       hash = {
-        "id" => id,
-        "text" => text,
-        "description" => description
+        'id' => id,
+        'text' => text,
+        'description' => description
       }
-      if self.translations.any? && with_translations
-        hash.update({ "translations" => [] })
+      if translations.any? && with_translations
+        hash.update({ 'translations' => [] })
         translations.each do |translation|
-          hash["translations"].push(translation.to_hash)
+          hash['translations'].push(translation.to_hash)
         end
       end
       MultiJson.dump(hash)

data/lib/web_translate_it/term_translation.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 module WebTranslateIt
   class TermTranslation
     require 'net/https'
     require 'multi_json'
-    
+
     attr_accessor :id, :locale, :text, :description, :status, :new_record, :term_id
-    
+
     # Initialize a new WebTranslateIt::TermTranslation
     #
     # Implementation Example:
@@ -14,18 +13,18 @@ module WebTranslateIt
     #
     # to instantiate a new TermTranslation.
     #
-    
+
     def initialize(params = {})
       params.stringify_keys!
-      self.id          = params["id"] || nil
-      self.locale      = params["locale"] || nil
-      self.text        = params["text"] || nil
-      self.description = params["description"] || nil
-      self.status      = params["status"] || nil
-      self.term_id     = params["term_id"] || nil
+      self.id          = params['id'] || nil
+      self.locale      = params['locale'] || nil
+      self.text        = params['text'] || nil
+      self.description = params['description'] || nil
+      self.status      = params['status'] || nil
+      self.term_id     = params['term_id'] || nil
       self.new_record  = true
     end
-    
+
     # Update or Create a WebTranslateIt::TermTranslation
     #
     # Implementation Example:
@@ -35,42 +34,41 @@ module WebTranslateIt
     #     translation.save
     #   end
     #
-    
+
     def save
-      self.new_record ? self.create : self.update
+      new_record ? create : update
     end
-    
+
     def to_hash
       {
-        "id" => id,
-        "locale" => locale,
-        "text" => text,
-        "description" => description,
-        "status" => status
+        'id' => id,
+        'locale' => locale,
+        'text' => text,
+        'description' => description,
+        'status' => status
       }
     end
 
-    def to_json
-      MultiJson.dump(self.to_hash)
+    def to_json(*_args)
+      MultiJson.dump(to_hash)
     end
-    
+
     protected
-    
-    def create
+
+    def create # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/terms/#{self.term_id}/locales/#{self.locale}/translations")
+      request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/terms/#{term_id}/locales/#{locale}/translations")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json
+      request.body = to_json
 
       begin
         response = YAML.load(Util.handle_response(Connection.http_connection.request(request), true, true))
-        self.id = response["id"]
+        self.id = response['id']
         self.new_record = false
         return true
-        
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
@@ -81,16 +79,16 @@ module WebTranslateIt
       success
     end
 
-    def update
+    def update # rubocop:todo Metrics/MethodLength
       success = true
       tries ||= 3
-      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/terms/#{self.id}/locales/#{self.locale}/translations/#{self.id}")
+      request = Net::HTTP::Put.new("/api/projects/#{Connection.api_key}/terms/#{id}/locales/#{locale}/translations/#{id}")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json
+      request.body = to_json
       begin
-        Util.handle_response(Connection.http_connection.request(request), true, true)        
+        Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry

data/lib/web_translate_it/translation.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
 module WebTranslateIt
   class Translation
     require 'net/https'
     require 'multi_json'
-    
+
     attr_accessor :id, :locale, :text, :status, :created_at, :updated_at, :version, :string_id
-    
+
     # Initialize a new WebTranslateIt::Translation
     #
     # Implementation Example:
@@ -14,23 +13,19 @@ module WebTranslateIt
     #
     # to instantiate a new Translation without any text.
     #
-    
-    def initialize(params = {})
+
+    def initialize(params = {}) # rubocop:todo Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
       params.stringify_keys!
-      self.id         = params["id"] || nil
-      self.locale     = params["locale"] || nil
-      self.text       = params["text"] || nil
-      self.status     = params["status"] || "status_unproofread"
-      self.created_at = params["created_at"] || nil
-      self.updated_at = params["updated_at"] || nil
-      self.version    = params["version"] || nil
-      if params["string"]
-        self.string_id  = params["string"]["id"]
-      else
-        self.string_id = nil
-      end
+      self.id         = params['id'] || nil
+      self.locale     = params['locale'] || nil
+      self.text       = params['text'] || nil
+      self.status     = params['status'] || 'status_unproofread'
+      self.created_at = params['created_at'] || nil
+      self.updated_at = params['updated_at'] || nil
+      self.version    = params['version'] || nil
+      self.string_id = (params['string']['id'] if params['string'])
     end
-    
+
     # Save a WebTranslateIt::Translation
     #
     # Implementation Example:
@@ -40,35 +35,33 @@ module WebTranslateIt
     #     translation.save
     #   end
     #
-    
-    def save
+
+    def save # rubocop:todo Metrics/MethodLength
       tries ||= 3
-      request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/strings/#{self.string_id}/locales/#{self.locale}/translations")
+      request = Net::HTTP::Post.new("/api/projects/#{Connection.api_key}/strings/#{string_id}/locales/#{locale}/translations")
       WebTranslateIt::Util.add_fields(request)
-      request.body = self.to_json
+      request.body = to_json
       begin
         Util.handle_response(Connection.http_connection.request(request), true, true)
       rescue Timeout::Error
-        puts "Request timeout. Will retry in 5 seconds."
+        puts 'Request timeout. Will retry in 5 seconds.'
         if (tries -= 1) > 0
           sleep(5)
           retry
-        else
-          success = false
         end
       end
     end
-    
+
     def to_hash
       {
-        "locale" => locale,
-        "text" => text,
-        "status" => status
+        'locale' => locale,
+        'text' => text,
+        'status' => status
       }
     end
 
-    def to_json
-      MultiJson.dump(self.to_hash)
+    def to_json(*_args)
+      MultiJson.dump(to_hash)
     end
   end
 end