proxy_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fe64c3a39411580b172dee7b78d3881eb4c6adb
+  data.tar.gz: bef4e0293b96c681fff87a4ed1aee82bc0d5b596
+SHA512:
+  metadata.gz: 8a32016d854eb268db463e123fa387e593cd15517ec87858851f5b5b64c1affdef403f8092d1133a7396606283f49cf4d4cd21753d04d985824dd0d8392f6211
+  data.tar.gz: adb5c27511b1b19aae97da7df82acf0c1ad51604bba504d02cb8d2c99f937e0fc70ed59d264197d422fbcdbc3f04e334b4121a30ceaf9cf3a92a6dfbd4fd9f55

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in proxy_service.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Buckley
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# ProxyService
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'proxy_service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proxy_service
+
+## Usage
+
+      ProxyService.new(:queue_name).with_mechanize do |agent|
+        agent.get('http://...')
+      end
+
+## Contributing
+
+1. Fork it ( https://github.com/ridiculous/proxy_service/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "proxy_service #{ProxyService::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/proxy_service.rb

@@ -0,0 +1,82 @@
+require 'json'
+
+class ProxyService
+
+  # = Class
+  # @example Usage
+  #
+  # ProxyService.new(:queue_name).with_mechanize do |agent|
+  #   agent.get('...')
+  # end
+  #
+
+  POLL_PERIOD = 1
+  MAX_FAILURES = 3
+
+  attr_accessor :source
+  attr_writer :proxies_enabled
+
+  # = Create a new proxy service with for a specific ODS
+  #
+  # @param [String|Symbol] source name of the ODS (e.g. :tripadvisor), will look for a queue with that name "proxy/#{source}"
+  # @param [Hash] options
+  # @option options [Boolean] :proxies_enabled override the app configuration
+  def initialize(source, options = {})
+    @source = source
+    @proxies_enabled = options.fetch(:proxies_enabled, false) # Rails.application.config.proxies.enabled
+  end
+
+  # @yield [agent] Passes a [proxied] Mechanize agent to the block
+  def with_mechanize
+    proxy = reserve_proxy
+    agent = MechanizeAgent.new
+    agent.set_proxy(proxy)
+    yield agent
+    proxy.reset_failures
+  rescue => e
+    if proxy.failures >= MAX_FAILURES
+      proxy.blocked!
+    else
+      proxy.increment_failures
+    end
+    puts "ERROR: #{e.message}"
+  ensure
+    proxy.release
+  end
+
+  #
+  # Private
+  #
+
+  def new_worker
+    if proxies_enabled?
+      Worker.new("proxy/#{source}")
+    else
+      NullWorker.new
+    end
+  end
+
+  def proxies_enabled?
+    @proxies_enabled
+  end
+
+  # = Creates a STOMP connection (consumer)
+  #
+  # @return [Proxy] a new proxy object
+  def reserve_proxy
+    worker = new_worker
+    worker.subscribe
+    loop do
+      if worker.ready?
+        return Proxy.new(worker)
+      else
+        sleep(POLL_PERIOD)
+      end
+    end
+  end
+end
+
+require 'proxy_service/mechanize_agent'
+require 'proxy_service/null_worker'
+require 'proxy_service/proxy'
+require 'proxy_service/worker'

data/lib/proxy_service/mechanize_agent.rb

@@ -0,0 +1,22 @@
+require 'mechanize'
+
+class ProxyService::MechanizeAgent < DelegateClass(Mechanize)
+  USER_AGENT_ALIASES = ['Windows Mozilla', 'Mac Safari', 'Mac FireFox', 'Mac Mozilla', 'Linux Mozilla', 'Linux Firefox']
+
+  def initialize
+    super Mechanize.new do |mech|
+      mech.open_timeout = 10
+      mech.read_timeout = 10
+      mech.follow_meta_refresh = true
+      mech.keep_alive = true
+      mech.max_history = 1
+      mech.user_agent_alias = USER_AGENT_ALIASES.sample
+    end
+  end
+
+  # @param [#ip, #port] proxy object that holds the ip and port
+  def set_proxy(proxy)
+    return unless proxy.ip
+    __getobj__.set_proxy(proxy.ip, proxy.port, Rails.application.config.proxies.user, Rails.application.config.proxies.password)
+  end
+end

data/lib/proxy_service/null_worker.rb

@@ -0,0 +1,24 @@
+class ProxyService::NullWorker
+  NullMessage = Struct.new(:body)
+  attr_accessor :message
+
+  def initialize
+    @message = NullMessage.new('{}')
+  end
+
+  def call(*)
+    # no-op
+  end
+
+  def ready?
+    true
+  end
+
+  def subscribe
+    # no-op
+  end
+
+  def release(*)
+    # no-op
+  end
+end

data/lib/proxy_service/proxy.rb

@@ -0,0 +1,69 @@
+class ProxyService::Proxy
+
+  attr_accessor :worker
+  attr_writer :failures, :message, :ip, :port
+
+  # @param [Worker, NullWorker] worker that has a message and body
+  def initialize(worker)
+    @worker = worker
+  end
+
+  def ip
+    @ip ||= message['ip']
+  end
+
+  def port
+    @port ||= message['port']
+  end
+
+  def failures
+    @failures ||= message['failures']
+  end
+
+  def message
+    @message ||= { 'failures' => 0 }.merge(JSON.parse(worker.message.body))
+  end
+
+  def release
+    worker.release(self, blocked?)
+  end
+
+  def increment_failures
+    @failures += 1
+  end
+
+  def reset_failures
+    @failures = 0
+  end
+
+  def blocked?
+    !!@blocked
+  end
+
+  def blocked!
+    @blocked = true
+  end
+
+  #
+  # Coercion overrides
+  #
+
+  def to_h
+    {
+      ip: ip,
+      port: port,
+      failures: failures
+    }
+  end
+
+  def to_json
+    to_h.to_json
+  end
+
+  def to_s
+    %(#<Proxy:#{object_id} @ip="#{ip}", @port="#{port}", @failures=#{failures}, @blocked=#{blocked?}, @message=#{message}, @worker="...">)
+  end
+
+  alias inspect to_s
+
+end

data/lib/proxy_service/version.rb

@@ -0,0 +1,3 @@
+class ProxyService
+  VERSION = '0.0.1'
+end

data/lib/proxy_service/worker.rb

@@ -0,0 +1,23 @@
+require 'queue_worker'
+
+class ProxyService::Worker < QueueWorker
+
+  attr_accessor :message
+  attr_writer :ready
+
+  def call(message)
+    @message = message
+    @ready = true
+  end
+
+  def ready?
+    !!@ready
+  end
+
+  def release(proxy, is_blocked)
+    ack(message)
+    unsubscribe
+    publish(proxy) unless is_blocked
+    close
+  end
+end

data/proxy_service.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proxy_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "proxy_service"
+  spec.version       = ProxyService::VERSION
+  spec.authors       = ["Ryan Buckley"]
+  spec.email         = ["arebuckley@gmail.com"]
+  spec.summary       = %q{Manages rotation of proxies using a queue}
+  spec.description   = %q{Manages rotation of proxies using a queuing system and STOMP}
+  spec.homepage      = "https://github.com/ridiculous/proxy_service"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+
+  spec.add_runtime_dependency 'queue_worker', '~> 0.0', '>= 0.0.1'
+  spec.add_runtime_dependency 'mechanize', '~> 2.7', '>= 2.7.3'
+end

data/spec/lib/proxy_service/proxy_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ProxyService::Proxy do
+  subject { described_class.new(ProxyService::NullWorker.new) }
+
+  describe '#message' do
+    context 'when message.body is present' do
+      let(:message_body) { { ip: '127.0.0.1', port: '8080', failures: 1 }.to_json }
+
+      it 'returns the contents as a hash' do
+        expect(subject.worker.message).to receive(:body).and_return(message_body)
+        expect(subject.message).to eq(JSON.parse(message_body))
+      end
+    end
+
+    context 'when message.body is empty' do
+      it "returns a hash with a 'failures' key set to 0" do
+        expect(subject.message).to eq({ 'failures' => 0 })
+      end
+    end
+  end
+
+  describe '#release' do
+    it 'passes itself to worker.release with the @blocked status' do
+      expect(subject.worker).to receive(:release).with(subject, false)
+      subject.release
+    end
+  end
+
+  describe '#increment_failures' do
+    it 'increments the @failures count by 1' do
+      expect { subject.increment_failures }.to change(subject, :failures).from(0).to(1)
+    end
+  end
+
+  describe '#reset_failures' do
+    before { subject.failures = 2 }
+
+    it 'resets the @failures count to 0' do
+      expect { subject.reset_failures }.to change(subject, :failures).from(2).to(0)
+    end
+  end
+
+  describe '#blocked!' do
+    it 'sets @blocked to true' do
+      expect { subject.blocked! }.to change(subject, :blocked?).from(false).to(true)
+    end
+  end
+end

data/spec/lib/proxy_service/worker_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ProxyService::Worker do
+
+  let(:queue_name) { 'proxy/trip_advisor' }
+  let(:message) { {} }
+  let(:proxy) { double('Proxy') }
+
+  subject { described_class.new(queue_name) }
+
+  describe '#call' do
+    it 'sets @message to message and @ready to true' do
+      expect(subject).to_not be_ready
+      expect { subject.call(message) }.to change(subject, :message).from(nil).to(message)
+      expect(subject).to be_ready
+    end
+  end
+
+  describe '#release' do
+    before(:each) { subject.message = message }
+
+    it 'pops and then pushes the -proxy- onto the queue' do
+      expect(subject).to receive(:ack).with(message)
+      expect(subject).to receive(:unsubscribe)
+      expect(subject).to receive(:publish).with(proxy)
+      expect(subject).to receive(:close)
+      subject.release(proxy, false)
+    end
+
+    context 'when proxy is blocked' do
+      it 'pops the message from the queue but does not push it back on' do
+        expect(subject).to receive(:ack).with(message)
+        expect(subject).to receive(:unsubscribe)
+        expect(subject).to_not receive(:publish).with(proxy)
+        expect(subject).to receive(:close)
+        subject.release(proxy, true)
+      end
+    end
+  end
+end

data/spec/lib/proxy_service_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe ProxyService do
+
+  subject { described_class.new(:trip_advisor) }
+
+  describe '#new_worker' do
+    context 'when proxies are enabled' do
+      before { subject.proxies_enabled = true }
+
+      it 'returns a new ProxyWorker' do
+        worker = subject.new_worker
+        expect(worker).to be_a(ProxyService::Worker)
+        expect(worker.queue).to eq 'proxy/trip_advisor'
+      end
+    end
+
+    context 'when proxies are disabled' do
+      it 'returns a new NullWorker' do
+        expect(subject.new_worker).to be_a(ProxyService::NullWorker)
+      end
+    end
+  end
+
+  describe '#with_mechanize' do
+    let(:worker) { ProxyService::NullWorker.new }
+    let(:proxy) { ProxyService::Proxy.new(worker) }
+
+    before(:each) { allow(subject).to receive(:reserve_proxy).and_return(proxy) }
+
+    it 'passes a new mechanize agent to the given block' do
+      expect_any_instance_of(ProxyService::MechanizeAgent).to receive(:set_proxy).with(proxy)
+      subject.with_mechanize do |agent|
+        expect(agent).to be_a(ProxyService::MechanizeAgent)
+        expect(agent).to respond_to(:get)
+      end
+    end
+
+    it 'releases the proxy and resets its failures count' do
+      expect(proxy).to receive(:reset_failures)
+      expect(proxy).to receive(:release)
+      subject.with_mechanize { |_| }
+    end
+
+    context 'when there is an exception' do
+      it 'does not reset the failures count' do
+        expect(proxy).to_not receive(:reset_failures)
+        expect(proxy).to receive(:release)
+        subject.with_mechanize { |_| raise 'Testing exception' }
+      end
+
+      context 'when +failures+ exceeds max failures' do
+        it 'blocks the proxy' do
+          expect(proxy).to receive(:failures).and_return(ProxyService::MAX_FAILURES + 1)
+          expect(proxy).to receive(:blocked!)
+          subject.with_mechanize { |_| raise 'Testing exception' }
+        end
+      end
+
+      context 'when +failures+ does not exceed max failures' do
+        it "increments the proxy's +failures+ count" do
+          expect(proxy).to receive(:increment_failures)
+          subject.with_mechanize { |_| raise 'Testing exception' }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'proxy_service'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: proxy_service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: queue_worker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.3
+description: Manages rotation of proxies using a queuing system and STOMP
+email:
+- arebuckley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proxy_service.rb
+- lib/proxy_service/mechanize_agent.rb
+- lib/proxy_service/null_worker.rb
+- lib/proxy_service/proxy.rb
+- lib/proxy_service/version.rb
+- lib/proxy_service/worker.rb
+- proxy_service.gemspec
+- spec/lib/proxy_service/proxy_spec.rb
+- spec/lib/proxy_service/worker_spec.rb
+- spec/lib/proxy_service_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ridiculous/proxy_service
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Manages rotation of proxies using a queue
+test_files:
+- spec/lib/proxy_service/proxy_spec.rb
+- spec/lib/proxy_service/worker_spec.rb
+- spec/lib/proxy_service_spec.rb
+- spec/spec_helper.rb