masquito 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10d01491a5d517a67884d816e177870592f4b9a1
-  data.tar.gz: e9aa4089332f7948e84ee93d358e7c6dc856cff4
+  metadata.gz: 3bd255a71a9aef95f8d300b2e9ba3aa1930ba541
+  data.tar.gz: ecbec6a6cb3a3c04b20a9bf9de381067e09ca33c
 SHA512:
-  metadata.gz: 106f4fd5b3f2741265bceb1021c8c4813d6235f956df46ce441592a513c2ca384becd690725d9d494a03b5ec45d913ef3dd7dd45aaa177f2fcf83a6113fe453a
-  data.tar.gz: ba2ff985b9504500ea9073be2311b0dfe5169059e3663115f8f0c4ee2bac6b22f460baf95281e785a422fe5f49adb79b2053252d5a41bb3cb5910d1ff2b24b1c
+  metadata.gz: 6374cff380b5836a521175d216d48fa69eb1dfa640086b341278097e853c4b0afbbddd829cb6fd6b7d169400f396fdd84756db2deec6b83dbd2abb24f65a8eea
+  data.tar.gz: 8c2bc34be59a1b6b1df55dd4a250d8c88b8f090f912a78c567713bba7b67f9a0864c73132491f7e4c028db381a65ca81c7e311421f5eb75095259c830a032fef

data/README.md

@@ -1,51 +1,53 @@
 # Masquito
 
 This gem is for DNS masquerading for rubists. Everyone knows `Pow`, but what
-I really don't like that it uses `node.js` to run ruby applications. Sometimes
+I really don't like that it uses `node.js` to run Ruby applications. Sometimes
 we have to run our apps on the certain domain. Masquito allows you to do it,
 you can create dns records in the similar Pow's way by creating symbolic links
-to your apps or just files in `.masquito` directory.
-
+to your apps or just empty files in `.masquito` directory.
 ## Notice:
 
-Masquito doesn't run rack applications. It just masquerads dns records to your
-local IP. Check our another gem
-[https://github.com/route/pump](https://github.com/route/pump) out for full
-replacement of Pow.
+Symbolic links were used by Pow in order to refer your application that will be
+run automatically, since Masquito doesn't run applications and does just DNS
+masquerading it's simplier to create just empty files. Check out another gem
+[https://github.com/route/pump](https://github.com/route/pump) for full Pow's
+replacement.
 
 ## Installation
 
 First of all, uninstall Pow if you have it installed.
-I suppose you're on rbenv(we will add rvm support as soon as we can).
+I suppose you're on rbenv (honestly I haven't checked rvm support).
 
 Install gem:
 
     $ gem install masquito
+    $ rbenv rehash
 
-Run these commands:
+Run this:
 
-    $ masquito daemon install
-    $ sudo masquito resolver install
+    $ sudo masquito install
 
-The first one installs masquito dns server as a daemon in your system which will
-be started at each boot. This daemon will respond on dns queries from your
-system. The second one registers dns resolver (`man 5 resolver` for more info)
-for `.dev` domain. You have to run it with sudo because we must write config to
-`/etc/resolver` path.
+This command installs masquito server as a daemon that your system will start
+every boot. This daemon will respond on DNS queries from your system and monitor
+`~/.masquito` directory for newly created domains.
 
 ## Usage
 
 Once you have installed masquito you can add domains to ~/.masquito
 
     $ cd ~/.masquito
-    $ touch example
+    $ touch yoursite.com
+
+It will create for you `yoursite.com` domain with the wild card for all
+subdomains and you can already ping and use it for the development.
 
-It will create for you example.dev domain and you can already ping and use it.
+    $ ping yoursite.com
+    PING yoursite.com (127.0.0.1): 56 data bytes
+    64 bytes from 127.0.0.1: icmp_seq=0 ttl=53 time=1 ms
 
-## Contributing
+    $ ping host.sub.yoursite.com
+    PING host.sub.yoursite.com (127.0.0.1): 56 data bytes
+    64 bytes from 127.0.0.1: icmp_seq=0 ttl=53 time=1 ms
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Run your favorite application server manually, open up your browser and fill in
+address with port, that's all.

data/bin/masquito

@@ -1,25 +1,26 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
+lib = File.expand_path('../../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+
 require 'masquito'
 
 abort 'Works only on Mac OS X' if RUBY_PLATFORM !~ /darwin/
 
 command = ARGV[0]
-subcommand = ARGV[1]
 filename = File.basename(__FILE__)
+options = %w(install remove version)
 
 case command
 when 'start'
-  Masquito::DNS.new
-when /daemon|resolver/
-  options = %w(install uninstall)
-  unless options.include?(subcommand)
-    abort "Usage: #{filename} #{command} #{options.join(' | ')}"
-  end
-  Masquito::Install.send("#{command}_#{subcommand}")
+  daemon = Masquito::Daemon.new
+  daemon.start
+when /install|remove/
+  abort "Run: sudo #{filename} #{command}" unless Process.euid == 0
+  installer = Masquito::Installer.new
+  installer.send(command)
 when 'version'
   puts Masquito::VERSION
 else
-  puts "Usage: #{filename} #{%w(daemon resolver version).join(' | ')}"
+  puts "Usage: #{filename} #{options.join(' | ')}"
 end

data/config/com.evrone.masquito.plist.erb

@@ -6,11 +6,15 @@
   <string>com.evrone.masquito</string>
   <key>ProgramArguments</key>
   <array>
-    <string>sh</string>
-    <string>-i</string>
-    <string>-c</string>
-    <string>$SHELL --login -c "<%= masquito_bin %> start"</string>
+    <string><%= RbConfig.ruby %></string>
+    <string><%= ::Masquito::BIN %></string>
+    <string>start</string>
   </array>
+  <key>EnvironmentVariables</key>
+  <dict>
+    <key>CONFIG_PATH</key>
+    <string><%= ::Masquito::CONFIG_PATH %></string>
+  </dict>
   <key>KeepAlive</key>
   <true/>
   <key>RunAtLoad</key>

data/config/masquito.erb

@@ -1,2 +1,3 @@
+# Masquito magic comment
 nameserver 127.0.0.1
-port <%= Masquito::DNS::PORT %>
+port <%= Masquito::Daemon::PORT %>

data/lib/masquito.rb

@@ -1,8 +1,19 @@
+require 'erb'
+require 'fileutils'
+require 'tempfile'
+require 'pathname'
+
 module Masquito
-  CONFIG_PATH = File.join(ENV['HOME'], '.masquito')
+  # When user installs Masquito we use his home path, but when it's launched as
+  # daemon with superuser rights there's no home directory at all. That's why
+  # we set environment variable and rely on it.
+  CONFIG_PATH = ENV['CONFIG_PATH'] || File.join(ENV['HOME'], '.masquito')
+  GEM_PATH    = File.expand_path('../../', __FILE__)
+  BIN         = File.join(GEM_PATH, 'bin', 'masquito')
 
-  autoload :DNS,      'masquito/dns'
-  autoload :Settings, 'masquito/settings'
-  autoload :Install,  'masquito/install'
-  autoload :VERSION,  'masquito/version'
+  autoload :Daemon,     'masquito/daemon'
+  autoload :Settings,   'masquito/settings'
+  autoload :Resolver,   'masquito/resolver'
+  autoload :Installer,  'masquito/installer'
+  autoload :VERSION,    'masquito/version'
 end

data/lib/masquito/{dns.rb → daemon.rb}

@@ -2,7 +2,7 @@ require 'socket'
 require 'resolv'
 
 module Masquito
-  class DNS
+  class Daemon
     ADDRESS = '127.0.0.1'
     PORT = 53532
 
@@ -12,27 +12,49 @@ module Masquito
     }
     @@ttl = 10800 # 3 hours
 
-    def initialize(addr = ADDRESS, port = PORT, settings = Settings.new)
-      puts "Starting Masquito on #{addr}:#{port}"
-      @settings = settings
+    def initialize(config_path = CONFIG_PATH, addr = ADDRESS, port = PORT)
+      @addr, @port = addr, port
+      @settings = Settings.new(config_path)
+      @resolver = Resolver.new(config_path)
+      at_exit { stop }
+    end
+
+    def start
+      start_resolver
+      start_dns_server
+    end
+
+    def start_resolver
+      @resolver_thread = Thread.new { @resolver.start }
+    end
+
+    def start_dns_server
+      puts "Starting Masquito on #{@addr}:#{@port}"
 
       # Bind port to receive requests
-      socket = UDPSocket.new
-      socket.bind(addr, port)
+      @socket = UDPSocket.new
+      @socket.bind(@addr, @port)
 
       loop do
         # Receive and parse query
-        data, sender_addrinfo = socket.recvfrom(512)
+        data, sender_addrinfo = @socket.recvfrom(512)
 
         Thread.new(data, sender_addrinfo) do |data, sender_addrinfo|
           sender_port, sender_ip = sender_addrinfo[1], sender_addrinfo[2]
           query = Resolv::DNS::Message.decode(data)
           answer = setup_answer(query)
-          socket.send(answer.encode, 0, sender_ip, sender_port) # Send the response
+          @socket.send(answer.encode, 0, sender_ip, sender_port) # Send the response
         end
       end
     end
 
+    def stop
+      @resolver_thread && (@resolver_thread.join(0.5) || @resolver_thread.kill)
+      @resolver.remove_configs
+    end
+
+    private
+
     # Setup answer
     def setup_answer(query)
       # Standard fields

data/lib/masquito/installer.rb

@@ -0,0 +1,73 @@
+require 'lunchy'
+
+# Lunchy doesn't have uninstall method and also installs all plists to
+# LaunchAgents. We can send a PR on spare time.
+class Lunchy
+  CONFIG = { :verbose => false, :write => nil }
+
+  def install(params)
+    raise ArgumentError, "install [file]" if params.empty?
+    filename = params[0]
+    %w(/Library/LaunchDaemons).each do |dir|
+      if File.exist?(File.expand_path(dir))
+        FileUtils.cp filename, File.join(File.expand_path(dir), File.basename(filename))
+        return puts "#{filename} installed to #{dir}"
+      end
+    end
+  end
+
+  def uninstall(params)
+    raise ArgumentError, "uninstall [file]" if params.empty?
+    filename = params[0]
+    %w(/Library/LaunchDaemons).each do |dir|
+      if File.exist?(File.expand_path(dir))
+        FileUtils.rm_rf(File.join(File.expand_path(dir), File.basename(filename)))
+        return puts "#{filename} removed from #{dir}"
+      end
+    end
+  end
+end
+
+module Masquito
+  class Installer
+    SERVICE_NAME = 'com.evrone.masquito'
+    SERVICE_PLIST = "#{SERVICE_NAME}.plist"
+    SERVICE_TEMPLATE_PATH = File.join(GEM_PATH, 'config', "#{SERVICE_PLIST}.erb")
+
+    def initialize
+      @lunchy = Lunchy.new
+    end
+
+    def install
+      switch_privileges {
+        FileUtils.mkdir_p(CONFIG_PATH)
+      }
+
+      plist = ERB.new File.read(SERVICE_TEMPLATE_PATH)
+      template = plist.result(binding)
+
+      filename = File.join(Dir.tmpdir, SERVICE_PLIST)
+      File.open(filename, 'w') { |f| f.write(template) }
+      @lunchy.install([filename])
+      @lunchy.start([SERVICE_NAME])
+      File.unlink(filename)
+
+      puts "Daemon was successfully installed."
+    end
+
+    def remove
+      @lunchy.stop([SERVICE_NAME])
+      @lunchy.uninstall([SERVICE_PLIST])
+      puts "You can remove #{CONFIG_PATH} if you don't need these settings"
+    end
+
+    private
+
+    def switch_privileges(&block)
+      uid, Process.uid = Process.uid, ENV['SUDO_UID'].to_i
+      Process::UID.switch(&block)
+    ensure
+      Process.uid = uid
+    end
+  end
+end

data/lib/masquito/resolver.rb

@@ -0,0 +1,42 @@
+require 'rb-fsevent'
+
+module Masquito
+  class Resolver
+    RESOLVER_TEMPLATE_PATH = File.join(GEM_PATH, 'config', 'masquito.erb')
+    RESOLVERS_PATH = Pathname.new('/etc/resolver')
+
+    def initialize(config_path)
+      @config_path = config_path
+    end
+
+    def start
+      reset
+      fsevent = FSEvent.new
+      fsevent.watch(@config_path) { reset }
+      fsevent.run
+    end
+
+    def reset
+      remove_configs
+      copy_configs
+    end
+
+    def copy_configs
+      resolver = ERB.new File.read(RESOLVER_TEMPLATE_PATH)
+      template = resolver.result(binding)
+      Masquito::Settings.new(CONFIG_PATH).domains.each do |domain|
+        File.open(RESOLVERS_PATH.join(domain.to_s), 'w') { |f| f.write(template) }
+      end
+    end
+
+    def remove_configs
+      Dir.foreach(RESOLVERS_PATH) do |name|
+        next if name == '.' or name == '..'
+        path = RESOLVERS_PATH.join(name)
+        if File.new(path).readline == %Q(# Masquito magic comment\n)
+          FileUtils.rm_rf(path)
+        end
+      end
+    end
+  end
+end

data/lib/masquito/settings.rb

@@ -3,7 +3,7 @@ require 'pathname'
 
 module Masquito
   class Settings
-    def initialize(config_path = CONFIG_PATH)
+    def initialize(config_path)
       @pattern = File.join(config_path, '*')
     end
 

data/lib/masquito/version.rb

@@ -1,3 +1,3 @@
 module Masquito
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

data/masquito.gemspec

@@ -1,5 +1,6 @@
 lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.unshift(lib) unless $:.include?(lib)
+
 require 'masquito/version'
 
 Gem::Specification.new do |gem|
@@ -7,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Masquito::VERSION
   gem.authors       = ['Dmitry Vorotilin', 'Kir Shatrov']
   gem.email         = ['d.vorotilin@gmail.com', 'kirs@evrone.ru']
-  gem.description   = 'Masquito is a dns masquerading server for rubists'
-  gem.summary       = 'It masquerades your dns records'
+  gem.description   = 'Masquito is a DNS masquerading server for rubists and their applications'
+  gem.summary       = 'Masquerades DNS records'
   gem.homepage      = 'https://github.com/evrone/masquito'
 
   gem.files         = `git ls-files`.split($\)
@@ -17,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency 'lunchy'
+  gem.add_runtime_dependency 'rb-fsevent'
 
   gem.add_development_dependency 'rake'
 end

data/test/{dns_test.rb → daemon_test.rb}

@@ -4,20 +4,20 @@ require 'test_helper'
 
 require 'masquito'
 
-class TestMasquitoDNS < Test::Unit::TestCase
+class TestMasquitoDaemon < Test::Unit::TestCase
   TEMP_DIR = File.join(Dir.pwd, 'test/tmp')
 
   def setup
     FileUtils.mkdir_p(TEMP_DIR)
 
     file = File.new(File.join(TEMP_DIR, 'file'), 'w')
-    ['link', 'symlink.dev', 'symlink.domain'].each do |name|
+    ['symlink.dev', 'symlink.domain'].each do |name|
       symlink = File.join(TEMP_DIR, name)
       FileUtils.ln_s(file.path, symlink)
     end
 
     @thread = Thread.new do
-      Masquito::DNS.new('127.0.0.1', '51234', Masquito::Settings.new(TEMP_DIR))
+      Masquito::Daemon.new(TEMP_DIR, '127.0.0.1', '51234').start_dns_server
     end
   end
 
@@ -34,8 +34,6 @@ class TestMasquitoDNS < Test::Unit::TestCase
 
     response = Resolv::IPv4.create('127.0.0.1')
     Resolv::DNS.open(:nameserver => ['127.0.0.1']) do |dns|
-      assert_equal response, dns.getaddress('link.dev.')
-      assert_equal response, dns.getaddress('sym.sym.link.dev.')
       assert_equal response, dns.getaddress('symlink.dev.')
       assert_equal response, dns.getaddress('www.symlink.dev.')
       assert_equal response, dns.getaddress('symlink.domain.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: masquito
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Dmitry Vorotilin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lunchy
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Masquito is a dns masquerading server for rubists
+description: Masquito is a DNS masquerading server for rubists and their applications
 email:
 - d.vorotilin@gmail.com
 - kirs@evrone.ru
@@ -57,12 +71,13 @@ files:
 - config/com.evrone.masquito.plist.erb
 - config/masquito.erb
 - lib/masquito.rb
-- lib/masquito/dns.rb
-- lib/masquito/install.rb
+- lib/masquito/daemon.rb
+- lib/masquito/installer.rb
+- lib/masquito/resolver.rb
 - lib/masquito/settings.rb
 - lib/masquito/version.rb
 - masquito.gemspec
-- test/dns_test.rb
+- test/daemon_test.rb
 - test/settings_test.rb
 - test/test_helper.rb
 homepage: https://github.com/evrone/masquito
@@ -87,9 +102,9 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: It masquerades your dns records
+summary: Masquerades DNS records
 test_files:
-- test/dns_test.rb
+- test/daemon_test.rb
 - test/settings_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/masquito/install.rb

@@ -1,97 +0,0 @@
-require 'erb'
-require 'fileutils'
-require 'lunchy'
-require 'tempfile'
-require 'pathname'
-
-module Masquito
-  GEM_PATH = File.expand_path('../../../', __FILE__)
-  TEMPLATE_PLIST_PATH = File.join(GEM_PATH, 'config', 'com.evrone.masquito.plist.erb')
-  PLIST_NAME = File.basename(TEMPLATE_PLIST_PATH, '.erb')
-  SERVICE_NAME = File.basename(PLIST_NAME, '.plist')
-
-  RESOLVER_TEMPLATE_PATH = File.join(GEM_PATH, 'config', 'masquito.erb')
-  RESOLVERS_PATH = Pathname.new('/etc/resolver')
-
-  module Install
-    class << self
-      def daemon_install
-        abort_if_superuser
-        FileUtils.mkdir_p(CONFIG_PATH)
-
-        plist = ERB.new(File.read(TEMPLATE_PLIST_PATH))
-        masquito_bin = File.join(GEM_PATH, 'bin', 'masquito')
-        template = plist.result(binding)
-
-        filename = File.join(Dir.tmpdir, PLIST_NAME)
-        File.open(filename, 'w') { |f| f.write(template) }
-        lunchy.install([filename])
-        lunchy.start([SERVICE_NAME])
-        File.unlink(filename)
-
-        puts 'Daemon was successfully installed.'
-        puts 'Run: sudo masquito resolver install'
-      end
-
-      def daemon_uninstall
-        abort_if_superuser
-        lunchy.stop([SERVICE_NAME])
-        lunchy.uninstall([PLIST_NAME])
-        puts "You can remove #{CONFIG_PATH} if you don't need these settings"
-      end
-
-      def resolver_install
-        abort_unless_superuser
-        resolver = ERB.new(File.read(RESOLVER_TEMPLATE_PATH))
-        template = resolver.result(binding)
-        Masquito::Settings.new.domains.each do |domain|
-          File.open(RESOLVERS_PATH.join(domain.to_s), 'w') { |f| f.write(template) }
-        end
-      end
-
-      def resolver_uninstall
-        abort_unless_superuser
-        Masquito::Settings.new.domains.each do |domain|
-          FileUtils.rm_rf(RESOLVERS_PATH.join(domain.to_s))
-        end
-      end
-
-      private
-
-      def lunchy
-        @lunchy ||= Lunchy.new
-      end
-
-      def abort_unless_superuser
-        unless superuser?
-          abort 'We need superuser privileges, run this command with sudo'
-        end
-      end
-
-      def abort_if_superuser
-        if superuser?
-          abort 'No need superuser privileges, run this command without sudo'
-        end
-      end
-
-      def superuser?
-        [Process.uid, Process.euid] == [0, 0]
-      end
-    end
-  end
-end
-
-class Lunchy
-  CONFIG = { :verbose => false, :write => nil }
-
-  def uninstall(params)
-    raise ArgumentError, "uninstall [file]" if params.empty?
-    filename = params[0]
-    %w(~/Library/LaunchAgents /Library/LaunchAgents).each do |dir|
-      if File.exist?(File.expand_path(dir))
-        FileUtils.rm_rf(File.join(File.expand_path(dir), File.basename(filename)))
-        return puts "#{filename} uninstalled from #{dir}"
-      end
-    end
-  end
-end