local_pac 0.6.3 → 0.7.0

data/app/controllers/lookup_controller.rb

@@ -2,34 +2,69 @@ module LocalPac
   module App
     class LookupController < ApplicationController
 
+      helpers Sinatra::Param
+
       get '/' do
         redirect to('/proxy.pac')
       end
 
       get '/:name' do
         file = local_storage.find(params[:name].to_s)
-        fail Sinatra::NotFound, params[:name].to_s if file.nil?
+        fail Sinatra::NotFound, name: params[:name].to_s if file.nil?
+
+        @client_ip = IPAddr.new(remote_addr).to_s
+        @time      = Time.now.strftime "%Y-%m-%d %H:%M:%S"
 
         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)
+        param :name, String, required: true
+        param :url, String, required: true
+        param :client_ip, String
+        param :time, String
 
+        parse_env = {}
 
-        fail Sinatra::NotFound, params[:name].to_s if @file.nil?
+        @file = local_storage.find(params[:name])
+        @uri = Addressable::URI.heuristic_parse(params[:url])
 
-        parser = LocalPac::ProxyPac::PacParser.new(file: @file)
+        fail Sinatra::NotFound, name: params[:name].to_s if @file.nil?
+        fail Exceptions::GivenUrlInvalid, JSON.dump(url: params[:url]) if @uri.host.blank?
+
+        begin
+          parse_env[:time] = @time = Time.parse(params[:time]).to_s unless params[:time].blank?
+        rescue ArgumentError
+          raise Exceptions::GivenTimeInvalid, JSON.dump(time: params[:time])
+        end
+
+        begin
+          parse_env[:client_ip] = @client_ip = IPAddr.new(params[:client_ip]).to_s unless params[:client_ip].blank?
+        rescue ArgumentError
+          raise Exceptions::GivenClientIpInvalid, JSON.dump(client_ip: params[:client_ip])
+        end
+
+
+        parser = LocalPac::ProxyPac::PacParser.new(file: @file, environment: parse_env)
 
         begin
           @result = parser.find(@uri)
         rescue Exceptions::PacFileInvalid
-          fail I18n.t('errors.invalid_proxy_pac', name: params[:name] )
+          raise Exceptions::PacFileInvalid, name: params[:name]
         end
 
         haml :lookup_result, layout: :application
       end
+
+      helpers do
+        def remote_addr
+          return '127.0.0.1'        if env['REMOTE_ADDR'] == ''
+          return env['REMOTE_ADDR'] if env['REMOTE_ADDR'] 
+
+          '127.0.0.1'
+        end
+      end
+
     end
   end
 end

data/app/locales/en.yml

@@ -19,15 +19,30 @@ en:
     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".
+    invalid_client_ip: 
+      summary: Invalid Client IP...
+      details: Sorry, but your request is invalid. The client ip address "%{client_ip}" is not a correct one. Allowed are IPs like "10.0.0.1".
+    invalid_time: 
+      summary: Invalid Time...
+      details: Sorry, but your request is invalid. The time "%{time}" is not a correct one. Allowed are IPs like "10.0.0.1".
     default: 
       summary: Unexpected Error...
-      details: Sorry, but I cannot full your request. Please ask your administrator for support.
+      details: Sorry, but I cannot fullfill your request. An unexpected error occured. 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...
+    invalid_pushed_pac_file: 
+      summary: Invalid pushed PAC-file...
       details: Sorry, but your push request is invalid. The pac-file "%{name}" is invalid.
+    internal_error: 
+      summary: Internal error...
+      details: 'Sorry, but I cannot fullfill your request. An internal error occured: "%{message}". Please notify the author of the software about the problem.'
+    user_error: 
+      summary: User Error...
+      details: Sorry, but I cannot fullfill your request. An error occured. There should be a better error message displayed here. Please notify the author of the software about the problem.
+    unreadable_config_file: 
+      summary: Unreadable config file...
+      details: 'Sorry, but I cannot fullfill your request. The config file "%{file}" given could not be read: "%{message}".'
   models:
     data:
       request_type: Request Type
@@ -38,8 +53,12 @@ en:
       buttons:
         search: Search
         reset: Clear
+        more: More Fields
       title: Lookup URLs in proxy.pac-files...
+    root:
+      link: Home
     lookup:
+      link: Lookup
       headline: Lookup
     lookup_result:
       subtitle: You asked me to look up "%{url}" for you. 
@@ -48,6 +67,12 @@ en:
         styled: Styled Output
         verbatim: Verbatim Output
       form:
-        search_field:
+        url:
           label: URL
-          placeholder: Please enter fully quallified url here, e.g. "http://www.example.org"...
+          placeholder: "http://www.example.org"
+        time:
+          label: Time
+          placeholder: "2014-01-01 12:00:00"
+        client_ip:
+          label: Client IP Address
+          placeholder: "127.0.0.1"

data/app/views/application.haml

@@ -3,8 +3,19 @@
   %head
     %meta{:charset => "utf-8"}
     %link{ rel: 'stylesheet', href: stylesheet_path('application.css') }
-    %script{ type: 'text/javascript', src: javascript_path('application.js') }
     %title= t('views.application.title')
   %body
+    .lp_page_header
+      %nav.lp_top_navigation
+        %ul.nav.navbar-nav
+          %li
+            %a{href: '/'}
+              = t('views.root.link')
+          %li.active
+            %a{href: '/v1/lookup/'}
+              = t('views.lookup.link')
     .lp_container
       = yield
+    .lp_page_footer
+      %nav.lp_bottom_navigation
+    %script{ type: 'text/javascript', src: javascript_path('application.js') }

data/app/views/form.haml

@@ -1,11 +1,29 @@
 %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_search_group
+    .lp_form_group
+      %label{for: 'url'} 
+        = t('views.lookup_result.form.url.label')
+      %input#url.lp_field_url{name: 'url', placeholder: t('views.lookup_result.form.url.placeholder'), autofocus: true, value: @uri, 'data-toggle' => 'tooltip', 'data-placement' => 'left', title: 'Please enter a valid url here.' }
+
+    %a.lp_show_fields{ href: '#' }
+      %span.lp_button_show_fields_open
+      %span.lp_button_show_fields_close
+      = t('views.application.buttons.more')
     .lp_buttons
       %button.lp_button_search{type: 'submit', value: t('views.application.buttons.search')}
         = t('views.application.buttons.search')
       %a#reset.lp_button_reset{href: '#'}
         = t('views.application.buttons.reset')
+    .lp_fields_close
+    .lp_fields_open
+      .lp_form_group
+        %label{for: 'name'} 
+          = t('views.lookup_result.form.client_ip.label')
+        %input#client_ip.lp_field_client_ip{name: 'client_ip', placeholder: t('views.lookup_result.form.client_ip.placeholder'), value: @client_ip, 'data-toggle' => 'tooltip', 'data-placement' => 'left', title: 'Please enter a valid ip address here.' }
+      .form-group
+        %label{for: 'time'} 
+          = t('views.lookup_result.form.time.label')
+        #datetimepicker.input-group.date.lp_time_group
+          %input#time.lp_field_time{name: 'time', placeholder: t('views.lookup_result.form.time.placeholder'), value: @time, 'data-format' => 'YYYY-MM-DD HH:mm:ss', 'data-toggle' => 'tooltip', 'data-placement' => 'left', title: 'Please enter a valid point in time here.' }
+          %span.input-group-addon
+            %span.lp_button_datetimepicker

data/bin/local_pac

@@ -3,7 +3,6 @@
 $LOAD_PATH << ::File.expand_path('../../lib', __FILE__)
 require 'local_pac'
 
-
 begin
   LocalPac::Cli::Main.start
 rescue StandardError => e

data/bower.json

@@ -0,0 +1,9 @@
+{
+  "name": "local_pac",
+  "dependencies": {
+    "bootstrap-sass": "~3.0.2",
+    "jquery": "~2.1.0",
+    "moment": "~2.5.1",
+    "eonasdan-bootstrap-datetimepicker": "latest"
+  }
+}

data/lib/local_pac/actions/create_file.rb

@@ -44,7 +44,7 @@ module LocalPac
 
         local_destination
       rescue Errno::ENOENT
-        fail Exceptions::ErbTemplateIsUnknown, "Unknown erb template \"#{template_path}\"."
+        fail Exceptions::ErbTemplateIsUnknown, JSON.dump(message: "Unknown erb template \"#{template_path}\".")
       end
 
       def need_to_run?

data/lib/local_pac/actions/create_output.rb

@@ -29,7 +29,7 @@ module LocalPac
         generator = engine.new(local_data)
         generator.compile(template, local_destination)
       rescue Errno::ENOENT
-        fail Exceptions::ErbTemplateIsUnknown, "Unknown erb template \"#{template_path}\"."
+        fail Exceptions::ErbTemplateIsUnknown, JSON.dump(message: "Unknown erb template \"#{template_path}\".")
       end
     end
   end

data/lib/local_pac/actions/handle_error.rb

@@ -19,7 +19,18 @@ module LocalPac
         handler = handler_klass.find exception
         handler.original_message = original_message
 
-        handler.run
+        handler.execute(parsed_message)
+      end
+
+      private
+
+      def parsed_message
+        result = JSON.parse(original_message)
+        return {} unless result.kind_of? Hash
+
+        result
+      rescue JSON::ParserError
+        {}
       end
     end
   end

data/lib/local_pac/config.rb

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

data/lib/local_pac/error_handler.rb

@@ -11,7 +11,7 @@ module LocalPac
 
     private
 
-    attr_reader :message, :exit_code
+    attr_reader :details_i18n, :summary_i18n, :exit_code
 
     public
 
@@ -19,9 +19,10 @@ module LocalPac
     attr_accessor :original_message
 
     def initialize(options = {})
-      @exception = options.fetch(:exception)
-      @message   = options.fetch(:message)
-      @exit_code = options.fetch(:exit_code)
+      @exception    = options.fetch(:exception)
+      @details_i18n = options.fetch(:details)
+      @summary_i18n = options.fetch(:summary)
+      @exit_code    = options.fetch(:exit_code)
     rescue KeyError => e
       raise ArgumentError, e.message
     end
@@ -44,17 +45,63 @@ module LocalPac
         mutex.synchronize do
           @default_handler ||= new(
             exception: StandardError,
-            message: 'Sorry, but I cannot fullfil your request. An unexpected error occured.',
+            details: 'errors.default.details',
+            summary: 'errors.default.summary',
             exit_code: 99,
           )
         end
       end
     end
 
-    def run
-      LocalPac.ui_logger.fatal message
+    def details(format = :plain)
+      case format
+      when :plain
+        @details
+      when :html
+        Rack::Utils.escape_html(@details)
+      else
+        @details
+      end
+    end
+
+    def summary(format = :plain)
+      case format
+      when :plain
+        @summary
+      when :html
+        Rack::Utils.escape_html(@summary)
+      else
+        @summary
+      end
+    end
+
+    def use(data)
+      data = JSON.parse(data).symbolize_keys if data.kind_of? String
+
+      @details = I18n.t(details_i18n, data)
+      @summary = I18n.t(summary_i18n, data)
+    end
+
+    def execute(data = {})
+      use(data)
+
+      LocalPac.ui_logger.fatal details
       LocalPac.ui_logger.debug original_message if original_message
       Kernel.exit exit_code
     end
+
+    def to_json
+      ErrorHandler.mutex.synchronize do
+        @details ||= I18n.t(details_i18n)
+        @summary ||= I18n.t(summary_i18n)
+      end
+
+      JSON.dump(
+          error_summary: summary,
+          error_details: details,
+          result: :failure,
+      )
+    end
+
   end
 end

data/lib/local_pac/error_messages.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+module LocalPac
+  module ErrorMessages
+
+    ErrorHandler.create(
+      exception: StandardError,
+      summary: 'errors.default.summary',
+      details: 'errors.default.details',
+      exit_code: 99,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::ApiKeyInvalid,
+      details: 'errors.invalid_api_key.details',
+      summary: 'errors.invalid_api_key.summary',
+      exit_code: 2,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::PacFileInvalid,
+      details: 'errors.invalid_pushed_pac_file.details',
+      summary: 'errors.invalid_pushed_pac_file.summary',
+      exit_code: 3,
+    )
+
+    ErrorHandler.create(
+      exception: Sinatra::Param::InvalidParameterError,
+      details: 'errors.invalid_parameter.details',
+      summary: 'errors.invalid_parameter.summary',
+      exit_code: 4,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::PidFileDoesNotExist,
+      details: 'errors.invalid_proxy_pac.details',
+      summary: 'errors.invalid_proxy_pac.summary',
+      exit_code: 5,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::GivenUrlInvalid,
+      details: 'errors.invalid_url.details',
+      summary: 'errors.invalid_url.summary',
+      exit_code: 6,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::ReloadOfLocalStorageFailed,
+      details: 'errors.reload_of_local_storage_failed.details',
+      summary: 'errors.reload_of_local_storage_failed.summary',
+      exit_code: 7,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::GitHookUnknown,
+      details: 'errors.unknown_git_hook.details',
+      summary: 'errors.unknown_git_hook.summary',
+      exit_code: 8,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::PacFileUnknown,
+      details: 'errors.unknown_proxy_pac.details',
+      summary: 'errors.unknown_proxy_pac.summary',
+      exit_code: 9,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::InternalError,
+      details: 'errors.internal_error.details',
+      summary: 'errors.internal_error.summary',
+      exit_code: 10,
+    )
+    
+    ErrorHandler.create(
+      exception: Exceptions::ServerListenStatementInvalid,
+      details: 'errors.invalid_listen_statement.details',
+      summary: 'errors.invalid_listen_statement.summary',
+      exit_code: 11,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::RepositoryDoesNotExist,
+      details: 'errors.missing_git_repository.details',
+      summary: 'errors.missing_git_repository.summary',
+      exit_code: 12,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::CommitDoesNotExist,
+      details: 'errors.missing_git_commit.details',
+      summary: 'errors.missing_git_commit.summary',
+      exit_code: 13,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::ConfigFileNotReadable,
+      details: 'errors.unreadable_config_file.details',
+      summary: 'errors.unreadable_config_file.summary',
+      exit_code: 14,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::UserError,
+      details: 'errors.user_error.details',
+      summary: 'errors.user_error.summary',
+      exit_code: 15,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::GivenTimeInvalid,
+      details: 'errors.invalid_time.details',
+      summary: 'errors.invalid_time.summary',
+      exit_code: 16,
+    )
+
+    ErrorHandler.create(
+      exception: Exceptions::GivenClientIpInvalid,
+      details: 'errors.invalid_client_ip.details',
+      summary: 'errors.invalid_client_ip.summary',
+      exit_code: 17,
+    )
+
+    #ErrorHandler.create(
+    #  exception:
+    #  summary:
+    #  details:
+    #  exit_code:
+    #)
+
+  end
+end

data/lib/local_pac/exceptions.rb

@@ -1,39 +1,60 @@
 module LocalPac
   module Exceptions
+    # raised if an internal error occured
+    class InternalError < StandardError; end
+
+    # raised if an error is occured which should be visible by the user
+    class UserError < StandardError; end
+
     # raise if there are template syntax errrors
-    class ErbTemplateHasSyntaxErrors < StandardError; end
+    class ErbTemplateHasSyntaxErrors < InternalError; end
 
     # raised if Template does not exist
-    class ErbTemplateIsUnknown < StandardError; end
+    class ErbTemplateIsUnknown < InternalError; end
 
     # raised if Template does not exist
-    class ConfigFileNotReadable < StandardError; end
+    class ConfigFileNotReadable < UserError; end
 
     # raised if listen statement is invalid
-    class ServerListenStatementInvalid < StandardError; end
+    class ServerListenStatementInvalid < UserError; end
 
     # raised if reload of local storage failed
-    class ReloadOfLocalStorageFailed < StandardError; end
+    class ReloadOfLocalStorageFailed < UserError; end
 
     # raised if entered url is invalid
-    class URLToSearchForInvalid < StandardError; end
+    class URLToSearchForInvalid < UserError; end
+
+    # raised if git hook cannot be found
+    class GitHookUnknown < UserError; end
+
+    # raised if pac file cannot be found
+    class PacFileUnknown < UserError; end
 
     # raised if pac file is invalid
-    class PacFileInvalid < StandardError; end
+    class PacFileInvalid < UserError; end
 
     # raised if api key is invalid
-    class ApiKeyInvalid < StandardError; end
+    class ApiKeyInvalid < UserError; end
 
     # raised if request is invalid
-    class GivenUrlInvalid < StandardError; end
+    class GivenUrlInvalid < UserError; end
+
+    # raised if request is invalid
+    class GivenTimeInvalid < UserError; end
+
+    # raised if request is invalid
+    class GivenClientIpInvalid < UserError; end
 
     # raised if pid file does not exist
-    class PidFileDoesNotExist < StandardError; end
+    class PidFileDoesNotExist < UserError; end
 
     # raised if repository does not exist
-    class RepositoryDoesNotExist < StandardError; end
+    class RepositoryDoesNotExist < UserError; end
 
     # raised if commit does not exist
-    class CommitDoesNotExist < StandardError; end
+    class CommitDoesNotExist < InternalError; end
+
+    # raised if variable cannot be looked up
+    class VariableUnknown < InternalError; end
   end
 end

data/lib/local_pac/main.rb

@@ -18,5 +18,16 @@ module LocalPac
     def error_id
       SecureRandom.hex
     end
+
+    def root_path
+      ::File.expand_path('../../..', __FILE__)
+    end
   end
+
+  I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+  I18n.load_path = Dir[::File.join(LocalPac.root_path, 'app', 'locales', '*.yml')]
+  I18n.backend.load_translations
+
+  I18n.enforce_available_locales = true
 end
+

data/lib/local_pac/pac_file_validator.rb

@@ -1,6 +1,15 @@
 # encoding: utf-8
 module LocalPac
   class PacFileValidator
+    private
+
+    attr_reader :pac_engine
+
+    public
+
+    def initialize(pac_engine = ProxyPacRb::Parser)
+      @pac_engine = pac_engine
+    end
 
     def valid?(file)
       validate(file)
@@ -21,7 +30,7 @@ module LocalPac
     private
 
     def validate(file)
-      pac = PAC.source(file.content) 
+      pac = pac_engine.new.source(file.content) 
       pac.find('http://www.example.com')
     end
   end

data/lib/local_pac/proxy_pac/pac_engine.rb

@@ -4,21 +4,24 @@ module LocalPac
     class PACEngine
       private
 
-      attr_reader :engine, :file
+      attr_reader :engine, :file, :environment, :environment_engine
 
       public
 
       def initialize(options = {})
-        @file = options.fetch(:file)
-        @engine = PAC
+        @file        = options.fetch(:file)
+        @environment = options.fetch(:environment, {})
+
+        @engine             = ProxyPacRb::Parser
+        @environment_engine = ProxyPacRb::Environment
       rescue KeyError
-        fail ArgumentError, ":file-option is missing"
+        fail ArgumentError, ":file-argument is missing"
       end
 
       def find(uri)
-        e = engine.source(file.content)
+        e = engine.new(environment_engine.new(environment)).source(file.content)
         e.find(uri)
-      rescue V8::Error, PAC::ProgramError => err
+      rescue V8::Error, ProxyPacRb::Exceptions::ProgramError => err
         error_id = LocalPac.error_id
         LocalPac.ui_logger.fatal "Error id \"#{error_id}\": An V8::Error occured. This can happen if compiling a proxy.pac fails. The V8::Error-message was: #{err.message}."
         fail Exceptions::PacFileInvalid, error_id 

data/lib/local_pac/proxy_pac/pac_parser.rb

@@ -10,8 +10,10 @@ module LocalPac
       public
 
       def initialize(options = {})
+        environment       = options.fetch(:environment, {})
+
         @file             = options.fetch(:file)
-        @engine           = options.fetch(:engine, PACEngine.new(file: @file))
+        @engine           = options.fetch(:engine, PACEngine.new(file: @file, environment: environment))
         @result_generator = options.fetch(:result_generator, PacResult)
         @stylist          = options.fetch(:stylist, PacResultHtmlStylist.new)
       rescue KeyError => e

data/lib/local_pac/version.rb

@@ -1,4 +1,4 @@
 #main LocalPac
 module LocalPac
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end