proxy_pac_rb 0.4.2 → 0.5.0

data/lib/proxy_pac_rb/proxy_pac_parser.rb

@@ -4,38 +4,26 @@ module ProxyPacRb
   class ProxyPacParser
     private
 
-    attr_reader :environment, :runtime
+    attr_reader :environment, :runtime, :compiler
 
     public
 
     def initialize(
       environment: Environment.new,
-      runtime: Runtimes.autodetect
+      compiler: JavascriptCompiler.new
     )
-      @runtime     = runtime
       @environment = environment
+      @compiler    = compiler
     end
 
     def parse(proxy_pac)
-      fail Exceptions::RuntimeUnavailable, "#{runtime.name} is unavailable on this system" unless runtime.available?
+      return unless proxy_pac.valid?
 
-      ProxyPac.new(
-        javascript: compile_javascript(proxy_pac.content),
-        file: proxy_pac
-      )
-    end
-
-    private
-
-    def compile_javascript(content)
-      environment.prepare(content)
-
-      context = runtime.compile(content)
-      context.include environment
-
-      Javascript.new(context)
-    rescue StandardError => err
-      raise ParserError, err.message
+      proxy_pac.javascript = compiler.compile(content: proxy_pac.content, environment: environment)
+      proxy_pac.parsable = true
+    rescue => err
+      proxy_pac.parsable = false
+      proxy_pac.message = err.message
     end
   end
 end

data/lib/proxy_pac_rb/rack/proxy_pac_compressor.rb

@@ -38,10 +38,10 @@ module ProxyPacRb
         status, headers, body = @app.call(env)
 
         return [status, headers, body] if enabled == false
-        # rubocop:disable Style/CaseEquality
+        # rubocop:disable Style/SpaceAroundOperators
         return [status, headers, body] unless headers.key?('Content-Type') \
-                                              && %r{application/x-ns-proxy-autoconfig} === headers['Content-Type']
-        # rubocop:enable Style/CaseEquality
+          && %r{application/x-ns-proxy-autoconfig} === headers['Content-Type']
+        # rubocop:enabled Style/SpaceAroundOperators
 
         content = ''
         body.each { |part| content << part }

data/lib/proxy_pac_rb/rack/proxy_pac_linter.rb

@@ -37,10 +37,10 @@ module ProxyPacRb
         status, headers, body = @app.call(env)
 
         return [status, headers, body] if enabled == false
-        # rubocop:disable Style/CaseEquality
+        # rubocop:disable Style/SpaceAroundOperators
         return [status, headers, body] unless headers.key?('Content-Type') \
-                                              && %r{application/x-ns-proxy-autoconfig} === headers['Content-Type']
-        # rubocop:enable Style/CaseEquality
+          && %r{application/x-ns-proxy-autoconfig} === headers['Content-Type']
+        # rubocop:enabled Style/SpaceAroundOperators
 
         content = ''
         body.each { |part| content << part }

data/lib/proxy_pac_rb/rspec/helpers.rb

@@ -0,0 +1,52 @@
+module ProxyPacRb
+  module Rspec
+    # Helpers for proxy.pac tests
+    module Helpers
+      def proxy_pac
+        source = if subject.nil? || Addressable::URI.parse(subject).host || /FindProxyForURL/ === subject
+                   subject
+                 else
+                   File.join(root_path, subject)
+                 end
+
+        file = ProxyPacRb::ProxyPacFile.new(source: source)
+
+        _proxy_pac_loader.load(file)
+        _proxy_pac_linter.lint(file)
+        _proxy_pac_parser.parse(file)
+
+        file
+      end
+
+      def time
+        '1970-01-01 00:00:00'
+      end
+
+      def client_ip
+        '127.0.0.1'
+      end
+
+      def root_path
+        @root_path ||= Dir.getwd
+      end
+
+      private
+
+      def _environment
+        Environment.new(time: time, client_ip: client_ip)
+      end
+
+      def _proxy_pac_parser
+        ProxyPacRb::ProxyPacParser.new(environment: _environment)
+      end
+
+      def _proxy_pac_loader
+        ProxyPacRb::ProxyPacLoader.new
+      end
+
+      def _proxy_pac_linter
+        ProxyPacRb::ProxyPacLinter.new
+      end
+    end
+  end
+end

data/lib/proxy_pac_rb/rspec/matchers/proxy.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :be_the_same_proxy_pac_file do |expected|
+  define_method :loader do
+    ProxyPacRb::ProxyPacLoader.new
+  end
+
+  match do |actual|
+    @file_a = ProxyPacRb::ProxyPacFile.new(source: actual)
+    loader.load(@file_a)
+
+    @file_b = ProxyPacRb::ProxyPacFile.new(source: expected)
+    loader.load(@file_b)
+
+    @file_a == @file_b
+  end
+
+  failure_message do
+    format(%(expected that proxy.pac "%s" is equal to proxy.pac "%s", but it is not equal.\n\nActual:\n%s\n\nExpected:\n%s), @file_a.source, @file_b.source, @file_a.content, @file_b.content)
+  end
+
+  failure_message_when_negated do
+    format(%(expected that proxy.pac "%s" is not equal to proxy.pac "%s", but it is equal.\n\nActual:\n%s\n\nExpected:\n%s), @file_a.source, @file_b.source, @file_a.content, @file_b.content)
+  end
+end

data/lib/proxy_pac_rb/rspec/matchers/url.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :be_downloaded_via do |expected|
+  match do |actual|
+    proxy_pac.find(actual) == expected
+  end
+
+  failure_message do |actual|
+    format(%(expected that url "%s" is downloaded via "%s", but it is downloaded via "%s".), actual, expected, proxy_pac.find(actual))
+  end
+
+  failure_message_when_negated do |actual|
+    format(%(expected that url "%s" is not downloaded via "%s", but it is downloaded via "%s".), actual, expected, proxy_pac.find(actual))
+  end
+end

data/lib/proxy_pac_rb/rspec.rb

@@ -0,0 +1,18 @@
+require 'proxy_pac_rb'
+require 'rspec'
+
+require 'proxy_pac_rb/rspec/helpers'
+ProxyPacRb.require_file_matching_pattern('rspec/matchers/*.rb')
+ProxyPacRb.require_file_matching_pattern('rspec/shared_examples/*.rb')
+ProxyPacRb.require_file_matching_pattern('rspec/shared_contexts/*.rb')
+
+# Main Module
+module ProxyPacRb
+  # Main Module
+  module Rspec
+  end
+end
+
+RSpec.configure do |config|
+  config.include ProxyPacRb::Rspec::Helpers, type: :proxy_pac
+end

data/lib/proxy_pac_rb/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # ProxyPacRb
 module ProxyPacRb
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/proxy_pac_rb.rb

@@ -7,7 +7,9 @@ require 'uglifier'
 require 'optparse'
 require 'ostruct'
 require 'resolv'
+require 'net/http'
 require 'time'
+require 'timeout'
 
 require 'proxy_pac_rb/version'
 require 'proxy_pac_rb/main'
@@ -15,6 +17,7 @@ require 'proxy_pac_rb/errors'
 require 'proxy_pac_rb/encoding'
 require 'proxy_pac_rb/exceptions'
 require 'proxy_pac_rb/environment'
+require 'proxy_pac_rb/javascript_compiler'
 require 'proxy_pac_rb/runtime'
 require 'proxy_pac_rb/runtimes/rubyracer'
 require 'proxy_pac_rb/runtimes/rubyrhino'
@@ -22,7 +25,6 @@ require 'proxy_pac_rb/runtimes'
 require 'proxy_pac_rb/parser'
 require 'proxy_pac_rb/javascript'
 require 'proxy_pac_rb/proxy_pac_js'
-require 'proxy_pac_rb/proxy_pac'
 require 'proxy_pac_rb/proxy_pac_file'
 require 'proxy_pac_rb/proxy_pac_template'
 require 'proxy_pac_rb/proxy_pac_compressor'
@@ -35,6 +37,8 @@ require 'proxy_pac_rb/cli_validator'
 
 require 'proxy_pac_rb/cli/shared'
 require 'proxy_pac_rb/cli/find_proxy'
+require 'proxy_pac_rb/cli/init_proxy_pac'
+require 'proxy_pac_rb/cli/init'
 require 'proxy_pac_rb/cli/lint_proxy_pac'
 require 'proxy_pac_rb/cli/lint'
 require 'proxy_pac_rb/cli/compress_proxy_pac'

data/script/config.ru

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler'
+Bundler.require :default, :test, :development
+
+require 'rack/directory'
+
+run Rack::Directory.new(File.expand_path('../../tmp/cucumber', __FILE__))

data/spec/api/proxy_pac_compressor_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacCompressor do
+  subject(:proxy_pac) { instance_double('ProxyPac::ProxyPacFile') }
+
+  let(:compressor) { described_class.new }
+  let(:modified_content) { %(function FindProxyForURL(){return"DIRECT"}) }
+
+  let(:content) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  before :each do
+    allow(proxy_pac).to receive(:content).and_return(content)
+    allow(proxy_pac).to receive(:type?).with(:string).and_return(true)
+  end
+
+  before :each do
+    expect(proxy_pac).to receive(:content=).with(modified_content)
+  end
+
+  describe '#modify' do
+    context 'when string contains white paces' do
+      it { compressor.compress(proxy_pac) }
+    end
+  end
+end

data/spec/api/proxy_pac_dumper_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacDumper do
+  subject(:proxy_pac) { instance_double('ProxyPac::ProxyPacFile') }
+
+  let(:content) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  let(:source) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  before :each do
+    allow(proxy_pac).to receive(:content).and_return(content)
+    allow(proxy_pac).to receive(:source).and_return(source)
+  end
+
+  let(:dumper) { ProxyPacDumper.new }
+  let(:destination) { absolute_path('proxy.pac') }
+
+  describe '#dump' do
+    before :each do
+      allow(proxy_pac).to receive(:source).and_return(source)
+    end
+
+    context 'when proxy pac is string' do
+      before :each do
+        in_current_dir do
+          dumper.dump(proxy_pac, type: :string)
+        end
+      end
+
+      it { expect(destination).to be_existing_file }
+      it { expect(destination).to have_content proxy_pac.content }
+    end
+
+    context 'when proxy pac is file' do
+      let(:source) { 'proxy.pac.in' }
+
+      before :each do
+        write_file(source, content)
+      end
+
+      before :each do
+        in_current_dir do
+          dumper.dump(proxy_pac, type: :template)
+        end
+      end
+
+      around :example do |example|
+        in_current_dir { example.call }
+      end
+
+      it { expect(destination).to be_existing_file }
+      it { expect(destination).to have_content proxy_pac.content }
+    end
+  end
+end

data/spec/api/proxy_pac_file_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacFile do
+  subject(:proxy_pac) { ProxyPacFile.new source: source }
+
+  let(:source) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  describe '#initalize' do
+    context 'when source is ProxyPacFile' do
+      before :each do
+        proxy_pac.content    = source
+        proxy_pac.javascript = BasicObject.new
+        proxy_pac.message    = 'message'
+        proxy_pac.parsable   = true
+        proxy_pac.readable   = true
+        proxy_pac.type       = :string
+        proxy_pac.valid      = true
+      end
+
+      let(:proxy_pac_2) { ProxyPacFile.new(source: proxy_pac) }
+
+      it { expect(proxy_pac.content).to eq proxy_pac_2.content }
+      it { expect(proxy_pac.javascript).to eq proxy_pac_2.javascript }
+      it { expect(proxy_pac.message).to eq proxy_pac_2.message }
+      it { expect(proxy_pac.parsable).to eq proxy_pac_2.parsable }
+      it { expect(proxy_pac.readable).to eq proxy_pac_2.readable }
+      it { expect(proxy_pac.source).to eq proxy_pac_2.source }
+      it { expect(proxy_pac.type).to eq proxy_pac_2.type }
+      it { expect(proxy_pac.valid).to eq proxy_pac_2.valid }
+    end
+  end
+
+  describe '#content' do
+    let(:content) { 'content' }
+    before(:each) { proxy_pac.content = content }
+
+    context 'when is "content"' do
+      it { expect(proxy_pac.content).to eq content }
+    end
+
+    context 'when is "content"' do
+      let(:content) { nil }
+      it { expect(proxy_pac.content).to eq nil }
+    end
+  end
+
+  describe '#content?' do
+    let(:content) { 'content' }
+
+    context 'when has content' do
+      before(:each) { proxy_pac.content = content }
+      it { expect(proxy_pac).to be_content }
+    end
+
+    context 'when does not have content' do
+      it { expect(proxy_pac).not_to be_content }
+    end
+  end
+
+  describe '#valid?' do
+    context 'when is invalid' do
+      it { expect(proxy_pac).not_to be_valid }
+    end
+
+    context 'when is valid' do
+      before(:each) { proxy_pac.readable = true }
+      before(:each) { proxy_pac.valid = true }
+
+      it { expect(proxy_pac).to be_valid }
+    end
+  end
+
+  describe '#readable?' do
+    context 'when is invalid' do
+      it { expect(proxy_pac).not_to be_readable }
+    end
+
+    context 'when is valid' do
+      before(:each) { proxy_pac.readable = true }
+
+      it { expect(proxy_pac).to be_readable }
+    end
+  end
+end

data/spec/api/proxy_pac_linter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacLinter do
+  subject(:proxy_pac) { instance_double('ProxyPac::ProxyPacFile') }
+
+  let(:content) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  let(:source) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  before :each do
+    allow(proxy_pac).to receive(:source).and_return(source)
+    allow(proxy_pac).to receive(:content).and_return(content)
+    allow(proxy_pac).to receive(:valid).and_return(true)
+    allow(proxy_pac).to receive(:type?).with(:string).and_return(true)
+  end
+
+  describe '#lint' do
+    let(:linter) {  ProxyPacLinter.new(silent: true) }
+    let(:result) { true }
+
+    before(:each) do
+      expect(proxy_pac).to receive(:valid=).with(result)
+      allow(proxy_pac).to receive(:message=)
+    end
+
+    context 'when is valid' do
+      it { linter.lint(proxy_pac) }
+    end
+
+    context 'when is proxy.pac does not contain FindProxyForURL' do
+      let(:result) { false }
+      let(:content) { '' }
+      it { linter.lint(proxy_pac) }
+    end
+
+    context 'when is proxy.pac cannot be compiled' do
+      let(:result) { false }
+      let(:content) do
+        <<-EOS.strip_heredoc.chomp
+          function FindProxyForURL(url, host) {
+           asdfasf $$ SDF
+          }
+        EOS
+      end
+
+      it { linter.lint(proxy_pac) }
+    end
+  end
+end

data/spec/api/proxy_pac_loader_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacLoader do
+  subject(:proxy_pac) { instance_double('ProxyPac::ProxyPacFile') }
+
+  let(:content) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  let(:source) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  before :each do
+    allow(proxy_pac).to receive(:content).and_return(content)
+    allow(proxy_pac).to receive(:source).and_return(source)
+  end
+
+  let(:loader) { ProxyPacLoader.new }
+  let(:type) { :string }
+
+  before :each do
+    allow(proxy_pac).to receive(:source).and_return(source)
+    allow(proxy_pac).to receive(:type=).with(type)
+  end
+
+  describe '#load' do
+    context 'when proxy pac is string' do
+      it_behaves_like 'a readable proxy.pac'
+    end
+
+    context 'when proxy pac has already been loaded' do
+      before(:each) { allow(proxy_pac).to receive(:content?).and_return(true) }
+      before(:each) { expect(proxy_pac).not_to receive(:content=) }
+
+      it { loader.load(proxy_pac) }
+    end
+
+    context 'when proxy pac is nil' do
+      let(:source) { nil }
+      let(:type) { :null }
+      it_behaves_like 'an un-readable proxy.pac'
+    end
+
+    context 'when proxy pac is file' do
+      let(:file) { 'proxy.pac' }
+      let(:type) { :file }
+      let(:source) { absolute_path(file) }
+
+      before(:each) { allow(proxy_pac).to receive(:source).and_return(source) }
+
+      context 'when is readable' do
+        before(:each) { write_file(file, content) }
+
+        it_behaves_like 'a readable proxy.pac'
+      end
+
+      context 'when is not readable' do
+        it_behaves_like 'an un-readable proxy.pac'
+      end
+    end
+
+    context 'when proxy pac is url' do
+      let(:type) { :url }
+      let(:source) { 'http://example.com/proxy.pac' }
+
+      context 'when is readable' do
+        before(:each) { stub_request(:get, source).to_return(body: content, status: 200) }
+
+        it_behaves_like 'a readable proxy.pac'
+      end
+
+      context 'when is not readable' do
+        before(:each) { stub_request(:get, source).to_raise(StandardError) }
+
+        it_behaves_like 'an un-readable proxy.pac'
+      end
+    end
+  end
+end

data/spec/api/proxy_pac_parser_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+RSpec.describe ProxyPacParser do
+  subject(:proxy_pac) { instance_double('ProxyPac::ProxyPacFile') }
+
+  let(:content) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  let(:source) do
+    <<-EOS.strip_heredoc.chomp
+      function FindProxyForURL(url, host) {
+        return "DIRECT";
+      }
+    EOS
+  end
+
+  before :each do
+    allow(proxy_pac).to receive(:content).and_return(content)
+    allow(proxy_pac).to receive(:valid?).and_return(true)
+    allow(proxy_pac).to receive(:source).and_return(source)
+    allow(proxy_pac).to receive(:type?).with(:string).and_return(true)
+  end
+
+  describe '#parse' do
+    context 'when is valid' do
+      before(:each) do
+        expect(proxy_pac).to receive(:javascript=)
+        expect(proxy_pac).to receive(:parsable=).with(true)
+      end
+
+      before(:each) { ProxyPacParser.new.parse(proxy_pac) }
+    end
+
+    context 'when is invalid' do
+      let(:content) do
+        <<-EOS.strip_heredoc.chomp
+          function FindProxyForURL(url, host) {
+           asdfasf $$ SDF
+          }
+        EOS
+      end
+
+      before(:each) do
+        expect(proxy_pac).to receive(:message=)
+        expect(proxy_pac).to receive(:parsable=).with(false)
+      end
+
+      before(:each) { ProxyPacParser.new.parse(proxy_pac) }
+    end
+  end
+end