proxy_service 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d49cd57c5826ec06f6ae183e30e4c20dbd46990
-  data.tar.gz: 08a602e1181b4fb98d453e181e84aa700e5073c9
+  metadata.gz: 7fdfe384bfb35ffcb1e776646c6b209d7f783415
+  data.tar.gz: cae3bb440cf6fcebabc4e10914dde221dcf9906c
 SHA512:
-  metadata.gz: 422d903c3560425ecb6851d35c0b81af0146a1c8e9200695117eacd855149e24e6b34eb83c4a873978a71487f5b7a44c7929d66fdb68e9fbe77d735df762f125
-  data.tar.gz: 403f40e3840ff425dd555d0ce00218b94acdba5c0be8d8eb43d706e1723e90cea04ab0ae581e722e852f0821adfbd754a10feedb8f0b7585178c5eb0281da292
+  metadata.gz: 62e29c6ab4d4c00140f4bd4b4cd7d2589968cef81b86d95fe92feb52a1e221e73b2a7ab9577a7e4d8989add8d2fbf95475ef3d7f29e37f95e922f996a4b7d6a9
+  data.tar.gz: 8ebabc07fb86da716f1dc175449c71e87e9fe37681308229094a155e671cb8504a3dc89140fba4a0602c3fdd9a2295e1bde87919a85d73c65302a1cc5be42095

data/README.md

@@ -1,6 +1,6 @@
 # ProxyService
 
-TODO: Write a gem description
+A service class that rotates a list of proxies stored in a queue. The queueing system must support the STOMP protocol. Can be used with or without proxies. A queue name should be given and the queue should have a list of proxies in the format of `{ failures: 0, ip: '127.0.0.1', port: '80' }`. The service uses this info to set the proxy of a mechanize agent. If an exception occurs in the block, the proxy's `:failures` count is incremented and it's put back in the queue to be used again. Once the `:failures` count exceeds the `#failure_limit` it will be removed from the queue.
 
 ## Installation
 
@@ -17,11 +17,25 @@ Or install it yourself as:
     $ gem install proxy_service
 
 ## Usage
-
-      ProxyService.new(:queue_name).with_mechanize do |agent|
-        agent.get('http://...')
-      end
-
+Configure the service, for example, in an initializer
+```ruby
+ProxyService.configure do |config|
+  config.proxies_enabled = true
+  config.username = '...'  # only used when proxies enabled
+  config.password = '...'  # only used when proxies enabled
+  config.failure_limit = 3 # only used when proxies enabled
+end
+```
+And then use it in your app
+```ruby
+ProxyService.new('queue_with_proxies').with_mechanize do |agent|
+  agent.get('http://...')
+end
+```
+Some config settings can be overwritten on initialize
+```ruby
+ProxyService.new('queue_with_proxies', proxies_enabled: false)
+```
 ## Contributing
 
 1. Fork it ( https://github.com/ridiculous/proxy_service/fork )

data/lib/proxy_service/mechanize_agent.rb

@@ -14,6 +14,7 @@ class ProxyService::MechanizeAgent < DelegateClass(Mechanize)
     end
   end
 
+  # @note proxy.ip should only be nil in the case where it's held by a NullWorker
   # @param [#ip, #port] proxy object that holds the ip and port
   def set_proxy(proxy)
     return unless proxy.ip

data/lib/proxy_service/version.rb

@@ -1,3 +1,3 @@
 class ProxyService
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/lib/proxy_service.rb

@@ -32,11 +32,13 @@ class ProxyService
     agent.set_proxy(proxy)
     yield agent
     proxy.reset_failures
-  rescue
-    if proxy.failures >= failure_limit
-      proxy.blocked!
-    else
-      proxy.increment_failures
+  rescue Mechanize::ResponseCodeError => e
+    if e.response_code == '403' # "forbidden"
+      if proxy.failures >= failure_limit
+        proxy.blocked!
+      else
+        proxy.increment_failures
+      end
     end
   ensure
     proxy.release

data/spec/lib/proxy_service_spec.rb

@@ -43,24 +43,26 @@ describe ProxyService do
     end
 
     context 'when there is an exception' do
+      let(:mechanize_error) { Mechanize::ResponseCodeError.new(OpenStruct.new(code: '403')) }
+
       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' }
+        subject.with_mechanize { |_| raise mechanize_error }
       end
 
       context 'when +failures+ exceeds max failures' do
         it 'blocks the proxy' do
           expect(proxy).to receive(:failures).and_return(subject.failure_limit + 1)
           expect(proxy).to receive(:blocked!)
-          subject.with_mechanize { |_| raise 'Testing exception' }
+          subject.with_mechanize { |_| raise mechanize_error }
         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' }
+          subject.with_mechanize { |_| raise mechanize_error }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proxy_service
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler