invoker 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a011067582381c326c0336b90527418663f120c
-  data.tar.gz: 9f460abe90192e73f05d1bf65aa6420f51744f49
+  metadata.gz: 5f28eeccfb582c4482a8b93fc177fc4625977f02
+  data.tar.gz: c9a2af72538ea3f50f416a47f9d53a834c2c9f1c
 SHA512:
-  metadata.gz: db67b1cb15a417511292aca216b298de317d9dda92a85537e69f5e877c697a3e313efdf5461dda0661bcad553f6efee19cf0a2af7b94aec8d8bc6825057a1720
-  data.tar.gz: 82eefa017bd91c908eaba440372a22894f2768c0d95fdead183eabcfcbcf09ffd9b5b695b79b38d67cb69e199ae94ca092c0bc742b8be5080c783565f54eb5cb
+  metadata.gz: 2c73710c5ef6e9d72c94dc61640558c6a38fa506cc00e0bebc5652222c64ad277538af4e3bebcfe32ca4cd0c6a6829e850d60b144a8d0ca50e808c5f6a644d8e
+  data.tar.gz: d38fd49ddab433bda1d37a25b5011fbecf1724b6c80c21d343b5c5f76a7f69b28d9ae1944186f49e8cc2e74fe44c92c241c8eab475f455105c74a602a7ad981f

data/.gitignore

@@ -1,7 +1,6 @@
 invoker.ini
 config/
 *.gem
-Gemfile.lock
 pkg/
 *.ini
 tags
@@ -13,3 +12,5 @@ coverage
 invoker_profile/
 *.pid
 .ruby-version
+Gemfile.lock
+.overcommit.yml

data/Gemfile

@@ -1,9 +1,8 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem 'pry'
-gem "rubydns", git: "https://github.com/ioquatix/rubydns.git"
-
-gem 'coveralls', require: false
-gem "simplecov", require: false
+group :development do
+  gem 'pry'
+  gem 'coveralls', require: false
+  gem "simplecov", require: false
+end

data/invoker.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.add_dependency("em-proxy", "~> 0.1")
   s.add_dependency("rubydns", "~> 0.7")
   s.add_dependency("uuid", "~> 2.3")
-  s.add_dependency("facter", "~> 2.0")
+  s.add_dependency("facter", "~> 2.2")
   s.add_dependency("http-parser-lite", "~> 0.6")
   s.add_dependency("dotenv", "~> 0.9")
   s.add_development_dependency("rspec", "~> 3.0")

data/lib/invoker.rb

@@ -22,6 +22,7 @@ require "invoker/power/setup"
 require "invoker/power/setup/linux_setup"
 require "invoker/power/setup/osx_setup"
 require "invoker/power/powerup"
+require "invoker/power/pf_migrate"
 require "invoker/errors"
 require "invoker/parsers/procfile"
 require "invoker/parsers/config"

data/lib/invoker/cli.rb

@@ -40,6 +40,7 @@ module Invoker
       Invoker.daemonize = options[:daemon]
       Invoker.load_invoker_config(file, port)
       warn_about_terminal_notifier
+      warn_about_old_configuration
       pinger = Invoker::CLI::Pinger.new(unix_socket)
       abort("Invoker is already running".color(:red)) if pinger.invoker_running?
       Invoker.commander.start_manager
@@ -117,6 +118,12 @@ module Invoker
         end
       end
     end
+
+    def warn_about_old_configuration
+      Invoker::Power::PfMigrate.new.tap do |pf_migrator|
+        pf_migrator.migrate
+      end
+    end
   end
 end
 

data/lib/invoker/parsers/config.rb

@@ -84,7 +84,7 @@ module Invoker
         OpenStruct.new(
           port: port,
           label: section["label"] || section.key,
-          dir: section["directory"],
+          dir: expand_directory(section["directory"]),
           cmd: replace_port_in_command(section["command"], port)
         )
       end
@@ -92,7 +92,7 @@ module Invoker
       def make_option(section)
         OpenStruct.new(
           label: section["label"] || section.key,
-          dir: section["directory"],
+          dir: expand_directory(section["directory"]),
           cmd: section["command"]
         )
       end
@@ -102,11 +102,15 @@ module Invoker
       end
 
       def check_directory(app_dir)
-        if app_dir && !app_dir.empty? && !File.directory?(app_dir)
+        if app_dir && !app_dir.empty? && !File.directory?(expand_directory(app_dir))
           raise Invoker::Errors::InvalidConfig.new("Invalid directory #{app_dir}")
         end
       end
 
+      def expand_directory(app_dir)
+        File.expand_path(app_dir) if app_dir
+      end
+
       def replace_port_in_command(command, port)
         if command =~ PORT_REGEX
           command.gsub(PORT_REGEX, port.to_s)

data/lib/invoker/power/balancer.rb

@@ -23,6 +23,7 @@ module Invoker
     class Balancer
       attr_accessor :connection, :http_parser, :session, :protocol
       DEV_MATCH_REGEX = /([\w-]+)\.dev(\:\d+)?$/
+      XIP_IO_MATCH_REGEX = /([\w-]+)\.\d+\.\d+\.\d+\.\d+\.xip\.io(\:\d+)?$/
 
       def self.run(options = {})
         start_http_proxy(InvokerHttpProxy, 'http', options)
@@ -101,7 +102,7 @@ module Invoker
       end
 
       def extract_host_from_domain(host)
-        host.match(DEV_MATCH_REGEX)
+        host.match(DEV_MATCH_REGEX) || host.match(XIP_IO_MATCH_REGEX)
       end
 
       private

data/lib/invoker/power/pf_migrate.rb

@@ -0,0 +1,64 @@
+module Invoker
+  module Power
+    # for migrating existins users to pf
+    class PfMigrate
+      def firewall_config_requires_migration?
+        return false if !Invoker.darwin?
+        # lets not migrate on osx < 10.10
+        return false if osx_version < Invoker::Version.new("14.0.0")
+        # also verify if firewall config is old
+        check_firewall_file?
+      end
+
+      def migrate
+        if firewall_config_requires_migration? && ask_user_for_migration
+          sudome
+          osx_setup = Invoker::Power::OsxSetup.new()
+          osx_setup.install_firewall(Invoker.config.http_port, Invoker.config.https_port)
+          drop_to_normal_user
+          Invoker::Logger.puts "Invoker has updated its configuration for yosemite."\
+            " Please restart OSX to complete the configuration process.".color(:red)
+          exit(-1)
+        end
+      end
+
+      def ask_user_for_migration
+        if not_already_root?
+          Invoker::Logger.puts "Invoker has detected you are running OSX 10.10 "\
+            " but your invoker configuration does not support it."
+          Invoker::Logger.puts "Invoker can update its configuration automaticaly"\
+            " but it will require a system reboot.".color(:red)
+          Invoker::CLI::Question.agree("Update Invoker configuration (y/n) :")
+        else
+          true
+        end
+      end
+
+      # http://jimeh.me/blog/2010/02/22/built-in-sudo-for-ruby-command-line-tools/
+      def sudome
+        if not_already_root?
+          exec("sudo #{$0} #{ARGV.join(' ')}")
+        end
+      end
+
+      def not_already_root?
+        ENV["USER"] != "root"
+      end
+
+      def drop_to_normal_user
+        EventMachine.set_effective_user(ENV["SUDO_USER"])
+      end
+
+      def osx_version
+        osx_kernel_version = `uname -r`.strip
+        Invoker::Version.new(osx_kernel_version)
+      end
+
+      def check_firewall_file?
+        return false unless File.exist?(Invoker::Power::OsxSetup::FIREWALL_PLIST_FILE)
+        firewall_contents = File.read(Invoker::Power::OsxSetup::FIREWALL_PLIST_FILE)
+        !!firewall_contents.match(/ipfw/)
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/arch.rb

@@ -0,0 +1,18 @@
+module Invoker
+  module Power
+    module Distro
+      class Arch < Base
+        def install_required_software
+          system("pacman -S --needed --noconfirm dnsmasq")
+          system("mkdir -p /etc/dnsmasq.d")
+          unless File.open("/etc/dnsmasq.conf").each_line.any? { |line| line.chomp == "conf-dir=/etc/dnsmasq.d" }
+            File.open("/etc/dnsmasq.conf", "a") {|f| f.write("conf-dir=/etc/dnsmasq.d") }
+          end
+          unless system("ls /usr/bin/rinetd > /dev/null 2>&1")
+            fail "You'll need to install rinetd from the AUR in order to continue"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/invoker/power/setup/distro/base.rb

@@ -13,6 +13,9 @@ module Invoker
           when "Fedora"
             require "invoker/power/setup/distro/redhat"
             Redhat.new
+          when "Archlinux"
+            require "invoker/power/setup/distro/arch"
+            Arch.new
           else
             raise "Your selected distro is not supported by Invoker"
           end
@@ -32,8 +35,13 @@ module Invoker
         end
 
         def restart_services
-          system("service rinetd restart")
-          system("service dnsmasq restart")
+          if Facter[:systemctl] == "true"
+            system("systemctl restart rinetd")
+            system("systemctl restart dnsmasq")
+          else
+            system("service rinetd restart")
+            system("service dnsmasq restart")
+          end
         end
       end
     end

data/lib/invoker/power/setup/linux_setup.rb

@@ -38,6 +38,12 @@ module Invoker
       private
 
       def initialize_distro_installer
+        # Create a new facter check for systemctl (in systemd)
+        Facter.add(:systemctl) do
+          setcode do
+            Facter::Util::Resolution.exec("[ -e /usr/bin/systemctl ] && echo 'true' || echo 'false'")
+          end
+        end
         @distro_installer =  Invoker::Power::Distro::Base.distro_installer
       end
 

data/lib/invoker/power/setup/osx_setup.rb

@@ -10,7 +10,6 @@ module Invoker
           find_open_ports
           install_resolver(port_finder.dns_port)
           install_firewall(port_finder.http_port, port_finder.https_port)
-          flush_dns_rules
           # Before writing the config file, drop down to a normal user
           drop_to_normal_user
           create_config_file
@@ -26,16 +25,11 @@ module Invoker
         if uninstall_invoker_flag
           remove_resolver_file
           unload_firewall_rule(true)
-          flush_dns_rules
           Invoker::Power::Config.delete
           Invoker::Logger.puts("Firewall rules were removed")
         end
       end
 
-      def flush_dns_rules
-        system("dscacheutil -flushcache")
-      end
-
       def create_config_file
         Invoker.setup_config_location
         Invoker::Power::Config.create(
@@ -76,6 +70,7 @@ module Invoker
       end
 
       def unload_firewall_rule(remove = false)
+        system("pfctl -a com.apple/250.InvokerFirewall -F nat 2>/dev/null")
         system("launchctl unload -w #{FIREWALL_PLIST_FILE} 2>/dev/null")
         system("rm -rf #{FIREWALL_PLIST_FILE}") if remove
       end
@@ -115,9 +110,11 @@ port #{dns_port}
 
       # Ripped from Pow code
       def firewall_command(http_port, https_port)
-        "ipfw add fwd 127.0.0.1,#{http_port} tcp from any to me dst-port 80 in"\
-          "&& ipfw add fwd 127.0.0.1,#{https_port} tcp from any to me dst-port 443 in"\
-          "&& sysctl -w net.inet.ip.forwarding=1"
+        rules = [
+          "rdr pass on lo0 inet proto tcp from any to any port 80 -> 127.0.0.1 port #{http_port}",
+          "rdr pass on lo0 inet proto tcp from any to any port 443 -> 127.0.0.1 port #{https_port}"
+        ].join("\n")
+        "echo \"#{rules}\" | pfctl -a 'com.apple/250.InvokerFirewall' -f - -E"
       end
 
       def setup_resolver_file

data/lib/invoker/version.rb

@@ -1,3 +1,47 @@
 module Invoker
-  VERSION = "1.2.0"
+  class Version
+    include Comparable
+    attr_reader :major, :minor, :patch
+
+    def initialize(number)
+      t_major, t_minor, t_patch = number.split('.')
+      @major = t_major.to_i
+      @minor = t_minor.to_i
+      @patch = t_patch.to_i
+    end
+
+    def to_a
+      [major, minor, patch].compact
+    end
+
+    def <=>(version)
+      (major.to_i <=> version.major.to_i).nonzero? ||
+        (minor.to_i <=> version.minor.to_i).nonzero? ||
+        patch.to_i <=> version.patch.to_i
+    end
+
+    def matches?(operator, number)
+      version = Version.new(number)
+      self == version
+
+      return self == version if operator == '='
+      return self > version  if operator == '>'
+      return self < version  if operator == '<'
+      return version <= self && version.next > self if operator  == '~>'
+    end
+
+    def next
+      next_splits = to_a
+
+      if next_splits.length == 1
+        next_splits[0] += 1
+      else
+        next_splits[-2] += 1
+        next_splits[-1] = 0
+      end
+
+      Version.new(next_splits.join('.'))
+    end
+  end
+  VERSION = "1.3.0"
 end

data/readme.md

@@ -11,12 +11,15 @@ First we need to install `invoker` gem to get command line utility called `invok
 
     gem install invoker
 
-Currently it only works with Ruby 1.9.3 and 2.0.
+Currently it only works with Ruby 1.9.3, 2.0 and 2.1.
 
 ## Manual ##
 
 Information about configuring and using Invoker can be found on -  [Invoker Website](http://invoker.codemancers.com)
 
+Invoker documentation is maintained via `Jekyll` and hosted on `github`. If you would like to fix an error
+or update something - please submit a pull request against `gh-pages` branch of `Invoker`.
+
 ## Bug reports and Feature requests
 
 Please use [Github Issue Tracker](https://github.com/code-mancers/invoker/issues) for feature requests or bug reports.

data/spec/invoker/config_spec.rb

@@ -24,6 +24,37 @@ command = ruby try_sleep.rb
     end
   end
 
+  describe "with relative directory path" do
+    it "should expand path in commands" do
+      begin
+        file = Tempfile.new(["config", ".ini"])
+
+        config_data =<<-EOD
+[pwd_home]
+directory = ~
+command = pwd
+
+[pwd_parent]
+directory = ../
+command = pwd
+      EOD
+        file.write(config_data)
+        file.close
+
+        config = Invoker::Parsers::Config.new(file.path, 9000)
+        command1 = config.processes.first
+
+        expect(command1.dir).to match(File.expand_path('~'))
+
+        command2 = config.processes[1]
+
+        expect(command2.dir).to match(File.expand_path('..'))
+      ensure
+        file.unlink()
+      end
+    end
+  end
+
   describe "for ports" do
     it "should replace port in commands" do
       begin

data/spec/invoker/power/balancer_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 describe Invoker::Power::Balancer do
-  context "matching domain part of incoming request" do
-    before do
-      @balancer = Invoker::Power::Balancer.new(mock("connection"), "http")
-    end
+  before do
+    @balancer = Invoker::Power::Balancer.new(mock("connection"), "http")
+  end
 
+  context "matching domain part of incoming request" do
     it "should do foo.dev match" do
       match = @balancer.extract_host_from_domain("foo.dev")
       expect(match).to_not be_nil
@@ -38,4 +38,38 @@ describe Invoker::Power::Balancer do
       expect(matching_string).to eq("hello-world")
     end
   end
+
+  context "matching domain part of incoming request using xip.io" do
+    it "should do foo.10.0.0.1.xip.io match" do
+      match = @balancer.extract_host_from_domain("foo.10.0.0.1.xip.io")
+      expect(match).to_not be_nil
+
+      matching_string = match[1]
+      expect(matching_string).to eq("foo")
+    end
+
+    it "should match foo.10.0.0.1.xip.io:1080" do
+      match = @balancer.extract_host_from_domain("foo.10.0.0.1.xip.io:1080")
+      expect(match).to_not be_nil
+
+      matching_string = match[1]
+      expect(matching_string).to eq("foo")
+    end
+
+    it "should match emacs.bar.10.0.0.1.xip.io" do
+      match = @balancer.extract_host_from_domain("emacs.bar.10.0.0.1.xip.io")
+      expect(match).to_not be_nil
+
+      matching_string = match[1]
+      expect(matching_string).to eq("bar")
+    end
+
+    it "should match hello-world.10.0.0.1.xip.io" do
+      match = @balancer.extract_host_from_domain("hello-world.10.0.0.1.xip.io")
+      expect(match).to_not be_nil
+
+      matching_string = match[1]
+      expect(matching_string).to eq("hello-world")
+    end
+  end
 end

data/spec/invoker/power/pf_migrate_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+describe Invoker::Power::PfMigrate do
+  before do
+    @old_firewall_file = Invoker::Power::OsxSetup::FIREWALL_PLIST_FILE
+    Invoker::Power::OsxSetup.const_set(:FIREWALL_PLIST_FILE, "/tmp/.invoker/firewall")
+  end
+
+  after do
+    Invoker::Power::OsxSetup.const_set(:FIREWALL_PLIST_FILE, @old_firewall_file)
+  end
+
+  let(:pf_migrator) { Invoker::Power::PfMigrate.new }
+
+  describe "#firewall_config_requires_migration?" do
+    context "for nonosx systems " do
+      it "should return false" do
+        Invoker.expects(:darwin?).returns(false)
+        expect(pf_migrator.firewall_config_requires_migration?).to eq(false)
+      end
+    end
+
+    context "for osx systems" do
+      before { Invoker.expects(:darwin?).returns(true) }
+
+      context "for osx < yosemite" do
+        it "should return false" do
+          pf_migrator.expects(:osx_version).returns(Invoker::Version.new("13.4.0"))
+          expect(pf_migrator.firewall_config_requires_migration?).to eq(false)
+        end
+      end
+
+      context "for osx > yosemite with existing ipfw rule" do
+        before do
+          write_to_firewall_file("ipfw firewall rule")
+        end
+        it "should return true" do
+          pf_migrator.expects(:osx_version).returns(Invoker::Version.new("14.0.0"))
+          expect(pf_migrator.firewall_config_requires_migration?).to eql(true)
+        end
+      end
+
+      context "for osx >= yosemite with no ipfw rule" do
+        before do
+          write_to_firewall_file("rdr pass on")
+        end
+        it "should return false" do
+          pf_migrator.expects(:osx_version).returns(Invoker::Version.new("14.0.0"))
+          expect(pf_migrator.firewall_config_requires_migration?).to eql(false)
+        end
+      end
+    end
+  end
+
+  describe "#migrate" do
+    before do
+      mock_config = mock()
+      mock_config.stubs(:http_port).returns(80)
+      mock_config.stubs(:https_port).returns(443)
+      Invoker.config = mock_config
+    end
+
+    it "should migrate firewall to new system" do
+      pf_migrator.expects(:firewall_config_requires_migration?).returns(true)
+      pf_migrator.expects(:ask_user_for_migration).returns(true)
+      pf_migrator.expects(:sudome)
+      pf_migrator.expects(:drop_to_normal_user)
+      pf_migrator.expects(:exit)
+
+      pf_migrator.migrate
+      expect(pf_migrator.check_firewall_file?).to eql(false)
+    end
+  end
+
+  def write_to_firewall_file(content)
+    File.open(Invoker::Power::OsxSetup::FIREWALL_PLIST_FILE, "w") do |fl|
+      fl.write(content)
+    end
+  end
+end

data/spec/invoker/power/setup/osx_setup_spec.rb

@@ -5,7 +5,6 @@ describe Invoker::Power::OsxSetup do
     it "should create a config file with port etc" do
       setup = Invoker::Power::OsxSetup.new
       setup.expects(:install_resolver).returns(true)
-      setup.expects(:flush_dns_rules).returns(true)
       setup.expects(:drop_to_normal_user).returns(true)
       setup.expects(:install_firewall).once
 
@@ -41,7 +40,6 @@ describe Invoker::Power::OsxSetup do
         @setup.expects(:setup_resolver_file).returns(true)
         @setup.expects(:drop_to_normal_user).returns(true)
         @setup.expects(:install_resolver).returns(true)
-        @setup.expects(:flush_dns_rules).returns(true)
         @setup.expects(:install_firewall).once()
 
         @setup.setup_invoker
@@ -53,7 +51,6 @@ describe Invoker::Power::OsxSetup do
         @setup.expects(:setup_resolver_file).returns(false)
 
         @setup.expects(:install_resolver).never
-        @setup.expects(:flush_dns_rules).never
         @setup.expects(:install_firewall).never
 
         @setup.setup_invoker
@@ -68,7 +65,6 @@ describe Invoker::Power::OsxSetup do
       Invoker::CLI::Question.expects(:agree).returns(true)
       setup.expects(:remove_resolver_file).once
       setup.expects(:unload_firewall_rule).with(true).once
-      setup.expects(:flush_dns_rules).once
       Invoker::Power::Config.expects(:delete).once
 
       setup.uninstall_invoker
@@ -85,7 +81,6 @@ describe Invoker::Power::OsxSetup do
       it "should create the directory and install" do
         @setup.expects(:setup_resolver_file).returns(true)
         @setup.expects(:drop_to_normal_user).returns(true)
-        @setup.expects(:flush_dns_rules).returns(true)
         @setup.expects(:install_firewall).once()
 
         @setup.setup_invoker

data/spec/support/mock_setup_file.rb

@@ -30,7 +30,7 @@ module MockSetupFile
   end
 
   def restore_invoker_config
-    safe_remove_file(Invoker::Power::Config.config_file)
+    safe_remove_file("/tmp/.invoker/config")
   end
 
   def restore_osx_resolver_setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: invoker
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Hemant Kumar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: http-parser-lite
   requirement: !ruby/object:Gem::Requirement
@@ -262,10 +262,12 @@ files:
 - lib/invoker/power/dns.rb
 - lib/invoker/power/http_parser.rb
 - lib/invoker/power/http_response.rb
+- lib/invoker/power/pf_migrate.rb
 - lib/invoker/power/port_finder.rb
 - lib/invoker/power/power.rb
 - lib/invoker/power/powerup.rb
 - lib/invoker/power/setup.rb
+- lib/invoker/power/setup/distro/arch.rb
 - lib/invoker/power/setup/distro/base.rb
 - lib/invoker/power/setup/distro/redhat.rb
 - lib/invoker/power/setup/distro/ubuntu.rb
@@ -297,6 +299,7 @@ files:
 - spec/invoker/power/config_spec.rb
 - spec/invoker/power/http_parser_spec.rb
 - spec/invoker/power/http_response_spec.rb
+- spec/invoker/power/pf_migrate_spec.rb
 - spec/invoker/power/port_finder_spec.rb
 - spec/invoker/power/setup/linux_setup_spec.rb
 - spec/invoker/power/setup/osx_setup_spec.rb
@@ -348,6 +351,7 @@ test_files:
 - spec/invoker/power/config_spec.rb
 - spec/invoker/power/http_parser_spec.rb
 - spec/invoker/power/http_response_spec.rb
+- spec/invoker/power/pf_migrate_spec.rb
 - spec/invoker/power/port_finder_spec.rb
 - spec/invoker/power/setup/linux_setup_spec.rb
 - spec/invoker/power/setup/osx_setup_spec.rb
@@ -356,4 +360,3 @@ test_files:
 - spec/invoker/reactor_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_setup_file.rb
-has_rdoc: