proxy_manager 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35ab032dab45fa2d252c021a447b8f46851b23ee
-  data.tar.gz: 25bde6a799ef93b589c66f68af8b139cc7feb716
+  metadata.gz: 5347792228f1358afe8763f4786894c3a574e257
+  data.tar.gz: 18add715d27e92b7cc2ea84d00de1f8fb4986a5d
 SHA512:
-  metadata.gz: 39f55eee88c8afbbc1e817e84a34c146473e02cad1b7ecb92a72bc476535bc1035ecd7dbbf6ed4785f4a7b2eec093c059b5846039dccde1e357eb0916dbf826f
-  data.tar.gz: 3818128cf8fb8040a5d362c67a153a9eee5c951ceaaf3be1b16c2227c52ef7cf8de6bd213414ed61635cae2c17661d4a180c7af3351d9e3ffa93ae24c9e82135
+  metadata.gz: 53acff22f244cbecec72cbd7611e85ce92340a0dad086a47fb1fdb9bb7ebc363584852ca1b3f6845c2ad178c544f857b0032248668e3644e36c0606bcc917e7c
+  data.tar.gz: f82b8f40a75d6b85310ab0a64135c7eb72eed164d5d97fbd762f8f08ce65f1bdc3b76e6f4d8ff9242475c4f8cee197488cecee2208f5f11bdb858bf517475748

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
-gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +1,10 @@
 # Ruby Proxy Manager
 
+[![Gem Version](https://badge.fury.io/rb/proxy_manager.svg)](http://badge.fury.io/rb/proxy_manager)
+[![Build Status](https://travis-ci.org/bloodyhistory/proxy_manager.svg?branch=master)](https://travis-ci.org/bloodyhistory/proxy_manager)
+[![Code Climate](https://codeclimate.com/github/bloodyhistory/proxy_manager.png)](https://codeclimate.com/github/bloodyhistory/proxy_manager)
+[![Coverage](https://codeclimate.com/github/bloodyhistory/proxy_manager/coverage.png)](https://codeclimate.com/github/bloodyhistory/proxy_manager)
+
 Easy manage proxy in your parsers/web-bots.
 
 
@@ -30,61 +35,81 @@ $ gem install proxy_manager
 From array (IP:PORT)
 
 ```ruby
-proxy = ProxyManager.load(['1.2.3.4:567', '9.8.7.6:543'])
+proxy = ProxyManager::Proxy.new(['127.0.0.1:80', '127.0.0.1:8080'])
 ```
 
 or from file
 
 ```ruby
-proxy = ProxyManager.load('proxies.txt', 'bad_proxies.txt')
+proxy = ProxyManager::Proxy.new('proxies.txt')
 ```
 
-Files `proxies.txt` and `bad_proxies.txt` should be writable.
+File with proxy list (in this case `proxies.txt`) should be readable and
+writable.
 Example of `proxies.txt` content:
 
 ```
-1.2.3.4:567
-9.8.7.6:543
+127.0.0.1:80
+127.0.0.1:8080
 ...
 ```
 
 ### Get proxy
 
-Get one proxy
+There is two methods to get proxy.
+
+First method return just next proxy, without any checking for availability:
 
 ```ruby
 proxy.get
-# => ["1.2.3.4", 567]
+# => ["127.0.0.1", 80]
 ```
 
-Get many proxies
+Band method return **only HTTP-available proxy**. It's perfect if you don't
+realy confidency on actuallity of your proxy list:
 
 ```ruby
-proxy.get(2)
-# => [["1.2.3.4", 567], ["9.8.7.6", 543]]
+proxy.get!
+# => ["127.0.0.1", 8080]
 ```
 
-Will be returning only pingable proxies
+You can also get for than one proxy per request by adding count for both
+methods like this:
+
+```ruby
+proxy.get(2)
+# => [["127.0.0.1", 80], ["127.0.0.1", 8080]]
+
+proxy.get!(2)
+# => [["127.0.0.1", 80], ["127.0.0.1", 8080]]
+```
 
-### Proxies lists
+### Proxies list
 
-You also can display list of loaded proxies
+For display list of loaded proxies use `list` method:
 
 ```ruby
 proxy.list
-# => [["1.2.3.4", 567], ["9.8.7.6", 543]]
+# => [["127.0.0.1", 80], ["127.0.0.1", 8080]]
 ```
 
-and list of bad proxies
+### Checking proxy manually
+
+You can also use class method for checking availability manually like this:
 
 ```ruby
-proxy.bad_list
-# => []
+# by passing a string
+ProxyManager::Proxy.connectable?('127.0.0.1:80')
+# => false
+
+# or by passing an array
+ProxyManager::Proxy.connectable?('127.0.0.1', 80)
+# => false
 ```
 
 ## Documentation
 
-http://rubydoc.info/gems/proxy_manager/frames
+http://rubydoc.info/gems/proxy_manager
 
 ## Contributing
 

data/lib/proxy_manager/proxy.rb

@@ -0,0 +1,93 @@
+module ProxyManager
+  class Proxy
+    attr_reader :list
+
+    def initialize(proxies)
+      @list = []
+
+      if proxies.is_a? Array
+        load_list_from_array(proxies)
+      else
+        @list_file = proxies
+        @list = load_from_file(@list_file)
+      end
+    end
+
+    def get(count = 1)
+      get_proxy(count)
+    end
+
+    def get!(count = 1)
+      get_proxy(count, true)
+    end
+
+    def self.connectable?(proxy)
+      proxy = proxy.chomp.split(':') if proxy.is_a? String
+      ip, port = proxy
+      connection = Net::HTTP.new("http://google.com", nil, ip, port)
+      connection.open_timeout = 3
+      connection.read_timeout = 3
+
+      connection.start do |http|
+        return true if http.get('/')
+      end
+
+      false
+    rescue Exception => e
+      false
+    end
+
+    private
+
+    def load_list_from_array(proxies)
+      @list = proxies.map { |arg| [arg.split(':')[0], arg.split(':')[1].to_i] }
+    end
+
+    def load_from_file(file)
+      result = []
+      IO.readlines(file).each do |line|
+        ip, port = line.chomp.split(':')
+        result << [ip, port.to_i] if ip.is_a?(String) && port.is_a?(String)
+      end
+      result
+    end
+
+    def get_proxy(count, check_connection = false)
+      raise 'List is empty' if @list.empty?
+
+      items = []
+      new_list = @list.clone
+
+      @list.each_with_index do |proxy, key|
+        new_list.shift
+
+        if !check_connection || self.class.connectable?(proxy)
+          new_list << proxy
+
+          if count == 1
+            items = proxy
+            break
+          else
+            items << proxy
+            break if items.size == count
+          end
+        end
+      end
+
+      @list = new_list
+
+      raise 'There are no available proxy' if items.empty?
+
+      save_to_file(@list_file, @list) if @list_file
+
+      items
+    end
+
+    def save_to_file(file, list)
+      source = ''
+      list.each { |p| source << "#{p[0]}:#{p[1]}\n" }
+
+      IO.write(file, source.sub(/\n$/, ''))
+    end
+  end
+end

data/lib/proxy_manager.rb

@@ -1,25 +1,8 @@
-require 'proxy_manager/main'
+require 'proxy_manager/proxy'
 require 'net/ping'
 
 module ProxyManager
-  # Define gem's root path
-  # @return [String] string path
   def self.root
     File.expand_path '../..', __FILE__
   end
-
-  # Create main object
-  # @param proxies [Array, String] array of proxies or file with proxies
-  # @param bad_proxies [String, nil] optional file for save bad proxies
-  # @example
-  #   # from array
-  #   proxy = ProxyManager.load(['1.2.3.4:567', '9.8.7.6:543'])
-  #
-  #   # or from file
-  #   proxy = ProxyManager.load('proxies.txt', 'bad_proxies.txt')
-  # @return [Class] Main object
-  # @see Main
-  def self.load(proxies, bad_proxies = nil)
-    Main.new(proxies, bad_proxies)
-  end
 end

data/proxy_manager.gemspec

@@ -3,22 +3,20 @@ $:.push File.expand_path("../lib", __FILE__)
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
   s.name        = "proxy_manager"
-  s.version     = '0.0.9'
+  s.version     = '1.0.0'
   s.authors     = ["Kirill Platonov"]
   s.licenses    = ['MIT']
   s.email       = ["platonov.kd@gmail.com"]
   s.homepage    = "https://github.com/bloodyhistory/proxy_manager"
-  s.summary     = "Ruby proxy manager for easy usage proxy in parser/web bots."
+  s.summary     = "This is gem for easy usage proxy in your parsers/web-bots."
   s.description = <<-DESCRIPTION
-    This gem is for easy usage proxy in your parsers/web-bots. It will manage
-    your proxy list and check availability.
+    This is gem for easy usage proxy in your parsers/web-bots.
+    It will manage your proxy list and check availability if you need it.
   DESCRIPTION
 
   s.files       = `git ls-files`.split("\n") - %w[.gitignore .travis.yml]
   s.test_files = Dir["spec/**/*"]
 
-  s.add_dependency 'net-ping', '~> 1.7', '>= 1.7.2'
-
   s.add_development_dependency 'turn', '~> 0.9', '>= 0.9.7'
   s.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
   s.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.8'

data/spec/proxy_manager/proxy_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'proxy_manager'
+
+describe ProxyManager::Proxy do
+  let(:list) { [['127.0.0.1', 80], ['127.0.0.1', 8080]] }
+  let(:proxies_file) { File.join(ProxyManager.root,
+                                 'spec',
+                                 'support',
+                                 'proxies.txt'
+                                ) }
+  subject { ProxyManager::Proxy.new(['127.0.0.1:80', '127.0.0.1:8080']) }
+
+  context '#get' do
+    its(:get) { should be_a Array }
+
+    it 'should return many proxies' do
+      expect { subject.get(3) }.not_to raise_error
+    end
+  end
+
+  context '#get!' do
+    it { should respond_to :get! }
+  end
+
+  context '#list' do
+    its(:list) { should match_array list }
+  end
+
+  context '::connectable' do
+    it 'should receive array' do
+      expect(ProxyManager::Proxy.connectable?(['127.0.0.1', 8080])).to be_false
+    end
+
+    it 'should receive string' do
+      expect(ProxyManager::Proxy.connectable?("127.0.0.1:8080")).to be_false
+    end
+  end
+
+  context 'when load from file' do
+    subject { ProxyManager::Proxy.new(proxies_file) }
+
+    its(:list) { should match_array list }
+
+    context 'and save file' do
+      let(:source) { IO.read(proxies_file) }
+
+      it 'should update proxies source' do
+        subject.get(2)
+
+        source = ''
+        subject.list.each { |p| source << "#{p[0]}:#{p[1]}\n" }
+        source.sub!(/\n$/, '')
+
+        expect(IO.read(proxies_file)).to eq(source)
+      end
+
+      after { IO.write(proxies_file, source) }
+    end
+  end
+end

data/spec/proxy_manager_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'proxy_manager'
+
+describe ProxyManager do
+  it { expect(subject.root).not_to be_empty }
+end

data/spec/spec_helper.rb

@@ -1,9 +1,6 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/proxies.txt

@@ -1,3 +1,2 @@
-0.0.1.0:9000
-0.0.0.1:2000
-0.0.0.0:7000
+127.0.0.1:80
+127.0.0.1:8080

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: proxy_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: net-ping
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +131,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.7.4
 description: |2
-      This gem is for easy usage proxy in your parsers/web-bots. It will manage
-      your proxy list and check availability.
+      This is gem for easy usage proxy in your parsers/web-bots.
+      It will manage your proxy list and check availability if you need it.
 email:
 - platonov.kd@gmail.com
 executables: []
@@ -162,34 +142,16 @@ files:
 - ".rspec"
 - ".yardopts"
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- doc/ProxyManager.html
-- doc/ProxyManager/Main.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - lib/proxy_manager.rb
-- lib/proxy_manager/main.rb
-- lib/tasks/proxy_manager_tasks.rake
+- lib/proxy_manager/proxy.rb
 - proxy_manager.gemspec
-- spec/proxy_manager/proxy_manager_spec.rb
+- spec/proxy_manager/proxy_spec.rb
+- spec/proxy_manager_spec.rb
 - spec/spec_helper.rb
-- spec/support/bad_proxies.txt
 - spec/support/proxies.txt
 homepage: https://github.com/bloodyhistory/proxy_manager
 licenses:
@@ -214,10 +176,10 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby proxy manager for easy usage proxy in parser/web bots.
+summary: This is gem for easy usage proxy in your parsers/web-bots.
 test_files:
-- spec/proxy_manager/proxy_manager_spec.rb
+- spec/proxy_manager/proxy_spec.rb
+- spec/proxy_manager_spec.rb
 - spec/spec_helper.rb
-- spec/support/bad_proxies.txt
 - spec/support/proxies.txt
 has_rdoc: