local_pac 0.1.13 → 0.2.0

data/README.DEVELOPER.md

@@ -11,6 +11,13 @@ Please make sure you have `phantomjs` installed.
 sudo pacman -S phantomjs
 ```
 
+During testing `git` is used a lot. So please install it as well.
+
+```bash
+# archlinux
+sudo pacman -S git
+```
+
 ## Start
 
 ```bash

data/README.md

@@ -5,7 +5,16 @@
 [![Coverage Status](https://coveralls.io/repos/dg-vrnetze/local_pac/badge.png?branch=master)](https://coveralls.io/r/dg-vrnetze/local_pac?branch=master)
 [![Gem Version](https://badge.fury.io/rb/local_pac.png)](http://badge.fury.io/rb/local_pac)
 
-Serve proxy.pac-files with ease.
+`local_pac` serves to purposes:
+
+1. Serve proxy.pac-files compressed from a vcs repository (git).
+2. Lookup of url in proxy.pac to find out which proxy will be used.
+
+Behind the scenes it uses a javascript compressor
+([uglifier](https://github.com/lautis/uglifier)) to make 1. and and a proxy-pac
+parser ([ruby-pac](https://github.com/samuelkadolph/ruby-pac)) to make 2.
+possible.
+
 
 ## Installation
 
@@ -21,8 +30,135 @@ Or install it yourself as:
 
     $ gem install local_pac
 
+Additionally you need to install `git` because `local_pac` makes a lot of use
+of it.
+
 ## Usage
 
+### Getting started
+
+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).
+
+* `$HOME/.config/local_pac/config.yaml`
+* `$HOME/.local_pac/config.yaml`
+* `/etc/local_pac/config.yaml`
+
+<table>
+  <caption>Table 1: Configuration values for <code>local_pac</code></caption>
+  <tr>
+    <th>
+      Option
+    </th>
+    <th>
+      Default value
+    </th>
+    <th>
+      Description
+    </th>
+  </tr>
+  <tr>
+    <td>
+      :local_storage
+    </td>
+    <td>
+      $HOME/.local/share/local_pac/data/storage.git
+    </td>
+    <td>
+     Path to git-(bare)-repository to store the proxy.pac-files. This is not for direct use!
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :executable
+    </td>
+    <td>
+      /path/to/gem/bin/local_pac
+    </td>
+    <td>
+    Internal use only
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :pid_file
+    </td>
+    <td>
+      $HOME/.local/share/local_pac/run/pid
+    </td>
+    <td>
+    If would do not use `systemd`, but want to run `local_pac` as a system service, you might need a pid file for your init-daemon.
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :gem_path
+    </td>
+    <td>
+      `ruby -rrubygems -e 'puts Gem.path.join(", ")'`
+    </td>
+    <td>
+    Internal use only
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :access_log
+    </td>
+    <td>
+      $HOME/home/xgvndeg/.local/share/local_pac/log/access.log
+    </td>
+    <td>
+     Write access to the file in production and test environment.
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :sass_cache
+    </td>
+    <td>
+      $HOME/home/xgvndeg/.local/share/local_pac/cache
+    </td>
+    <td>
+    Cache for assets for the lookup of urls
+    </td>
+  </tr>
+  <tr>
+    <td>
+      :config_file
+    </td>
+    <td>
+      No default
+    </td>
+    <td>
+    Internal use only
+    </td>
+  </tr>
+</table>
+
+A config file could look like the following one:
+
+```yaml
+:local_storage: /var/local_pac/data/storage.git
+:pid_file: /run/local_pac/pid
+:access_log: /var/log/local_pac/access.log
+:sass_cache: /var/local_pac/cache
+```
+
+After creating creating that file, you can check it by running `local_pac status --config-file <file>`. If your file could be parsed successfully, you can initialize the `local_pac`-environment by running `local_pac initialize --config-file <file>` or `local_pac initialize`. The latter works only if you placed your config file at one of the known paths mentioned above.
+
+The next step is to clone the newly created repository - e.g. at `/home/<user>/.local/share/data/storage.git`.
+
+
+Summary:
+1. Create a config file
+2. Check config file
+3. Initialize `local_pac`
+4. Clone `local_pac`-git-repository
+5. Add a proxy.pac to git-repository
+6. Push to `local_pac`-git-repository
+7. Restart `local_pac`-service
+
 ### Serving proxy.pacs
 
 You need to place your proxy.pac in one of the following directories:
@@ -101,7 +237,7 @@ To make debugging a little bit easier you can view the config values used by
 ```bash
 option | value
 -------------------- + --------------------------------------------------------------------------------
-            log_sink | /home/user/.local/share/local_pac/log
+          access_log | /home/user/.local/share/local_pac/log/access.log
        local_storage | /home/user/.local/share/local_pac/data
             pid_file | /home/user/.local/share/local_pac/run/pid
             gem_path | /home/user/.gem/ruby/1.9.3, /opt/rubies/1.9.3/lib/ruby/gems/1.9.1

data/Rakefile

@@ -13,27 +13,27 @@ def version
 end
 
 def root_directory
-  File.expand_path('../', __FILE__)
+  ::File.expand_path('../', __FILE__)
 end
 
 def tar_file
-  File.join(pkg_directory, "#{software}-#{version}.tar.gz")
+  ::File.join(pkg_directory, "#{software}-#{version}.tar.gz")
 end
 
 def tmp_directory
-  File.join(root_directory, 'tmp', "#{software}-#{version}")
+  ::File.join(root_directory, 'tmp', "#{software}-#{version}")
 end
 
 def gem_file
-  File.join(root_directory, 'pkg', "#{software}-#{version}.gem")
+  ::File.join(root_directory, 'pkg', "#{software}-#{version}.gem")
 end
 
 def pkg_directory
-  File.join(root_directory, 'pkg')
+  ::File.join(root_directory, 'pkg')
 end
 
 def gem_directory
-  File.join(root_directory, 'vendor', 'cache')
+  ::File.join(root_directory, 'vendor', 'cache')
 end
 
 task :default => 'gem:build'
@@ -47,10 +47,18 @@ end
 namespace :gem do
   desc 'build tar file'
   task :package => [gem_file, tmp_directory] do
-    FileUtils.mv File.join(pkg_directory, "#{software}-#{version}.gem"), tmp_directory
+    FileUtils.mv ::File.join(pkg_directory, "#{software}-#{version}.gem"), tmp_directory
 
     Dir.chdir('tmp') do
-      sh "tar -czf #{tar_file} #{File.basename tmp_directory}"
+      sh "tar -czf #{tar_file} #{::File.basename tmp_directory}"
     end
   end
 end
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+
+namespace :test do
+  desc 'Test with coveralls'
+  task :coveralls => ['test:rspec', 'test:cucumber', 'coveralls:push']
+end

data/app/controllers/application_controller.rb

@@ -4,11 +4,13 @@ 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
-      set :root, File.expand_path('../../', __FILE__)
+      set :root, ::File.expand_path('../../', __FILE__)
       set :haml, :format => :html5
 
       def local_storage
@@ -60,14 +62,14 @@ module LocalPac
 
       configure :test do
         use Rack::CommonLogger, LocalPac::NullAccessLogger.new
-        set :raise_errors, true
+        set :raise_errors, false
       end
       
       configure do
         mime_type :proxy_pac_file, 'application/x-ns-proxy-autoconfig'
 
         I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
-        I18n.load_path = Dir[File.join(settings.root, 'locales', '*.yml')]
+        I18n.load_path = Dir[::File.join(settings.root, 'locales', '*.yml')]
         I18n.backend.load_translations
 
         I18n.enforce_available_locales = true

data/app/controllers/assets_controller.rb

@@ -1,5 +1,6 @@
 require 'compass'
 require 'sass'
+require 'sinatra'
 require 'sprockets'
 require 'sprockets-sass'
 require 'compass'
@@ -10,12 +11,12 @@ require 'uglifier'
 module LocalPac
   module App
     class AssetsController < Sinatra::Base
-      set :root, File.expand_path('../../', __FILE__)
+      set :root, ::File.expand_path('../../', __FILE__)
       set :assets, Sprockets::Environment.new(root)
       set :precompile, [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
       set :assets_prefix, '/assets'
       set :digest_assets, false
-      set(:assets_path) { File.join public_folder, assets_prefix }
+      set(:assets_path) { ::File.join public_folder, assets_prefix }
 
       configure :profile do
         require 'ruby-prof'

data/app/controllers/file_serve_controller.rb

@@ -9,13 +9,10 @@ module LocalPac
       get '/:name' do
         content_type :proxy_pac_file
 
-        file = local_storage.find(params[:name])
+        file = local_storage.find(params[:name].to_s)
+        fail Sinatra::NotFound, params[:name].to_s if file.nil?
 
-        if file.nil?
-          fail Sinatra::NotFound, "#{params[:name]}"
-        else
-          file.compressed_content 
-        end
+        file.compressed_content 
       end
     end
   end

data/app/controllers/lookup_controller.rb

@@ -7,6 +7,9 @@ module LocalPac
       end
 
       get '/:name' do
+        file = local_storage.find(params[:name].to_s)
+        fail Sinatra::NotFound, params[:name].to_s if file.nil?
+
         haml :lookup, layout: :application
       end
 
@@ -14,17 +17,14 @@ module LocalPac
         @file = local_storage.find(params[:name].to_s)
         @uri = Addressable::URI.heuristic_parse(params[:url].to_s)
 
-        if @file.nil?
-          fail Sinatra::NotFound, params[:name]
-        else
-          parser = LocalPac::ProxyPac::PacParser.new(file: @file)
+        fail Sinatra::NotFound, params[:name].to_s if @file.nil?
 
-          begin
-            @result = parser.find(@uri)
-          rescue Exceptions::PacFileInvalid
-            fail I18n.t('errors.invalid_proxy_pac', name: params[:name] )
-          end
+        parser = LocalPac::ProxyPac::PacParser.new(file: @file)
 
+        begin
+          @result = parser.find(@uri)
+        rescue Exceptions::PacFileInvalid
+          fail I18n.t('errors.invalid_proxy_pac', name: params[:name] )
         end
 
         haml :lookup_result, layout: :application

data/app/locales/en.yml

@@ -17,6 +17,7 @@ en:
       buttons:
         search: Search
         reset: Clear
+      title: Lookup URLs in proxy.pac-files...
     lookup:
       headline: Lookup
     lookup_result:

data/app/views/application.haml

@@ -4,7 +4,7 @@
     %meta{:charset => "utf-8"}
     %link{ rel: 'stylesheet', href: stylesheet_path('application.css') }
     %script{ type: 'text/javascript', src: javascript_path('application.js') }
-    %title Lookup url in proxy.pac
+    %title= t('views.application.title')
   %body
     .lp_container
       = yield

data/bin/local_pac

@@ -1,84 +1,69 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
-require 'thor'
-require 'fileutils'
-
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH <<::File.expand_path('../../lib', __FILE__)
 require 'local_pac'
 
-class Default < 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'
-
-  no_commands {
-    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
+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'
 
-    def set_debug(request)
-      if request
-        LocalPac.ui_logger.info "Activating debug mode."
+      no_commands {
+        include LocalPac::Cli::Helper
+      }
 
-        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
-  }
+      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'
+      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]
 
-  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'
-  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.lock
 
-    LocalPac.config.lock
+        set_log_level(options[:log_level])
+        set_debug(options[:debug])
 
-    set_log_level(options[:log_level])
-    set_debug(options[:debug])
+        LocalPac.ui_logger.debug('Options: ' + options.to_s)
+        LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
 
-    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
+      end
 
-    LocalPac::Server.new(options[:listen], options[:rack_environment]).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?'
+      def init
+        LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
+        LocalPac.config.lock
 
-  desc 'init', 'Create files/directories to use local_pac in dir or $PWD'
-  option :force, type: :boolean, default: false, desc: 'Overwrite existing files?'
-  def init
-    LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
-    LocalPac.config.lock
+        set_log_level(options[:log_level])
+        set_debug(options[:debug])
 
-    set_log_level(options[:log_level])
-    set_debug(options[:debug])
+        LocalPac.ui_logger.debug('Options: ' + options.to_s)
+        LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
 
-    LocalPac.ui_logger.debug('Options: ' + options.to_s)
-    LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
+        Initializer.new(force: options[:force]).run
+      end
 
-    LocalPac::Initializer.new(force: options[:force]).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.lock
+
+        set_log_level(options[:log_level])
+        set_debug(options[:debug])
 
-  desc 'status', 'Show status of local_pac: configuration, known proxy pacs, server running etc.'
-  def config
-    LocalPac.config = LocalPac::Config.new(options[:config_file]) if options[:config_file]
-    LocalPac.config.lock
+        ApplicationStatus.new.show
+      end
 
-    set_log_level(options[:log_level])
-    set_debug(options[:debug])
+      desc 'reload', 'Reload configuration, local storage etc.'
+      option :pid_file, type: :string, desc: 'Pid file of daemon'
+      subcommand 'reload', LocalPac::Cli::Reload
+    end
 
-    puts LocalPac.config
   end
 end
-
-Default.start
+LocalPac::Cli::Main.start