proxy_pac_rb 0.0.3 → 0.2.0

data/README.md

@@ -44,35 +44,78 @@ parsepac https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample.pac
 
 ### Ruby
 
-*Simple*
+*Load from website*
 
 ```ruby
-require "rubygems"
-require "pac"
+require 'proxy_pac_rb'
 
-pac = PAC.load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample.pac')
-pac.find('https://github.com')        # => "PROXY proxy:8080"
-pac.find('http://ruby-lang.com')      # => "PROXY proxy:8080; DIRECT"
-pac.find('http://samuel.kadolph.com') # => "DIRECT"
+file = ProxyPacRb::Parser.new.load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample.pac')
+file.find('https://github.com')        # => "DIRECT"
+```
+
+*Load from filesystem*
+
+```bash
+curl -L -o sample.pac https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample.pac
+```
+
+```ruby
+require 'proxy_pac_rb'
 
-pac = PAC.read("sample.pac")
+file = ProxyPacRb::Parser.new.read("sample.pac")
+file.find('https://github.com')        # => "DIRECT"
+```
+
+*Use string*
+
+```ruby
+require 'proxy_pac_rb'
 
-pac = PAC.source <<-JS
+file = ProxyPacRb::Parser.new.source <<-JS
   function FindProxyForURL(url, host) {
     return "DIRECT";
   }
 JS
-pac.find('http://localhost') # => "DIRECT"
+
+file.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"
+
+```ruby
+require 'proxy_pac_rb'
+
+environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.1')
+file = ProxyPacRb::Parser.new(environment).load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample2.pac')
+file.find('https://github.com')        # => "PROXY localhost:8080"
+
+environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.2')
+file = ProxyPacRb::Parser.new(environment).load('https://github.com/dg-vrnetze/proxy_pac_rb/raw/master/files/sample2.pac')
+file.find('https://github.com')        # => "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"
+
+```ruby
+require 'proxy_pac_rb'
+
+string = <<-EOS
+function FindProxyForURL(url, host) {
+  if (dateRange("JUL", "SEP")) {
+    return "PROXY localhost:8080";                                                                                                          
+  } else {
+    return "DIRECT";
+  }
+}
+EOS
+
+environment = ProxyPacRb::Environment.new(time: Time.parse('2014-07-06 12:00'))
+file = ProxyPacRb::Parser.new(environment).source(string)
+file.find('http://localhost') # => 'PROXY localhost:8080'
+
+environment = ProxyPacRb::Environment.new(time: Time.parse('2014-03-08 6:00'))
+file = ProxyPacRb::Parser.new(environment).source(string)
+file.find('http://localhost') # => 'DIRECT'
 ```
 
 ## Available JavaScript Functions
@@ -89,6 +132,7 @@ pac.find('https://github.com', time: '2014-01-02 19:00:00')   # => "DIRECT"
 * weekdayRange(wd1, wd2, gmt)
 * dateRange(*args)
 * timeRange(*args)
+* alert(msg) (output on stderr by default)
 
 ## Developers
 

data/bin/parsepac

@@ -1,10 +1,110 @@
 #!/usr/bin/env ruby
 
-if ARGV.size < 2
-  puts "usage: parsepac pac-url-or-file url-to-test"
-  exit 1
-else
-  require "pac"
-  puts PAC.load(ARGV.shift).find(ARGV.shift)
-  exit 0
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'proxy_pac_rb'
+require 'ostruct'
+require 'ipaddr'
+require 'optparse'
+
+module ProxyPacRb
+  class Cli
+
+    class Validator
+      private
+
+      attr_reader :options
+
+      public
+
+      def initialize(options)
+        @options = options
+      end
+
+      def validate
+        exit_with_message 'You need to provide at least one url. Multiple urls need to be separated by a space.' if empty_url? 
+        exit_with_message 'You need to provide a proxy pac file.' if empty_pac_file? 
+      end
+
+      private
+
+      def empty_url?
+        options.urls.empty?
+      end
+
+      def empty_pac_file?
+        options.proxy_pac_file.nil?
+      end
+
+      def exit_with_message(msg)
+        $stderr.puts msg
+        exit 1
+      end
+      
+    end
+
+    attr_accessor :options
+
+    def self.start(argv = $*)
+      cli = new
+      cli.parse(argv)
+
+      Validator.new(cli.options).validate
+
+      environment = ProxyPacRb::Environment.new(client_ip: cli.options.client_ip, time: cli.options.time)
+      file = ProxyPacRb::Parser.new(environment).read(cli.options.proxy_pac_file)
+
+      $stderr.printf("%30s: %-s\n", 'url', 'result')
+      cli.options.urls.each do |u| 
+        begin
+          $stderr.printf("%30s: %-s\n", u, file.find(u))
+        rescue Exceptions::UrlInvalid
+          $stderr.puts "You provide an invalid url \"#{u}\". Please use a correct one."
+        end
+      end
+    end
+
+    def initialize
+      @options = OpenStruct.new
+
+      @options.client_ip = IPAddr.new('127.0.0.1')
+      @options.time      = Time.now
+    end
+
+    def parse(argv)
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: parsepac [options] url1 [url2..urln]"
+
+        opts.on('-c', '--client-ip IP', 'Client ip address') do |i|
+          options.client_ip = IPAddr.new(i)
+        end
+
+        opts.on('-t', '--time YYYY-MM-DD HH:MM:SS', 'Time to use during lookup url') do |t|
+          options.time = Time.parse(t)
+        end
+
+        opts.on('-p', '--proxy-pac FILE', 'Proxy.pac-file') do |f|
+          options.proxy_pac_file = ::File.expand_path(::File.join(Dir.getwd, f))
+        end
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          $stderr.puts opts
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          $stderr.puts ProxyPacRb::VERSION
+          exit
+        end
+      end
+
+      $stderr.puts parser.help if argv.empty?
+
+      parser.parse!(argv)
+      options.urls = argv
+    end
+  end
 end
+
+ProxyPacRb::Cli.start
+exit 0

data/lib/proxy_pac_rb/environment.rb

@@ -4,7 +4,7 @@ module ProxyPacRb
 
     private
 
-    attr_reader :days, :months, :my_ip_address, :time, :io, :javascript_function_templates
+    attr_reader :days, :months, :client_ip, :time, :io, :javascript_function_templates
 
     public
 
@@ -14,7 +14,7 @@ module ProxyPacRb
       @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')
+      @client_ip = options.fetch(:client_ip, '127.0.0.1')
       @time          = options.fetch(:time, Time.now)
       @io            = options.fetch(:io, $stderr)
 
@@ -66,7 +66,7 @@ module ProxyPacRb
     end
 
     def MyIpAddress 
-      IPAddr.new(my_ip_address).to_s
+      IPAddr.new(client_ip).to_s
     end
 
     def dnsDomainLevels(host)
@@ -180,9 +180,9 @@ module ProxyPacRb
     public
 
     def prepare(string)
-      if my_ip_address
+      if client_ip
         string << "\n\n"
-        string << javascript_function_templates.my_ip_address_template(my_ip_address)
+        string << javascript_function_templates.my_ip_address_template(client_ip)
       end
 
       if time

data/lib/proxy_pac_rb/exceptions.rb

@@ -9,5 +9,8 @@ module ProxyPacRb
 
     #raise on invalid argument
     class InvalidArgument < StandardError; end
+
+    #raise on invalid argument
+    class UrlInvalid < StandardError; end
   end
 end

data/lib/proxy_pac_rb/file.rb

@@ -13,7 +13,7 @@ module ProxyPacRb
 
     def find(url)
       uri = Addressable::URI.heuristic_parse(url)
-      fail ArgumentError, "url is missing host" unless uri.host
+      fail Exceptions::UrlInvalid, "url is missing host" unless uri.host
 
       javascript.call("FindProxyForURL", url, uri.host)
     end

data/lib/proxy_pac_rb/version.rb

@@ -1,4 +1,4 @@
 #main ProxyPacRb
 module ProxyPacRb
-  VERSION = '0.0.3'
+  VERSION = '0.2.0'
 end

data/spec/environment_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe ProxyPacRb::Environment do
   let(:environment) do
-    Environment.new(my_ip_address: '127.0.0.1', time: Time.now)
+    Environment.new(client_ip: '127.0.0.1', time: Time.now)
   end
 
   describe "#isResolvable()" do
@@ -80,7 +80,7 @@ describe ProxyPacRb::Environment do
   describe '#MyIpAddress ' do
     it 'returns the given ip address' do
       ip = '127.0.0.1'
-      environment = Environment.new(my_ip_address: ip, time: Time.now)
+      environment = Environment.new(client_ip: ip, time: Time.now)
 
       expect(environment.MyIpAddress).to eq(ip)
     end
@@ -106,7 +106,7 @@ describe ProxyPacRb::Environment do
   end
 
   describe '#weekdayRange' do
-    let(:environment) { Environment.new(my_ip_address: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
+    let(:environment) { Environment.new(client_ip: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
 
     it 'returns true for SUN - MON' do
       result = environment.weekdayRange("SUN", "MON")
@@ -127,7 +127,7 @@ describe ProxyPacRb::Environment do
   end
 
   describe '#dateRange' do
-    let(:environment) { Environment.new(my_ip_address: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
+    let(:environment) { Environment.new(client_ip: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
 
     it 'returns true for JUL - SEP' do
       result = environment.dateRange("JUL", "SEP")
@@ -147,7 +147,7 @@ describe ProxyPacRb::Environment do
   end
 
   describe '#timeRange' do
-    let(:environment) { Environment.new(my_ip_address: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
+    let(:environment) { Environment.new(client_ip: '127.0.0.1', time: Time.parse('1991-08-25 12:00')) }
 
     it 'returns true for 8 - 18h' do
       result = environment.timeRange(8, 18)

data/spec/parser_spec.rb

@@ -43,11 +43,11 @@ describe ProxyPacRb::Parser do
       }
       EOS
 
-      environment = ProxyPacRb::Environment.new(my_ip_address: '127.0.0.1')
+      environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.1')
       file = ProxyPacRb::Parser.new(environment).source(string)
       expect(file.find('http://localhost')).to eq('PROXY localhost:8080')
 
-      environment = ProxyPacRb::Environment.new(my_ip_address: '127.0.0.2')
+      environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.2')
       file = ProxyPacRb::Parser.new(environment).source(string)
       expect(file.find('http://localhost')).to eq('DIRECT')
     end

data/tmp/script.rb

@@ -5,18 +5,20 @@ require 'proxy_pac_rb'
 
 string = <<-EOS
 function FindProxyForURL(url, host) {
-  if (weekdayRange("FRI", "SUN")) {
-    return "PROXY localhost:8080";                                                                                                          
-  } else {
+  if ( MyIpAddress() == '127.0.0.2' ) {
     return "DIRECT";
+  } else {
+    return "PROXY localhost:8080";
   }
 }
 EOS
 
-environment = ProxyPacRb::Environment.new(time: Time.parse('2014-03-06 12:00'))
+environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.1')
 file = ProxyPacRb::Parser.new(environment).source(string)
-puts file.find('http://localhost')
+puts(file.find('http://localhost'))
 
-environment = ProxyPacRb::Environment.new(time: Time.parse('2014-03-08 6:00'))
+environment = ProxyPacRb::Environment.new(client_ip: '127.0.0.2')
 file = ProxyPacRb::Parser.new(environment).source(string)
-puts file.find('http://localhost')
+puts(file.find('http://localhost'))
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proxy_pac_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable