local_pac 0.5.0 → 0.6.1

data/.travis.yml

@@ -4,4 +4,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-script: bundle exec rake test:coveralls
+script: script/ci

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    local_pac (0.4.0)
+    local_pac (0.5.0)
       activesupport
       addressable
       bootstrap-sass
       compass
       facter
-      git_hook-pre_receive (~> 0.1.0)
       haml
       i18n
       pac
@@ -105,7 +104,6 @@ GEM
       ruby-progressbar (~> 1.3)
     gherkin (2.12.2)
       multi_json (~> 1.3)
-    git_hook-pre_receive (0.1.0)
     github-markup (1.0.1)
     haml (4.0.5)
       tilt

data/app/controllers/git_hook_controller.rb

@@ -48,19 +48,40 @@ module LocalPac
         )
       end
 
+      error Exceptions::ApiKeyInvalid do
+        halt 403, json(
+          error_summary: I18n.t('errors.invalid_api_key.summary'),
+          error_details: I18n.t('errors.invalid_api_key.details', name: env['sinatra.error']),
+          result: :failure,
+        )
+      end
+
+      error Exceptions::ReloadOfLocalStorageFailed do
+        halt 500, json(
+          error_summary: I18n.t('errors.reload_of_local_storage_failed.summary'),
+          error_details: I18n.t('errors.reload_of_local_storage_failed.details'),
+          result: :failure,
+        )
+      end
+
+      before do
+        fail Exceptions::ApiKeyInvalid unless params['api_key'] == LocalPac.config.api_key
+      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
+        repo = GitStorage.new(LocalPac.config.local_storage)
+        repo.each_added_pac_file(params[:old_commit_id], params[:new_commit_id]) do |f|
+          fail Exceptions::PacFileInvalid, f.path  unless validator.valid?(f)
+        end
 
-        fail Exceptions::PacFileInvalid if files.any? { |f| !validator.valid?(f) }
+        LocalPac::Actions::ReloadLocalStorage.new([LocalPac::App::FileServeController, LocalPac::App::LookupController]).run
 
         json result: :success
       end

data/app/controllers/lookup_controller.rb

@@ -17,6 +17,7 @@ module LocalPac
         @file = local_storage.find(params[:name].to_s)
         @uri = Addressable::URI.heuristic_parse(params[:url].to_s)
 
+
         fail Sinatra::NotFound, params[:name].to_s if @file.nil?
 
         parser = LocalPac::ProxyPac::PacParser.new(file: @file)

data/app/locales/en.yml

@@ -1,7 +1,15 @@
 ---
 en:
   errors:
-    invalid_proxy_pac: The requested proxy.pac-file "%{name}" is invalid.
+    reload_of_local_storage_failed:
+      summary: Reload failure...
+      details: The reload of local storage failed. Please ask the administrator for support.
+    invalid_api_key: 
+      summary: Invalid API-key...
+      details: Your request does not contain a valid api key.
+    invalid_proxy_pac: 
+      summary: Invalid ProxyPac-file...
+      details: The requested proxy.pac-file "%{name}" is invalid.
     unknown_proxy_pac:
       summary: Unknown ProxyPac-file...
       details: Sorry, but I cannot find proxy.pac-file "%{name}".

data/bin/local_pac

@@ -1,135 +1,11 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-$LOAD_PATH <<::File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << ::File.expand_path('../../lib', __FILE__)
 require 'local_pac'
 
-module LocalPac
-  module Cli
-    class Main < Thor
-      class_option :config_file, type: :string, desc: 'Config file'
-      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
-      }
-
-      desc 'serve', 'Serve pacfiles'
-      option :access_log, type: :string, desc: 'File to write access log to'
-      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
-
-        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)
-
-        command_klass = case options[:with].to_sym
-                 when :puma
-                   ServerCommands::Puma
-                 when :rackup
-                   ServerCommands::Rackup
-                 else
-                   ServerCommands::Rackup
-                 end
-
-        command = command_klass.new(
-          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
-
-        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],
-          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
-
-        LocalPac.ui_logger.level = LocalPac.config.log_level
-        LocalPac.enable_debug_mode if LocalPac.config.debug_mode
-
-        ApplicationStatus.new.show
-      end
-
-      desc 'reload', 'Reload configuration, local storage etc.'
-      option :pid_file, type: :string, desc: 'Pid file of daemon'
-      subcommand 'reload', LocalPac::Cli::Reload
-    end
-
-  end
+begin
+  LocalPac::Cli::Main.start
+rescue StandardError => e
+  LocalPac::Actions::HandleError.new(e).run
 end
-LocalPac::Cli::Main.start

data/config.ru

@@ -17,7 +17,7 @@ trap LocalPac.config.reload_config_signal do
     LocalPac.ui_logger.warn 'Reload of configuration requested'
     LocalPac::Actions::ReloadConfiguration.new.run
     LocalPac.ui_logger.info 'Reload of configuration successful'
-  rescue => e
+  rescue Exceptions::ReloadOfLocalStorageFailed => e
     LocalPac.ui_logger.fatal "Reload of configuration failed: #{e.message}"
   end
 end
@@ -27,7 +27,7 @@ trap LocalPac.config.reload_storage_signal do
     LocalPac.ui_logger.warn 'Reload of local storage requested'
     LocalPac::Actions::ReloadLocalStorage.new([LocalPac::App::FileServeController, LocalPac::App::LookupController]).run
     LocalPac.ui_logger.info 'Reload of local storage successful'
-  rescue => e
+  rescue Exceptions::ReloadOfLocalStorageFailed => e
     LocalPac.ui_logger.fatal "Reload of local storage failed: #{e.message}"
   end
 end

data/features/{show_status.feature_ → show_status.feature}

@@ -4,6 +4,7 @@ Feature: Show status
   In order to make less mistakes
 
   @wip
+  @slow_process
   Scenario: Default
     Given a file named "config.yaml" with:
     """
@@ -12,7 +13,7 @@ Feature: Show status
     access_log: 'log/access.log'
     executable: 'bin/local_pac'
     """
-    When I successfully run `local_pac status`
+    When I successfully run `local_pac status --config-file config.yaml`
     Then the stdout should contain:
     """
     pid_file: 'run/pid'

data/features/step_definitions.rb

@@ -12,3 +12,7 @@ end
 Then(/^I got$/) do |string|
   expect(@result).to eq(string)
 end
+
+Before('@slow_process') do
+  @aruba_timeout_seconds = 10
+end

data/lib/local_pac.rb

@@ -35,6 +35,7 @@ require 'active_support/cache'
 require 'active_support/core_ext/string/inflections'
 
 require 'local_pac/exceptions'
+require 'local_pac/error_handler'
 require 'local_pac/config'
 require 'local_pac/ui_logger'
 require 'local_pac/main'
@@ -54,6 +55,8 @@ require 'local_pac/template_repository'
 require 'local_pac/template_file'
 require 'local_pac/pac_file_validator'
 require 'local_pac/actions/show_available_proxy_pac_files'
+require 'local_pac/actions/show_pac_file'
+require 'local_pac/actions/validate_pac_file'
 require 'local_pac/actions/get_system_information'
 require 'local_pac/actions/send_signal'
 require 'local_pac/actions/create_repository'
@@ -67,12 +70,16 @@ 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/actions/show_application_status'
+require 'local_pac/actions/initialize_application'
+require 'local_pac/actions/handle_error'
 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'
-require 'local_pac/application_status'
+require 'local_pac/cli/show'
+require 'local_pac/cli/validate'
+require 'local_pac/cli/main'
 require 'local_pac/local_storage'
 require 'local_pac/server'
 require 'local_pac/proxy_pac/html_table_style'

data/lib/local_pac/actions/get_system_information.rb

@@ -21,11 +21,11 @@ module LocalPac
       private
 
       def data
-        Timeout::timeout(5) do
+        Timeout::timeout(10) do
           Facter.to_hash.keep_if { |key,_| fields.include?(key.to_s) }
         end
       rescue Timeout::Error
-        LocalPac.ui_logger.warn 'Getting environment information took to long. Please make sure the name resolver is avaiable. This might cause the latency.'
+        LocalPac.ui_logger.warn 'Getting environment information took to long. Please make sure the name resolver is available. This might cause the latency.'
         {}
       end
 

data/lib/local_pac/actions/handle_error.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module LocalPac
+  module Actions
+    class HandleError
+
+      private
+
+      attr_reader :exception, :original_message, :handler_klass
+
+      public
+
+      def initialize(exception, handler_klass = ErrorHandler)
+        @exception        = exception.class
+        @original_message = exception.message
+        @handler_klass    = handler_klass
+      end
+
+      def run
+        handler = handler_klass.find exception
+        handler.original_message = original_message
+
+        handler.run
+      end
+    end
+  end
+end

data/lib/local_pac/actions/initialize_application.rb

@@ -0,0 +1,71 @@
+module LocalPac
+  module Actions
+    class InitializeApplication
+
+      private
+
+      attr_reader :config, :options
+
+      public
+
+      def initialize(options = {}, config = LocalPac.config)
+        @options = options
+        @config  = config
+      end
+
+      def run
+        create_pid_directory if options[:create_pid_directory]
+        create_log_directory if options[:create_log_directory]
+        create_sass_cache if options[:create_sass_cache]
+        create_local_storage if options[:create_local_storage]
+        create_pre_receive_hook if options[:create_pre_receive_hook]
+        create_config_file if options[:create_config_file]
+        pre_seed if options[:pre_seed]
+
+        show_example_config
+      end
+
+      private
+
+      def create_pid_directory
+        LocalPac.ui_logger.info "Creating pid directory: #{::File.dirname(config.pid_file)}"
+        Actions::CreateDirectory.new(::File.dirname(config.pid_file), force: options[:force]).run
+      end
+
+      def create_log_directory
+        LocalPac.ui_logger.info "Creating log directory: #{::File.dirname(config.access_log)}"
+        Actions::CreateDirectory.new(::File.dirname(config.access_log), force: options[:force]).run
+      end
+
+      def create_sass_cache
+        LocalPac.ui_logger.info "Creating sass cache #{config.sass_cache}"
+        Actions::CreateDirectory.new(config.sass_cache, force: options[:force]).run
+      end
+
+      def create_local_storage
+        LocalPac.ui_logger.info "Creating local storage: #{config.local_storage}"
+        Actions::CreateRepository.new(config.local_storage, bare: true, force: options[:force]).run
+      end
+
+      def create_pre_receive_hook
+        LocalPac.ui_logger.info "Creating pre-receive hook in local storage \"#{config.local_storage}\"."
+        Actions::CreateFile.new(:'git-hook.rb', ::File.join(config.local_storage, 'hooks', 'pre-receive'), Data.new(config), force: options[:force], executable: true).run
+      end
+
+      def create_config_file
+        LocalPac.ui_logger.info "Creating config file at \"#{config.config_file}\"."
+        Actions::CreateFile.new(:'example-config', config.config_file, Data.new(config), force: options[:force], create_directories: true).run
+      end
+
+      def pre_seed
+        LocalPac.ui_logger.info "Adding examples to repository at #{config.local_storage}/examples"
+        Actions::AddExamplesToLocalStorage.new(config.local_storage).run
+      end
+
+      def show_example_config
+        LocalPac.ui_logger.info "Showing the configuration of local_pac on your system."
+        Actions::CreateOutput.new(:'example-config', $stdout, Data.new(config)).run
+      end
+    end
+  end
+end

data/lib/local_pac/actions/reload_local_storage.rb

@@ -16,6 +16,8 @@ module LocalPac
 
       def run
         sinatra_apps.each { |app| app.set :local_storage, local_storage }
+      rescue StandardError => e
+        raise Exceptions::ReloadOfLocalStorageFailed, e.message
       end
     end
   end

data/lib/local_pac/actions/show_application_status.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module LocalPac
+  module Actions
+    class ShowApplicationStatus
+
+      private
+
+      include Pager
+
+      attr_reader :should_page
+
+      public
+
+      def initialize(options = {})
+        @should_page = options.fetch(:pager, :true)
+        config = options.fetch(:config, LocalPac.config)
+
+        @actions = []
+        @actions << Actions::PrintTitle.new('System Information')
+        @actions << Actions::GetSystemInformation.new
+        @actions << Actions::PrintNewline.new(2)
+        @actions << Actions::PrintTitle.new('Application Configuration')
+        @actions << Actions::ShowConfig.new
+        @actions << Actions::PrintNewline.new(2)
+        @actions << Actions::PrintTitle.new('Process Information')
+        @actions << Actions::ShowProcessInformation.new(config.pid_file)
+        @actions << Actions::PrintNewline.new(2)
+        @actions << Actions::PrintTitle.new('Available Proxy.Pac-Files')
+        @actions << Actions::ShowAvailableProxyPacFiles.new(config.local_storage)
+      end
+
+      def run
+        page if should_page
+
+        @actions.each(&:run)
+      end
+    end
+  end
+end