homeaway 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01ef48fbd4fbbd8b863426e4cb4fda814691ee05067df920fca6fe0210c07839
+  data.tar.gz: e1606ec3e8cefde4f5beeaf19392e219ac416d8867c9b1583d2358f5cdd2f709
+SHA512:
+  metadata.gz: 04db149ea9aed3ebd0b0c15e32d8318a6923fe69d1471b8ec31e2e41c05b52424d6b0785a55d463ae94678c33fc15119fc644fed81c16a6453a079d912661f39
+  data.tar.gz: 1eb6d2d36dea2f7f3f48a6f1ad6c9e3605f5c3a0722e4ee210816950b100ca7c78a2016b9880b2f43effe05e4caf8b241e19e15aa77ef79016672268774ff798

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Good Bran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Homeaway
+
+A CLI tool to quickly toggle your macOS WiFi between manual (static IP) and DHCP mode.
+
+## Features
+
+- **Smart IP Detection**: Automatically scans and finds an available IP in your subnet
+- **DNS Management**: Clears DNS settings when switching to DHCP (configurable)
+- **First-Run Wizard**: Interactive setup on first run
+- **Simple Interface**: Just run `homeaway` and toggle with a single keypress
+
+## Installation
+
+### Via RubyGems (Recommended)
+
+```bash
+gem install homeaway
+```
+
+### Via curl (One-liner)
+
+```bash
+curl -L https://raw.githubusercontent.com/GoodBran/homeaway/main/bin/homeaway -o /usr/local/bin/homeaway && chmod +x /usr/local/bin/homeaway
+```
+
+### From Source
+
+```bash
+git clone https://github.com/GoodBran/homeaway.git
+cd homeaway
+ruby -Ilib bin/homeaway
+```
+
+## Usage
+
+Simply run:
+
+```bash
+homeaway
+```
+
+### First Run
+
+On first run, you'll be prompted to configure:
+- Default router address (default: 192.168.1.1)
+- Whether to clear DNS when toggling to DHCP (default: yes)
+- Default DNS server (default: 8.8.8.8)
+
+Configuration is stored at `~/.config/homeaway/config.yml`.
+
+### Normal Usage
+
+```bash
+$ homeaway
+Current mode: DHCP
+
+Toggle to Manual mode? [Y/n]: y
+
+Scanning for available IP in 192.168.1.x range...
+Configuring static IP:
+  IP Address: 192.168.1.42
+  Subnet Mask: 255.255.255.0
+  Router: 192.168.1.1
+  DNS Server: 8.8.8.8
+
+Successfully switched to Manual mode!
+Your IP is now: 192.168.1.42
+```
+
+## How It Works
+
+### Finding Available IP
+
+When switching to manual mode, the tool:
+1. Scans the range 192.168.1.2 through 192.168.1.254
+2. Pings each IP to check if it's in use
+3. Returns the first available IP address
+
+### Network Commands Used
+
+The tool uses macOS's built-in `networksetup` command:
+
+- `networksetup -listallhardwareports` - Detects WiFi interface
+- `networksetup -getinfo <device>` - Gets current configuration
+- `networksetup -setmanual <device> <ip> <subnet> <router>` - Sets static IP
+- `networksetup -setdhcp <device>` - Enables DHCP
+- `networksetup -setdnsservers <device> <dns>` - Sets DNS
+- `networksetup -setdnsservers <device> empty` - Clears DNS
+
+## Requirements
+
+- macOS (uses `networksetup` command)
+- Ruby 2.6 or higher
+- Administrator privileges (for changing network settings)
+
+## Configuration File
+
+```yaml
+# ~/.config/homeaway/config.yml
+router: 192.168.1.1
+clear_dns_on_dhcp: true
+dns_server: 8.8.8.8
+subnet_mask: 255.255.255.0
+```
+
+## Security Note
+
+This tool modifies system network settings. On macOS, you may need to:
+1. Run with sudo: `sudo homeaway`
+2. Or grant Terminal/ITerm permission to modify network settings in System Preferences
+
+## License
+
+MIT

data/bin/homeaway

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/homeaway'
+
+Homeaway::CLI.new(ARGV).run

data/lib/homeaway/cli.rb

@@ -0,0 +1,140 @@
+module Homeaway
+  class CLI
+    def initialize(args = [])
+      @args = args
+      @config = Config.new
+      @network = Network.new
+    end
+
+    def run
+      handle_args
+
+      @config.setup_wizard if @config.first_run?
+
+      current_mode = @network.current_mode
+      current_ip = @network.current_ip
+
+      display_current_status(current_mode, current_ip)
+
+      case current_mode
+      when :dhcp
+        handle_dhcp_mode
+      when :manual
+        handle_manual_mode
+      else
+        puts 'Error: Could not determine current network mode'
+        exit 1
+      end
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+      exit 1
+    end
+
+    private
+
+    def handle_args
+      case @args[0]
+      when '--version', '-v'
+        puts "homeaway #{Homeaway::VERSION}"
+        exit 0
+      when '--help', '-h'
+        show_help
+        exit 0
+      when '--config', '-c'
+        @config.setup_wizard
+        exit 0
+      end
+    end
+
+    def show_help
+      puts <<~HELP
+        homeaway #{Homeaway::VERSION} - Toggle WiFi between manual and DHCP mode
+
+        Usage:
+          homeaway [options]
+
+        Options:
+          -h, --help       Show this help message
+          -v, --version    Show version
+          -c, --config     Re-run configuration wizard
+
+        Description:
+          When in DHCP mode, toggles to manual with auto-selected IP.
+          When in manual mode, toggles back to DHCP.
+      HELP
+    end
+
+    def display_current_status(mode, ip)
+      case mode
+      when :dhcp
+        puts 'Current mode: DHCP'
+        puts "Current IP: #{ip}" if ip
+      when :manual
+        puts 'Current mode: Manual (Static IP)'
+        puts "Current IP: #{ip}" if ip
+      else
+        puts 'Current mode: Unknown'
+      end
+      puts
+    end
+
+    def handle_dhcp_mode
+      print 'Toggle to Manual mode? [Y/n]: '
+      answer = gets.chomp.downcase
+
+      if answer.empty? || answer == 'y' || answer == 'yes'
+        switch_to_manual
+      else
+        puts 'Cancelled.'
+      end
+    end
+
+    def handle_manual_mode
+      print 'Toggle to DHCP mode? [Y/n]: '
+      answer = gets.chomp.downcase
+
+      if answer.empty? || answer == 'y' || answer == 'yes'
+        switch_to_dhcp
+      else
+        puts 'Cancelled.'
+      end
+    end
+
+    def switch_to_manual
+      ip = @network.find_available_ip
+      subnet = @config['subnet_mask']
+      router = @config['router']
+      dns = @config['dns_server']
+
+      puts "\nConfiguring static IP:"
+      puts "  IP Address: #{ip}"
+      puts "  Subnet Mask: #{subnet}"
+      puts "  Router: #{router}"
+      puts "  DNS Server: #{dns}"
+      puts
+
+      @network.set_manual_mode(ip, subnet, router, dns)
+
+      puts 'Successfully switched to Manual mode!'
+      puts "Your IP is now: #{ip}"
+    end
+
+    def switch_to_dhcp
+      clear_dns = @config['clear_dns_on_dhcp']
+
+      puts "\nSwitching to DHCP mode..."
+
+      @network.set_dhcp_mode(clear_dns: clear_dns)
+
+      puts 'Successfully switched to DHCP mode!'
+
+      # Give the system a moment to get an IP
+      sleep 1
+
+      new_ip = @network.current_ip
+      return unless new_ip
+
+      puts "Your new IP is: #{new_ip}"
+    end
+  end
+end

data/lib/homeaway/config.rb

@@ -0,0 +1,67 @@
+require 'yaml'
+require 'fileutils'
+
+module Homeaway
+  class Config
+    CONFIG_DIR = File.expand_path('~/.config/homeaway')
+    CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
+
+    DEFAULTS = {
+      'router' => '192.168.1.1',
+      'clear_dns_on_dhcp' => true,
+      'dns_server' => '8.8.8.8',
+      'subnet_mask' => '255.255.255.0'
+    }.freeze
+
+    attr_reader :data
+
+    def initialize
+      @data = load_config
+    end
+
+    def first_run?
+      !File.exist?(CONFIG_FILE)
+    end
+
+    def setup_wizard
+      puts "\nWelcome to homeaway! Let's configure your preferences.\n\n"
+
+      print "Default router address [#{DEFAULTS['router']}]: "
+      router_input = gets.chomp
+      @data['router'] = router_input.empty? ? DEFAULTS['router'] : router_input
+
+      print 'Clear DNS records when toggling to DHCP? [Y/n]: '
+      clear_dns_input = gets.chomp.downcase
+      @data['clear_dns_on_dhcp'] = clear_dns_input.empty? || clear_dns_input == 'y' || clear_dns_input == 'yes'
+
+      print "Default DNS server [#{DEFAULTS['dns_server']}]: "
+      dns_input = gets.chomp
+      @data['dns_server'] = dns_input.empty? ? DEFAULTS['dns_server'] : dns_input
+
+      @data['subnet_mask'] = DEFAULTS['subnet_mask']
+
+      save!
+
+      puts "\nConfiguration saved to #{CONFIG_FILE}\n\n"
+    end
+
+    def save!
+      FileUtils.mkdir_p(CONFIG_DIR)
+      File.write(CONFIG_FILE, @data.to_yaml)
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    private
+
+    def load_config
+      if File.exist?(CONFIG_FILE)
+        YAML.load_file(CONFIG_FILE) || {}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/homeaway/network.rb

@@ -0,0 +1,149 @@
+require 'open3'
+require 'timeout'
+require 'ipaddr'
+
+module Homeaway
+  class Network
+    SUBNET_PREFIX = '192.168.1'.freeze
+    IP_RANGE = (2..254).freeze
+    TIMEOUT_SECONDS = 1
+
+    def self.detect_wifi_interface
+      # Get the WiFi service name using networksetup
+      output, status = Open3.capture2('networksetup', '-listallhardwareports')
+
+      raise 'Failed to list hardware ports' unless status.success?
+
+      # Parse the output to find WiFi service name (not device name)
+      # networksetup commands require the service name (e.g., "Wi-Fi"), not device (e.g., "en0")
+      lines = output.split("\n")
+      lines.each do |line|
+        next unless line =~ /Hardware Port:\s*(.+)/i
+
+        service_name = ::Regexp.last_match(1).strip
+        # Check if this is a WiFi interface by name
+        return service_name if service_name =~ /Wi-Fi|AirPort|Wireless/i
+      end
+
+      raise 'Could not find Wi-Fi interface'
+    end
+
+    def initialize
+      @device = self.class.detect_wifi_interface
+    end
+
+    def current_mode
+      output, status = Open3.capture2('networksetup', '-getinfo', @device)
+
+      raise "Failed to get network info for '#{@device}'" unless status.success?
+
+      if output.include?('DHCP Configuration')
+        :dhcp
+      elsif output.include?('Manual Configuration')
+        :manual
+      else
+        :unknown
+      end
+    end
+
+    def current_ip
+      output, status = Open3.capture2('networksetup', '-getinfo', @device)
+
+      return nil unless status.success?
+
+      # Extract IP address from output
+      return unless output =~ /IP address:\s*(\d+\.\d+\.\d+\.\d+)/
+
+      ::Regexp.last_match(1)
+    end
+
+    def find_available_ip
+      puts "Scanning for available IP in #{SUBNET_PREFIX}.x range..."
+
+      available_ip = nil
+
+      IP_RANGE.each do |last_octet|
+        ip = "#{SUBNET_PREFIX}.#{last_octet}"
+
+        # Check if IP is the router
+        next if ip == router_ip
+
+        # Check if IP is already in use
+        unless ip_in_use?(ip)
+          available_ip = ip
+          break
+        end
+
+        print '.'
+        $stdout.flush
+      end
+
+      puts
+
+      available_ip || raise("No available IP found in #{SUBNET_PREFIX}.2-254")
+    end
+
+    def set_manual_mode(ip, subnet_mask, router, dns)
+      # Set manual IP configuration
+      output, status = Open3.capture2(
+        'networksetup', '-setmanual', @device, ip, subnet_mask, router
+      )
+
+      raise "Failed to set manual configuration: #{output}" unless status.success?
+
+      # Set DNS
+      output, status = Open3.capture2(
+        'networksetup', '-setdnsservers', @device, dns
+      )
+
+      raise "Failed to set DNS: #{output}" unless status.success?
+
+      true
+    end
+
+    def set_dhcp_mode(clear_dns: true)
+      # Switch to DHCP
+      output, status = Open3.capture2('networksetup', '-setdhcp', @device)
+
+      raise "Failed to set DHCP: #{output}" unless status.success?
+
+      # Clear DNS if requested
+      if clear_dns
+        puts 'Clearing DNS settings...'
+        _, status = Open3.capture2(
+          'networksetup', '-setdnsservers', @device, 'empty'
+        )
+
+        puts 'Warning: Failed to clear DNS settings' unless status.success?
+      end
+
+      true
+    end
+
+    def device_name
+      @device
+    end
+
+    private
+
+    def router_ip
+      @router_ip ||= Config.new['router']
+    end
+
+    def ip_in_use?(ip)
+      # Use ping with timeout to check if IP is in use
+      # -c 1: send 1 packet
+      # -W 500: wait 500ms for response
+      # -t 1: TTL of 1 (macOS specific)
+
+      cmd = ['ping', '-c', '1', '-W', '500', '-t', '1', ip]
+      _output, status = Open3.capture2(*cmd)
+
+      # If ping succeeds (status 0), IP is in use
+      status.success?
+    rescue StandardError
+      # If ping fails for any reason, assume IP is not in use
+      false
+    end
+  end
+end

data/lib/homeaway.rb

@@ -0,0 +1,7 @@
+require_relative 'homeaway/config'
+require_relative 'homeaway/network'
+require_relative 'homeaway/cli'
+
+module Homeaway
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: homeaway
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Good Bran
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Homeaway allows you to quickly switch your macOS WiFi between manual
+  static IP configuration and DHCP mode, with automatic IP scanning and DNS management.
+email:
+- bran.liang@icloud.com
+executables:
+- homeaway
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/homeaway
+- lib/homeaway.rb
+- lib/homeaway/cli.rb
+- lib/homeaway/config.rb
+- lib/homeaway/network.rb
+homepage: https://github.com/GoodBran/homeaway
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A CLI tool to toggle WiFi between manual and DHCP mode
+test_files: []