proxy_pac_rb 0.0.2 → 0.0.3

data/.rdebugrc

@@ -0,0 +1,7 @@
+set listsize 30
+set history save on
+set history size 99999
+set history filename ~/.rdebug_history
+set autolist
+set autoeval
+set autoreload

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--order rand
+--color

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  add_filter "/features/"
+  add_filter "/spec/"
+  add_filter "/tmp"
+  add_filter "/vendor"
+  
+  add_group "lib", "lib"
+end

data/.yardopts

@@ -0,0 +1,5 @@
+-o doc/yard
+--verbose
+-
+LICENSE.md
+README.md

data/README.md

@@ -44,6 +44,8 @@ parsepac https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample.pac
 
 ### Ruby
 
+*Simple*
+
 ```ruby
 require "rubygems"
 require "pac"
@@ -61,6 +63,16 @@ pac = PAC.source <<-JS
   }
 JS
 pac.find('http://localhost') # => "DIRECT"
+
+*Use Client IP*
+pac = PAC.load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample2.pac')
+pac.find('https://github.com', client_ip: '127.0.0.1')        # => "PROXY localhost:8080"
+pac.find('https://github.com', client_ip: '127.0.0.2')        # => "DIRECT"
+
+*Use Date Time*
+pac = PAC.load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample2.pac')
+pac.find('https://github.com', time: '2014-01-02 08:00:00')   # => "PROXY localhost:8080"
+pac.find('https://github.com', time: '2014-01-02 19:00:00')   # => "DIRECT"
 ```
 
 ## Available JavaScript Functions

data/files/sample2.pac

@@ -0,0 +1,7 @@
+function FindProxyForURL(url, host) {
+  if ( MyIpAddress() == '127.0.0.2' ) {
+    return "DIRECT";
+  } else {
+    return "PROXY localhost:8080";
+  }
+}

data/files/sample3.pac

@@ -0,0 +1,7 @@
+function FindProxyForURL(url, host) {
+  if ( timeRange(8, 18) ) {
+    return "PROXY localhost:8080";
+  } else {
+    return "DIRECT";
+  }
+}

data/lib/proxy_pac_rb.rb

@@ -1,38 +1,18 @@
-require 'uri'
+require 'addressable/uri'
 require 'ipaddr'
 require 'resolv'
 require 'time'
+require 'open-uri'
+require 'active_support/core_ext/string/strip'
 
 require 'proxy_pac_rb/version'
+require 'proxy_pac_rb/encoding'
 require 'proxy_pac_rb/exceptions'
-require 'proxy_pac_rb/functions'
 require 'proxy_pac_rb/file'
+require 'proxy_pac_rb/environment'
+require 'proxy_pac_rb/runtime'
 require 'proxy_pac_rb/runtimes/rubyracer'
 require 'proxy_pac_rb/runtimes/rubyrhino'
 require 'proxy_pac_rb/runtimes'
-
-module ProxyPacRb
-  class << self
-    attr_reader :runtime
-
-    def runtime=(runtime)
-      fail Exceptions::RuntimeUnavailable, "#{runtime.name} is unavailable on this system" unless runtime.available?
-      @runtime = runtime
-    end
-
-    def load(url, options = {})
-      require "open-uri"
-      File.new(open(url, { :proxy => false }.merge(options)).read)
-    end
-
-    def read(file)
-      File.new(::File.read(file))
-    end
-
-    def source(source)
-      File.new(source)
-    end
-  end
-
-  self.runtime = Runtimes.autodetect
-end
+require 'proxy_pac_rb/parser'
+require 'proxy_pac_rb/proxy_pac_js'

data/lib/proxy_pac_rb/encoding.rb

@@ -0,0 +1,33 @@
+module ProxyPacRb
+  # Encodes strings as UTF-8
+  module Encoding
+    if "".respond_to?(:encode)
+      if RUBY_ENGINE == 'jruby' || RUBY_ENGINE == 'rbx'
+        # workaround for jruby bug http://jira.codehaus.org/browse/JRUBY-6588
+        # workaround for rbx bug https://github.com/rubinius/rubinius/issues/1729
+        def encode(string)
+          if string.encoding.name == 'ASCII-8BIT'
+            data = string.dup
+            data.force_encoding('UTF-8')
+
+            unless data.valid_encoding?
+              fail ::Encoding::UndefinedConversionError, "Could not encode ASCII-8BIT data #{string.dump} as UTF-8"
+            end
+          else
+            data = string.encode('UTF-8')
+          end
+          data
+        end
+      else
+        def encode(string)
+          string.encode('UTF-8')
+        end
+      end
+    else
+      # Define no-op on 1.8
+      def encode(string)
+        string
+      end
+    end
+  end
+end

data/lib/proxy_pac_rb/environment.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+module ProxyPacRb
+  class Environment
+
+    private
+
+    attr_reader :days, :months, :my_ip_address, :time, :io, :javascript_function_templates
+
+    public
+
+    attr_reader :available_methods
+
+    def initialize(options = {})
+      @days          = { "MON" => 1, "TUE" => 2, "WED" => 3, "THU" => 4, "FRI" => 5, "SAT" => 6, "SUN" => 0 }
+      @months        = { "JAN" => 1, "FEB" => 2, "MAR" => 3, "APR" => 4, "MAY" => 5, "JUN" => 6, "JUL" => 7, "AUG" => 8, "SEP" => 9, "OCT" => 10, "NOV" => 11, "DEC" => 12 }
+
+      @my_ip_address = options.fetch(:my_ip_address, '127.0.0.1')
+      @time          = options.fetch(:time, Time.now)
+      @io            = options.fetch(:io, $stderr)
+
+      @javascript_function_templates = ProxyPacJs
+
+      @available_methods = [
+        :alert,
+        :isPlainHostName,
+        :dnsDomainIs,
+        :localHostOrDomainIs,
+        :isResolvable,
+        :isInNet,
+        :dnsResolve,
+#        :MyIpAddress ,
+        :dnsDomainLevels,
+        :shExpMatch,
+#        :weekdayRange,
+#        :dateRange,
+#        :timeRange,
+      ]
+    end
+
+    def alert(msg)
+      io.puts msg
+    end
+
+    def isPlainHostName(host)
+      not host.include? "."
+    end
+
+    def dnsDomainIs(host, domain)
+      host.end_with? domain
+    end
+
+    def localHostOrDomainIs(host, hostdom)
+      host == hostdom or hostdom.include? host
+    end
+
+    def isResolvable(host)
+      !!resolve_host(host)
+    end
+
+    def isInNet(host, pattern, mask)
+      IPAddr.new(pattern).mask(mask).include? resolve_host(host)
+    end
+
+    def dnsResolve(host)
+      resolve_host(host)
+    end
+
+    def MyIpAddress 
+      IPAddr.new(my_ip_address).to_s
+    end
+
+    def dnsDomainLevels(host)
+      host.scan(".").size
+    end
+
+    def shExpMatch(str, shexp)
+      ::File.fnmatch(shexp, str)
+    end
+
+    def weekdayRange(wd1, wd2 = nil, gmt = nil)
+      fail Exceptions::InvalidArgument, "wd1 needs to be one of #{days.keys.collect {|k| "\"#{k}\""}.join(', ')}" unless days.key?(wd1)
+      fail Exceptions::InvalidArgument, "wd2 needs to be one of #{days.keys.collect {|k| "\"#{k}\""}.join(', ')}" if wd2 and !days.key?(wd2)
+
+      if gmt == "GMT"
+        local_time = time.utc 
+      else
+        local_time = time
+      end
+
+      (days[wd1]..days[wd2 || wd1]).include? local_time.wday
+    end
+
+    def dateRange(*args)
+      fail Exceptions::InvalidArgument, "range needs to be one of #{months.keys.collect {|k| "\"#{k}\""}.join(', ')}" if args.any? { |a| !months.key?(a)  }
+
+      if args.last == "GMT" and args.pop
+        local_time = time.utc 
+      else
+        local_time = time
+      end
+
+      case args.size
+      when 1
+        check_date_part(local_time, args[0])
+      when 2
+        check_date_part(local_time, args[0]..args[1])
+      when 4
+        check_date_part(local_time, args[0]..args[2]) and
+          check_date_part(local_time, args[1]..args[3])
+      when 6
+        check_date_part(local_time, args[0]..args[3]) and
+          check_date_part(local_time, args[1]..args[4]) and
+          check_date_part(local_time, args[2]..args[5])
+      else
+        fail ArgumentError, "wrong number of arguments"
+      end
+    end
+
+    def timeRange(*args)
+      fail Exceptions::InvalidArgument, "args need to be integer values" if args.any? { |a| !a.kind_of? Fixnum }
+
+      if args.last == "GMT" and args.pop
+        local_time = time.utc 
+      else
+        local_time = time
+      end
+
+      case args.size
+      when 1
+        local_time.hour == args[0]
+      when 2
+        (args[0]..args[1]).include? local_time.hour
+      when 4
+        (args[0]..args[2]).include? local_time.hour and
+          (args[1]..args[3]).include? local_time.min
+      when 6
+        (args[0]..args[3]).include? local_time.hour and
+          (args[1]..args[4]).include? local_time.min  and
+          (args[2]..args[5]).include? local_time.sec
+      else
+        fail ArgumentError, "wrong number of arguments"
+      end
+    end
+
+    private
+
+    def check_date_part(time, part, operation = :==)
+      case part
+      when String
+        time.month.send(operation, months[part])
+      when Integer
+        if part < 100
+          time.day.send(operation, part)
+        else
+          time.year.send(operation, part)
+        end
+      when Range
+        check_date_part(time, part.begin, :>=) and check_date_part(time, part.end, :<=)
+      else
+        fail ArgumentError, "wrong type"
+      end
+    end
+
+    def resolve_host(host)
+      Resolv.each_address(host) do |address|
+        begin
+          return address if IPAddr.new(address).ipv4?
+        rescue ArgumentError
+        end
+      end
+
+      # We couldn't find an IPv4 address for the host
+      nil
+    rescue Resolv::ResolvError, NoMethodError
+      # Have to rescue NoMethodError because jruby has a bug with non existant hostnames
+      # See http://jira.codehaus.org/browse/JRUBY-6054
+      nil
+    end
+
+    public
+
+    def prepare(string)
+      if my_ip_address
+        string << "\n\n"
+        string << javascript_function_templates.my_ip_address_template(my_ip_address)
+      end
+
+      if time
+        string << javascript_function_templates.time_variables
+        string << "\n\n"
+        string << javascript_function_templates.week_day_range_template(time)
+        string << "\n\n"
+        string << javascript_function_templates.week_day_range_template(time)
+        string << "\n\n"
+        string << javascript_function_templates.date_range_template(time)
+        string << "\n\n"
+        string << javascript_function_templates.time_range_template(time)
+      end
+
+      string
+    end
+  end
+end

data/lib/proxy_pac_rb/exceptions.rb

@@ -6,5 +6,8 @@ module ProxyPacRb
 
     #raise on java script runtime error
     class RuntimeUnavailable < StandardError; end
+
+    #raise on invalid argument
+    class InvalidArgument < StandardError; end
   end
 end

data/lib/proxy_pac_rb/file.rb

@@ -1,17 +1,21 @@
 module ProxyPacRb
   class File
-    attr_reader :source, :context
 
-    def initialize(source)
-      @source = source.dup.freeze
-      @context = ProxyPacRb.runtime.compile(@source)
-      @context.include Functions
+    private
+
+    attr_reader :javascript
+
+    public
+
+    def initialize(javascript)
+      @javascript  = javascript
     end
 
     def find(url)
-      uri = URI.parse(url)
+      uri = Addressable::URI.heuristic_parse(url)
       fail ArgumentError, "url is missing host" unless uri.host
-      context.call("FindProxyForURL", url, uri.host)
+
+      javascript.call("FindProxyForURL", url, uri.host)
     end
   end
 end

data/lib/proxy_pac_rb/parser.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module ProxyPacRb
+  class Parser
+
+    private
+
+    attr_reader :runtime, :environment
+
+    public
+
+    def initialize(environment = Environment.new, runtime = Runtimes.autodetect)
+      fail Exceptions::RuntimeUnavailable, "#{runtime.name} is unavailable on this system" unless runtime.available?
+
+      @runtime     = runtime
+      @environment = environment
+    end
+
+    def load(url, options = {})
+      create_file(open(url, { :proxy => false }.merge(options)).read)
+    end
+
+    def read(file)
+      create_file(::File.read(file))
+    end
+
+    def source(source)
+      create_file(source)
+    end
+
+    private
+
+    def compile_javascript(source)
+      environment.prepare(source)
+
+      context = runtime.compile(source)
+      context.include environment
+
+      context
+    end
+
+    def create_file(source)
+      File.new(compile_javascript(source))
+    end
+  end
+end