apt-spy2 0.4.0 → 0.7.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91d09bec4d6918e39405d38ee164b8215c6e04d778887c0e570bdab6cc39592e
+  data.tar.gz: d2f69bf166ca8bf79fff732e30184270dfbc0422a41dbe616afc9ddd56b21641
+SHA512:
+  metadata.gz: 931ef089f949e870538b77887a7825a42647bcc8a4ef577118a12b51112bcba1b1a63c235d2bbe0e1fed348608d84954c6a44c7f16a578e42c29e198a4403619
+  data.tar.gz: 956aa4b5d89409a4366549b84846a42b95c46f7013197182fdfd22956ba07e60fddccf5f210a5eb85d0c09f3e8ff15cc730642ea1afb66b9fee81703cb172da3

data/.dockerignore

@@ -0,0 +1 @@
+vendor/bundle

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  assignees:
+  - till

data/.github/workflows/pr.yml

@@ -0,0 +1,32 @@
+---
+name: pr
+
+on:
+  pull_request
+
+jobs:
+  test:
+    name: "test-${{ matrix.ruby-version }}"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+          - '3.0'
+          - 2.7
+          - 2.6
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - run: bundle install
+      - run: bundle exec rake test
+      - run: bundle exec rake build
+      - run: ls -lah ./pkg/apt-spy2*
+      - run: gem install pkg/apt-spy2*
+      - run: apt-spy2
+      - uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+

data/.gitignore

@@ -1,2 +1,5 @@
 .vagrant
 pkg
+vendor
+coverage
+.bundle

data/.ruby_version

@@ -0,0 +1 @@
+2.6.3-p62

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contribute!
+
+First off: all contributions are welcome and thanks for taking the time!
+
+## Setup
+
+Clone the repository and install the dependencies:
+
+```
+gem install bundler
+bundle install --dev
+```
+
+## Submit
+
+ 1. Make a feature branch (`topics/foo` or `bugfix/foo`).
+ 2. Run `bundle exec rake test`.
+ 3. Send a pull-request.
+
+## Testing
+
+If applicable, please add a new test. :)

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ubuntu:18.04
+
+RUN apt-get update -y \
+	&& apt-get install -y ruby ruby-dev git gcc g++ make zlib1g-dev lsb-release \
+	&& gem install bundler \
+	&& mkdir -p /work
+
+WORKDIR /work
+COPY . /work
+
+CMD ["ruby", "-v"]

data/Gemfile.lock

@@ -1,23 +1,42 @@
 PATH
   remote: .
   specs:
-    apt-spy2 (0.4.0)
+    apt-spy2 (0.7.2)
       colored (>= 1.2)
       json
+      nokogiri (>= 1.6, < 1.13)
       thor (>= 0.18.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     colored (1.2)
-    json (1.8.0)
-    rake (10.1.0)
-    thor (0.18.1)
+    docile (1.4.0)
+    json (2.6.1)
+    minitest (5.15.0)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rake (13.0.6)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   apt-spy2!
-  bundler (~> 1.3)
+  bundler (~> 2.0)
+  minitest (~> 5.15.0)
   rake
+  simplecov (~> 0.18)
+  simplecov-lcov (~> 0.8.0)
+
+BUNDLED WITH
+   2.2.32

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2013-2019, Till Klampaeckel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -0,0 +1,11 @@
+install:
+	bundle install --path ./vendor/bundle
+
+release:
+	bundle exec rake release
+
+docker-build:
+	docker build -t lagged/apt-spy2:dev .
+
+docker-run: docker-build
+	docker run -it lagged/apt-spy2:dev bash

data/README.md

@@ -1,23 +1,20 @@
-# apt-spy2 or, "apt-spy for ubuntu"
-
-[![Gem Version](https://badge.fury.io/rb/apt-spy2.png)](http://badge.fury.io/rb/apt-spy2)
-[![Code Climate](https://codeclimate.com/github/lagged/apt-spy2.png)](https://codeclimate.com/github/lagged/apt-spy2)
+# apt-spy2
 
+… or: "apt-spy for Ubuntu"
 
-## setup
+[![pr](https://github.com/lagged/apt-spy2/actions/workflows/pr.yml/badge.svg)](https://github.com/lagged/apt-spy2/actions/workflows/pr.yml)
+[![Gem Version](https://badge.fury.io/rb/apt-spy2.svg)](https://badge.fury.io/rb/apt-spy2)
+[![Code Climate](https://codeclimate.com/github/lagged/apt-spy2.png)](https://codeclimate.com/github/lagged/apt-spy2)
+[![Coverage Status](https://coveralls.io/repos/lagged/apt-spy2/badge.png)](https://coveralls.io/r/lagged/apt-spy2)
 
-```
-gem install bundler
-bundle install --dev
-```
 
-or:
+## Installation
 
 ```
 gem install apt-spy2
 ```
 
-## usage
+## Usage
 
 ```
 $ apt-spy2                                                                                                                                                         [21:03:52]
@@ -28,25 +25,48 @@ apt-spy2 commands:
   apt-spy2 list            # List the currently available mirrors
 ```
 
-### list
+### list command
 
 Displays a list of currently available mirrors. These mirrors are automatically selected via
 [ubuntu-mirrors](http://mirrors.ubuntu.com) using your IP's location.
 
-### check
+```
+$ apt-spy2 list
+...
+```
+
+Since `mirrors.ubuntu.com` is frequently down, you can the list on [Launchpad](launchpad.net/ubuntu/+archivemirrors):
+
+```
+$ apt-spy2 list --launchpad --country=Germany
+...
+```
+
+### check command
+
+`check` works like `list`, but also determines if the servers returned are working. It supports Launchpad as well.
 
-`check` works like `list`, but also determines if the servers returned are working.
+```
+$ apt-spy2 check
+...
+$ apt-spy2 list --launchpad --country=US
+...
+```
 
-### fix
+### fix command
 
 `fix` applies the result of `check` and updates `/etc/apt/sources.list`.
 
-Please note: Depending on the context, it may require sudo.
+Once the fix is applied, please run `apt-get update`.
+
+**Please note:** Depending on the context, it may require sudo.
 
 ### options/switches
 
 See `apt-spy2 help list|check|fix` for available options.
 
+**Please note:** `--launchpad` always requires you pass `--country=FOO` as well.
+
 ### exit codes
 
  * 0 - all went well
@@ -56,13 +76,8 @@ See `apt-spy2 help list|check|fix` for available options.
 
 See `apt-spy2 help COMMAND` for more information.
 
-Generally, this piece of code plays especially nice in a non-interactive environment and won't ask for anything.
+Generally, `apt-spy2` plays especially nice in a non-interactive environment and won't ask for anything without setting environment variables or using the usual `-y`.
 
 ## License
 
 [New BSD License](http://opensource.org/licenses/BSD-2-Clause)
-
-## Contributions
-
-Contributions are welcome!
-

data/Rakefile

@@ -1 +1,24 @@
 require "bundler/gem_tasks"
+require "minitest/autorun"
+require "simplecov"
+require "simplecov-lcov"
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+task :test do
+  ENV['COVERAGE'] = 'true'
+
+  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
+  SimpleCov.start
+
+  $LOAD_PATH.unshift('lib', 'tests')
+  Dir.glob('./tests/*_test.rb') do |f|
+    require f
+  end
+end

data/apt-spy2.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Keep your /etc/apt/sources.list up to date"
   spec.summary       = "apt-spy2, or apt-spy for ubuntu"
   spec.homepage      = "https://github.com/lagged/apt-spy2"
-  spec.license       = "BSD"
+  spec.license       = 'BSD-2-Clause'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -21,7 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor', '>= 0.18.1'
   spec.add_dependency 'colored', '>= 1.2'
   spec.add_dependency 'json'
+  spec.add_dependency 'nokogiri', '>= 1.6', '< 1.13'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.15.0"
+  spec.add_development_dependency "simplecov", "~> 0.18"
+  spec.add_development_dependency "simplecov-lcov", "~> 0.8.0"
 end

data/bin/apt-spy2

@@ -3,6 +3,9 @@
 require 'apt/spy2'
 require 'colored'
 
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
 begin
   AptSpy2.start
 rescue => the_error

data/lib/apt/spy2/country.rb

@@ -0,0 +1,33 @@
+module Apt
+  module Spy2
+    class Country
+
+      def initialize(country_database)
+        @database = country_database
+      end
+
+      def to_country_name(code)
+        code = code.upcase
+        return capitalize(code) unless code.length == 2
+
+        File.open(@database).each do |line|
+          country, tld = line.split(';', 2)
+          tld.gsub!(/\n/, '')
+
+          if code == tld
+            return capitalize(country)
+          end
+
+        end
+
+        raise "Could not look up: #{code}"
+      end
+
+      private
+      def capitalize(str)
+        return str.split(" ").map(&:capitalize).join(" ")
+      end
+
+    end
+  end
+end

data/lib/apt/spy2/downloader.rb

@@ -0,0 +1,30 @@
+require 'open-uri'
+
+module Apt
+  module Spy2
+    class Downloader
+
+      def initialize(url = nil)
+        @url = url if !url.nil?
+      end
+
+      def do_download(url = nil)
+        @url = url if !url.nil?
+
+        raise "Please supply a url." if url.nil?
+
+        begin
+          return open(@url).read
+        rescue OpenURI::HTTPError => the_error
+          case the_error.io.status[0]
+          when "404"
+            raise "The URL #{@url} does not exist."
+          else
+            raise "Status: #{the_error.io.status[0]}"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/apt/spy2/launchpad.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+
+module Apt
+  module Spy2
+    class Launchpad
+
+      def initialize(download)
+        @launchpad = download
+      end
+
+      def get_mirrors(country)
+
+        mirrors = []
+
+        document = Nokogiri::HTML(@launchpad)
+        table_rows = document.xpath("//tr/th[text()='#{country}']/../following-sibling::*")
+        raise "Couldn't find a mirror for #{country}." if table_rows.empty?
+
+        table_rows.each do |node|
+          break if node['class'] == 'head' # this is the next country heading
+
+          next if node.xpath(".//span[@class='distromirrorstatusUP']").empty? # this mirror is broken, behind, etc.
+
+          # return all mirrors: .//a[not(starts-with(@href, '/'))] - we'll just get http(s):// for now
+          node.xpath(".//a[starts-with(@href, 'http')]").each do |child|
+            mirrors << child['href']
+          end
+        end
+
+        return mirrors
+
+      end
+
+    end
+  end
+end

data/lib/apt/spy2/ubuntu_mirrors.rb

@@ -0,0 +1,19 @@
+module Apt
+  module Spy2
+    class UbuntuMirrors
+
+      def initialize(download)
+        @ubuntu_mirrors = download
+      end
+
+      def get_mirrors(country)
+
+        mirrors = @ubuntu_mirrors
+        mirrors = mirrors.split(/\n/)
+        return mirrors
+
+      end
+
+    end
+  end
+end

data/lib/apt/spy2/version.rb

@@ -1,5 +1,5 @@
 module Apt
   module Spy2
-    VERSION = "0.4.0"
+    VERSION = "0.7.2"
   end
 end

data/lib/apt/spy2.rb

@@ -3,7 +3,10 @@ require 'open-uri'
 require 'colored'
 require 'fileutils'
 require 'apt/spy2/writer'
-require 'json'
+require 'apt/spy2/country'
+require 'apt/spy2/downloader'
+require 'apt/spy2/ubuntu_mirrors'
+require 'apt/spy2/launchpad'
 
 class AptSpy2 < Thor
   package_name "apt-spy2"
@@ -11,10 +14,11 @@ class AptSpy2 < Thor
   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"
   def fix
-    working = filter(retrieve(), false)
+    working = filter(retrieve(options[:country], use_launchpad?(options)), false)
     print "The closest mirror is: "
-    puts "#{working[0]}".white_on_green
+    puts "#{working[0]}".bold.magenta
     if !options[:commit]
       puts "Run with --commit to adjust /etc/apt/sources.list".yellow
     else
@@ -27,11 +31,12 @@ class AptSpy2 < Thor
   option :country, :default => "mirrors"
   option :output, :type => :boolean, :default => true
   option :format, :default => "shell"
+  option :launchpad, :type => :boolean, :banner => "Use launchpad's mirror list"
   def check
 
     @writer = Apt::Spy2::Writer.new(options[:format])
 
-    mirrors = retrieve(options[:country])
+    mirrors = retrieve(options[:country], use_launchpad?(options))
     filter(mirrors, options[:output])
 
     puts @writer.to_json if @writer.json?
@@ -40,9 +45,10 @@ class AptSpy2 < Thor
   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"
   def list
+    mirrors = retrieve(options[:country], use_launchpad?(options))
 
-    mirrors = retrieve(options[:country])
     @writer = Apt::Spy2::Writer.new(options[:format])
 
     @writer.set_complete(mirrors)
@@ -51,24 +57,32 @@ class AptSpy2 < Thor
     puts mirrors if !@writer.json?
   end
 
+  desc "version", "Show which version of apt-spy2 is installed"
+  def version
+    puts Apt::Spy2::VERSION
+    exit
+  end
+
   private
-  def retrieve(country = "mirrors")
-    begin
-      country.upcase! if country.length == 2
-      mirrors = open("http://mirrors.ubuntu.com/#{country}.txt") do |list|
-        list.read
-      end
-    rescue OpenURI::HTTPError => the_error
-      case the_error.io.status[0]
-      when "404"
-        raise "The country code '#{country}' is incorrect."
-      else
-        raise "Status: #{the_error.io.status[0]}"
-      end
+  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")
+      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)
     end
 
-    mirrors = mirrors.split(/\n/)
+    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
+
   end
 
   private
@@ -80,12 +94,13 @@ class AptSpy2 < Thor
     mirrors.each do |mirror|
       data = {"mirror" => mirror }
       begin
-        mirror_status = open(mirror)
+        open(mirror)
         data["status"] = "up"
         working_mirrors << mirror
-      rescue OpenURI::HTTPError => the_error
+      rescue OpenURI::HTTPError
         data["status"] = "broken"
-      rescue Errno::ECONNREFUSED
+      rescue
+        # this is a catch-all for everything else
         data["status"] = "down"
       end
 
@@ -121,6 +136,19 @@ class AptSpy2 < Thor
     end
 
     puts "Updated '#{apt_sources}' with #{mirror}".green
-    puts "Run `apt-get update` to update".red_on_yellow
+    puts "Run `apt-get update` to update".black_on_yellow
+  end
+
+  private
+  def use_launchpad?(options)
+    if !options[:launchpad]
+      return false
+    end
+
+    if options[:country] && options[:country] == 'mirrors'
+      raise "Please supply a `--country=foo`. Launchpad cannot guess!"
+    end
+
+    return true
   end
 end

data/tests/country_test.rb

@@ -0,0 +1,27 @@
+require 'apt/spy2/country'
+
+class CountryTest < Minitest::Test
+  def setup
+    @country_list = File.expand_path(File.dirname(__FILE__) + "/../var/country-names.txt")
+  end
+
+  def test_tld_to_name()
+
+    # fixtures for people who don't want to read about rails
+    data = {
+      'de' => 'Germany',
+      'fr' => 'France',
+      'IE' => 'Ireland',
+      'US' => 'United States',
+      'United Kingdom' => 'United Kingdom',
+      'germany' => 'Germany'
+    }
+
+    c = Apt::Spy2::Country.new(@country_list)
+
+    data.each_pair do |code, expected|
+      assert_equal(expected, c.to_country_name(code))
+    end
+
+  end
+end