local_pac 0.5.0 → 0.6.1

data/lib/local_pac/actions/show_pac_file.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module LocalPac
+  module Actions
+    class ShowPacFile
+      private
+
+      attr_reader :name, :repo, :options, :vcs_engine, :storage_path
+
+      public
+
+      def initialize(file, storage_path, options = {}, vcs_engine = GitStorage)
+        @name         = ::File.basename(file, '.pac').to_sym
+        @storage_path = storage_path
+        @options      = options
+        @vcs_engine   = vcs_engine
+      end
+
+      def run
+        begin
+          @repo = vcs_engine.new(storage_path)
+        rescue Rugged::OSError
+          raise Exceptions::RepositoryDoesNotExist, "Sorry, but the repository at #{storage_path} does not exist" unless ::Dir.exists? storage_path
+        end
+
+        puts repo[name].content
+      end
+    end
+  end
+end

data/lib/local_pac/actions/validate_pac_file.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module LocalPac
+  module Actions
+    class ValidatePacFile
+
+      private
+
+      attr_reader :path, :validator, :creator
+
+      public
+
+      def initialize(path, creator = File, validator = PacFileValidator.new)
+        @path      = path
+        @validator = validator
+        @creator   = creator
+      end
+
+      def run
+        file = creator.new(path, ::File.read(path))
+
+        if validator.valid?(file)
+          puts "File \"#{file.path}\" is a valid pac file."
+        else
+          puts "File \"#{file.path}\" is not a valid pac file:"
+          puts validator.errors(file)
+        end
+      rescue Errno::EISDIR => e
+        raise Exceptions::PacFileInvalid, e.message
+      end
+    end
+  end
+end
+
+

data/lib/local_pac/cli/main.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+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)
+
+        Actions::InitializeApplication.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 'reload', 'Reload configuration, local storage etc.'
+      option :pid_file, type: :string, desc: 'Pid file of daemon'
+      subcommand 'reload', LocalPac::Cli::Reload
+
+      desc 'show', 'Show information about status.'
+      subcommand 'show', LocalPac::Cli::Show
+
+      desc 'validate', 'Validate information about status.'
+      subcommand 'validate', LocalPac::Cli::Validate
+    end
+  end
+end

data/lib/local_pac/cli/reload.rb

@@ -9,11 +9,13 @@ module LocalPac
       desc 'configuration', 'Reload configuration'
       def configuration
         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.pid_file = options[:pid_file] if options[:pid_file] 
         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.info "Ask web application (PID: #{pid(LocalPac.config)}) to reload configuration"
         Actions::SendSignal.new(LocalPac.config.reload_config_signal).run
@@ -22,11 +24,13 @@ module LocalPac
       desc 'local_storage', 'Reload local_storage'
       def local_storage
         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.pid_file = options[:pid_file] if options[:pid_file] 
         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.info "Ask web application (PID: #{pid(LocalPac.config)}) to reload storage"
         Actions::SendSignal.new(LocalPac.config.reload_storage_signal).run

data/lib/local_pac/cli/show.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module LocalPac
+  module Cli
+    class Show < Thor
+
+      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
+
+        Actions::ShowApplicationStatus.new.run
+      end
+
+      desc 'pac_fiel', 'Show pac file.'
+      def pac_file(file)
+        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
+
+        Actions::PrintTitle.new("Content of \"#{file}\"").run
+        Actions::ShowPacFile.new(file, LocalPac.config.local_storage).run
+      end
+    end
+  end
+end

data/lib/local_pac/cli/validate.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module LocalPac
+  module Cli
+    class Validate < Thor
+
+      desc 'configuration', 'Reload configuration'
+      def pac_file(path)
+        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
+
+        LocalPac.ui_logger.info "Validating pac file #{path}"
+        Actions::ValidatePacFile.new(path).run
+      end
+
+    end
+  end
+end

data/lib/local_pac/config.rb

@@ -49,7 +49,7 @@ module LocalPac
           @config = {}
         end
       end
-    rescue => e
+    rescue StandardError => e
       fail Exceptions::ConfigFileNotReadable, "Sorry, but there was a problem reading the config file: #{e.message}."
     end
 

data/lib/local_pac/error_handler.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+module LocalPac
+  class ErrorHandler
+
+    @handlers = []
+    @mutex    = Mutex.new
+
+    class << self
+      attr_reader :handlers, :mutex
+    end
+
+    private
+
+    attr_reader :message, :exit_code
+
+    public
+
+    attr_reader :exception
+    attr_accessor :original_message
+
+    def initialize(options = {})
+      @exception = options.fetch(:exception)
+      @message   = options.fetch(:message)
+      @exit_code = options.fetch(:exit_code)
+    rescue KeyError => e
+      raise ArgumentError, e.message
+    end
+
+    class << self
+      def create(options = {}, &block)
+        handler = new(options, &block)
+        handlers << handler
+
+        handler
+      end
+
+      def find(exception)
+        handlers.find(proc { default_handler }) { |h| h.exception == exception }
+      end
+
+      private
+
+      def default_handler
+        mutex.synchronize do
+          @default_handler ||= new(
+            exception: StandardError,
+            message: 'Sorry, but I cannot fullfil your request. An unexpected error occured.',
+            exit_code: 99,
+          )
+        end
+      end
+    end
+
+    def run
+      LocalPac.ui_logger.fatal message
+      LocalPac.ui_logger.debug original_message if original_message
+      Kernel.exit exit_code
+    end
+  end
+end

data/lib/local_pac/exceptions.rb

@@ -12,12 +12,18 @@ module LocalPac
     # raised if listen statement is invalid
     class ServerListenStatementInvalid < StandardError; end
 
+    # raised if reload of local storage failed
+    class ReloadOfLocalStorageFailed < StandardError; end
+
     # raised if entered url is invalid
     class URLToSearchForInvalid < StandardError; end
 
     # raised if pac file is invalid
     class PacFileInvalid < StandardError; end
 
+    # raised if api key is invalid
+    class ApiKeyInvalid < StandardError; end
+
     # raised if request is invalid
     class GivenUrlInvalid < StandardError; end
 

data/lib/local_pac/git_storage.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 module LocalPac
   class GitStorage
+
     private
 
-    attr_reader :storage_path, :data, :repository, :file_creator, :null_file, :vcs_engine
+    attr_reader :storage_path, :repository, :file_creator, :null_file, :vcs_engine, :compressor_engine
 
     public
 
@@ -11,16 +12,33 @@ module LocalPac
       @storage_path = ::File.expand_path(storage_path)
       @null_file    = null_file
       @vcs_engine   = vcs_engine
+      @compressor_engine = compressor_engine
 
       begin
         @repository = vcs_engine.new(storage_path)
       rescue Exceptions::RepositoryDoesNotExist
         @repository = vcs_engine.create(storage_path)
       end
+    end
+
+    def [](key)
+      data.fetch(key, null_file)
+    end
+
+    def each_pac_file(&block)
+      pac_files.each(&block)
+    end
+
+    def each_added_pac_file(old_commit_id, new_commit_id, &block)
+      added_pac_files(old_commit_id, new_commit_id).each(&block)
+    end
 
+    private
+
+    def data
       mutex = Mutex.new
       mutex.synchronize do
-        @data = pac_files.reduce({}) do |memo, file| 
+        @data ||= pac_files.reduce({}) do |memo, file| 
           compressor_engine.new.prepare(file)
           memo[file.name.to_sym] = file
 
@@ -29,19 +47,21 @@ module LocalPac
       end
     end
 
-    def [](key)
-      data.fetch(key, null_file)
+    def added_pac_files(old_commit_id, new_commit_id)
+      logging_for_repo_action do
+        repository.added_files(old_commit_id, new_commit_id).keep_if { |f| f.extension? '.pac' }
+      end
     end
 
-    def each_pac_file(&block)
-      pac_files.each(&block)
+    def pac_files
+      logging_for_repo_action do
+        repository.all_files.keep_if { |f| f.extension? '.pac' }
+      end
     end
 
-    private
-
-    def pac_files
+    def logging_for_repo_action(&block)
       LocalPac.ui_logger.debug "I'm using the following storage path: \"#{storage_path}\"."
-      files = repository.all_files.keep_if { |f| f.extension? '.pac' }
+      files = block.call
       LocalPac.ui_logger.debug "Found the following files: #{files.collect { |f| "\"#{f.path}\"" }.join(", ")}."
 
       files

data/lib/local_pac/pac_file_validator.rb

@@ -1,13 +1,28 @@
 # encoding: utf-8
 module LocalPac
   class PacFileValidator
+
     def valid?(file)
-      pac = PAC.source(file.content) 
-      pac.find('http://www.example.com')
+      validate(file)
 
       true
     rescue StandardError
       false
     end
+
+    def errors(file)
+      validate(file)
+
+      ''
+    rescue StandardError => e
+      e.message
+    end
+
+    private
+
+    def validate(file)
+      pac = PAC.source(file.content) 
+      pac.find('http://www.example.com')
+    end
   end
 end