ronin-web-user_agents 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a3e3bfe46dc0c698ffee051249993e16f7cb1e3f411e140b4379a168b4f5ee
-  data.tar.gz: aed3f4680b30846c2d8c61caa8addca28e86de85deeb94fb6fdb7ac6f18bd05a
+  metadata.gz: 362b831e0de6d339b41a3c12fd0c80cc542f250ddb8cb00304a10b9efe4f4d05
+  data.tar.gz: 2f56546e867a79c8a9a1393261f2b4546c70f192d93736c7499ecf2289961f84
 SHA512:
-  metadata.gz: 76ebaf12208752b5ec1b2466a1dc0992aa202a026a2b700062014ee7c4d7ed15e6161340176dda532b3f6d0330f97c9a10be5146f2996b7b622f341d764c7759
-  data.tar.gz: b9dbce6211bfe348305adf37ff68de6b77ebb5a5b96c6fea4173accfae17a893834ea831297f741c1211089525b9b61bcf68d27b77189965b88a894fe1b8334d
+  metadata.gz: 69d452562cbf97cb037ece1d94e364ab39aff4458295cc5339140307248962838a24e87dcec8cc11abc9c1f1c6574c512177f16a142bfc445b7be1a6b9076e5a
+  data.tar.gz: 708c8b9ca36740ca6d8a90eb5bd7059e521e9f98b46af10aa7fc07b2c65c1a99ade85e1befcd5b30fade7e204ad0d076a0e6b66116bb9d277a08d7c4ff5fe0d4

data/.github/workflows/ruby.yml

@@ -12,11 +12,13 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
+          - '3.4'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -30,3 +32,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-FIXME specific exceptions
+#

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1
+ruby-3.3

data/ChangeLog.md

@@ -1,4 +1,8 @@
-### 0.1.0 / 2023-XX-XX
+### 0.1.1 / 2025-02-14
+
+* Use `require_relative` to improve load times.
+
+### 0.1.0 / 2023-02-01
 
 * Extracted and refactored from [ronin-web](https://github.com/ronin-rb/ronin-web/tree/v0.3.0.rc1).
 * Relicensed as LGPL-3.0.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -23,4 +25,6 @@ group :development do
   gem 'dead_end',        require: false
   gem 'sord',            require: false, platform: :mri
   gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
 end

data/README.md

@@ -9,7 +9,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-web-user_agents/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-web-user_agents/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
@@ -45,8 +44,7 @@ user_agent = Ronin::Web::UserAgents.chrome.random
 Build a specific Chrome `User-Agent` for Android 10.0 string:
 
 ```ruby
-Ronin::Web::UserAgents.chrome.build(chrome_version: '100.0.4758.81', os: :
-android, os_version: '10.0')
+Ronin::Web::UserAgents.chrome.build(chrome_version: '100.0.4758.81', os: :android, os_version: '10.0')
 # => "Mozilla/5.0 (Linux; Android 10.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4758.81 Mobile Safari/537.36"
 ```
 
@@ -160,7 +158,7 @@ gem.add_dependency 'ronin-web-user_agents', '~> 0.1'
 
 ## License
 
-Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3@gmail.com)
+Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3@gmail.com)
 
 ronin-web-user_agents is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published

data/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin

data/gemspec.yml

@@ -2,7 +2,7 @@ name: ronin-web-user_agents
 summary: Generate random but realistic User-Agent strings
 description: Yet another User-Agent string generator library.
 
-license: LGPL-3.0
+license: LGPL-3.0-or-later
 authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://ronin-rb.dev/

data/lib/ronin/web/user_agents/chrome.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,10 +18,10 @@
 # along with ronin-web-user_agents.  If not, see <https://www.gnu.org/licenses/>
 #
 
-require 'ronin/web/user_agents/os/windows'
-require 'ronin/web/user_agents/os/mac_os'
-require 'ronin/web/user_agents/os/linux'
-require 'ronin/web/user_agents/os/android'
+require_relative 'os/windows'
+require_relative 'os/mac_os'
+require_relative 'os/linux'
+require_relative 'os/android'
 
 module Ronin
   module Web
@@ -30,7 +30,6 @@ module Ronin
       # Represents every possible Chrome `User-Agent` string.
       #
       module Chrome
-
         #
         # Builds a new Chrome `User-Agent` string.
         #
@@ -186,8 +185,6 @@ module Ronin
           )
         end
 
-        private
-
         #
         # Builds a Chrome `User-Agent` string for Windows.
         #

data/lib/ronin/web/user_agents/data_dir.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/web/user_agents/firefox.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,11 +18,11 @@
 # along with ronin-web-user_agents.  If not, see <https://www.gnu.org/licenses/>
 #
 
-require 'ronin/web/user_agents/os/windows'
-require 'ronin/web/user_agents/os/mac_os'
-require 'ronin/web/user_agents/os/linux'
-require 'ronin/web/user_agents/os/android'
-require 'ronin/web/user_agents/data_dir'
+require_relative 'os/windows'
+require_relative 'os/mac_os'
+require_relative 'os/linux'
+require_relative 'os/android'
+require_relative 'data_dir'
 
 module Ronin
   module Web
@@ -33,7 +33,6 @@ module Ronin
       # @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent/Firefox
       #
       module Firefox
-
         # The default `Gecko/...` version.
         #
         # @note: On desktop, the `Gecko/...` version is hardcoded to `20100101`
@@ -244,8 +243,6 @@ module Ronin
           )
         end
 
-        private
-
         #
         # Builds a Firefox `User-Agent` string for Windows.
         #
@@ -319,12 +316,12 @@ module Ronin
         #
         def self.build_linux(encryption: nil, linux_distro: nil, arch: nil, lang: nil, firefox_version: )
           encryption_flag = ENCRYPTION.fetch(encryption)
-          linux_arch    = OS::Linux::ARCHES[arch]
-          linux_distro  = OS::Linux::DISTROS.fetch(linux_distro,linux_distro)
+          linux_arch      = OS::Linux::ARCHES[arch]
+          linux_distro    = OS::Linux::DISTROS.fetch(linux_distro,linux_distro)
 
           extensions = String.new("X11")
           extensions << "; #{encryption_flag}" if encryption_flag
-          extensions << "; #{linux_distro}"  if linux_distro
+          extensions << "; #{linux_distro}" if linux_distro
           extensions << "; Linux"
           extensions << " #{linux_arch}" if linux_arch
           extensions << "; #{lang}" if lang
@@ -353,7 +350,6 @@ module Ronin
 
           return "Mozilla/5.0 (#{extensions}) Gecko/#{firefox_version} Firefox/#{firefox_version}"
         end
-
       end
     end
   end

data/lib/ronin/web/user_agents/google_bot.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-web-user_agents.  If not, see <https://www.gnu.org/licenses/>
 #
 
-require 'ronin/web/user_agents/chrome'
+require_relative 'chrome'
 
 module Ronin
   module Web
@@ -64,7 +64,6 @@ module Ronin
         # @api public
         #
         def self.build(crawler: :search, compatible: nil, chrome_version: nil)
-
           case crawler
           when :image
             "Googlebot-Image/1.0"

data/lib/ronin/web/user_agents/os/android.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -18,7 +18,7 @@
 # along with ronin-web-user_agents.  If not, see <https://www.gnu.org/licenses/>
 #
 
-require 'ronin/web/user_agents/data_dir'
+require_relative '../data_dir'
 
 module Ronin
   module Web

data/lib/ronin/web/user_agents/os/linux.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/web/user_agents/os/mac_os.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -97,8 +97,10 @@ module Ronin
             '11.55'   => '11_55',
             '11.6.3'  => '11_6_3',
             '12.2.0'  => '12_2_0',
-            '16.55'   => '16_55',
+            '16.55'   => '16_55'
           }
+
+          # Set a default `VERSIONS_UNDERSCORED` rule of `X.Y` -> `X_Y`.
           VERSIONS_UNDERSCORED.default_proc = ->(hash,version) {
             version.tr('.','_')
           }
@@ -108,7 +110,6 @@ module Ronin
             intel:  'Intel',
             x86_64: 'Intel'
           }
-
         end
       end
     end

data/lib/ronin/web/user_agents/os/windows.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/web/user_agents/version.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -22,7 +22,7 @@ module Ronin
   module Web
     module UserAgents
       # ronin-web-user_agents version
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

data/lib/ronin/web/user_agents.rb

@@ -2,7 +2,7 @@
 #
 # ronin-web-user_agents - Yet another User-Agent string generator library.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2025 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-web-user_agents is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -19,13 +19,13 @@
 #
 
 # browsers
-require 'ronin/web/user_agents/chrome'
-require 'ronin/web/user_agents/firefox'
+require_relative 'user_agents/chrome'
+require_relative 'user_agents/firefox'
 
 # crawlers
-require 'ronin/web/user_agents/google_bot'
+require_relative 'user_agents/google_bot'
 
-require 'ronin/web/user_agents/version'
+require_relative 'user_agents/version'
 
 module Ronin
   module Web
@@ -55,7 +55,6 @@ module Ronin
     #     # => "GoogleBot/2.1 (+http://www.google.com/bot.html)"
     #
     module UserAgents
-
       #
       # Google Chrome `User-Agent` strings.
       #
@@ -91,7 +90,7 @@ module Ronin
       #
       # @example
       #   user_agent = Ronin::Web::UserAgents.firefox.random
-      #   # => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.16.0; rv:52.55.07) Gecko/20100101 Firefox/52.55.07" 
+      #   # => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.16.0; rv:52.55.07) Gecko/20100101 Firefox/52.55.07"
       #
       # @api public
       #
@@ -129,13 +128,13 @@ module Ronin
       #   Ronin::Web::UserAgents.random
       #   # => "Mozilla/5.0 (X11; Fedora; Linux i686; en-IE; rv:123.4) Gecko/20100101 Firefox/123.4"
       #
-      def self.random(&block)
+      def self.random
         method = [
           :chrome,
-          :firefox,
+          :firefox
         ].sample
 
-        return send(method).random(&block)
+        return send(method).random
       end
     end
   end

data/ronin-web-user_agents.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.homepage    = gemspec['homepage']
   gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
-  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+  glob = ->(patterns) { gem.files & Dir[*patterns] }
 
   gem.files  = `git ls-files`.split($/)
   gem.files  = glob[gemspec['files']] if gemspec['files']
@@ -46,7 +46,7 @@ Gem::Specification.new do |gem|
   gem.required_rubygems_version = gemspec['required_rubygems_version']
   gem.post_install_message      = gemspec['post_install_message']
 
-  split = lambda { |string| string.split(/,\s*/) }
+  split = ->(string) { string.split(/,\s*/) }
 
   if gemspec['dependencies']
     gemspec['dependencies'].each do |name,versions|

data/scripts/index_user_agents

@@ -1,7 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'set'
 
+#
+# A `User-Agent` strings txt file parser.
+#
 class UserAgentsFile
 
   attr_reader :path
@@ -27,7 +31,7 @@ class UserAgentsFile
 
   EXTENSION_SEPARATOR = /\s*;\s+/
 
-  REGEXP = /(#{PRODUCT_REGEXP})\/(#{PRODUCT_VERSION_REGEXP})(?:\s+\((#{EXTENSIONS_REGEXP})\))?/
+  REGEXP = %r{(#{PRODUCT_REGEXP})/(#{PRODUCT_VERSION_REGEXP})(?:\s+\((#{EXTENSIONS_REGEXP})\))?}
 
   VERSION_REGEXP = /\d+(?:\.\d+)*/
 
@@ -55,7 +59,7 @@ class UserAgentsFile
     product_versions = Hash.new { |hash,key| hash[key] = 0 }
 
     parse do |matches|
-      _,product_version,_ = *matches.find do |(product,_,_)|
+      _, product_version, = *matches.find do |(product,_,_)|
         product == search_product
       end
 
@@ -74,8 +78,6 @@ class UserAgentsFile
       _,_,extensions = matches.find { |(product,_,_)| product == target_product }
 
       if extensions
-        tree_node = product_extensions
-
         product_extensions[extensions.split(EXTENSION_SEPARATOR)] += 1
       end
     end
@@ -115,7 +117,7 @@ class UserAgentsFile
     each_product('Mozilla') do |product,product_version,extensions|
       if extensions
         if (match = extensions.match(/Windows NT (#{VERSION_REGEXP});/))
-            windows_versions << match[1]
+          windows_versions << match[1]
         end
       end
     end
@@ -129,7 +131,7 @@ class UserAgentsFile
     each_product('Mozilla') do |product,product_version,extensions|
       if extensions
         if (match = extensions.match(/; Android (#{VERSION_REGEXP});/))
-            android_versions << match[1]
+          android_versions << match[1]
         end
       end
     end
@@ -199,7 +201,7 @@ if $0 == __FILE__
     opts.banner = './scripts/index_user_agents [options] FILE'
 
     opts.on('--products', 'List all product names') do
-      @method = :index_product_combinations
+      @method     = :index_product_combinations
       @print_mode = :count
     end
 
@@ -249,21 +251,21 @@ if $0 == __FILE__
   args = begin
            optparser.parse(ARGV)
          rescue OptionParser::ParseError => error
-           $stderr.puts "./scripts/index_user_agents: #{error.message}"
-           exit -1
+           warn "./scripts/index_user_agents: #{error.message}"
+           exit(-1)
          end
 
   unless (file_path = args[0])
-    $stderr.puts "./scripts/index_user_agents: must specify a User-Agents FILE"
-    exit -1
+    warn "./scripts/index_user_agents: must specify a User-Agents FILE"
+    exit(-1)
   end
 
   user_agents = UserAgentsFile.new(file_path)
 
   unless @method
-    $stderr.puts "./scripts/index_user_agents: must specify atleast one option"
-    $stderr.puts optparser
-    exit -1
+    warn "./scripts/index_user_agents: must specify atleast one option"
+    warn optparser
+    exit(-1)
   end
 
   results = user_agents.send(@method,*@method_args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-web-user_agents
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -37,6 +37,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".yardopts"
 - COPYING.txt
@@ -64,7 +65,7 @@ files:
 - scripts/index_user_agents
 homepage: https://ronin-rb.dev/
 licenses:
-- LGPL-3.0
+- LGPL-3.0-or-later
 metadata:
   documentation_uri: https://ronin-rb.dev/docs/ronin-web-user_agents
   source_code_uri: https://github.com/ronin-rb/ronin-web-user_agents
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Generate random but realistic User-Agent strings