local_pac 0.2.3 → 0.3.0

data/Gemfile

@@ -18,7 +18,6 @@ group :test do
 end
 
 group :development do
-  gem 'awesome_print', require: false
   gem 'debugger'
   gem 'debugger-completion'
   gem 'foreman', require: false
@@ -29,6 +28,7 @@ group :development do
   gem 'redcarpet', require: false
   gem 'tmrb', require: false
   gem 'yard', require: false
+  gem 'inch', require: false
 end
 
 group :profile do
@@ -42,8 +42,10 @@ gem 'erubis', group: [:development, :test]
 gem 'versionomy', group: [:development, :test], require: false
 gem 'activesupport', '~> 4.0.0', group: [:development, :test], require: false
 
-#group :webserver do
-#  group :puma do
-#    gem 'puma'
-#  end
-#end
+gem 'awesome_print', group: [:development, :test], require: 'ap'
+
+group :webserver do
+  group :puma do
+    gem 'puma'
+  end
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    local_pac (0.2.2)
+    local_pac (0.2.3)
       activesupport
       addressable
       bootstrap-sass
@@ -108,6 +108,10 @@ GEM
       tilt
     hike (1.2.3)
     i18n (0.6.9)
+    inch (0.3.1)
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7)
     json (1.8.1)
     libv8 (3.16.14.3)
     method_source (0.8.2)
@@ -139,6 +143,8 @@ GEM
     pry-doc (0.5.1)
       pry (>= 0.9)
       yard (>= 0.8)
+    puma (2.7.1)
+      rack (>= 1.1, < 2.0)
     rack (1.5.2)
     rack-contrib (1.1.0)
       rack (>= 0.9.1)
@@ -179,6 +185,7 @@ GEM
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     slop (3.4.7)
+    sparkr (0.4.1)
     sprockets (2.10.1)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -232,11 +239,13 @@ DEPENDENCIES
   foreman
   fuubar
   github-markup
+  inch
   local_pac!
   poltergeist
   pry
   pry-debugger
   pry-doc
+  puma
   rack-test
   rake
   redcarpet

data/README.md

@@ -97,7 +97,7 @@ makepkg -is
 % firefox http://localhost:8000/v1/lookup/proxy.pac
 ```
 
-### Getting started
+### Getting started (Work in Progress)
 
 Make sure that you place a config file for `local_pac` in one of the following
 places or let `local_pac` generate a file on default values (see below).
@@ -310,6 +310,10 @@ option | value
 A good website to support you writing proxy.pac-files is:
 http://findproxyforurl.com.
 
+## Documentation
+
+http://www.rubydoc.info/github/dg-vrnetze/local_pac/frames
+
 ## Future
 
 * Improve API to support further functionality

data/bin/local_pac

@@ -18,6 +18,7 @@ module LocalPac
       option :access_log, type: :string, desc: 'File to write access log to'
       option :listen, type: :string, default: 'tcp://localhost:8000', desc: 'Listen for requests'
       option :rack_environment, type: :string, default: 'production', desc: 'Rack environment for application'
+      option :with, type: :string, default: 'puma', desc: 'Server used to serve proxy pac'
       def serve
         LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
         LocalPac.config.access_log = options[:access_log] if options[:access_log]
@@ -30,7 +31,21 @@ module LocalPac
         LocalPac.ui_logger.debug('Options: ' + options.to_s)
         LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
 
-        Server.new(options[:listen], options[:rack_environment]).start
+        command_klass = case options[:with].to_sym
+                 when :puma
+                   ServerCommands::Puma
+                 when :rackup
+                   ServerCommands::Rackup
+                 else
+                   ServerCommands::Rackup
+                 end
+
+        command = command_klass.new(
+          listen: options[:listen], 
+          environment: options[:rack_environment],
+        )
+
+        Server.new(command).start
       end
 
       desc 'init', 'Create files/directories to use local_pac in dir or $PWD'

data/lib/local_pac.rb

@@ -55,6 +55,8 @@ require 'local_pac/actions/print_title'
 require 'local_pac/actions/reload_configuration'
 require 'local_pac/actions/reload_local_storage'
 require 'local_pac/actions/add_examples_to_local_storage'
+require 'local_pac/server_commands/rackup'
+require 'local_pac/server_commands/puma'
 require 'local_pac/cli/helper'
 require 'local_pac/cli/reload'
 require 'local_pac/initializer'

data/lib/local_pac/server.rb

@@ -1,28 +1,19 @@
 # encoding:utf-8
 module LocalPac
   class Server
-    attr_reader :port, :host, :path, :environment
 
-    def initialize(listen, environment = 'development')
-      uri = URI.parse(listen)
+    private
 
-      @port        = uri.port
-      @host        = uri.host
-      @environment = environment
-    rescue => e
-      fail Exceptions::ServerListenStatementInvalid, "I cannot parse the listen statement: #{listen}. It is invalid: #{e.message}"
+    attr_reader :command
+
+    public
+
+    def initialize(command = ServerCommands::Rackup.new)
+      @command = command
     end
 
     def start
-      cmd = []
-      cmd << 'rackup'
-      cmd << "-E #{environment}"
-      cmd << "-P #{LocalPac.config.pid_file}"
-      cmd << "-o #{host}"
-      cmd << "-p #{port}"
-      cmd << ::File.expand_path('../../../config.ru', __FILE__)
-
-      exec(cmd.join(" "))
+      exec command.to_s
     end
   end
 end

data/lib/local_pac/server_commands/puma.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+module LocalPac
+  module ServerCommands
+    class Puma
+
+      private
+
+      attr_reader :environment, :pid_file, :config_file, :listen, :worker_count
+
+      public
+
+      def initialize(options = {})
+        @environment  = options.fetch(:environment, :development)
+        @pid_file     = options.fetch(:pid_file, LocalPac.config.pid_file)
+        @config_file  = options.fetch(:config_file, ::File.expand_path('../../../../config.ru', __FILE__))
+        @listen       = options.fetch(:listen, 'tcp://127.0.0.1:8080')
+        @worker_count = options.fetch(:worker_count, nil)
+
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def to_s
+        cmd = []
+
+        cmd << 'puma'
+        cmd << "-e #{environment}" if environment
+        cmd << "--pidfile #{pid_file}" if pid_file
+        cmd << "-b #{listen}" if listen
+        cmd << "-w #{worker_count}" if worker_count
+        cmd << config_file if config_file
+
+        cmd.join(" ")
+      end
+    end
+  end
+end

data/lib/local_pac/server_commands/rackup.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module LocalPac
+  module ServerCommands
+    class Rackup
+
+      private
+
+      attr_reader :environment, :pid_file, :config_file, :host, :port
+
+      public
+
+      def initialize(options = {})
+        @environment = options.fetch(:environment, :development)
+        @pid_file    = options.fetch(:pid_file, LocalPac.config.pid_file)
+        @config_file = options.fetch(:config_file, ::File.expand_path('../../../../config.ru', __FILE__))
+        listen       = options.fetch(:listen, '127.0.0.1:8080')
+
+        begin
+          uri = Addressable::URI.heuristic_parse(listen)
+        rescue StandardError => e
+          fail Exceptions::ServerListenStatementInvalid, "I cannot parse the listen statement: #{listen}. It is invalid: #{e.message}"
+        end
+
+        @port        = uri.port
+        @host        = uri.host
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def to_s
+        cmd = []
+
+        cmd << 'rackup'
+        cmd << "-E #{environment}" if environment
+        cmd << "-P #{pid_file}" if pid_file
+        cmd << "-o #{host}" if host
+        cmd << "-p #{port}" if port
+        cmd << config_file if config_file
+
+        cmd.join(" ")
+      end
+    end
+  end
+end

data/lib/local_pac/version.rb

@@ -1,4 +1,4 @@
 #main LocalPac
 module LocalPac
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/share/archlinux/Makefile

@@ -3,3 +3,5 @@ clean:
 	rm -f *.src.tar.gz
 	rm -f *.pkg.tar.xz
 	rm -f *.gem
+	rm -rf src
+	rm -rf pkg

data/share/archlinux/PKGBUILD

@@ -34,10 +34,12 @@ package() {
 
   msg "Starting download of gems. Don't get alert if the download takes a lot of time. Since rubygems 2.2.0 a new algorithm to resolve dependencies is used. Upgrade to > 2.2.0 via sudo /usr/bin/gem update --system to improve performance."
 
-  GEM_HOME="${pkgdir}${_library_dir}" GEM_ROOT="${pkgdir}${_library_dir}" GEM_PATH="${pkgdir}${_library_dir}" /usr/bin/gem install --env-shebang --wrappers --no-ri --no-rdoc --no-prerelease --install-dir ${pkgdir}${_library_dir} $pkgname puma
+  GEM_HOME="${pkgdir}${_library_dir}" GEM_ROOT="${pkgdir}${_library_dir}" GEM_PATH="${pkgdir}${_library_dir}" /usr/bin/gem install --env-shebang --wrappers --no-ri --no-rdoc --no-prerelease --install-dir ${pkgdir}${_library_dir} $pkgname -v $pkgver
+  GEM_HOME="${pkgdir}${_library_dir}" GEM_ROOT="${pkgdir}${_library_dir}" GEM_PATH="${pkgdir}${_library_dir}" /usr/bin/gem install --env-shebang --wrappers --no-ri --no-rdoc --no-prerelease --install-dir ${pkgdir}${_library_dir} puma
 
   install -D -m 644 ${pkgdir}${_share_dir}/archlinux/config.yaml ${pkgdir}${_examples_dir}/config.yaml.example
 
+  set -x
   SOFTWARE_BINARY=$_library_dir/gems/${pkgname}-${pkgver}/bin/${pkgname} SOFTWARE_LIB=/usr/lib/local_pac filegen  ${pkgdir}${_share_dir}/archlinux/startup.erb > ${pkgdir}${_bin_dir}/${pkgname}
 
   chmod a+x ${pkgdir}/${_bin_dir}/${pkgname}

data/share/archlinux/startup.erb

@@ -4,4 +4,6 @@ export GEM_ROOT='<%= lookup('SOFTWARE_LIB') %>'
 export GEM_PATH='<%= lookup('SOFTWARE_LIB') %>'
 export GEM_HOME='<%= lookup('SOFTWARE_LIB') %>'
 
+export PATH="<%= lookup('SOFTWARE_LIB') %>/bin"
+
 exec <%= lookup('SOFTWARE_BINARY') %> $*

data/spec/server_commands/puma_spec.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+describe ServerCommands::Puma do
+
+  context '#initialize' do
+    it 'requires a listen statement' do
+      pid_file    = create_file 'pid', $$
+      config_file = create_file 'config.ru'
+
+      expect {
+        ServerCommands::Puma.new(
+          listen: 'localhost:8080',
+          pid_file: pid_file,
+          config_file: config_file,
+        )
+      }.not_to raise_error
+    end
+  end
+
+  context '#to_s' do
+    it 'has defaults' do
+      command = ServerCommands::Puma.new
+      expect(command.to_s).to eq("puma -e development --pidfile #{LocalPac.config.pid_file} -b tcp://127.0.0.1:8080 #{File.expand_path('../../../config.ru', __FILE__)}")
+    end
+
+    it 'respects changed environment' do
+      command = ServerCommands::Puma.new(
+        environment: 'super_env'
+      )
+
+      expect(command.to_s).to include('-e super_env')
+    end
+
+    it 'respects changed pid file' do
+      pid_file    = create_file 'pid', $$
+
+      command = ServerCommands::Puma.new(
+        pid_file: pid_file,
+      )
+
+      expect(command.to_s).to include("--pidfile #{pid_file}")
+    end
+
+    it 'respects changed config_file' do
+      config_file = create_file 'config.ru'
+
+      command = ServerCommands::Puma.new(
+        config_file: config_file,
+      )
+
+      expect(command.to_s).to include(config_file)
+    end
+
+    it 'respects changed worker count' do
+      command = ServerCommands::Puma.new(
+        worker_count: 20,
+      )
+
+      expect(command.to_s).to include('-w 20')
+    end
+  end
+end

data/spec/server_commands/rackup_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+describe ServerCommands::Rackup do
+
+  context '#initialize' do
+    it 'requires a listen statement' do
+      pid_file    = create_file 'pid', $$
+      config_file = create_file 'config.ru'
+
+      expect {
+        ServerCommands::Rackup.new(
+          listen: 'localhost:8080',
+          pid_file: pid_file,
+          config_file: config_file,
+        )
+      }.not_to raise_error
+    end
+  end
+
+  context '#to_s' do
+    it 'has defaults' do
+      command = ServerCommands::Rackup.new
+      expect(command.to_s).to eq("rackup -E development -P #{LocalPac.config.pid_file} -o 127.0.0.1 -p 8080 #{File.expand_path('../../../config.ru', __FILE__)}")
+    end
+
+    it 'respects changed environment' do
+      command = ServerCommands::Rackup.new(
+        environment: '-E super_env'
+      )
+
+      expect(command.to_s).to include('-E super_env')
+    end
+
+    it 'respects changed pid file' do
+      pid_file    = create_file 'pid', $$
+
+      command = ServerCommands::Rackup.new(
+        pid_file: pid_file,
+      )
+
+      expect(command.to_s).to include("-P #{pid_file}")
+    end
+
+    it 'respects changed config_file' do
+      config_file = create_file 'config.ru'
+
+      command = ServerCommands::Rackup.new(
+        config_file: config_file,
+      )
+
+      expect(command.to_s).to include(config_file)
+    end
+  end
+end

data/spec/server_spec.rb

@@ -3,16 +3,70 @@ require 'spec_helper'
 
 describe Server do
   context '#initialize' do
-    it 'requires listen statement' do
+    it 'requires a command' do
+      command = double('Command')
+
       expect {
-        Server.new('tcp://locahost:8000')
+        Server.new(command)
       }.not_to raise_error
     end
 
-    it 'fails on invalid listen statement' do
+    it 'uses rackup by default' do
       expect {
-        Server.new(nil)
-      }.to raise_error Exceptions::ServerListenStatementInvalid
+        Server.new
+      }.not_to raise_error
+    end
+  end
+
+  context '#start' do
+    it 'starts the server' do
+      create_file 'app.rb', <<-EOS.strip_heredoc
+      require 'sinatra'
+
+      trap 'USR1' do
+        $stderr.puts "Exit"
+        Kernel.exit!
+      end
+
+      class App < Sinatra::Base
+        get '/' do
+          'Hello World'
+        end
+      end
+      EOS
+
+      config_file = create_file 'config.ru', <<-EOS.strip_heredoc
+      $LOAD_PATH << File.expand_path('..', __FILE__)
+
+      #$stderr = StringIO.new
+      #$stdout = StringIO.new
+
+      require 'app'
+      run App
+      EOS
+
+      command = double('Command')
+      allow(command).to receive(:to_s).and_return("rackup -E development -o 127.0.0.1 -p 9999 #{config_file} 2>/dev/null >&1")
+
+      server = Server.new(command)
+
+      unless child_pid = Kernel.fork
+        server.start
+      end
+
+      begin
+        tries ||= 3
+
+        response = with_environment({}, clear: true) do
+          Excon.get('http://127.0.0.1:9999')
+        end
+      rescue Excon::Errors::SocketError
+        sleep 1
+        retry unless (tries -= 1).zero?
+      end
+
+      Process.kill :USR1, child_pid
+      expect(response.body).to eq('Hello World')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: local_pac
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -485,6 +485,8 @@ files:
 - lib/local_pac/router.rb
 - lib/local_pac/runner.rb
 - lib/local_pac/server.rb
+- lib/local_pac/server_commands/puma.rb
+- lib/local_pac/server_commands/rackup.rb
 - lib/local_pac/spec_helper.rb
 - lib/local_pac/spec_helper_file_server.rb
 - lib/local_pac/template_file.rb
@@ -537,6 +539,8 @@ files:
 - spec/proxy_pac/pac_result_spec.rb
 - spec/proxy_pac_result_parser_spec.rb
 - spec/runner_spec.rb
+- spec/server_commands/puma_spec.rb
+- spec/server_commands/rackup_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_features.rb
@@ -617,6 +621,8 @@ test_files:
 - spec/proxy_pac/pac_result_spec.rb
 - spec/proxy_pac_result_parser_spec.rb
 - spec/runner_spec.rb
+- spec/server_commands/puma_spec.rb
+- spec/server_commands/rackup_spec.rb
 - spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_features.rb