apt-spy2 0.7.3 → 0.8.2

data/lib/apt/spy2/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Apt
   module Spy2
-    VERSION = "0.7.3"
+    VERSION = '0.8.2'
   end
 end

data/lib/apt/spy2/writer.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 require 'colored'
 require 'json'
 
 module Apt
   module Spy2
+    # abstracted puts or json
     class Writer
       def initialize(format)
-
-        if !["json", "shell"].include?(format)
-          raise "Unknown format: #{format}"
-        end
+        raise "Unknown format: #{format}" unless %w[json shell].include?(format)
 
         @format = format
         @complete = []
       end
 
-      def set_complete(complete)
+      def complete(complete)
         @complete = complete
       end
 
@@ -24,32 +24,29 @@ module Apt
           return
         end
 
-        print "Mirror: #{data["mirror"]} - "
+        print "Mirror: #{data['mirror']} - "
 
-        case data["status"]
-        when "up"
-          puts data["status"].upcase.green
-        when "down"
-          puts data["status"].upcase.red
-        when "broken"
-          puts data["status"].upcase.yellow
+        case data['status']
+        when 'up'
+          puts data['status'].upcase.green
+        when 'down'
+          puts data['status'].upcase.red
+        when 'broken'
+          puts data['status'].upcase.yellow
         else
-          puts "Unknown status: #{data["status"]}".white_on_red
+          puts "Unknown status: #{data['status']}".white_on_red
         end
       end
 
       def json?
-        if @format == 'json'
-          return true
-        end
+        return true if @format == 'json'
 
-        return false
+        false
       end
 
-      def to_json
+      def to_json(*_args)
         JSON.generate(@complete)
       end
-
     end
   end
 end

data/lib/apt/spy2.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'thor'
-require 'open-uri'
 require 'colored'
 require 'fileutils'
 require 'apt/spy2/writer'
@@ -7,120 +8,130 @@ require 'apt/spy2/country'
 require 'apt/spy2/downloader'
 require 'apt/spy2/ubuntu_mirrors'
 require 'apt/spy2/launchpad'
+require 'apt/spy2/request'
+require 'apt/spy2/url'
 
+# apt-spy2 command interface
 class AptSpy2 < Thor
-  package_name "apt-spy2"
+  package_name 'apt-spy2'
+  class_option :country, default: 'mirrors'
+  class_option :launchpad, type: :boolean, banner: "Use launchpad's mirror list"
 
-  desc "fix", "Set the closest/fastest mirror"
-  option :country, :default => "mirrors"
-  option :commit, :type => :boolean
-  option :launchpad, :type => :boolean, :banner => "Use launchpad's mirror list"
+  desc 'fix', 'Set the closest/fastest mirror'
+  option :commit, type: :boolean
+  option :strict, type: :boolean
   def fix
-    working = filter(retrieve(options[:country], use_launchpad?(options)), false)
-    print "The closest mirror is: "
-    puts "#{working[0]}".bold.magenta
-    if !options[:commit]
-      puts "Run with --commit to adjust /etc/apt/sources.list".yellow
-    else
-      puts "Updating /etc/apt/sources.list".yellow
-      update(working[0])
+    mirrors = retrieve(options[:country], use_launchpad?(options))
+    working = filter(mirrors, options[:strict], false)
+    print 'The closest mirror is: '
+    puts (working[0]).to_s.bold.magenta
+    unless options[:commit]
+      puts 'Run with --commit to adjust /etc/apt/sources.list'.yellow
+      return
     end
+
+    puts 'Updating /etc/apt/sources.list'.yellow
+    update(working[0])
   end
 
-  desc "check", "Evaluate mirrors"
-  option :country, :default => "mirrors"
-  option :output, :type => :boolean, :default => true
-  option :format, :default => "shell"
-  option :launchpad, :type => :boolean, :banner => "Use launchpad's mirror list"
+  desc 'check', 'Evaluate mirrors'
+  option :output, type: :boolean, default: true
+  option :format, default: 'shell'
+  option :strict, type: :boolean
   def check
-
     @writer = Apt::Spy2::Writer.new(options[:format])
 
     mirrors = retrieve(options[:country], use_launchpad?(options))
-    filter(mirrors, options[:output])
+    filter(mirrors, options[:strict], options[:output])
 
     puts @writer.to_json if @writer.json?
   end
 
-  desc "list", "List the currently available mirrors"
-  option :country, :default => "mirrors"
-  option :format, :default => "shell"
-  option :launchpad, :type => :boolean, :banner => "Use launchpad's mirror list"
+  desc 'list', 'List the currently available mirrors'
+  option :format, default: 'shell'
   def list
     mirrors = retrieve(options[:country], use_launchpad?(options))
 
     @writer = Apt::Spy2::Writer.new(options[:format])
 
-    @writer.set_complete(mirrors)
+    @writer.complete(mirrors)
 
     puts @writer.to_json if @writer.json?
-    puts mirrors if !@writer.json?
+    puts mirrors unless @writer.json?
   end
 
-  desc "version", "Show which version of apt-spy2 is installed"
+  desc 'version', 'Show which version of apt-spy2 is installed'
   def version
     puts Apt::Spy2::VERSION
     exit
   end
 
   private
-  def retrieve(country = "mirrors", launchpad = false)
 
+  def retrieve(country = 'mirrors', launchpad = false)
     downloader = Apt::Spy2::Downloader.new
 
-    if launchpad === true
-      csv_path = File.expand_path(File.dirname(__FILE__) + "/../../var/country-names.txt")
+    if launchpad
+      csv_path = File.expand_path("#{File.dirname(__FILE__)}/../../var/country-names.txt")
       country  = Apt::Spy2::Country.new(csv_path)
       name     = country.to_country_name(options[:country])
 
       launchpad = Apt::Spy2::Launchpad.new(downloader.do_download('https://launchpad.net/ubuntu/+archivemirrors'))
-      return launchpad.get_mirrors(name)
+      return launchpad.mirrors(name)
     end
 
     country.upcase! if country.length == 2
 
     ubuntu_mirrors = Apt::Spy2::UbuntuMirrors.new(downloader.do_download("http://mirrors.ubuntu.com/#{country}.txt"))
-    mirrors = ubuntu_mirrors.get_mirrors(country)
-    return mirrors
-
+    ubuntu_mirrors.mirrors(country)
   end
 
-  private
-  def filter(mirrors, output = true)
+  def filter(mirrors, strict = false, output = true)
     # f me :)
 
     working_mirrors = []
 
+    url = Apt::Spy2::Url.new(strict)
+
     mirrors.each do |mirror|
-      data = {"mirror" => mirror }
-      begin
-        URI.open(mirror)
-        data["status"] = "up"
-        working_mirrors << mirror
-      rescue OpenURI::HTTPError
-        data["status"] = "broken"
-      rescue
-        # this is a catch-all for everything else
-        data["status"] = "down"
-      end
+      data = { 'mirror' => mirror }
+
+      check = url.adjust!(mirror)
+
+      status = broken?(check)
+
+      data['status'] = status
+
+      working_mirrors << mirror if status == 'up'
 
       @writer.echo(data) if output
     end
 
-    return working_mirrors
+    working_mirrors
+  end
+
+  def broken?(url)
+    begin
+      req = Apt::Spy2::Request.new(url)
+      response = req.head
+      return 'up' if response.code == '200'
+
+      return 'broken' if response.code == '404'
+    rescue StandardError
+      # connection errors, ssl errors, etc.
+    end
 
+    'down'
   end
 
-  private
   def update(mirror)
-
     t = Time.now
-    r = `lsb_release -c`.split(" ")[1]
-    sources = "## Updated on #{t.to_s} by apt-spy2\n"
-    sources << "deb #{mirror} #{r} main restricted universe multiverse\n"
-    sources << "deb #{mirror} #{r}-updates main restricted universe multiverse\n"
-    sources << "deb #{mirror} #{r}-backports main restricted universe multiverse\n"
-    sources << "deb #{mirror} #{r}-security main restricted universe multiverse\n"
+    r = `lsb_release -c`.split(' ')[1]
+    sources = "## Updated on #{t} by apt-spy2\n"
+    sources += "deb #{mirror} #{r} main restricted universe multiverse\n"
+    sources += "deb #{mirror} #{r}-updates main restricted universe multiverse\n"
+    sources += "deb #{mirror} #{r}-backports main restricted universe multiverse\n"
+    sources += "deb #{mirror} #{r}-security main restricted universe multiverse\n"
 
     apt_sources = '/etc/apt/sources.list'
 
@@ -129,26 +140,23 @@ class AptSpy2 < Thor
       File.open(apt_sources, 'w') do |f|
         f.write(sources)
       end
-    rescue
+    rescue StandardError
       msg  = "Failed updating #{apt_sources}!"
-      msg << "You probably need sudo!"
+      msg += 'You probably need sudo!'
       raise msg
     end
 
     puts "Updated '#{apt_sources}' with #{mirror}".green
-    puts "Run `apt-get update` to update".black_on_yellow
+    puts 'Run `apt-get update` to update'.black_on_yellow
   end
 
-  private
   def use_launchpad?(options)
-    if !options[:launchpad]
-      return false
-    end
+    return false unless options[:launchpad]
 
     if options[:country] && options[:country] == 'mirrors'
-      raise "Please supply a `--country=foo`. Launchpad cannot guess!"
+      raise 'Please supply a `--country=foo`. Launchpad cannot guess!'
     end
 
-    return true
+    true
   end
 end

data/test_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov-lcov'
+
+if ENV['CI']
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+  SimpleCov::Formatter::LcovFormatter.config do |c|
+    c.output_directory = './coverage'
+    c.report_with_single_file = true
+    c.single_report_path = './coverage/lcov.info'
+  end
+else
+  SimpleCov.formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                                 SimpleCov::Formatter::SimpleFormatter,
+                                                                 SimpleCov::Formatter::HTMLFormatter
+                                                               ])
+end
+
+SimpleCov.profiles.define 'apt-spy2' do
+  add_filter '/tests/'
+  add_filter '/pkg/'
+  add_filter '/vendor/'
+  add_filter '/var'
+
+  add_group 'lib', 'lib/apt'
+  add_group 'bin', 'bin'
+end
+SimpleCov.start 'apt-spy2'
+require 'minitest/autorun'

data/tests/country_test.rb

@@ -1,12 +1,15 @@
-require 'apt/spy2/country'
+# frozen_string_literal: true
 
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/country'
+
+# test the name resolution
 class CountryTest < Minitest::Test
   def setup
-    @country_list = File.expand_path(File.dirname(__FILE__) + "/../var/country-names.txt")
+    @country_list = File.expand_path("#{File.dirname(__FILE__)}/../var/country-names.txt")
   end
 
-  def test_tld_to_name()
-
+  def test_tld_to_name
     # fixtures for people who don't want to read about rails
     data = {
       'de' => 'Germany',
@@ -22,6 +25,5 @@ class CountryTest < Minitest::Test
     data.each_pair do |code, expected|
       assert_equal(expected, c.to_country_name(code))
     end
-
   end
 end

data/tests/downloader_test.rb

@@ -1,15 +1,18 @@
-require 'apt/spy2/downloader'
+# frozen_string_literal: true
 
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/downloader'
+
+# this is an integration test (needs interwebs)
 class DownloaderTest < Minitest::Test
-  # this is an integration test (needs interwebs)
-  def test_do()
+  def test_do
     downloader = Apt::Spy2::Downloader.new
-    data = downloader.do_download("http://mirrors.ubuntu.com/DE.txt")
-    assert(!data.empty?, "There should have been a response, unless the mirrors are down.")
+    data = downloader.do_download('http://mirrors.ubuntu.com/DE.txt')
+    assert(!data.empty?, 'There should have been a response, unless the mirrors are down.')
   end
 
-  def test_do_wrong_countrys()
+  def test_do_wrong_countrys
     downloader = Apt::Spy2::Downloader.new
-    assert_raises(RuntimeError) { downloader.do_download("http://mirrors.ubuntu.com/de.txt") }
+    assert_raises(RuntimeError) { downloader.do_download('http://mirrors.ubuntu.com/de.txt') }
   end
 end

data/tests/launchpad_test.rb

@@ -1,13 +1,17 @@
-require 'apt/spy2/launchpad'
+# frozen_string_literal: true
 
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/launchpad'
+
+# test to confirm launchpad format (HTML) is parsed
 class LaunchpadTest < Minitest::Test
   def setup
-    @download_fixture = File.read(File.expand_path(File.dirname(__FILE__) + "/fixtures/launchpad.html"))
+    @download_fixture = File.read(File.expand_path("#{File.dirname(__FILE__)}/fixtures/launchpad.html"))
   end
 
   def test_german_mirrors
     lp = Apt::Spy2::Launchpad.new(@download_fixture)
-    mirrors = lp.get_mirrors('Germany')
+    mirrors = lp.mirrors('Germany')
     assert_equal(false, mirrors.empty?)
   end
 end

data/tests/ubuntu_mirrors_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/ubuntu_mirrors'
+
+# test to confirm launchpad format (HTML) is parsed
+class UbuntuMirrorsTest < Minitest::Test
+  def test_mirrors
+    expected = ['http://example.org', 'http://example.de']
+    fixture = expected.join("\n")
+
+    m = Apt::Spy2::UbuntuMirrors.new(fixture)
+    assert_equal(expected, m.mirrors('country'))
+  end
+end

data/tests/url_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/url'
+
+# test to check request lib
+class UrlTest < Minitest::Test
+  def test_non_strict
+    expected = 'http://example.org'
+
+    url = Apt::Spy2::Url.new(false)
+    assert_equal(expected, url.adjust!(expected))
+  end
+
+  # def strict
+  #   skip "Test only runs on ubuntu" if OS.unix? and not OS.mac?
+
+  #   expected = 'http://example.org'
+
+  #   url = Apt::Spy2::Url.new(true)
+  #   assert_not_equal(expected, url.mirror)
+  # end
+end

data/tests/writer_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require_relative '../lib/apt/spy2/writer'
+require 'json'
+
+# test to check request lib
+class WriterTest < Minitest::Test
+  def test_json
+    fixture = { 'mirror': 'http://example.org', 'status': 'up' }
+
+    w = Apt::Spy2::Writer.new('json')
+    w.echo(fixture)
+
+    # json string
+    j = w.to_json
+
+    assert_equal(true, w.json?)
+    assert_equal(true, j.is_a?(String))
+    assert_equal(true, JSON.parse(j).is_a?(Array))
+  end
+
+  def test_no_json
+    w = Apt::Spy2::Writer.new('shell')
+    assert_equal(false, w.json?)
+  end
+end

metadata

@@ -1,77 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: apt-spy2
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.2
 platform: ruby
 authors:
 - till
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.14.1
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.15.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +160,7 @@ extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".github/dependabot.yml"
+- ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/pr.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
@@ -170,19 +179,25 @@ files:
 - lib/apt/spy2/country.rb
 - lib/apt/spy2/downloader.rb
 - lib/apt/spy2/launchpad.rb
+- lib/apt/spy2/request.rb
 - lib/apt/spy2/ubuntu_mirrors.rb
+- lib/apt/spy2/url.rb
 - lib/apt/spy2/version.rb
 - lib/apt/spy2/writer.rb
+- test_helper.rb
 - tests/country_test.rb
 - tests/downloader_test.rb
 - tests/fixtures/launchpad.html
 - tests/launchpad_test.rb
+- tests/ubuntu_mirrors_test.rb
+- tests/url_test.rb
+- tests/writer_test.rb
 - var/country-names.txt
 homepage: https://github.com/lagged/apt-spy2
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,18 +205,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: apt-spy2, or apt-spy for ubuntu
 test_files: []