mullvadrb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3efb415f1b28c22ae2da6a06d3f2d7d695e84c2bab9e9894d3c3d560b2bca172
+  data.tar.gz: 86fdb6c682838b06643aa6af8db3397e72a7bbc015666e49f76784c1a48b4ac8
+SHA512:
+  metadata.gz: 1621452ffdfe7a4b16d88796839752670752cb7dec214af858455cad4f38dcae77d1992a1e175eadbe9f19d86ccb4332322ed9780f0dcc2ed5b1ea43c99ddb53
+  data.tar.gz: 84a6e4b648fa849c3a0c3f2bc7e660cca96427d92954b9a0ba7a46798b4eca486a4478b761c23de94e115725c170ef37cbdb9100c663b6ae7658a318b2789679

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+servers.dump
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'tty-prompt'
+
+group :test, :development do
+  gem 'debug'
+end

data/README.md

@@ -0,0 +1,19 @@
+# Ruby TUI for Mullvad VPN
+
+This is a Terminal App I wrote for myself to use with Mullvad VPN on Linux. It adds a Ruby terminal interface to [Mullvad CLI](https://mullvad.net/en/help/how-use-mullvad-cli). 
+
+On first run, you need to log in (unless you've already run `mullvad account login` on your terminal before). The servers list will be updated and will be serialized to `~/.local/share/mullvadrb.dump`.
+
+
+## Requirements
+
+You need to have a [Mullvad VPN](https://mullvad.net) account and install [the CLI](https://mullvad.net/en/download/vpn/linux).
+
+## Development
+
+Run gem from the source:
+
+```bash
+$ irb -Ilib -rmullvadrb
+```
+

data/bin/mullvadrb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'mullvadrb'

data/lib/mullvadrb/account.rb

@@ -0,0 +1,17 @@
+module Mullvadrb
+  module Account
+    class << self
+      def login(account)
+        puts `mullvad account login #{account}`
+      end
+
+      def info
+        puts `mullvad account get`
+      end
+
+      def devices
+        puts `mullvad account list-devices`
+      end
+    end
+  end
+end

data/lib/mullvadrb/connection.rb

@@ -0,0 +1,33 @@
+module Mullvadrb
+  #
+  # Manage Mullvad connect, disconnect and status
+  #
+  module Connection
+    class << self
+      def connect
+        puts `mullvad connect`
+        if $?.success?
+          puts '☎ Connecting...'
+        else
+          puts 'Error connecting'
+        end
+      end
+
+      def disconnect
+        puts `mullvad disconnect`
+        if $?.success?
+          puts '🔌 Pulling the plug'
+        else
+          puts 'Error disconnecting'
+          puts 'Maybe the connection wasn\'t active? 🤨'
+        end
+        sleep 2
+        status
+      end
+
+      def status
+        puts `mullvad status -v`
+      end
+    end
+  end
+end

data/lib/mullvadrb/servers.rb

@@ -0,0 +1,107 @@
+module Mullvadrb
+  module Servers
+    SERVERS_FILE = File.expand_path('~/.local/share/mullvadrb.dump').freeze
+
+    def update
+      `mullvad relay update`
+      data = `mullvad relay list`
+      country, city, info, flag, value = nil
+
+      # Each line is either a country, a city or a server
+      servers = data.split("\n").compact.reject(&:empty?).map do |s|
+        if s.start_with?("\t\t")
+          info = s.gsub("\t\t", '')
+          { country: country, city: city, info: info, flag: flag, value: info.split(' ').first }
+        elsif s.start_with?("\t")
+          city = s.gsub("\t", '').split("(").first.strip
+          next
+        else
+          regexp = /\(([a-z]{2})\)/ # Country (xx) - Country name + code and group code
+          flag = s.match(regexp)[1]
+                   .upcase
+                   .codepoints
+                   .map { |c| (c + 127397).chr('utf-8') }.join
+          country = s.gsub(regexp, '').strip
+          next
+        end
+      end.compact
+
+      save_servers(servers)
+      puts '🗃 Server list updated'
+      puts
+    end
+
+    def select_country
+      servers = @servers
+      country = TTY::Prompt.new.select('Select country', countries(servers), cycle: true, per_page: 10, filter: true, symbols: { marker: '🛫' })
+      connection = servers.select do |s|
+        s[:country] == country
+      end.sample
+      puts `mullvad relay set location #{connection[:value]}`
+    end
+
+    def random
+      server = all_connections.sample
+      puts "Connecting to #{server[:name]}"
+      puts `mullvad relay set location #{server[:value]}`
+    end
+
+    def select_specific
+      connections = all_connections
+      server = TTY::Prompt.new.select(
+        'Select server',
+        connections,
+        cycle: true,
+        per_page: 10,
+        filter: true,
+        symbols: { marker: '🛫' }
+      )
+      puts `mullvad relay set location #{server}`
+    end
+
+    def servers
+      @servers ||= load_servers
+    end
+
+    private
+
+    def countries(servers)
+      servers.uniq { |s| s[:country] }.map do |server|
+        {
+          name: "#{server[:flag]} #{server[:country]}",
+          value: server[:country]
+        }
+      end
+    end
+
+    def all_connections
+      servers.map do |server|
+        {
+          name: "#{server[:flag]} #{server[:country]} - #{server[:city]}: #{server[:info]}",
+          value: server[:value]
+        }
+      end
+    end
+
+    def emoji_from_code(code)
+      code.upcase
+        .codepoints
+        .map { |c| (c + 127397).chr('utf-8') }.join
+    end
+
+    def load_servers
+      servers = File.expand_path(SERVERS_FILE)
+      if File.file?(servers)
+        Marshal.load(File.read(servers))
+      else
+        update
+      end
+    end
+
+    def save_servers(servers)
+      File.open(SERVERS_FILE, 'w+') do |f|
+        f.write(Marshal.dump(servers))
+      end
+    end
+  end
+end

data/lib/mullvadrb.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'mullvadrb/account'
+require 'mullvadrb/connection'
+require 'mullvadrb/servers'
+
+include Mullvadrb::Servers
+@servers = load_servers
+
+def main_menu
+  TTY::Prompt.new.select('Select', cycle: true, per_page: 10) do |menu|
+    menu.choice name: '📡 Status', value: 'status'
+    menu.choice name: '🎰 Random', value: 'random'
+    menu.choice name: "#{['🌏', '🌎', '🌍'].sample} Choose country", value: 'country'
+    menu.choice name: '🗺 Choose specific', value: 'specific'
+    menu.choice name: '🔌 Disconnect', value: 'disconnect'
+    menu.choice name: '🗃 Update Servers', value: 'update_servers'
+    menu.choice name: '🔑 Log in', value: 'account_login'
+    menu.choice name: '📁 Account info', value: 'account_info'
+    menu.choice name: '🖥 Devices', value: 'account_devices'
+    menu.choice name: '❌ Exit', value: 'exit'
+  end
+end
+
+puts Mullvadrb::Connection.status
+
+loop do
+  selection = main_menu
+  puts "\e[H\e[2J"
+  case selection
+  when 'status'
+    puts Mullvadrb::Connection.status
+  when 'disconnect'
+    Mullvadrb::Connection.disconnect
+  when 'country'
+    select_country
+    Mullvadrb::Connection.connect
+  when 'specific'
+    Mullvadrb::Servers.select_specific
+    Mullvadrb::Connection.connect
+  when 'random'
+    random
+    Mullvadrb::Connection.connect
+  when 'update_servers'
+    update
+  when 'account_login'
+    Mullvadrb::Account.login(
+      TTY::Prompt.new.ask('Please enter your account number:')
+    )
+  when 'account_info'
+    Mullvadrb::Account.info
+  when 'account_devices'
+    Mullvadrb::Account.devices
+  when 'exit'
+    abort('Tioraidh!')
+  end
+rescue SystemExit, Interrupt
+  puts
+  exit
+end

data/mullvadrb.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name          = 'mullvadrb'
+  s.version       = '0.0.1'
+  s.summary       = 'A TUI to use with Mullvad VPN'
+  s.description   = 'A Terminal User Interface to use with Mullvad VPN'
+  s.authors       = ['Fernando Briano']
+  s.email         = 'fernando@picandocodigo.net'
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+  s.homepage      = 'https://github.com/picandocodigo/mullvad-ruby'
+  s.license       = 'GPL-3.0-or-later'
+  s.required_ruby_version = '>= 3.0'
+  s.executables << 'mullvadrb'
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: mullvadrb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fernando Briano
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-22 00:00:00.000000000 Z
+dependencies: []
+description: A Terminal User Interface to use with Mullvad VPN
+email: fernando@picandocodigo.net
+executables:
+- mullvadrb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- bin/mullvadrb
+- lib/mullvadrb.rb
+- lib/mullvadrb/account.rb
+- lib/mullvadrb/connection.rb
+- lib/mullvadrb/servers.rb
+- mullvadrb.gemspec
+homepage: https://github.com/picandocodigo/mullvad-ruby
+licenses:
+- GPL-3.0-or-later
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.20
+signing_key:
+specification_version: 4
+summary: A TUI to use with Mullvad VPN
+test_files: []