local_pac 0.3.0 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    local_pac (0.2.3)
+    local_pac (0.3.0)
       activesupport
       addressable
       bootstrap-sass
@@ -16,6 +16,8 @@ PATH
       rugged
       sass
       sinatra
+      sinatra-contrib
+      sinatra-param
       sprockets
       sprockets-helpers
       sprockets-sass
@@ -41,6 +43,7 @@ GEM
     ast (1.1.0)
     atomic (1.1.14)
     awesome_print (1.2.0)
+    backports (3.6.0)
     blockenspiel (0.4.5)
     bond (0.5.1)
     bootstrap-sass (3.1.1.0)
@@ -184,16 +187,25 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
+    sinatra-contrib (1.4.2)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (~> 1.3)
+    sinatra-param (1.1.1)
+      sinatra (~> 1.3)
     slop (3.4.7)
     sparkr (0.4.1)
-    sprockets (2.10.1)
+    sprockets (2.11.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
     sprockets-helpers (1.1.0)
       sprockets (~> 2.0)
-    sprockets-sass (1.0.2)
+    sprockets-sass (1.0.3)
       sprockets (~> 2.0)
       tilt (~> 1.1)
     sys-proctable (0.9.3)

data/app/controllers/application_controller.rb

@@ -1,44 +1,64 @@
 # encoding: utf-8
-require 'haml'
-require 'i18n'
-require 'i18n/backend/fallbacks'
-require 'rack/contrib/locale'
-require 'sprockets-helpers'
-require 'sass'
-require 'sinatra'
-
 module LocalPac
   module App
     class ApplicationController < Sinatra::Base
+
+      @local_storage_mutex = Mutex.new
+
+      class << self
+        attr_reader :local_storage_mutex
+      end
+
       set :root, ::File.expand_path('../../', __FILE__)
       set :haml, :format => :html5
 
       def local_storage
         return @local_storage if @local_storage
 
-        if settings.respond_to? :local_storage
-          @local_storage = settings.local_storage
-        else
-          @local_storage = LocalPac::LocalStorage.new
+        ApplicationController.local_storage_mutex.synchronize do
+          if settings.respond_to? :local_storage
+            LocalPac.ui_logger.debug 'Using local storage in production mode: loaded once on startup'
+            @local_storage = settings.local_storage
+          else
+            LocalPac.ui_logger.debug 'Using local storage in development mode: reloaded per request'
+            @local_storage = LocalPac::LocalStorage.new
+          end
         end
       end
 
       use Rack::Deflater
       use Rack::Locale
+      use Rack::NestedParams
+      use Rack::PostBodyContentTypeParser
 
       not_found do
-        I18n.t('errors.not_found', name: env['sinatra.error'].message)
+        @error_summary = I18n.t('errors.unknown_proxy_pac.summary')
+        @error_details = I18n.t('errors.unknown_proxy_pac.details', name: env['PATH_INFO'])
+
+        halt 404, haml(:error, layout: :application)
       end
       
       error do
-        I18n.t('errors.default', message: env['sinatra.error'].message)
+        @error_summary = I18n.t('errors.default.summary')
+        @error_details = I18n.t('errors.default.details')
+
+        halt 500, haml(:error, layout: :application)
       end
 
       error Exceptions::GivenUrlInvalid do
-        @error_summary   = I18n.t('errors.invalid_url.summary') 
+        @error_summary = I18n.t('errors.invalid_url.summary') 
         @error_details = I18n.t('errors.invalid_url.details', url: env['sinatra.error'].message)
 
-        haml :error, layout: :application
+        halt 401, haml(:error, layout: :application)
+      end
+
+      set :raise_sinatra_param_exceptions, true
+
+      error Sinatra::Param::InvalidParameterError do
+        @error_summary = I18n.t('errors.invalid_parameter.summary') 
+        @error_details = I18n.t('errors.invalid_parameter.details', parameter: env['sinatra.error'].param)
+
+        halt 401, haml(:error, layout: :application)
       end
 
       configure :profile do
@@ -58,6 +78,10 @@ module LocalPac
 
       configure :development do
         set :raise_errors, true
+
+        before do
+          LocalPac.ui_logger.debug "Parameters: " + params.to_s
+        end
       end
 
       configure :test do
@@ -86,7 +110,6 @@ module LocalPac
           I18n.t(*args)
         end
       end
-
     end
   end
 end

data/app/controllers/git_hook_controller.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module LocalPac
+  module App
+    class GitHookController < ApplicationController
+
+      helpers Sinatra::Param
+      helpers Sinatra::JSON
+
+      not_found do
+        halt 404, json(
+          error_summary: I18n.t('errors.unknown_git_hook.summary'),
+          error_details: I18n.t('errors.unknown_git_hook.details', name: env['PATH_INFO']),
+          result: :failure,
+        )
+      end
+      
+      error do
+        halt 500, json(
+          error_summary: I18n.t('errors.default.summary'),
+          error_details: I18n.t('errors.default.details'),
+          result: :failure,
+        )
+      end
+
+      error Exceptions::GivenUrlInvalid do
+        halt 401, json(
+          error_summary: I18n.t('errors.invalid_url.summary'),
+          error_details: I18n.t('errors.invalid_url.details', url: env['sinatra.error'].message),
+          result: :failure,
+        )
+      end
+
+      set :raise_sinatra_param_exceptions, true
+
+      error Sinatra::Param::InvalidParameterError do
+        halt 401, json(
+          error_summary: I18n.t('errors.invalid_parameter.summary'),
+          error_details: I18n.t('errors.invalid_parameter.details', parameter: env['sinatra.error'].param),
+          result: :failure,
+        )
+      end
+
+      error Exceptions::PacFileInvalid do
+        halt 403, json(
+          error_summary: I18n.t('errors.invalid_pac_file.summary'),
+          error_details: I18n.t('errors.invalid_pac_file.details', name: env['sinatra.error']),
+          result: :failure,
+        )
+      end
+
+      post '/pre-receive' do
+        param :old_commit_id, String, required: true
+        param :new_commit_id, String, required: true
+        param :reference, String, required: true
+        param :api_key, String, required: true
+
+        repo = GitRepository.new(LocalPac.config.local_storage)
+        files = repo.added_files(params[:old_commit_id], params[:new_commit_id])
+        validator = PacFileValidator.new
+
+        LocalPac.ui_logger.debug "Files found: " + files.to_s
+
+        fail Exceptions::PacFileInvalid if files.any? { |f| !validator.valid?(f) }
+
+        json result: :success
+      end
+    end
+  end
+end

data/app/locales/en.yml

@@ -2,11 +2,24 @@
 en:
   errors:
     invalid_proxy_pac: The requested proxy.pac-file "%{name}" is invalid.
-    not_found: Sorry, but I cannot find proxy.pac-file "%{name}".
+    unknown_proxy_pac:
+      summary: Unknown ProxyPac-file...
+      details: Sorry, but I cannot find proxy.pac-file "%{name}".
+    unknown_git_hook:
+      summary: Unknown git hook...
+      details: Sorry, but I cannot find git hook "%{name}".
     invalid_url: 
-      summary: 'Invalid URL...'
-      details: 'Sorry, but your request is invalid. The URL "%{url}" is not a correct one. Allowed are URLs like "http://www.example.org" or "www.example.org".'
-    default: Sorry, but I cannot full your request. %{message}. Please ask your administrator for support.
+      summary: Invalid URL...
+      details: Sorry, but your request is invalid. The URL "%{url}" is not a correct one. Allowed are URLs like "http://www.example.org" or "www.example.org".
+    default: 
+      summary: Unexpected Error...
+      details: Sorry, but I cannot full your request. Please ask your administrator for support.
+    invalid_parameter: 
+      summary: Invalid Parameter...
+      details: Sorry, but your request is invalid. The parameter "%{parameter}" is unknown or the format given cannot be accepted.
+    invalid_pac_file: 
+      summary: Invalid PAC-file...
+      details: Sorry, but your push request is invalid. The pac-file "%{name}" is invalid.
   models:
     data:
       request_type: Request Type

data/bin/local_pac

@@ -7,8 +7,8 @@ module LocalPac
   module Cli
     class Main < Thor
       class_option :config_file, type: :string, desc: 'Config file'
-      class_option :log_level, type: :string, desc: 'Log level for ui logging'
-      class_option :debug, type: :boolean, default: false, desc: 'Run application in debug mode'
+      class_option :log_level, default: 'info', type: :string, desc: 'Log level for ui logging'
+      class_option :debug_mode, type: :boolean, desc: 'Run application in debug mode'
 
       no_commands {
         include LocalPac::Cli::Helper
@@ -16,17 +16,20 @@ module LocalPac
 
       desc 'serve', 'Serve pacfiles'
       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 :listen, type: :string, desc: 'Listen for requests'
+      option :environment, type: :string, 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]
-
+        LocalPac.config.log_level = options[:log_level] if options[:log_level]
+        LocalPac.config.debug_mode = options[:debug_mode] if options[:debug_mode]
+        LocalPac.config.environment = options[:environment] if options[:environment]
+        LocalPac.config.listen = options[:listen] if options[:listen]
         LocalPac.config.lock
 
-        set_log_level(options[:log_level])
-        set_debug(options[:debug])
+        LocalPac.ui_logger.level = LocalPac.config.log_level
+        LocalPac.enable_debug_mode if LocalPac.config.debug_mode
 
         LocalPac.ui_logger.debug('Options: ' + options.to_s)
         LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
@@ -41,36 +44,83 @@ module LocalPac
                  end
 
         command = command_klass.new(
-          listen: options[:listen], 
-          environment: options[:rack_environment],
+          listen: LocalPac.config.listen,
+          environment: LocalPac.config.environment,
         )
 
+        ENV['DEBUG']      = LocalPac.config.debug_mode.to_s if LocalPac.config.debug_mode
+        ENV['ACCESS_LOG'] = LocalPac.config.access_log.to_s if LocalPac.config.access_log
+        ENV['LOG_LEVEL']  = LocalPac.config.log_level.to_s  if LocalPac.config.log_level
+
         Server.new(command).start
       end
 
       desc 'init', 'Create files/directories to use local_pac in dir or $PWD'
       option :force, type: :boolean, default: false, desc: 'Overwrite existing files?'
       option :pre_seed, type: :boolean, default: false, desc: 'Add some example files to git repository'
+      option :config_file, type: :string, desc: 'Path to config file'
+
+      option :local_storage, type: :string, desc: 'Path to local storage'
+      option :pid_file, type: :string, desc: 'Path to pid file'
+      option :access_log, type: :string, desc: 'Path to access log'
+      option :sass_cache, type: :string, desc: 'Path to sass cache'
+      option :reload_config_signal, type: :string, desc: 'Signal to reload config'
+      option :reload_storage_signal, type: :string, desc: 'Signal to reload local storage'
+      option :api_key, type: :string, desc: 'API key for communication between git hook and web application'
+      option :listen, type: :string, desc: 'Listen statement for rack server'
+      option :environment, type: :string, desc: 'Default environment for rack server'
+
+      option :create_pid_directory, type: :boolean, desc: 'Create pid directory', default: true
+      option :create_log_directory, type: :boolean, desc: 'Create log directory', default: true
+      option :create_sass_cache, type: :boolean, desc: 'Create sass cache directory', default: true
+      option :create_local_storage, type: :boolean, desc: 'Create local storage directory', default: true
+      option :create_pre_receive_hook, type: :boolean, desc: 'Create pre receive hook', default: true
+      option :create_config_file, type: :boolean, desc: 'Create config_directory', default: true
       def init
         LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
+
+        LocalPac.config.log_level             = options[:log_level]              if options[:log_level]
+        LocalPac.config.debug_mode            = options[:debug_mode]             if options[:debug_mode]
+        LocalPac.config.local_storage         = options[:local_storage]          if options[:local_storage]
+        LocalPac.config.pid_file              = options[:pid_file]               if options[:pid_file]
+        LocalPac.config.access_log            = options[:access_log]             if options[:access_log]
+        LocalPac.config.sass_cache            = options[:sass_cache]             if options[:sass_cache]
+        LocalPac.config.reload_config_signal  = options[:reload_config_signal]   if options[:reload_config_signal]
+        LocalPac.config.reload_storage_signal = options[:reload_storage_signal]  if options[:reload_storage_signal]
+        LocalPac.config.log_level             = options[:log_level]              if options[:log_level]
+        LocalPac.config.api_key               = options[:api_key]                if options[:api_key]
+        LocalPac.config.listen                = options[:listen]                 if options[:listen]
+        LocalPac.config.environment           = options[:environment]            if options[:environment]
+
         LocalPac.config.lock
 
-        set_log_level(options[:log_level])
-        set_debug(options[:debug])
+        LocalPac.ui_logger.level = LocalPac.config.log_level
+        LocalPac.enable_debug_mode if LocalPac.config.debug_mode
 
         LocalPac.ui_logger.debug('Options: ' + options.to_s)
         LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
 
-        Initializer.new(force: options[:force], pre_seed: options[:pre_seed]).run
+        Initializer.new(
+          force: options[:force], 
+          pre_seed: options[:pre_seed],
+          create_pid_directory: options[:create_pid_directory],
+          create_log_directory: options[:create_log_directory],
+          create_sass_cache: options[:create_sass_cache],
+          create_local_storage: options[:create_local_storage],
+          create_pre_receive_hook: options[:create_pre_receive_hook],
+          create_config_file: options[:create_config_file],
+        ).run
       end
 
       desc 'status', 'Show status of local_pac: configuration, known proxy pacs, server running etc.'
       def status
         LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
+        LocalPac.config.log_level = options[:log_level] if options[:log_level]
+        LocalPac.config.debug_mode = options[:debug_mode] if options[:debug_mode]
         LocalPac.config.lock
 
-        set_log_level(options[:log_level])
-        set_debug(options[:debug])
+        LocalPac.ui_logger.level = LocalPac.config.log_level
+        LocalPac.enable_debug_mode if LocalPac.config.debug_mode
 
         ApplicationStatus.new.show
       end

data/config.ru

@@ -2,10 +2,15 @@ $LOAD_PATH <<::File.expand_path('../lib/', __FILE__)
 
 require 'local_pac'
 
+LocalPac.config.debug_mode = true if ENV['DEBUG']
+LocalPac.config.log_level = ENV['LOG_LEVEL'] if ENV['LOG_LEVEL']
+LocalPac.config.access_log = ENV['ACCESS_LOG'] if ENV['ACCESS_LOG']
+
+LocalPac.ui_logger.level = LocalPac.config.log_level
+
 require File.expand_path('../app/controllers/application_controller.rb', __FILE__)
 Dir.glob(::File.expand_path('../app/controllers/*.rb', __FILE__)).each { |f| require f }
 
-LocalPac.ui_logger.level = ::Logger::INFO
 
 trap LocalPac.config.reload_config_signal do
   begin
@@ -39,6 +44,10 @@ map '/v1/lookup/' do
   run LocalPac::App::LookupController
 end
 
+map '/v1/git_hook/' do
+  run LocalPac::App::GitHookController
+end
+
 map LocalPac::App::AssetsController.assets_prefix do
   run LocalPac::App::AssetsController.assets
 end

data/files/example-config.erb

@@ -7,8 +7,6 @@
 # * <%= p %>
 <% end -%>
 
-:access_log: <%=::File.expand_path(lookup('access_log')) %>
-:local_storage: <%=::File.expand_path(lookup('local_storage')) %>
-:pid_file: <%=::File.expand_path(lookup('pid_file')) %>
-:sass_cache: <%=::File.expand_path(lookup('sass_cache')) %>
-
+<% LocalPac::Config.options.delete_if { |o| [:expand_path, :gem_path].include? o }.each do |o| -%>
+:<%= o %>: <%= lookup(o) %>
+<% end -%>

data/files/git-hook.rb.erb

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'ostruct'
+
+class EnvironmentCleaner
+  attr_reader :variables
+
+  def initialize
+    @variables = %w{http_proxy https_proxy HTTP_PROXY HTTPS_PROXY}
+  end
+
+  def cleanup
+    variables.each { |v| ENV.delete v }
+  end
+end
+
+class InputParser
+  def parse(input)
+    change = OpenStruct.new
+    change.old_commit_id, change.new_commit_id, change.reference = input.read.chomp.split(/ /)
+
+    change
+  end
+end
+
+class Server
+
+  attr_reader :uri, :api_key, :path, :http_version
+
+  def initialize(uri, api_key, path = '/v1/git_hook/pre-receive')
+    @uri          = parse(uri)
+    @api_key      = api_key
+    @path         = path
+    @http_version = '1.1'
+  end
+
+  def check(change)
+    data = {
+      old_commit_id: change.old_commit_id, 
+      new_commit_id: change.new_commit_id, 
+      reference: change.reference, 
+      api_key: api_key
+    }
+
+    begin
+      response = send_request(data)
+    rescue Errno::ECONNREFUSED
+      $stderr.puts 'No connection to validator server. Please make sure the server is running before pushing files again.'
+      exit 1
+    rescue Timeout::Error
+      $stderr.puts 'A time out occured. The validation server does not respond in time. Please make sure the server does not hang before pushing files again.'
+      exit 1
+    end
+
+    json = JSON.parse(response.body)
+
+    if json['result'] == 'success'
+      $stderr.puts 'New proxy.pac-files accepted'
+      exit 0
+    else
+      $stderr.puts json['error_details']
+      exit 1
+    end
+  end
+
+  private
+
+  def send_request(data)
+    request = Net::HTTP::Post.new(path)
+    request.set_form_data(data)
+
+    request.exec(socket, http_version, path)
+
+    begin
+      response = Net::HTTPResponse.read_new(socket)
+      if RUBY_VERSION >= '2'
+        response.decode_content = request.decode_content
+      end
+    end while response.kind_of?(Net::HTTPContinue)
+        
+    response.reading_body(socket, request.response_body_permitted?) { }
+
+    if RUBY_VERSION >= '2'
+      response.uri = request.uri
+    end
+
+    response
+  end
+
+  def socket
+    @socket ||= case uri.scheme
+                when 'unix'
+                  unix_socket
+                else
+                  tcp_socket
+                end
+  end
+
+  def unix_socket
+    Net::BufferedIO.new(UNIXSocket.new(uri.path))
+  end
+
+  def tcp_socket
+    Net::BufferedIO.new(TCPSocket.new(uri.host, uri.port))
+  end
+
+  def parse(local_uri)
+    local_uri = URI.parse(local_uri)
+    local_uri.scheme = 'http'  if local_uri.scheme == 'tcp'
+    local_uri.scheme = 'https' if local_uri.scheme == 'ssl'
+
+    local_uri
+  end
+end
+
+cleaner = EnvironmentCleaner.new.cleanup
+server = Server.new('<%= lookup('listen') %>', '<%= lookup('api_key') %>')
+server.check(InputParser.new.parse($stdin))

data/lib/local_pac/cli/helper.rb

@@ -7,28 +7,6 @@ module LocalPac
       rescue Errno::ENOENT
         'Stale PID-file'
       end
-
-      def set_log_level(requested_level)
-        case requested_level.to_s.to_sym
-        when :info
-          LocalPac.ui_logger.level = ::Logger::INFO
-        when :debug
-          LocalPac.ui_logger.level = ::Logger::DEBUG
-        else
-          LocalPac.ui_logger.level = ::Logger::WARN
-        end
-      end
-
-      def set_debug(request)
-        if request
-          LocalPac.ui_logger.info "Activating debug mode."
-
-          require 'pry'
-          require 'debugger'
-        end
-      rescue LoadError
-        LocalPac.ui_logger.error "You tried to enable debug-mode, but either 'pry'- or 'debugger'-gem are not installed. Please fix that before using the debug-switch again."
-      end
     end
   end
 end

data/lib/local_pac/config.rb

@@ -1,27 +1,39 @@
 # encoding: utf-8
 module LocalPac
-
   class Config
+
     private
 
     attr_reader :config
 
-    @options = []
+    @options = Set.new
+
     class << self
 
+      public
+
       attr_reader :options
 
-      def option(option, default_value)
+      def option_reader(option, default_value)
         define_method option.to_sym do
           config.fetch(option.to_sym, default_value)
         end
 
+        @options << option
+      end
+
+      def option_writer(option)
         define_method "#{option}=".to_sym do |value|
           config[option.to_sym] = value
         end
 
         @options << option
       end
+
+      def option(option, default_value)
+        option_reader(option, default_value)
+        option_writer(option)
+      end
     end
 
     public
@@ -54,6 +66,11 @@ module LocalPac
     option :config_file, ::File.expand_path(::File.join(ENV['HOME'], '.config', 'local_pac', 'config.yaml'))
     option :reload_config_signal, :USR1
     option :reload_storage_signal, :USR2
+    option :debug_mode, false
+    option :log_level, :info
+    option :api_key, SecureRandom.hex
+    option :listen, 'tcp://127.0.0.1:8000'
+    option :environment, 'development'
 
     def to_s
       result = []

data/lib/local_pac/exceptions.rb

@@ -1,30 +1,33 @@
 module LocalPac
   module Exceptions
     # raise if there are template syntax errrors
-    class ErbTemplateHasSyntaxErrors < Exception; end
+    class ErbTemplateHasSyntaxErrors < StandardError; end
 
     # raised if Template does not exist
-    class ErbTemplateIsUnknown < Exception; end
+    class ErbTemplateIsUnknown < StandardError; end
 
     # raised if Template does not exist
-    class ConfigFileNotReadable < Exception; end
+    class ConfigFileNotReadable < StandardError; end
 
     # raised if listen statement is invalid
-    class ServerListenStatementInvalid < Exception; end
+    class ServerListenStatementInvalid < StandardError; end
 
     # raised if entered url is invalid
-    class URLToSearchForInvalid < Exception; end
+    class URLToSearchForInvalid < StandardError; end
 
     # raised if pac file is invalid
-    class PacFileInvalid < Exception; end
+    class PacFileInvalid < StandardError; end
 
     # raised if request is invalid
-    class GivenUrlInvalid < Exception; end
+    class GivenUrlInvalid < StandardError; end
 
     # raised if pid file does not exist
-    class PidFileDoesNotExist < Exception; end
+    class PidFileDoesNotExist < StandardError; end
 
     # raised if repository does not exist
-    class RepositoryDoesNotExist < Exception; end
+    class RepositoryDoesNotExist < StandardError; end
+
+    # raised if commit does not exist
+    class CommitDoesNotExist < StandardError; end
   end
 end