recog 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adbba4275e0d4b8b6c41541ea76d522529d17525f1f1fcce5147625d2a8adb59
-  data.tar.gz: 71929660f907cd74dfcd3f74ea0f3761efd33992821333059b50e5e6e5d52629
+  metadata.gz: 06e7e85a8a5531bf315f482708ed3ada966be06efea9d09d85add533d098c2f9
+  data.tar.gz: e683dd6e7c529d95eef78cf1ebf32a19594449a2105593234860619393643aa0
 SHA512:
-  metadata.gz: e37368c659cbeadbc38cd90e9a71b41825a02d2e060d88b19f06bab86f791474033b0a26c0481be4a89ab46dc9ddbc5f151241f45bdf96eeb0644edd19be548b
-  data.tar.gz: c7d438651a3b40f1586793ce60d1589c00541fd8fe587e480d477af6f02618d013c2edd5afeafff010931aa495ef6c417ba980072c8667e5e41a1a25efe585c6
+  metadata.gz: 69bc3fe5c446de07ee4234f668293839c902eb7df8dbd89e5e5b410a8d43bcddecd4cda0d0acb513c3f262d6aa5496e3ade0a2ad4df02b724a6b5b21edc37f9c
+  data.tar.gz: 2fb2209fcc598a8a592e4f81ced771dc5520e4cb46f06277e8e9a47e3827f7d0f4d0348a6c41bb759eb538943e06694c3b1f34d04fe09c235ac375110c2cedb1

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec name: 'recog'
@@ -8,3 +10,7 @@ group :test do
   gem 'rake'
   gem 'regexp_parser'
 end
+
+group :rubocop do
+  gem 'rubocop'
+end

data/Rakefile

@@ -1,15 +1,17 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new do |t|
-    t.pattern = ['spec/**/*_spec.rb', 'recog/spec/**/*_spec.rb']
+  t.pattern = ['spec/**/*_spec.rb', 'recog/spec/**/*_spec.rb']
 end
 
 require 'yard'
 require 'yard/rake/yardoc_task'
 YARD::Rake::YardocTask.new do |t|
-    t.files = ['lib/**/*.rb', '-', 'README.md']
+  t.files = ['lib/**/*.rb', '-', 'README.md']
 end
 
-task :default => [ :tests, :yard ]
-task :tests => [ :spec ]
+task default: %i[tests yard]
+task tests: [:spec]

data/lib/recog/db.rb

@@ -1,79 +1,78 @@
-module Recog
-
-# A collection of {Fingerprint fingerprints} for matching against a particular
-# kind of fingerprintable data, e.g. an HTTP `Server` header
-class DB
-  require 'nokogiri'
-  require 'recog/fingerprint'
-
-  # @return [String]
-  attr_reader :path
-
-  # @return [Array<Fingerprint>] {Fingerprint} objects that can be matched
-  #   against strings that make sense for the {#match_key}
-  attr_reader :fingerprints
-
-  # @return [String] Taken from the `fingerprints/matches` attribute, or
-  #   defaults to the basename of {#path} without the `.xml` extension.
-  attr_reader :match_key
-
-  # @return [String] Taken from the `fingerprints/protocol` attribute, or
-  #   defaults to an empty string
-  attr_reader :protocol
-
-  # @return [String] Taken from the `fingerprints/database_type` attribute
-  #   defaults to an empty string
-  attr_reader :database_type
-
-  # @return [Float] Taken from the `fingerprints/preference` attribute,
-  #   defaults to 0.10.  Used when ordering databases, highest numbers
-  #   are given priority and are processed first.
-  attr_reader :preference
-
-  # Default Fingerprint database preference when it isn't specified in file
-  # Do not use a value below 0.10 so as to allow users to specify lower
-  # values in their own custom XML that will always run last.
-  DEFAULT_FP_PREFERENCE = 0.10
-
-  # @param path [String]
-  def initialize(path)
-    @match_key = nil
-    @protocol = ''
-    @database_type = ''
-    @preference = DEFAULT_FP_PREFERENCE.to_f
-    @path = path
-    @fingerprints = []
-
-    parse_fingerprints
-  end
+# frozen_string_literal: true
 
-  # @return [void]
-  def parse_fingerprints
-    xml = nil
-
-    File.open(self.path, 'rb') do |fd|
-      xml = Nokogiri::XML(fd.read(fd.stat.size))
+module Recog
+  # A collection of {Fingerprint fingerprints} for matching against a particular
+  # kind of fingerprintable data, e.g. an HTTP `Server` header
+  class DB
+    require 'nokogiri'
+    require 'recog/fingerprint'
+
+    # @return [String]
+    attr_reader :path
+
+    # @return [Array<Fingerprint>] {Fingerprint} objects that can be matched
+    #   against strings that make sense for the {#match_key}
+    attr_reader :fingerprints
+
+    # @return [String] Taken from the `fingerprints/matches` attribute, or
+    #   defaults to the basename of {#path} without the `.xml` extension.
+    attr_reader :match_key
+
+    # @return [String] Taken from the `fingerprints/protocol` attribute, or
+    #   defaults to an empty string
+    attr_reader :protocol
+
+    # @return [String] Taken from the `fingerprints/database_type` attribute
+    #   defaults to an empty string
+    attr_reader :database_type
+
+    # @return [Float] Taken from the `fingerprints/preference` attribute,
+    #   defaults to 0.10.  Used when ordering databases, highest numbers
+    #   are given priority and are processed first.
+    attr_reader :preference
+
+    # Default Fingerprint database preference when it isn't specified in file
+    # Do not use a value below 0.10 so as to allow users to specify lower
+    # values in their own custom XML that will always run last.
+    DEFAULT_FP_PREFERENCE = 0.10
+
+    # @param path [String]
+    def initialize(path)
+      @match_key = nil
+      @protocol = ''
+      @database_type = ''
+      @preference = DEFAULT_FP_PREFERENCE.to_f
+      @path = path
+      @fingerprints = []
+
+      parse_fingerprints
     end
 
-    raise "#{self.path} is invalid XML: #{xml.errors.join(',')}" unless xml.errors.empty?
+    # @return [void]
+    def parse_fingerprints
+      xml = nil
 
-    xml.xpath('/fingerprints').each do |fbase|
+      File.open(path, 'rb') do |fd|
+        xml = Nokogiri::XML(fd.read(fd.stat.size))
+      end
 
-      @match_key = fbase['matches'].to_s if fbase['matches']
-      @protocol = fbase['protocol'].to_s if fbase['protocol']
-      @database_type = fbase['database_type'].to_s if fbase['database_type']
-      @preference = fbase['preference'].to_f if fbase['preference']
+      raise "#{path} is invalid XML: #{xml.errors.join(',')}" unless xml.errors.empty?
 
-    end
+      xml.xpath('/fingerprints').each do |fbase|
+        @match_key = fbase['matches'].to_s if fbase['matches']
+        @protocol = fbase['protocol'].to_s if fbase['protocol']
+        @database_type = fbase['database_type'].to_s if fbase['database_type']
+        @preference = fbase['preference'].to_f if fbase['preference']
+      end
 
-    filepath =  self.path.sub(/\.xml$/, '')
-    @match_key = File.basename(self.path).sub(/\.xml$/, '') unless @match_key
+      filepath = path.sub(/\.xml$/, '')
+      @match_key ||= File.basename(path).sub(/\.xml$/, '')
 
-    xml.xpath('/fingerprints/fingerprint').each do |fprint|
-      @fingerprints << Fingerprint.new(fprint, @match_key, @protocol, filepath)
-    end
+      xml.xpath('/fingerprints/fingerprint').each do |fprint|
+        @fingerprints << Fingerprint.new(fprint, @match_key, @protocol, filepath)
+      end
 
-    xml = nil
+      xml = nil
+    end
   end
 end
-end

data/lib/recog/db_manager.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
+
 module Recog
-class DBManager
-  require 'nokogiri'
-  require 'recog/db'
+  class DBManager
+    require 'nokogiri'
+    require 'recog/db'
 
-  attr_accessor :path, :databases
+    attr_accessor :path, :databases
 
-  DefaultDatabasePath = File.expand_path(File.join(File.expand_path(__dir__), ["..", "..", "recog", "xml"]))
+    DefaultDatabasePath = File.expand_path(File.join(File.expand_path(__dir__), ['..', '..', 'recog', 'xml']))
 
-  def initialize(path = DefaultDatabasePath)
-    self.path = path
-    reload
-  end
+    def initialize(path = DefaultDatabasePath)
+      self.path = path
+      reload
+    end
 
-  def load_databases
-    if File.directory?(self.path)
-      Dir[self.path + "/*.xml"].each do |dbxml|
-        self.databases << DB.new(dbxml)
+    def load_databases
+      if File.directory?(path)
+        Dir["#{path}/*.xml"].each do |dbxml|
+          databases << DB.new(dbxml)
+        end
+      else
+        databases << DB.new(path)
       end
-    else
-      self.databases << DB.new(self.path)
     end
-  end
 
-  def reload
-    self.databases = []
-    load_databases
+    def reload
+      self.databases = []
+      load_databases
+    end
   end
-
-end
 end

data/lib/recog/fingerprint/regexp_factory.rb

@@ -1,14 +1,13 @@
+# frozen_string_literal: true
 
 module Recog
   class Fingerprint
-
     #
     # @example
     #   r = RegexpFactory.build("^Apache[ -]Coyote/(\d\.\d)$", "REG_ICASE")
     #   r.match("Apache-Coyote/1.1")
     #
     module RegexpFactory
-
       # Currently, only options relating to case insensitivity and
       # multiline/newline are supported.  Because Recog's data is used by tools
       # written in different languages like Ruby and Java, we currently support
@@ -19,13 +18,13 @@ module Recog
       # that use Recog data translate accordingly
       FLAG_MAP = {
         # multiline variations
-        'REG_DOT_NEWLINE'   => Regexp::MULTILINE,
+        'REG_DOT_NEWLINE' => Regexp::MULTILINE,
         'REG_LINE_ANY_CRLF' => Regexp::MULTILINE,
-        'REG_MULTILINE'     => Regexp::MULTILINE,
+        'REG_MULTILINE' => Regexp::MULTILINE,
         # case variations
-        'REG_ICASE'         => Regexp::IGNORECASE,
-        'IGNORECASE'        => Regexp::IGNORECASE
-      }
+        'REG_ICASE' => Regexp::IGNORECASE,
+        'IGNORECASE' => Regexp::IGNORECASE
+      }.freeze
 
       DEFAULT_FLAGS = 0
 
@@ -42,15 +41,13 @@ module Recog
       # @param flags [Array<String>]
       # @return [Fixnum] Flags for creating a regular expression object
       def self.build_options(flags)
-        unsupported_flags = flags.select { |flag| !FLAG_MAP.key?(flag) }
-        unless unsupported_flags.empty?
-          fail "Unsupported regular expression flags found: #{unsupported_flags.join(',')}. Must be one of: #{FLAG_MAP.keys.join(',')}"
-        end
+        unsupported_flags = flags.reject { |flag| FLAG_MAP.key?(flag) }
+        raise "Unsupported regular expression flags found: #{unsupported_flags.join(',')}. Must be one of: #{FLAG_MAP.keys.join(',')}" unless unsupported_flags.empty?
+
         flags.reduce(DEFAULT_FLAGS) do |sum, flag|
-          sum |= (FLAG_MAP[flag] || 0)
+          sum | (FLAG_MAP[flag] || 0)
         end
       end
     end
   end
 end
-

data/lib/recog/fingerprint/test.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
 
 class Recog::Fingerprint::Test
-  attr_accessor :content
-  attr_accessor :attributes
-  def initialize(content, attributes=[])
+  attr_accessor :content, :attributes
+
+  def initialize(content, attributes = [])
     @attributes = attributes
 
-    if @attributes['_encoding'] && @attributes['_encoding'] == 'base64'
-      @content = content.to_s.unpack('m*').first
-    else
-      @content = content
-    end
+    @content = if @attributes['_encoding'] && @attributes['_encoding'] == 'base64'
+                 content.to_s.unpack1('m*')
+               else
+                 content
+               end
   end
 
   def to_s