zypper-onlinesearch 1.0.0 → 1.1.0

data/lib/zypper/onlinesearch/request.rb

@@ -1,9 +1,13 @@
-require 'net/http'
-require 'uri'
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
 
 module Zypper
   module Onlinesearch
-
+    #
+    # Handles the list of requests.
+    #
     class RequestList
       attr_reader :engines, :refresh, :timeout, :query
 
@@ -12,35 +16,36 @@ module Zypper
         @refresh = args[:refresh]
         @timeout = args[:timeout]
         @query = args[:query]
+        m = Request.const_get(args[:operation].to_s.capitalize)
 
         if args[:engine] == :all
-          m = Request.const_get(args[:operation].to_s.capitalize)
           m.constants.each do |k|
             @engines[k.to_s.downcase] = m.const_get(k).new(args[:query], args[:refresh], args[:timeout])
           end
         else
-          m = Request.const_get(args[:operation].to_s.capitalize)
           klass = args[:engine].to_s.capitalize.to_sym
           raise InvalidEngine, args[:engine] unless m.constants.include? klass
+
           @engines[args[:engine].to_s.downcase] = m.const_get(klass).new(args[:query], args[:refresh], args[:timeout])
         end
       end
 
-      def self.has_class?(operation, engine)
+      def self.class?(operation, engine)
         Request.const_get(operation.to_s.capitalize).constants.include?(engine.to_s.capitalize.to_sym)
       end
     end
 
-
+    #
+    # The single page request.
+    #
     class PageRequest
-
       attr_reader :page
 
-      USER_AGENT = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0'
+      USER_AGENT = "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:59.0) Gecko/20100101 Firefox/59.0"
 
       def initialize(query, refresh, timeout = 60, cookies = [])
         @query = query.strip
-        @cache = Cache.new(*(self.class.to_s.split('::')[-2..-1].map(&:downcase)))
+        @cache = Cache.new(*self.class.to_s.split("::")[-2..].map(&:downcase))
         @refresh = refresh
         @cookies = cookies
         @timeout = timeout
@@ -55,7 +60,7 @@ module Zypper
       end
 
       def redirected_to
-        ping['location']
+        ping["location"]
       end
 
       def not_found?
@@ -79,7 +84,7 @@ module Zypper
       end
 
       def to_data
-        klass = self.class.to_s.split('::')[-2..-1]
+        klass = self.class.to_s.split("::")[-2..]
         Data.const_get(klass[0].to_sym).const_get(klass[1].to_sym).new(@page.body).data
       end
 
@@ -90,31 +95,32 @@ module Zypper
       private
 
       def get_request(request_uri = nil, limit = 10)
-        if request_uri
-          request_uri = (request_uri =~ /:\/\//) ? URI(request_uri).request_uri : request_uri
-        else
-          request_uri = uri.request_uri
-        end
+        request_uri = if request_uri
+                        request_uri =~ %r{://} ? URI(request_uri).request_uri : request_uri
+                      else
+                        uri.request_uri
+                      end
 
         request = Net::HTTP::Get.new(request_uri)
-        request['User-Agent'] = USER_AGENT
-        request['Cookie'] = @cookies.join(';') unless @cookies.empty?
+        request["User-Agent"] = USER_AGENT
+        request["Cookie"] = @cookies.join(";") unless @cookies.empty?
 
         http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = (uri.scheme == 'https')
+        http.use_ssl = (uri.scheme == "https")
         http.open_timeout = @timeout
 
         res = http.request(request)
 
         if res.is_a? Net::HTTPRedirection
-          raise TooManyRedirections, uri.to_s if limit < 0
-          res = get_request(res['location'], limit - 1)
+          raise TooManyRedirections, uri.to_s if limit.negative?
+
+          res = get_request(res["location"], limit - 1)
         end
 
         res
       end
 
-      def ping(force = false)
+      def ping(force: false)
         begin
           @page = @cache.get(@query) unless @refresh
           if @page.nil? || force
@@ -124,23 +130,23 @@ module Zypper
         rescue SocketError
           raise NoConnection
         rescue Net::OpenTimeout
-          @page = Net::HTTPRequestTimeOut.new('1.1', '', '')
+          @page = Net::HTTPRequestTimeOut.new("1.1", "", "")
         end
         @page
       end
     end
 
-
     module Request
-
       module Search
-
+        #
+        # Handles the search on openSUSE.
+        #
         class Opensuse < PageRequest
-
-          URL = 'https://software.opensuse.org/search'
+          URL = "https://software.opensuse.org/search"
 
           def initialize(query, cache, timeout, cookies = [])
-            super query, cache, timeout, cookies << 'baseproject=ALL;search_devel=true;search_debug=false;search_lang=false'
+            super query, cache, timeout,
+                  cookies << "baseproject=ALL;search_devel=true;search_debug=false;search_lang=false"
           end
 
           def uri
@@ -150,29 +156,30 @@ module Zypper
           end
         end
 
-
+        #
+        # Handles the search on Packman.
+        #
         class Packman < PageRequest
-
-          URL = 'http://packman.links2linux.org/search'
+          URL = "http://packman.links2linux.org/search"
 
           def uri
             u = URI(URL)
-            u.query = URI.encode_www_form({q: @query, scope: 'name'})
+            u.query = URI.encode_www_form({ q: @query, scope: "name" })
             u
           end
         end
-
       end
 
-
       module Page
-
+        #
+        # Handle the page on openSUSE.
+        #
         class Opensuse < PageRequest
-
-          URL  = 'https://software.opensuse.org/package/'
+          URL = "https://software.opensuse.org/package/"
 
           def initialize(query, cache, timeout, cookies = [])
-            super query, cache, timeout, cookies << 'baseproject=ALL;search_devel=true;search_debug=false;search_lang=false'
+            super query, cache, timeout,
+                  cookies << "baseproject=ALL;search_devel=true;search_debug=false;search_lang=false"
           end
 
           def uri
@@ -180,24 +187,24 @@ module Zypper
           end
         end
 
-
+        #
+        # Handle the page on Packman.
+        #
         class Packman < PageRequest
-
-          URL = 'http://packman.links2linux.org/package/'
+          URL = "http://packman.links2linux.org/package/"
 
           def uri
             URI(URL + URI.encode(@query))
           end
-
         end
       end
 
-
       module Links
-
+        #
+        # Handles the links on openSUSE
+        #
         class Opensuse < PageRequest
-
-          URL = 'https://software.opensuse.org/download/package'
+          URL = "https://software.opensuse.org/download/package"
 
           def initialize(query, refresh, timeout = 60, cookies = [])
             query = URI(query).query
@@ -205,25 +212,26 @@ module Zypper
           end
 
           def uri
-            URI(@query =~ /:\/\// ? @query : URL + '?' + @query)
+            URI(@query =~ %r{://} ? @query : "#{URL}?#{@query}")
           end
         end
 
+        #
+        # Handles the links on Packman.
+        #
         class Packman < PageRequest
-
-          URL = 'http://packman.links2linux.org/package/'
+          URL = "http://packman.links2linux.org/package/"
 
           def initialize(query, refresh, timeout = 60, cookies = [])
-            query = query.split('/')[-2..-1].join('/') if query =~ /:\/\//
+            query = query.split("/")[-2..].join("/") if query =~ %r{://}
             super query, refresh, timeout, cookies
           end
 
           def uri
-            URI(@query =~ /:\/\// ? @query : URL + URI.encode(@query))
+            URI(@query =~ %r{://} ? @query : "#{URL}#{URI.encode(@query)}")
           end
         end
       end
-
     end
   end
 end

data/lib/zypper/onlinesearch/utils.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 module Zypper
+  #
+  # Collection of util classes.
+  #
   module Onlinesearch
-
+    #
+    # String class patch.
+    #
     class ::String
       def black;          "\033[30m#{self}\033[0m" end
       def red;            "\033[31m#{self}\033[0m" end
@@ -26,48 +33,63 @@ module Zypper
       def none;           self end
     end
 
+    #
+    # Float class patch.
+    #
     class ::Float
       def to_human
         conv = {
-          1024=>'B',
-          1024*1024=>'KB',
-          1024*1024*1024=>'MB',
-          1024*1024*1024*1024=>'GB',
-          1024*1024*1024*1024*1024=>'TB',
-          1024*1024*1024*1024*1024*1024=>'PB',
-          1024*1024*1024*1024*1024*1024*1024=>'EB'
+          1024 => "B",
+          1024 * 1024 => "KB",
+          1024 * 1024 * 1024 => "MB",
+          1024 * 1024 * 1024 * 1024 => "GB",
+          1024 * 1024 * 1024 * 1024 * 1024 => "TB",
+          1024 * 1024 * 1024 * 1024 * 1024 * 1024 => "PB",
+          1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 => "EB"
         }
-        conv.keys.sort.each { |mult|
+        conv.keys.sort.each do |mult|
           next if self >= mult
-          suffix=conv[mult]
-          return "%.2f %s" % [ self / (mult / 1024), suffix ]
-        }
+
+          suffix = conv[mult]
+          return format("%<fnum>.2f %<suffix>s", fnum: self / (mult / 1024), suffix: suffix)
+        end
       end
     end
 
+    #
+    # Array class patch.
+    #
     class ::Array
       def max_column(field)
-        self.max_by { |x| x[field].to_s.length }[field].to_s.length
+        max_by { |x| x[field].to_s.length }[field].to_s.length
       end
     end
 
+    #
+    # Default error code.
+    #
     class ::StandardError
       def error_code
         1
       end
     end
 
+    #
+    # Color the error message.
+    #
     class Messages
-
-      def self.error(e)
-        if e.class == String
-          puts ' [E] '.bold.red + e
+      def self.error(err)
+        if err.instance_of? String
+          puts " #{"[E]".bold.red} #{err}"
         else
-          STDERR.puts 'Error! '.bold.red + e.message
+          warn "Error! ".bold.red + err.message
         end
       end
     end
 
+    #
+    # Too short query string.
+    #
     class QueryStringTooShort < StandardError
       def initialize(query)
         super "The query string '#{query}' is too short, be sure to use more than 3 characters."
@@ -78,12 +100,18 @@ module Zypper
       end
     end
 
+    #
+    # Too many redirections.
+    #
     class TooManyRedirections < StandardError
       def initialize(url)
         super "#{url} generates too many redirections!"
       end
     end
 
+    #
+    # Invalid engine request.
+    #
     class InvalidEngine < StandardError
       def initialize(engine)
         super "#{engine} is not a valid engine!"
@@ -94,21 +122,30 @@ module Zypper
       end
     end
 
+    #
+    # No item number provided.
+    #
     class MissingItemNumber < StandardError
       def initialize
-        super 'No item number has been provided!'
+        super "No item number has been provided!"
       end
     end
 
+    #
+    # Empty cache folder.
+    #
     class EmptyCache < StandardError
       def initialize
-        super 'The cache folder is already empty!'
+        super "The cache folder is already empty!"
       end
     end
 
+    #
+    # No internet connection.
+    #
     class NoConnection < StandardError
       def initialize
-        super 'Internet connection has some trouble'
+        super "Internet connection has some trouble"
       end
 
       def error_code
@@ -116,15 +153,16 @@ module Zypper
       end
     end
 
+    #
+    # Ctrl + C message error.
+    #
     class Interruption < StandardError
       def initialize
-        super 'Ok ok... Exiting!'
+        super "Ok ok... Exiting!"
       end
     end
 
-    Signal.trap('INT') { raise Interruption }
-
-    Signal.trap('TERM') { raise Interruption }
-
+    Signal.trap("INT") { raise Interruption }
+    Signal.trap("TERM") { raise Interruption }
   end
 end

data/lib/zypper/onlinesearch/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zypper
   module Onlinesearch
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end