local_pac 0.1.11 → 0.1.13

data/app/controllers/lookup_controller.rb

@@ -0,0 +1,34 @@
+module LocalPac
+  module App
+    class LookupController < ApplicationController
+
+      get '/' do
+        redirect to('/proxy.pac')
+      end
+
+      get '/:name' do
+        haml :lookup, layout: :application
+      end
+
+      post '/:name' do
+        @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)
+
+          begin
+            @result = parser.find(@uri)
+          rescue Exceptions::PacFileInvalid
+            fail I18n.t('errors.invalid_proxy_pac', name: params[:name] )
+          end
+
+        end
+
+        haml :lookup_result, layout: :application
+      end
+    end
+  end
+end

data/app/locales/de.yml

@@ -0,0 +1,2 @@
+---
+:de:

data/app/locales/en.yml

@@ -0,0 +1,31 @@
+---
+en:
+  errors:
+    invalid_proxy_pac: The requested proxy.pac-file "%{name}" is invalid.
+    not_found: Sorry, but I cannot find proxy.pac-file "%{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.
+  models:
+    data:
+      request_type: Request Type
+      proxy: Proxy
+      proxy_port: Proxy Port
+  views:
+    application:
+      buttons:
+        search: Search
+        reset: Clear
+    lookup:
+      headline: Lookup
+    lookup_result:
+      subtitle: You asked me to look up "%{url}" for you. 
+      headline: Lookup
+      buttons: 
+        styled: Styled Output
+        verbatim: Verbatim Output
+      form:
+        search_field:
+          label: URL
+          placeholder: Please enter fully quallified url here, e.g. "http://www.example.org"...

data/app/views/application.haml

@@ -0,0 +1,10 @@
+!!!
+%html
+  %head
+    %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
+  %body
+    .lp_container
+      = yield

data/app/views/error.haml

@@ -0,0 +1,6 @@
+.lp_warning_container
+  .lp_warning_summary
+    %i.fa.fa-exclamation-circle
+    = @error_summary
+  .lp_warning_details
+    = @error_details

data/app/views/form.haml

@@ -0,0 +1,11 @@
+%form#search.lp_form{ role: 'form', method: 'post'}
+  .lp_form_controls
+    .lp_search_group
+      %label.sr-only{for: 'url'} 
+        = t('views.lookup_result.form.search_field.label')
+      %input#url.lp_field_search{name: 'url', placeholder: t('views.lookup_result.form.search_field.placeholder'), autofocus: true, value: @uri }
+    .lp_buttons
+      %button.lp_button_search{type: 'submit', value: t('views.application.buttons.search')}
+        = t('views.application.buttons.search')
+      %button#reset.lp_button_reset{type: 'submit', value: t('views.application.buttons.reset')}
+        = t('views.application.buttons.reset')

data/app/views/lookup.haml

@@ -0,0 +1,3 @@
+%h1.text-center= t('views.lookup.headline')
+
+= haml :form, layout: false

data/app/views/lookup_result.haml

@@ -0,0 +1,19 @@
+%h1.text-center= t('views.lookup_result.headline')
+
+= haml :form, layout: false
+
+%ul.lp_navigation#navigation
+  %li.active
+    %a{ href: "#styled", :"data-toggle" => "tab" } 
+      = t('views.lookup_result.buttons.styled')
+  %li
+    %a{ href: "#verbatim", :"data-toggle" => "tab" }
+      = t('views.lookup_result.buttons.verbatim')
+
+.tab-content
+  #styled.tab-pane.active
+    .lp_requested_uri= t('views.lookup_result.subtitle', url: h(@uri))
+    = @result.styled_content
+  #verbatim.tab-pane
+    .lp_verbatim
+      = @result.verbatim_content

data/bin/local_pac

@@ -9,44 +9,59 @@ 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
+
+    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
+  }
 
   desc 'serve', 'Serve pacfiles'
   option :access_log, type: :string, desc: 'File to write access log to'
-  option :port, type: :numeric, default: 8000, desc: 'The port the server listens on'
+  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]
-    access_log = options[:access_log] || ::File.join(LocalPac.config.log_sink, 'access.log')
-
-    case options[:log_level]
-    when 'info'
-      LocalPac.ui_logger.level = Logger::INFO
-    when 'debug'
-      LocalPac.ui_logger.level = Logger::DEBUG
-    else
-      LocalPac.ui_logger.level = Logger::WARN
-    end
+    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
+
+    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::FileServer.use Rack::CommonLogger, LocalPac::Logger.new(access_log)
-    LocalPac::FileServer.set :port, options[:port]
-    LocalPac::FileServer.run!
+    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]
-
-    case options[:log_level]
-    when 'info'
-      LocalPac.ui_logger.level = Logger::INFO
-    when 'debug'
-      LocalPac.ui_logger.level = Logger::DEBUG
-    else
-      LocalPac.ui_logger.level = Logger::WARN
-    end
+    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])
 
     LocalPac.ui_logger.debug('Options: ' + options.to_s)
     LocalPac.ui_logger.debug("Config:\n" + LocalPac.config.to_s)
@@ -54,9 +69,14 @@ class Default < Thor
     LocalPac::Initializer.new(force: options[:force]).run
   end
 
-  desc 'config', 'Show configuration'
+  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 = LocalPac::Config.new(options[:config_file]) if options[:config_file]
+    LocalPac.config.lock
+
+    set_log_level(options[:log_level])
+    set_debug(options[:debug])
+
     puts LocalPac.config
   end
 end

data/config.ru

@@ -1,6 +1,27 @@
 $LOAD_PATH << File.expand_path('../lib/', __FILE__)
+
+#require 'rack/contrib'
+
 require 'local_pac'
 
-logger = LocalPac::Logger.new ENV['LOGFILE'] || File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'access.log'))
-use Rack::CommonLogger, logger
-run LocalPac::FileServer.new
+require File.expand_path('../app/controllers/application_controller.rb', __FILE__)
+Dir.glob(File.expand_path('../app/controllers/*.rb', __FILE__)).each { |f| require f }
+#
+#logger = LocalPac::AccessLogger.new ENV['ACCESS_LOG'] || File.expand_path(File.join(LocalPac.config.access_log))
+#use Rack::CommonLogger, logger
+
+map '/' do
+  run LocalPac::App::FileServeController
+end
+
+map '/v1/pac/' do
+  run LocalPac::App::FileServeController
+end
+
+map '/v1/lookup/' do
+  run LocalPac::App::LookupController
+end
+
+map LocalPac::App::AssetsController.assets_prefix do
+  run LocalPac::App::AssetsController.assets
+end

data/features/fetch_proxy_pac.feature

@@ -5,7 +5,7 @@ Feature: Fetch proxy pac
   In order to reach different proxy servers
 
   Scenario: Default
-    Given an empty environment
+    Given no proxy urls in environment
     When I sucessfully fetch the proxy pac
     Then I got
     """

data/features/initializer.feature

@@ -3,7 +3,6 @@ Feature: Initialize environment
   I want to have utility to init environment for local_pac
   In order to make less mistakes
 
-  @wip
   Scenario: Not initialized
     Given a file named "config.yaml" with:
     """

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

@@ -1,4 +1,4 @@
-Feature: Show config
+Feature: Show status
   As a administrator
   I want to have utility to show config of local pac
   In order to make less mistakes
@@ -12,7 +12,7 @@ Feature: Show config
     log_sink: 'log'
     executable: 'bin/local_pac'
     """
-    When I successfully run `local_pac config`
+    When I successfully run `local_pac status`
     Then the stdout should contain:
     """
     pid_file: 'run/pid'

data/features/step_definitions.rb

@@ -0,0 +1,14 @@
+Given(/^no proxy urls in environment$/) do
+  ENV.delete('http_proxy')
+  ENV.delete('https_proxy')
+  ENV.delete('HTTP_PROXY')
+  ENV.delete('HTTPS_PROXY')
+end
+
+When(/^I sucessfully fetch the proxy pac$/) do
+  @result = Excon.get('http://localhost:8000/v1/pac/proxy.pac').body
+end
+
+Then(/^I got$/) do |string|
+  expect(@result).to eq(string)
+end

data/features/support/env.rb

@@ -1 +1,2 @@
 require 'aruba/cucumber'
+require 'excon'

data/files/config.yaml

@@ -2,3 +2,4 @@
 :log_sink: ~/.local/share/local_pac/log
 :local_storage: ~/.local/share/local_pac/data
 :pid_file: ~/.local/share/local_pac/run/pid
+:access_log: ~/.local/share/local_pac/log/access.log

data/files/example-config.erb

@@ -0,0 +1,16 @@
+
+---
+# You might want to copy the following output to one of the searched config
+# file paths - in the given order.
+<% Array(lookup('allowed_config_file_paths')).each do |p| -%>
+# <%= p %>
+<% end -%>
+:gem_path: 
+<% Array(lookup('gem_path')).collect { |p| File.expand_path(p) }.each do |p| -%>
+  - <%= p %>
+<% end -%>
+:log_sink: <%= File.expand_path(lookup('log_sink')) %>
+:local_storage: <%= File.expand_path(lookup('local_storage')) %>
+:executable: <%= File.expand_path(lookup('executable')) %>
+:pid_file: <%= File.expand_path(lookup('pid_file')) %>
+

data/lib/local_pac/{logger.rb → access_logger.rb}

@@ -1,5 +1,5 @@
 module LocalPac
-  class Logger
+  class AccessLogger
     def initialize(path)
       @logger = ::Logger.new(::File.expand_path(path))
     end

data/lib/local_pac/actions/create_directory.rb

@@ -16,10 +16,10 @@ module LocalPac
 
       def run
         if need_to_run? || options[:force] == true
-          LocalPac.ui_logger.warn "Creating repository \"#{path}\"."
+          LocalPac.ui_logger.warn "Creating directory \"#{path}\"."
           fs_engine.mkdir_p(path)
         else
-          LocalPac.ui_logger.warn "Repository \"#{path}\" already exists. Do not create it again!."
+          LocalPac.ui_logger.warn "Directory \"#{path}\" already exists. Do not create it again!."
         end
       end
 

data/lib/local_pac/actions/create_file.rb

@@ -21,7 +21,7 @@ module LocalPac
         if need_to_run? || options[:force] == true
           LocalPac.ui_logger.warn "Creating file \"#{destination}\"."
 
-          file = template(name, destination, data)
+          file = template(name, ::File.new(destination, 'w'), data)
           FileUtils.chmod('+x', file) if options[:executable] == true
         else
           LocalPac.ui_logger.warn "File \"#{destination}\" already exists. Do not create it again!."
@@ -34,7 +34,7 @@ module LocalPac
         template = repository.find(local_name)
 
         generator = engine.new(local_data)
-        generator.compile(template, ::File.new(local_destination, 'w'))
+        generator.compile(template, local_destination)
 
         local_destination
       rescue Errno::ENOENT

data/lib/local_pac/actions/create_output.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module LocalPac
+  module Actions
+    class CreateOutput
+      private
+
+      attr_reader :name, :output, :engine, :repository, :data
+
+      public
+
+      def initialize(name, output, data, engine = ErbGenerator, repository = TemplateRepository.new)
+        @name        = name
+        @output      = output
+        @data        = data
+        @engine      = engine
+        @repository  = repository
+      end
+
+      def run
+        LocalPac.ui_logger.info "Creating example configuration:"
+        template(name, output, data)
+      end
+
+      private
+
+      def template(local_name, local_destination, local_data)
+        template = repository.find(local_name)
+
+        generator = engine.new(local_data)
+        generator.compile(template, local_destination)
+      rescue Errno::ENOENT
+        fail Exceptions::ErbTemplateIsUnknown, "Unknown erb template \"#{template_path}\"."
+      end
+    end
+  end
+end

data/lib/local_pac/config.rb

@@ -16,6 +16,10 @@ module LocalPac
           config.fetch(option.to_sym, default_value)
         end
 
+        define_method "#{option}=".to_sym do |value|
+          config[option.to_sym] = value
+        end
+
         @options << option
       end
     end
@@ -30,18 +34,24 @@ module LocalPac
         if yaml.respond_to? :[]
           @config = yaml.symbolize_keys.freeze
         else
-          @config = {}.freeze
+          @config = {}
         end
       end
     rescue => e
       fail Exceptions::ConfigFileNotReadable, "Sorry, but there was a problem reading the config file: #{e.message}."
     end
 
+    def lock
+      config.freeze
+    end
+
     option :log_sink, File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'log'))
     option :local_storage, File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'data'))
     option :executable, File.expand_path(File.expand_path('../../../bin/local_pac', __FILE__))
     option :pid_file, File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'run', 'pid'))
     option :gem_path, Gem.path.collect {|p| File.expand_path(p) }
+    option :access_log, File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'log', 'access.log'))
+    option :sass_cache, File.expand_path(File.join(ENV['HOME'], '.local', 'share', 'local_pac', 'cache', 'sass'))
 
     def to_s
       result = []
@@ -55,9 +65,7 @@ module LocalPac
       result.join("\n")
     end
 
-    private
-
-    def candiate_files
+    def allowed_config_file_paths
       [
         File.expand_path(File.join(ENV['HOME'], '.config', 'local_pac', 'config.yaml')),
         File.expand_path(File.join(ENV['HOME'], '.local_pac', 'config.yaml')),
@@ -66,8 +74,10 @@ module LocalPac
       ]
     end
 
+    private
+
     def available_config_file
-      candiate_files.find { |f| File.exists? f }
+      allowed_config_file_paths.find { |f| File.exists? f }
     end
   end
 end

data/lib/local_pac/exceptions.rb

@@ -8,5 +8,17 @@ module LocalPac
 
     # raised if Template does not exist
     class ConfigFileNotReadable < Exception; end
+
+    # raised if listen statement is invalid
+    class ServerListenStatementInvalid < Exception; end
+
+    # raised if entered url is invalid
+    class URLToSearchForInvalid < Exception; end
+
+    # raised if pac file is invalid
+    class PacFileInvalid < Exception; end
+
+    # raised if request is invalid
+    class GivenUrlInvalid < Exception; end
   end
 end

data/lib/local_pac/initializer.rb

@@ -15,12 +15,21 @@ module LocalPac
     def run
       LocalPac.ui_logger.info "Creating pid directory: #{::File.dirname(config.pid_file)}"
       Actions::CreateDirectory.new(::File.dirname(config.pid_file), force: options[:force]).run
+
       LocalPac.ui_logger.info "Creating log sink: #{config.log_sink}"
       Actions::CreateDirectory.new(config.log_sink, force: options[:force]).run
+
+      LocalPac.ui_logger.info "Creating sass cache #{config.sass_cache}"
+      Actions::CreateDirectory.new(config.sass_cache, force: options[:force]).run
+
       LocalPac.ui_logger.info "Creating local storage: #{config.local_storage}"
       Actions::CreateRepository.new(config.local_storage, bare: true, force: options[:force]).run
+
       LocalPac.ui_logger.info "Creating pre-receive hook in local storage \"#{config.local_storage}\"."
-      Actions::CreateFile.new(:'git-hook', File.join(config.local_storage, 'hooks', 'pre-receive'), Data.new(config), force: options[:force]).run
+      Actions::CreateFile.new(:'git-hook', File.join(config.local_storage, 'hooks', 'pre-receive'), Data.new(config), force: options[:force], executable: true).run
+
+      LocalPac.ui_logger.info "Creating example configuration."
+      Actions::CreateOutput.new(:'example-config', $stdout, Data.new(LocalPac::Config.new)).run
     end
   end
 end

data/lib/local_pac/main.rb

@@ -2,22 +2,59 @@
 module LocalPac
   @config_semaphore = Mutex.new
   @logger_semaphore = Mutex.new
+  @routing_semaphore = Mutex.new
 
   class << self
     attr_reader :config_semaphore
     attr_reader :logger_semaphore
+    attr_reader :routing_semaphore
     attr_accessor :debug_mode
 
-    def config(local_config = LocalPac::Config.new)
+    def config
       config_semaphore.synchronize do
-        @config ||= local_config
+        @config ||= LocalPac::Config.new
       end
     end
 
+    def config=(config)
+      @config = config
+    end
+
     def ui_logger(local_logger = LocalPac::UiLogger.new)
       logger_semaphore.synchronize do
         @ui_logger ||= local_logger
       end
     end
+
+    def error_id
+      SecureRandom.hex
+    end
+
+    def routing
+      routing_semaphore.synchronize do
+        @routing ||= Rack::Builder.new do
+          require_relative File.expand_path('../../../app/controllers/application_controller.rb', __FILE__)
+          Dir.glob(File.expand_path('../../../app/controllers/*.rb', __FILE__)).each { |f| require_relative f }
+
+          map '/' do
+            run LocalPac::App::FileServeController
+          end
+
+          map '/v1/pac/' do
+            run LocalPac::App::FileServeController
+          end
+
+          map '/v1/lookup/' do
+            run LocalPac::App::LookupController
+          end
+
+          map LocalPac::App::ApplicationController.assets_prefix do
+            run LocalPac::App::ApplicationController.assets
+          end
+        end
+      end
+    end
   end
+
+
 end

data/lib/local_pac/null_access_logger.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module LocalPac
+  class NullAccessLogger
+    def write(*args, &block); end
+  end
+end

data/lib/local_pac/proxy_pac/html_data.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module LocalPac
+  module ProxyPac
+    class HTMLData
+      attr_reader :header_css_class, :header, :element_css_class, :element, :html_style, :html_data
+
+      def initialize(options = {})
+        @header_css_class  = options.fetch(:header_css_class, nil)
+        @element_css_class = options.fetch(:element_css_class)
+        @element           = options.fetch(:element)
+        @header            = options.fetch(:header, nil)
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+    end
+  end
+end

data/lib/local_pac/proxy_pac/html_div_style.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module LocalPac
+  module ProxyPac
+    class HTMLDivStyle
+      private
+
+      attr_reader :data, :main_container_css_class, :element_container_css_class
+
+      public
+
+      def initialize(options = {})
+        @main_container_css_class    = options.fetch(:main_container_css_class)
+        @element_container_css_class = options.fetch(:element_container_css_class)
+        @data                        = []
+      rescue KeyError => e
+        raise ArgumentError, e.message
+      end
+
+      def add_data(data)
+        @data << data
+      end
+
+      def to_s
+        data_row = data.reduce([]) do |memo, element|
+          memo << "  <div class=\"#{element_container_css_class}\">"
+
+          if element.header
+            memo << "    <div class=\"#{element.header_css_class}\">" if element.header_css_class
+            memo << "    #{element.header}"
+            memo << '    </div>'                                      if element.header_css_class
+          end
+
+          memo << "    <div class=\"#{element.element_css_class}\">" if element.element_css_class
+          memo << "      #{element.element}"
+          memo << '    </div>'                                      if element.element_css_class
+
+          memo << '  </div>'
+        end
+
+        content = ["<div class=\"#{main_container_css_class}\">"]
+        content.concat data_row
+        content << '</div>'
+
+        content.join("\n")
+      end
+    end
+  end
+end